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

Class: Aws::MediaStore::Client

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

Overview

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

mediastore = Aws::MediaStore::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::MediaStore::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::MediaStore::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.

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc 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_container(options = {}) ⇒ Types::CreateContainerOutput

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.

Examples:

Request syntax with placeholder values


resp = client.create_container({
  container_name: "ContainerName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.container.endpoint #=> String
resp.container.creation_time #=> Time
resp.container.arn #=> String
resp.container.name #=> String
resp.container.status #=> String, one of "ACTIVE", "CREATING", "DELETING"
resp.container.access_logging_enabled #=> true/false

Options Hash (options):

  • :container_name (required, String) —

    The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

  • :tags (Array<Types::Tag>) —

    An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

Returns:

See Also:

#delete_container(options = {}) ⇒ Struct

Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers.

Examples:

Request syntax with placeholder values


resp = client.delete_container({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_container_policy(options = {}) ⇒ Struct

Deletes the access policy that is associated with the specified container.

Examples:

Request syntax with placeholder values


resp = client.delete_container_policy({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that holds the policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_cors_policy(options = {}) ⇒ Struct

Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.

To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others.

Examples:

Request syntax with placeholder values


resp = client.delete_cors_policy({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container to remove the policy from.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_lifecycle_policy(options = {}) ⇒ Struct

Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

Examples:

Request syntax with placeholder values


resp = client.delete_lifecycle_policy({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that holds the object lifecycle policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_metric_policy(options = {}) ⇒ Struct

Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.

Examples:

Request syntax with placeholder values


resp = client.delete_metric_policy({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that is associated with the metric policy that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#describe_container(options = {}) ⇒ Types::DescribeContainerOutput

Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers.

Examples:

Request syntax with placeholder values


resp = client.describe_container({
  container_name: "ContainerName",
})

Response structure


resp.container.endpoint #=> String
resp.container.creation_time #=> Time
resp.container.arn #=> String
resp.container.name #=> String
resp.container.status #=> String, one of "ACTIVE", "CREATING", "DELETING"
resp.container.access_logging_enabled #=> true/false

Options Hash (options):

  • :container_name (String) —

    The name of the container to query.

Returns:

See Also:

#get_container_policy(options = {}) ⇒ Types::GetContainerPolicyOutput

Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_container_policy({
  container_name: "ContainerName", # required
})

Response structure


resp.policy #=> String

Options Hash (options):

  • :container_name (required, String) —

    The name of the container.

Returns:

See Also:

#get_cors_policy(options = {}) ⇒ Types::GetCorsPolicyOutput

Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.

To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others.

Examples:

Request syntax with placeholder values


resp = client.get_cors_policy({
  container_name: "ContainerName", # required
})

Response structure


resp.cors_policy #=> Array
resp.cors_policy[0].allowed_origins #=> Array
resp.cors_policy[0].allowed_origins[0] #=> String
resp.cors_policy[0].allowed_methods #=> Array
resp.cors_policy[0].allowed_methods[0] #=> String, one of "PUT", "GET", "DELETE", "HEAD"
resp.cors_policy[0].allowed_headers #=> Array
resp.cors_policy[0].allowed_headers[0] #=> String
resp.cors_policy[0].max_age_seconds #=> Integer
resp.cors_policy[0].expose_headers #=> Array
resp.cors_policy[0].expose_headers[0] #=> String

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that the policy is assigned to.

Returns:

See Also:

#get_lifecycle_policy(options = {}) ⇒ Types::GetLifecyclePolicyOutput

Retrieves the object lifecycle policy that is assigned to a container.

Examples:

Request syntax with placeholder values


resp = client.get_lifecycle_policy({
  container_name: "ContainerName", # required
})

Response structure


resp.lifecycle_policy #=> String

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that the object lifecycle policy is assigned to.

Returns:

See Also:

#get_metric_policy(options = {}) ⇒ Types::GetMetricPolicyOutput

Returns the metric policy for the specified container.

Examples:

Request syntax with placeholder values


resp = client.get_metric_policy({
  container_name: "ContainerName", # required
})

Response structure


resp.metric_policy.container_level_metrics #=> String, one of "ENABLED", "DISABLED"
resp.metric_policy.metric_policy_rules #=> Array
resp.metric_policy.metric_policy_rules[0].object_group #=> String
resp.metric_policy.metric_policy_rules[0].object_group_name #=> String

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that is associated with the metric policy.

Returns:

See Also:

#list_containers(options = {}) ⇒ Types::ListContainersOutput

Lists the properties of all containers in AWS Elemental MediaStore.

You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive.

See also DescribeContainer, which gets the properties of one container.

Examples:

Request syntax with placeholder values


resp = client.list_containers({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.containers #=> Array
resp.containers[0].endpoint #=> String
resp.containers[0].creation_time #=> Time
resp.containers[0].arn #=> String
resp.containers[0].name #=> String
resp.containers[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING"
resp.containers[0].access_logging_enabled #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    Only if you used MaxResults in the first command, enter the token (which was included in the previous response) to obtain the next set of containers. This token is included in a response only if there actually are more containers to list.

  • :max_results (Integer) —

    Enter the maximum number of containers in the response. Use from 1 to 255 characters.

Returns:

See Also:

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

Returns a list of the tags assigned to the specified container.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource: "ContainerARN", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource (required, String) —

    The Amazon Resource Name (ARN) for the container.

Returns:

See Also:

#put_container_policy(options = {}) ⇒ Struct

Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.

For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.

Examples:

Request syntax with placeholder values


resp = client.put_container_policy({
  container_name: "ContainerName", # required
  policy: "ContainerPolicy", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container.

  • :policy (required, String) —

    The contents of the policy, which includes the following:

    • One Version tag

    • One Statement tag that contains the standard tags for the policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#put_cors_policy(options = {}) ⇒ Struct

Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.

To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.

Examples:

Request syntax with placeholder values


resp = client.put_cors_policy({
  container_name: "ContainerName", # required
  cors_policy: [ # required
    {
      allowed_origins: ["Origin"], # required
      allowed_methods: ["PUT"], # accepts PUT, GET, DELETE, HEAD
      allowed_headers: ["Header"], # required
      max_age_seconds: 1,
      expose_headers: ["Header"],
    },
  ],
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that you want to assign the CORS policy to.

  • :cors_policy (required, Array<Types::CorsRule>) —

    The CORS policy to apply to the container.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#put_lifecycle_policy(options = {}) ⇒ Struct

Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.

For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.

Examples:

Request syntax with placeholder values


resp = client.put_lifecycle_policy({
  container_name: "ContainerName", # required
  lifecycle_policy: "LifecyclePolicy", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that you want to assign the object lifecycle policy to.

  • :lifecycle_policy (required, String) —

    The object lifecycle policy to apply to the container.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#put_metric_policy(options = {}) ⇒ Struct

The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.

Examples:

Request syntax with placeholder values


resp = client.put_metric_policy({
  container_name: "ContainerName", # required
  metric_policy: { # required
    container_level_metrics: "ENABLED", # required, accepts ENABLED, DISABLED
    metric_policy_rules: [
      {
        object_group: "ObjectGroup", # required
        object_group_name: "ObjectGroupName", # required
      },
    ],
  },
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that you want to add the metric policy to.

  • :metric_policy (required, Types::MetricPolicy) —

    The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:

    • An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can\'t have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.

    • An object group name that allows you to refer to the object group. The name can\'t have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#start_access_logging(options = {}) ⇒ Struct

Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.

Examples:

Request syntax with placeholder values


resp = client.start_access_logging({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that you want to start access logging on.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#stop_access_logging(options = {}) ⇒ Struct

Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.

Examples:

Request syntax with placeholder values


resp = client.stop_access_logging({
  container_name: "ContainerName", # required
})

Options Hash (options):

  • :container_name (required, String) —

    The name of the container that you want to stop access logging on.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource: "ContainerARN", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Options Hash (options):

  • :resource (required, String) —

    The Amazon Resource Name (ARN) for the container.

  • :tags (required, Array<Types::Tag>) —

    An array of key:value pairs that you want to add to the container. You need to specify only the tags that you want to add or update. For example, suppose a container already has two tags (customer:CompanyA and priority:High). You want to change the priority tag and also add a third tag (type:Contract). For TagResource, you specify the following tags: priority:Medium, type:Contract. The result is that your container has three tags: customer:CompanyA, priority:Medium, and type:Contract.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes tags from the specified container. You can specify one or more tags to remove.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource: "ContainerARN", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

  • :resource (required, String) —

    The Amazon Resource Name (ARN) for the container.

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

    A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove (priority).

Returns:

  • (Struct) —

    Returns an empty response.

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:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.