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

Class: Aws::Schemas::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

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.

Region

You can configure a default region in the following locations:

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

Go here for a list of supported regions.

Credentials

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:

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

# load credentials from disk
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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

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

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_discoverer(options = {}) ⇒ Types::CreateDiscovererResponse

Creates a discoverer.

Examples:

Request syntax with placeholder values


resp = client.create_discoverer({
  description: "__stringMin0Max256",
  source_arn: "__stringMin20Max1600", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.description #=> String
resp.discoverer_arn #=> String
resp.discoverer_id #=> String
resp.source_arn #=> String
resp.state #=> String, one of "STARTED", "STOPPED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :description (String)
  • :source_arn (required, String)
  • :tags (Hash<String,String>) —

    Key-value pairs associated with a resource.

Returns:

See Also:

#create_registry(options = {}) ⇒ Types::CreateRegistryResponse

Creates a registry.

Examples:

Request syntax with placeholder values


resp = client.create_registry({
  description: "__stringMin0Max256",
  registry_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.description #=> String
resp.registry_arn #=> String
resp.registry_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :description (String)
  • :registry_name (required, String)
  • :tags (Hash<String,String>) —

    Key-value pairs associated with a resource.

Returns:

See Also:

#create_schema(options = {}) ⇒ Types::CreateSchemaResponse

Creates a schema definition.

Inactive schemas will be deleted after two years.

Examples:

Request syntax with placeholder values


resp = client.create_schema({
  content: "__stringMin1Max100000", # required
  description: "__stringMin0Max256",
  registry_name: "__string", # required
  schema_name: "__string", # required
  tags: {
    "__string" => "__string",
  },
  type: "OpenApi3", # required, accepts OpenApi3
})

Response structure


resp.description #=> String
resp.last_modified #=> Time
resp.schema_arn #=> String
resp.schema_name #=> String
resp.schema_version #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.type #=> String
resp.version_created_date #=> Time

Options Hash (options):

  • :content (required, String)
  • :description (String)
  • :registry_name (required, String)
  • :schema_name (required, String)
  • :tags (Hash<String,String>) —

    Key-value pairs associated with a resource.

  • :type (required, String)

Returns:

See Also:

#delete_discoverer(options = {}) ⇒ Struct

Deletes a discoverer.

Examples:

Request syntax with placeholder values


resp = client.delete_discoverer({
  discoverer_id: "__string", # required
})

Options Hash (options):

  • :discoverer_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_registry(options = {}) ⇒ Struct

Deletes a Registry.

Examples:

Request syntax with placeholder values


resp = client.delete_registry({
  registry_name: "__string", # required
})

Options Hash (options):

  • :registry_name (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_resource_policy(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  registry_name: "__string",
})

Options Hash (options):

  • :registry_name (String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_schema(options = {}) ⇒ Struct

Delete a schema definition.

Examples:

Request syntax with placeholder values


resp = client.delete_schema({
  registry_name: "__string", # required
  schema_name: "__string", # required
})

Options Hash (options):

  • :registry_name (required, String)
  • :schema_name (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_schema_version(options = {}) ⇒ Struct

Delete the schema version definition

Examples:

Request syntax with placeholder values


resp = client.delete_schema_version({
  registry_name: "__string", # required
  schema_name: "__string", # required
  schema_version: "__string", # required
})

Options Hash (options):

  • :registry_name (required, String)
  • :schema_name (required, String)
  • :schema_version (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

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

Describe the code binding URI.

Examples:

Request syntax with placeholder values


resp = client.describe_code_binding({
  language: "__string", # required
  registry_name: "__string", # required
  schema_name: "__string", # required
  schema_version: "__string",
})

Response structure


resp.creation_date #=> Time
resp.last_modified #=> Time
resp.schema_version #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"

Options Hash (options):

  • :language (required, String)
  • :registry_name (required, String)
  • :schema_name (required, String)
  • :schema_version (String)

Returns:

See Also:

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

Describes the discoverer.

Examples:

Request syntax with placeholder values


resp = client.describe_discoverer({
  discoverer_id: "__string", # required
})

Response structure


resp.description #=> String
resp.discoverer_arn #=> String
resp.discoverer_id #=> String
resp.source_arn #=> String
resp.state #=> String, one of "STARTED", "STOPPED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :discoverer_id (required, String)

Returns:

See Also:

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

Describes the registry.

Examples:

Request syntax with placeholder values


resp = client.describe_registry({
  registry_name: "__string", # required
})

Response structure


resp.description #=> String
resp.registry_arn #=> String
resp.registry_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :registry_name (required, String)

Returns:

See Also:

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

Retrieve the schema definition.

Examples:

Request syntax with placeholder values


resp = client.describe_schema({
  registry_name: "__string", # required
  schema_name: "__string", # required
  schema_version: "__string",
})

Response structure


resp.content #=> String
resp.description #=> String
resp.last_modified #=> Time
resp.schema_arn #=> String
resp.schema_name #=> String
resp.schema_version #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.type #=> String
resp.version_created_date #=> Time

Options Hash (options):

  • :registry_name (required, String)
  • :schema_name (required, String)
  • :schema_version (String)

Returns:

See Also:

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

Exports a schema to a different specification.

Examples:

Request syntax with placeholder values


resp = client.export_schema({
  registry_name: "__string", # required
  schema_name: "__string", # required
  schema_version: "__string",
  type: "__string", # required
})

Response structure


resp.content #=> String
resp.schema_arn #=> String
resp.schema_name #=> String
resp.schema_version #=> String
resp.type #=> String

Options Hash (options):

  • :registry_name (required, String)
  • :schema_name (required, String)
  • :schema_version (String)
  • :type (required, String)

Returns:

See Also:

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

Get the code binding source URI.

Examples:

Request syntax with placeholder values


resp = client.get_code_binding_source({
  language: "__string", # required
  registry_name: "__string", # required
  schema_name: "__string", # required
  schema_version: "__string",
})

Response structure


resp.body #=> IO

Options Hash (options):

  • :language (required, String)
  • :registry_name (required, String)
  • :schema_name (required, String)
  • :schema_version (String)

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.get_discovered_schema({
  events: ["GetDiscoveredSchemaVersionItemInput"], # required
  type: "OpenApi3", # required, accepts OpenApi3
})

Response structure


resp.content #=> String

Options Hash (options):

  • :events (required, Array<String>)
  • :type (required, String)

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  registry_name: "__string",
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Options Hash (options):

  • :registry_name (String)

Returns:

See Also:

#list_discoverers(options = {}) ⇒ Types::ListDiscoverersResponse

List the discoverers.

Examples:

Request syntax with placeholder values


resp = client.list_discoverers({
  discoverer_id_prefix: "__string",
  limit: 1,
  next_token: "__string",
  source_arn_prefix: "__string",
})

Response structure


resp.discoverers #=> Array
resp.discoverers[0].discoverer_arn #=> String
resp.discoverers[0].discoverer_id #=> String
resp.discoverers[0].source_arn #=> String
resp.discoverers[0].state #=> String, one of "STARTED", "STOPPED"
resp.discoverers[0].tags #=> Hash
resp.discoverers[0].tags["__string"] #=> String
resp.next_token #=> String

Options Hash (options):

  • :discoverer_id_prefix (String)
  • :limit (Integer)
  • :next_token (String)
  • :source_arn_prefix (String)

Returns:

See Also:

#list_registries(options = {}) ⇒ Types::ListRegistriesResponse

List the registries.

Examples:

Request syntax with placeholder values


resp = client.list_registries({
  limit: 1,
  next_token: "__string",
  registry_name_prefix: "__string",
  scope: "__string",
})

Response structure


resp.next_token #=> String
resp.registries #=> Array
resp.registries[0].registry_arn #=> String
resp.registries[0].registry_name #=> String
resp.registries[0].tags #=> Hash
resp.registries[0].tags["__string"] #=> String

Options Hash (options):

  • :limit (Integer)
  • :next_token (String)
  • :registry_name_prefix (String)
  • :scope (String)

Returns:

See Also:

#list_schema_versions(options = {}) ⇒ Types::ListSchemaVersionsResponse

Provides a list of the schema versions and related information.

Examples:

Request syntax with placeholder values


resp = client.list_schema_versions({
  limit: 1,
  next_token: "__string",
  registry_name: "__string", # required
  schema_name: "__string", # required
})

Response structure


resp.next_token #=> String
resp.schema_versions #=> Array
resp.schema_versions[0].schema_arn #=> String
resp.schema_versions[0].schema_name #=> String
resp.schema_versions[0].schema_version #=> String
resp.schema_versions[0].type #=> String

Options Hash (options):

  • :limit (Integer)
  • :next_token (String)
  • :registry_name (required, String)
  • :schema_name (required, String)

Returns:

See Also:

#list_schemas(options = {}) ⇒ Types::ListSchemasResponse

List the schemas.

Examples:

Request syntax with placeholder values


resp = client.list_schemas({
  limit: 1,
  next_token: "__string",
  registry_name: "__string", # required
  schema_name_prefix: "__string",
})

Response structure


resp.next_token #=> String
resp.schemas #=> Array
resp.schemas[0].last_modified #=> Time
resp.schemas[0].schema_arn #=> String
resp.schemas[0].schema_name #=> String
resp.schemas[0].tags #=> Hash
resp.schemas[0].tags["__string"] #=> String
resp.schemas[0].version_count #=> Integer

Options Hash (options):

  • :limit (Integer)
  • :next_token (String)
  • :registry_name (required, String)
  • :schema_name_prefix (String)

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

Get tags for resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :resource_arn (required, String)

Returns:

See Also:

#put_code_binding(options = {}) ⇒ Types::PutCodeBindingResponse

Put code binding URI

Examples:

Request syntax with placeholder values


resp = client.put_code_binding({
  language: "__string", # required
  registry_name: "__string", # required
  schema_name: "__string", # required
  schema_version: "__string",
})

Response structure


resp.creation_date #=> Time
resp.last_modified #=> Time
resp.schema_version #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"

Options Hash (options):

  • :language (required, String)
  • :registry_name (required, String)
  • :schema_name (required, String)
  • :schema_version (String)

Returns:

See Also:

#put_resource_policy(options = {}) ⇒ Types::PutResourcePolicyResponse

The name of the policy.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  policy: "__string", # required
  registry_name: "__string",
  revision_id: "__string",
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Options Hash (options):

  • :policy (required, String) —

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :registry_name (String)
  • :revision_id (String)

Returns:

See Also:

#search_schemas(options = {}) ⇒ Types::SearchSchemasResponse

Search the schemas

Examples:

Request syntax with placeholder values


resp = client.search_schemas({
  keywords: "__string", # required
  limit: 1,
  next_token: "__string",
  registry_name: "__string", # required
})

Response structure


resp.next_token #=> String
resp.schemas #=> Array
resp.schemas[0].registry_name #=> String
resp.schemas[0].schema_arn #=> String
resp.schemas[0].schema_name #=> String
resp.schemas[0].schema_versions #=> Array
resp.schemas[0].schema_versions[0].created_date #=> Time
resp.schemas[0].schema_versions[0].schema_version #=> String
resp.schemas[0].schema_versions[0].type #=> String

Options Hash (options):

  • :keywords (required, String)
  • :limit (Integer)
  • :next_token (String)
  • :registry_name (required, String)

Returns:

See Also:

#start_discoverer(options = {}) ⇒ Types::StartDiscovererResponse

Starts the discoverer

Examples:

Request syntax with placeholder values


resp = client.start_discoverer({
  discoverer_id: "__string", # required
})

Response structure


resp.discoverer_id #=> String
resp.state #=> String, one of "STARTED", "STOPPED"

Options Hash (options):

  • :discoverer_id (required, String)

Returns:

See Also:

#stop_discoverer(options = {}) ⇒ Types::StopDiscovererResponse

Stops the discoverer

Examples:

Request syntax with placeholder values


resp = client.stop_discoverer({
  discoverer_id: "__string", # required
})

Response structure


resp.discoverer_id #=> String
resp.state #=> String, one of "STARTED", "STOPPED"

Options Hash (options):

  • :discoverer_id (required, String)

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Add tags to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "__string", # required
  tags: { # required
    "__string" => "__string",
  },
})

Options Hash (options):

  • :resource_arn (required, String)
  • :tags (required, Hash<String,String>) —

    Key-value pairs associated with a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Options Hash (options):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#update_discoverer(options = {}) ⇒ Types::UpdateDiscovererResponse

Updates the discoverer

Examples:

Request syntax with placeholder values


resp = client.update_discoverer({
  description: "__stringMin0Max256",
  discoverer_id: "__string", # required
})

Response structure


resp.description #=> String
resp.discoverer_arn #=> String
resp.discoverer_id #=> String
resp.source_arn #=> String
resp.state #=> String, one of "STARTED", "STOPPED"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :description (String)
  • :discoverer_id (required, String)

Returns:

See Also:

#update_registry(options = {}) ⇒ Types::UpdateRegistryResponse

Updates a registry.

Examples:

Request syntax with placeholder values


resp = client.update_registry({
  description: "__stringMin0Max256",
  registry_name: "__string", # required
})

Response structure


resp.description #=> String
resp.registry_arn #=> String
resp.registry_name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Options Hash (options):

  • :description (String)
  • :registry_name (required, String)

Returns:

See Also:

#update_schema(options = {}) ⇒ Types::UpdateSchemaResponse

Updates the schema definition

Inactive schemas will be deleted after two years.

Examples:

Request syntax with placeholder values


resp = client.update_schema({
  client_token_id: "__stringMin0Max36",
  content: "__stringMin1Max100000",
  description: "__stringMin0Max256",
  registry_name: "__string", # required
  schema_name: "__string", # required
  type: "OpenApi3", # accepts OpenApi3
})

Response structure


resp.description #=> String
resp.last_modified #=> Time
resp.schema_arn #=> String
resp.schema_name #=> String
resp.schema_version #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.type #=> String
resp.version_created_date #=> Time

Options Hash (options):

  • :client_token_id (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :content (String)
  • :description (String)
  • :registry_name (required, String)
  • :schema_name (required, String)
  • :type (String)

Returns:

See Also:

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

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

Basic Usage

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)

Configuration

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

Callbacks

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

Handling Errors

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

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {}) —

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

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

Waiter NameClient MethodDefault Delay:Default Max Attempts:
:code_binding_exists#describe_code_binding230

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.