Class: Aws::Schemas::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    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.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



305
306
307
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 305

def initialize(*args)
  super
end

Instance Method Details

#create_discoverer(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

    Key-value pairs associated with a resource.

Returns:

See Also:



353
354
355
356
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 353

def create_discoverer(params = {}, options = {})
  req = build_request(:create_discoverer, params)
  req.send_request(options)
end

#create_registry(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

    Key-value pairs associated with a resource.

Returns:

See Also:



396
397
398
399
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 396

def create_registry(params = {}, options = {})
  req = build_request(:create_registry, params)
  req.send_request(options)
end

#create_schema(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



460
461
462
463
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 460

def create_schema(params = {}, options = {})
  req = build_request(:create_schema, params)
  req.send_request(options)
end

#delete_discoverer(params = {}) ⇒ Struct

Deletes a discoverer.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :discoverer_id (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



481
482
483
484
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 481

def delete_discoverer(params = {}, options = {})
  req = build_request(:delete_discoverer, params)
  req.send_request(options)
end

#delete_registry(params = {}) ⇒ Struct

Deletes a Registry.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :registry_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



502
503
504
505
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 502

def delete_registry(params = {}, options = {})
  req = build_request(:delete_registry, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ 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",
})

Parameters:

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

    ({})

Options Hash (params):

  • :registry_name (String)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



523
524
525
526
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 523

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_schema(params = {}) ⇒ Struct

Delete a schema definition.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



547
548
549
550
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 547

def delete_schema(params = {}, options = {})
  req = build_request(:delete_schema, params)
  req.send_request(options)
end

#delete_schema_version(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



574
575
576
577
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 574

def delete_schema_version(params = {}, options = {})
  req = build_request(:delete_schema_version, params)
  req.send_request(options)
end

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

Describe the code binding URI.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • code_binding_exists

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"

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



621
622
623
624
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 621

def describe_code_binding(params = {}, options = {})
  req = build_request(:describe_code_binding, params)
  req.send_request(options)
end

#describe_discoverer(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :discoverer_id (required, String)

Returns:

See Also:



659
660
661
662
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 659

def describe_discoverer(params = {}, options = {})
  req = build_request(:describe_discoverer, params)
  req.send_request(options)
end

#describe_registry(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :registry_name (required, String)

Returns:

See Also:



693
694
695
696
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 693

def describe_registry(params = {}, options = {})
  req = build_request(:describe_registry, params)
  req.send_request(options)
end

#describe_schema(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



743
744
745
746
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 743

def describe_schema(params = {}, options = {})
  req = build_request(:describe_schema, params)
  req.send_request(options)
end

#get_code_binding_source(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



779
780
781
782
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 779

def get_code_binding_source(params = {}, options = {}, &block)
  req = build_request(:get_code_binding_source, params)
  req.send_request(options, &block)
end

#get_discovered_schema(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



809
810
811
812
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 809

def get_discovered_schema(params = {}, options = {})
  req = build_request(:get_discovered_schema, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :registry_name (String)

Returns:

See Also:



838
839
840
841
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 838

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

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

List the discoverers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



884
885
886
887
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 884

def list_discoverers(params = {}, options = {})
  req = build_request(:list_discoverers, params)
  req.send_request(options)
end

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

List the registries.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



928
929
930
931
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 928

def list_registries(params = {}, options = {})
  req = build_request(:list_registries, params)
  req.send_request(options)
end

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

Provides a list of the schema versions and related information.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



971
972
973
974
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 971

def list_schema_versions(params = {}, options = {})
  req = build_request(:list_schema_versions, params)
  req.send_request(options)
end

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

List the schemas.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1017
1018
1019
1020
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1017

def list_schemas(params = {}, options = {})
  req = build_request(:list_schemas, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



1045
1046
1047
1048
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1045

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_code_binding(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1087
1088
1089
1090
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1087

def put_code_binding(params = {}, options = {})
  req = build_request(:put_code_binding, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1125
1126
1127
1128
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1125

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

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

Search the schemas

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1171
1172
1173
1174
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1171

def search_schemas(params = {}, options = {})
  req = build_request(:search_schemas, params)
  req.send_request(options)
end

#start_discoverer(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :discoverer_id (required, String)

Returns:

See Also:



1200
1201
1202
1203
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1200

def start_discoverer(params = {}, options = {})
  req = build_request(:start_discoverer, params)
  req.send_request(options)
end

#stop_discoverer(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :discoverer_id (required, String)

Returns:

See Also:



1229
1230
1231
1232
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1229

def stop_discoverer(params = {}, options = {})
  req = build_request(:stop_discoverer, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Add tags to a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

    Key-value pairs associated with a resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1256
1257
1258
1259
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1256

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1280
1281
1282
1283
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1280

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_discoverer(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1321
1322
1323
1324
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1321

def update_discoverer(params = {}, options = {})
  req = build_request(:update_discoverer, params)
  req.send_request(options)
end

#update_registry(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



1358
1359
1360
1361
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1358

def update_registry(params = {}, options = {})
  req = build_request(:update_registry, params)
  req.send_request(options)
end

#update_schema(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token_id (String)

    A suitable default value is auto-generated. You should normally not need to pass this option.**

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

Returns:

See Also:



1421
1422
1423
1424
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1421

def update_schema(params = {}, options = {})
  req = build_request(:update_schema, params)
  req.send_request(options)
end

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

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

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

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

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(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

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

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

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

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
code_binding_exists #describe_code_binding 2 30

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {})

    ({})

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

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.



1531
1532
1533
1534
1535
# File 'gems/aws-sdk-schemas/lib/aws-sdk-schemas/client.rb', line 1531

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end