Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/Schemas/Client.html below:

Client — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

An API client for Schemas. To construct a client, you need to configure a :region and :credentials.

schemas = Aws::Schemas::Client.new(
  region: region_name,
  credentials: credentials,
  )

See #initialize for a full list of supported configuration options.

You can configure a default region in the following locations:

• ENV['AWS_REGION']
• Aws.config[:region]

Go here for a list of supported regions.

Default credentials are loaded automatically from the following locations:

• ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
• Aws.config[:credentials]
• The shared credentials ini file at ~/.aws/credentials (more information)
• From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

• Credentials
• Aws::SharedCredentials
• InstanceProfileCredentials
• AssumeRoleCredentials

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::Schemas::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

#config, #handlers

• #initialize(options = {}) ⇒ Aws::Schemas::Client constructor

  Constructs an API client.

• #create_discoverer(options = {}) ⇒ Types::CreateDiscovererResponse
• #create_registry(options = {}) ⇒ Types::CreateRegistryResponse
• #create_schema(options = {}) ⇒ Types::CreateSchemaResponse

  Creates a schema definition.

  Inactive schemas will be deleted after two years.

  .

• #delete_discoverer(options = {}) ⇒ Struct
• #delete_registry(options = {}) ⇒ Struct
• #delete_resource_policy(options = {}) ⇒ Struct

  Delete the resource-based policy attached to the specified registry.

  .

• #delete_schema(options = {}) ⇒ Struct

  Delete a schema definition.

  .

• #delete_schema_version(options = {}) ⇒ Struct

  Delete the schema version definition

  .

• #describe_code_binding(options = {}) ⇒ Types::DescribeCodeBindingResponse

  Describe the code binding URI.

  .

• #describe_discoverer(options = {}) ⇒ Types::DescribeDiscovererResponse

  Describes the discoverer.

  .

• #describe_registry(options = {}) ⇒ Types::DescribeRegistryResponse

  Describes the registry.

  .

• #describe_schema(options = {}) ⇒ Types::DescribeSchemaResponse

  Retrieve the schema definition.

  .

• #export_schema(options = {}) ⇒ Types::ExportSchemaResponse

  Exports a schema to a different specification.

  .

• #get_code_binding_source(options = {}) ⇒ Types::GetCodeBindingSourceResponse

  Get the code binding source URI.

  .

• #get_discovered_schema(options = {}) ⇒ Types::GetDiscoveredSchemaResponse

  Get the discovered schema that was generated based on sampled events.

  .

• #get_resource_policy(options = {}) ⇒ Types::GetResourcePolicyResponse

  Retrieves the resource-based policy attached to a given registry.

  .

• #list_discoverers(options = {}) ⇒ Types::ListDiscoverersResponse
• #list_registries(options = {}) ⇒ Types::ListRegistriesResponse
• #list_schema_versions(options = {}) ⇒ Types::ListSchemaVersionsResponse

  Provides a list of the schema versions and related information.

  .

• #list_schemas(options = {}) ⇒ Types::ListSchemasResponse
• #list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
• #put_code_binding(options = {}) ⇒ Types::PutCodeBindingResponse
• #put_resource_policy(options = {}) ⇒ Types::PutResourcePolicyResponse

  The name of the policy.

  .

• #search_schemas(options = {}) ⇒ Types::SearchSchemasResponse
• #start_discoverer(options = {}) ⇒ Types::StartDiscovererResponse
• #stop_discoverer(options = {}) ⇒ Types::StopDiscovererResponse
• #tag_resource(options = {}) ⇒ Struct

  Add tags to a resource.

  .

• #untag_resource(options = {}) ⇒ Struct

  Removes tags from a resource.

  .

• #update_discoverer(options = {}) ⇒ Types::UpdateDiscovererResponse
• #update_registry(options = {}) ⇒ Types::UpdateRegistryResponse
• #update_schema(options = {}) ⇒ Types::UpdateSchemaResponse

  Updates the schema definition

  Inactive schemas will be deleted after two years.

  .

• #wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

  Waiters polls an API operation until a resource enters a desired state.

• #waiter_names ⇒ Array<Symbol>

  Returns the list of supported waiters.

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

#handle, #handle_request, #handle_response

Creates a schema definition.

Inactive schemas will be deleted after two years.

Delete the resource-based policy attached to the specified registry.

Delete a schema definition.

Delete the schema version definition

Removes tags from a resource.

Updates the schema definition

Inactive schemas will be deleted after two years.

Waiters polls an API operation until a resource enters a desired state.

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4