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

Class: Aws::Snowball::Client

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

Overview

An API client for Amazon Import/Export Snowball. To construct a client, you need to configure a :region and :credentials.

snowball = Aws::Snowball::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::Snowball::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::Snowball::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner 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.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint 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

#cancel_cluster(options = {}) ⇒ Struct

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Examples:

Example: To cancel a cluster job


# This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.

resp = client.cancel_cluster({
  cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
})

Request syntax with placeholder values


resp = client.cancel_cluster({
  cluster_id: "ClusterId", # required
})

Options Hash (options):

  • :cluster_id (required, String)

    The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#cancel_job(options = {}) ⇒ Struct

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned.

Examples:

Example: To cancel a job for a Snowball device


# This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.

resp = client.cancel_job({
  job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
})

Request syntax with placeholder values


resp = client.cancel_job({
  job_id: "JobId", # required
})

Options Hash (options):

  • :job_id (required, String)

    The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#create_address(options = {}) ⇒ Types::CreateAddressResult

Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

Examples:

Example: To create an address for a job


# This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

resp = client.create_address({
  address: {
    city: "Seattle", 
    company: "My Company's Name", 
    country: "USA", 
    name: "My Name", 
    phone_number: "425-555-5555", 
    postal_code: "98101", 
    state_or_province: "WA", 
    street_1: "123 Main Street", 
  }, 
})

# resp.to_h outputs the following:
{
  address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
}

Request syntax with placeholder values


resp = client.create_address({
  address: { # required
    address_id: "AddressId",
    name: "String",
    company: "String",
    street_1: "String",
    street_2: "String",
    street_3: "String",
    city: "String",
    state_or_province: "String",
    prefecture_or_district: "String",
    landmark: "String",
    country: "String",
    postal_code: "String",
    phone_number: "String",
    is_restricted: false,
  },
})

Response structure


resp.address_id #=> String

Options Hash (options):

  • :address (required, Types::Address)

    The address that you want the Snowball shipped to.

Returns:

See Also:

#create_cluster(options = {}) ⇒ Types::CreateClusterResult

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Examples:

Example: To create a cluster


# Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

resp = client.create_cluster({
  address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  description: "MyCluster", 
  job_type: "LOCAL_USE", 
  kms_key_arn: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
  notification: {
    job_states_to_notify: [
    ], 
    notify_all: false, 
  }, 
  resources: {
    s3_resources: [
      {
        bucket_arn: "arn:aws:s3:::MyBucket", 
        key_range: {
        }, 
      }, 
    ], 
  }, 
  role_arn: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
  shipping_option: "SECOND_DAY", 
  snowball_type: "EDGE", 
})

# resp.to_h outputs the following:
{
  cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
}

Request syntax with placeholder values


resp = client.create_cluster({
  job_type: "IMPORT", # required, accepts IMPORT, EXPORT, LOCAL_USE
  resources: { # required
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  description: "String",
  address_id: "AddressId", # required
  kms_key_arn: "KmsKeyARN",
  role_arn: "RoleARN", # required
  snowball_type: "STANDARD", # accepts STANDARD, EDGE
  shipping_option: "SECOND_DAY", # required, accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  forwarding_address_id: "AddressId",
})

Response structure


resp.cluster_id #=> String

Options Hash (options):

  • :job_type (required, String)

    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

  • :resources (required, Types::JobResource)

    The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

  • :description (String)

    An optional description of this specific cluster, for example Environmental Data Cluster-01.

  • :address_id (required, String)

    The ID for the address that you want the cluster shipped to.>

  • :kms_key_arn (String)

    The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

  • :role_arn (required, String)

    The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

  • :snowball_type (String)

    The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

  • :shipping_option (required, String)

    The shipping speed for each node in this cluster. This speed doesn\'t dictate how soon you\'ll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

    • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

    • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snowball Edges are delivered in one to seven days.

    • In the US, you have access to one-day shipping and two-day shipping.

  • :notification (Types::Notification)

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

  • :forwarding_address_id (String)

    The forwarding address ID for a cluster. This field is not supported in most regions.

Returns:

See Also:

#create_job(options = {}) ⇒ Types::CreateJobResult

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Examples:

Example: To create a job


# Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

resp = client.create_job({
  address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  description: "My Job", 
  job_type: "IMPORT", 
  kms_key_arn: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
  notification: {
    job_states_to_notify: [
    ], 
    notify_all: false, 
  }, 
  resources: {
    s3_resources: [
      {
        bucket_arn: "arn:aws:s3:::MyBucket", 
        key_range: {
        }, 
      }, 
    ], 
  }, 
  role_arn: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
  shipping_option: "SECOND_DAY", 
  snowball_capacity_preference: "T80", 
  snowball_type: "STANDARD", 
})

# resp.to_h outputs the following:
{
  job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
}

Request syntax with placeholder values


resp = client.create_job({
  job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
  resources: {
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  description: "String",
  address_id: "AddressId",
  kms_key_arn: "KmsKeyARN",
  role_arn: "RoleARN",
  snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
  shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  cluster_id: "ClusterId",
  snowball_type: "STANDARD", # accepts STANDARD, EDGE
  forwarding_address_id: "AddressId",
})

Response structure


resp.job_id #=> String

Options Hash (options):

  • :job_type (String)

    Defines the type of job that you\'re creating.

  • :resources (Types::JobResource)

    Defines the Amazon S3 buckets associated with this job.

    With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

    With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

  • :description (String)

    Defines an optional description of this specific job, for example Important Photos 2016-08-11.

  • :address_id (String)

    The ID for the address that you want the Snowball shipped to.

  • :kms_key_arn (String)

    The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

  • :role_arn (String)

    The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

  • :snowball_capacity_preference (String)

    If your job is being created in one of the US regions, you have the option of specifying what size Snowball you\'d like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

  • :shipping_option (String)

    The shipping speed for this job. This speed doesn\'t dictate how soon you\'ll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:

    • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.

    • In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snowballs are delivered in one to seven days.

    • In the US, you have access to one-day shipping and two-day shipping.

  • :notification (Types::Notification)

    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

  • :cluster_id (String)

    The ID of a cluster. If you\'re creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

  • :snowball_type (String)

    The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE.

  • :forwarding_address_id (String)

    The forwarding address ID for a job. This field is not supported in most regions.

Returns:

See Also:

#describe_address(options = {}) ⇒ Types::DescribeAddressResult

Takes an AddressId and returns specific details about that address in the form of an Address object.

Examples:

Example: To describe an address for a job


# This operation describes an address for a job.

resp = client.describe_address({
  address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
})

# resp.to_h outputs the following:
{
  address: {
    address_id: "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b", 
    city: "Seattle", 
    company: "My Company", 
    country: "US", 
    name: "My Name", 
    phone_number: "425-555-5555", 
    postal_code: "98101", 
    state_or_province: "WA", 
    street_1: "123 Main Street", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_address({
  address_id: "AddressId", # required
})

Response structure


resp.address.address_id #=> String
resp.address.name #=> String
resp.address.company #=> String
resp.address.street_1 #=> String
resp.address.street_2 #=> String
resp.address.street_3 #=> String
resp.address.city #=> String
resp.address.state_or_province #=> String
resp.address.prefecture_or_district #=> String
resp.address.landmark #=> String
resp.address.country #=> String
resp.address.postal_code #=> String
resp.address.phone_number #=> String
resp.address.is_restricted #=> true/false

Options Hash (options):

  • :address_id (required, String)

    The automatically generated ID for a specific address.

Returns:

See Also:

#describe_addresses(options = {}) ⇒ Types::DescribeAddressesResult

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Examples:

Example: To describe all the addresses you've created for AWS Snowball


# This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

resp = client.describe_addresses({
})

# resp.to_h outputs the following:
{
  addresses: [
    {
      address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
      city: "Seattle", 
      company: "My Company", 
      country: "US", 
      name: "My Name", 
      phone_number: "425-555-5555", 
      postal_code: "98101", 
      state_or_province: "WA", 
      street_1: "123 Main Street", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_addresses({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.addresses #=> Array
resp.addresses[0].address_id #=> String
resp.addresses[0].name #=> String
resp.addresses[0].company #=> String
resp.addresses[0].street_1 #=> String
resp.addresses[0].street_2 #=> String
resp.addresses[0].street_3 #=> String
resp.addresses[0].city #=> String
resp.addresses[0].state_or_province #=> String
resp.addresses[0].prefecture_or_district #=> String
resp.addresses[0].landmark #=> String
resp.addresses[0].country #=> String
resp.addresses[0].postal_code #=> String
resp.addresses[0].phone_number #=> String
resp.addresses[0].is_restricted #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

    The number of ADDRESS objects to return.

  • :next_token (String)

    HTTP requests are stateless. To identify what object comes \"next\" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

Returns:

See Also:

#describe_cluster(options = {}) ⇒ Types::DescribeClusterResult

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Examples:

Example: To describe a cluster


# Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

resp = client.describe_cluster({
  cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
})

# resp.to_h outputs the following:
{
  cluster_metadata: {
    address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
    cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
    cluster_state: "Pending", 
    creation_date: Time.parse("1480475517.0"), 
    description: "MyCluster", 
    job_type: "LOCAL_USE", 
    kms_key_arn: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
    notification: {
      job_states_to_notify: [
      ], 
      notify_all: false, 
    }, 
    resources: {
      s3_resources: [
        {
          bucket_arn: "arn:aws:s3:::MyBucket", 
          key_range: {
          }, 
        }, 
      ], 
    }, 
    role_arn: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
    shipping_option: "SECOND_DAY", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_cluster({
  cluster_id: "ClusterId", # required
})

Response structure


resp..cluster_id #=> String
resp..description #=> String
resp..kms_key_arn #=> String
resp..role_arn #=> String
resp..cluster_state #=> String, one of "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled"
resp..job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
resp..snowball_type #=> String, one of "STANDARD", "EDGE"
resp..creation_date #=> Time
resp..resources.s3_resources #=> Array
resp..resources.s3_resources[0].bucket_arn #=> String
resp..resources.s3_resources[0].key_range.begin_marker #=> String
resp..resources.s3_resources[0].key_range.end_marker #=> String
resp..resources.lambda_resources #=> Array
resp..resources.lambda_resources[0].lambda_arn #=> String
resp..resources.lambda_resources[0].event_triggers #=> Array
resp..resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
resp..address_id #=> String
resp..shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
resp..notification.sns_topic_arn #=> String
resp..notification.job_states_to_notify #=> Array
resp..notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp..notification.notify_all #=> true/false
resp..forwarding_address_id #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The automatically generated ID for a cluster.

Returns:

See Also:

#describe_job(options = {}) ⇒ Types::DescribeJobResult

Returns information about a specific job including shipping information, job status, and other important metadata.

Examples:

Example: To describe a job you've created for AWS Snowball


# This operation describes a job you've created for AWS Snowball.

resp = client.describe_job({
  job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
})

# resp.to_h outputs the following:
{
  job_metadata: {
    address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
    creation_date: Time.parse("1475626164"), 
    description: "My Job", 
    job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
    job_state: "New", 
    job_type: "IMPORT", 
    kms_key_arn: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
    notification: {
      job_states_to_notify: [
      ], 
      notify_all: false, 
    }, 
    resources: {
      s3_resources: [
        {
          bucket_arn: "arn:aws:s3:::MyBucket", 
          key_range: {
          }, 
        }, 
      ], 
    }, 
    role_arn: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
    shipping_details: {
      shipping_option: "SECOND_DAY", 
    }, 
    snowball_capacity_preference: "T80", 
    snowball_type: "STANDARD", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_job({
  job_id: "JobId", # required
})

Response structure


resp..job_id #=> String
resp..job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp..job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
resp..snowball_type #=> String, one of "STANDARD", "EDGE"
resp..creation_date #=> Time
resp..resources.s3_resources #=> Array
resp..resources.s3_resources[0].bucket_arn #=> String
resp..resources.s3_resources[0].key_range.begin_marker #=> String
resp..resources.s3_resources[0].key_range.end_marker #=> String
resp..resources.lambda_resources #=> Array
resp..resources.lambda_resources[0].lambda_arn #=> String
resp..resources.lambda_resources[0].event_triggers #=> Array
resp..resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
resp..description #=> String
resp..kms_key_arn #=> String
resp..role_arn #=> String
resp..address_id #=> String
resp..shipping_details.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
resp..shipping_details.inbound_shipment.status #=> String
resp..shipping_details.inbound_shipment.tracking_number #=> String
resp..shipping_details.outbound_shipment.status #=> String
resp..shipping_details.outbound_shipment.tracking_number #=> String
resp..snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
resp..notification.sns_topic_arn #=> String
resp..notification.job_states_to_notify #=> Array
resp..notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp..notification.notify_all #=> true/false
resp..data_transfer_progress.bytes_transferred #=> Integer
resp..data_transfer_progress.objects_transferred #=> Integer
resp..data_transfer_progress.total_bytes #=> Integer
resp..data_transfer_progress.total_objects #=> Integer
resp..job_log_info.job_completion_report_uri #=> String
resp..job_log_info.job_success_log_uri #=> String
resp..job_log_info.job_failure_log_uri #=> String
resp..cluster_id #=> String
resp..forwarding_address_id #=> String
resp. #=> Array
resp.[0].job_id #=> String
resp.[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp.[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
resp.[0].snowball_type #=> String, one of "STANDARD", "EDGE"
resp.[0].creation_date #=> Time
resp.[0].resources.s3_resources #=> Array
resp.[0].resources.s3_resources[0].bucket_arn #=> String
resp.[0].resources.s3_resources[0].key_range.begin_marker #=> String
resp.[0].resources.s3_resources[0].key_range.end_marker #=> String
resp.[0].resources.lambda_resources #=> Array
resp.[0].resources.lambda_resources[0].lambda_arn #=> String
resp.[0].resources.lambda_resources[0].event_triggers #=> Array
resp.[0].resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
resp.[0].description #=> String
resp.[0].kms_key_arn #=> String
resp.[0].role_arn #=> String
resp.[0].address_id #=> String
resp.[0].shipping_details.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
resp.[0].shipping_details.inbound_shipment.status #=> String
resp.[0].shipping_details.inbound_shipment.tracking_number #=> String
resp.[0].shipping_details.outbound_shipment.status #=> String
resp.[0].shipping_details.outbound_shipment.tracking_number #=> String
resp.[0].snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
resp.[0].notification.sns_topic_arn #=> String
resp.[0].notification.job_states_to_notify #=> Array
resp.[0].notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp.[0].notification.notify_all #=> true/false
resp.[0].data_transfer_progress.bytes_transferred #=> Integer
resp.[0].data_transfer_progress.objects_transferred #=> Integer
resp.[0].data_transfer_progress.total_bytes #=> Integer
resp.[0].data_transfer_progress.total_objects #=> Integer
resp.[0].job_log_info.job_completion_report_uri #=> String
resp.[0].job_log_info.job_success_log_uri #=> String
resp.[0].job_log_info.job_failure_log_uri #=> String
resp.[0].cluster_id #=> String
resp.[0].forwarding_address_id #=> String

Options Hash (options):

  • :job_id (required, String)

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Returns:

See Also:

#get_job_manifest(options = {}) ⇒ Types::GetJobManifestResult

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

Examples:

Example: To get the manifest for a job you've created for AWS Snowball


# Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

Request syntax with placeholder values


resp = client.get_job_manifest({
  job_id: "JobId", # required
})

Response structure


resp.manifest_uri #=> String

Options Hash (options):

  • :job_id (required, String)

    The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.

Returns:

See Also:

#get_job_unlock_code(options = {}) ⇒ Types::GetJobUnlockCodeResult

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

Examples:

Example: To get the unlock code for a job you've created for AWS Snowball


# Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

Request syntax with placeholder values


resp = client.get_job_unlock_code({
  job_id: "JobId", # required
})

Response structure


resp.unlock_code #=> String

Options Hash (options):

  • :job_id (required, String)

    The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.

Returns:

See Also:

#get_snowball_usage(options = {}) ⇒ Types::GetSnowballUsageResult

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

Examples:

Example: To see your Snowball service limit and the number of Snowballs you have in use


# Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

Request syntax with placeholder values


resp = client.get_snowball_usage()

Response structure


resp.snowball_limit #=> Integer
resp.snowballs_in_use #=> Integer

Returns:

See Also:

#list_cluster_jobs(options = {}) ⇒ Types::ListClusterJobsResult

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

Examples:

Example: To get a list of jobs in a cluster that you've created for AWS Snowball


# Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

resp = client.list_cluster_jobs({
  cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
})

# resp.to_h outputs the following:
{
  job_list_entries: [
    {
      creation_date: Time.parse("1480475524.0"), 
      description: "MyClustrer-node-001", 
      is_master: false, 
      job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
      job_state: "New", 
      job_type: "LOCAL_USE", 
      snowball_type: "EDGE", 
    }, 
    {
      creation_date: Time.parse("1480475525.0"), 
      description: "MyClustrer-node-002", 
      is_master: false, 
      job_id: "JID123e4567-e89b-12d3-a456-426655440001", 
      job_state: "New", 
      job_type: "LOCAL_USE", 
      snowball_type: "EDGE", 
    }, 
    {
      creation_date: Time.parse("1480475525.0"), 
      description: "MyClustrer-node-003", 
      is_master: false, 
      job_id: "JID123e4567-e89b-12d3-a456-426655440002", 
      job_state: "New", 
      job_type: "LOCAL_USE", 
      snowball_type: "EDGE", 
    }, 
    {
      creation_date: Time.parse("1480475525.0"), 
      description: "MyClustrer-node-004", 
      is_master: false, 
      job_id: "JID123e4567-e89b-12d3-a456-426655440003", 
      job_state: "New", 
      job_type: "LOCAL_USE", 
      snowball_type: "EDGE", 
    }, 
    {
      creation_date: Time.parse("1480475525.0"), 
      description: "MyClustrer-node-005", 
      is_master: false, 
      job_id: "JID123e4567-e89b-12d3-a456-426655440004", 
      job_state: "New", 
      job_type: "LOCAL_USE", 
      snowball_type: "EDGE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_cluster_jobs({
  cluster_id: "ClusterId", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.job_list_entries #=> Array
resp.job_list_entries[0].job_id #=> String
resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp.job_list_entries[0].is_master #=> true/false
resp.job_list_entries[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
resp.job_list_entries[0].snowball_type #=> String, one of "STANDARD", "EDGE"
resp.job_list_entries[0].creation_date #=> Time
resp.job_list_entries[0].description #=> String
resp.next_token #=> String

Options Hash (options):

  • :cluster_id (required, String)

    The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

  • :max_results (Integer)

    The number of JobListEntry objects to return.

  • :next_token (String)

    HTTP requests are stateless. To identify what object comes \"next\" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Returns:

See Also:

#list_clusters(options = {}) ⇒ Types::ListClustersResult

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Examples:

Example: To get a list of clusters that you've created for AWS Snowball


# Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

resp = client.list_clusters({
})

# resp.to_h outputs the following:
{
  cluster_list_entries: [
    {
      cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
      cluster_state: "Pending", 
      creation_date: Time.parse("1480475517.0"), 
      description: "MyCluster", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_clusters({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.cluster_list_entries #=> Array
resp.cluster_list_entries[0].cluster_id #=> String
resp.cluster_list_entries[0].cluster_state #=> String, one of "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled"
resp.cluster_list_entries[0].creation_date #=> Time
resp.cluster_list_entries[0].description #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

    The number of ClusterListEntry objects to return.

  • :next_token (String)

    HTTP requests are stateless. To identify what object comes \"next\" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Returns:

See Also:

#list_jobs(options = {}) ⇒ Types::ListJobsResult

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

Examples:

Example: To get a list of jobs that you've created for AWS Snowball


# Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

resp = client.list_jobs({
})

# resp.to_h outputs the following:
{
  job_list_entries: [
    {
      creation_date: Time.parse("1460678186.0"), 
      description: "MyJob", 
      is_master: false, 
      job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
      job_state: "New", 
      job_type: "IMPORT", 
      snowball_type: "STANDARD", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_jobs({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.job_list_entries #=> Array
resp.job_list_entries[0].job_id #=> String
resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
resp.job_list_entries[0].is_master #=> true/false
resp.job_list_entries[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
resp.job_list_entries[0].snowball_type #=> String, one of "STANDARD", "EDGE"
resp.job_list_entries[0].creation_date #=> Time
resp.job_list_entries[0].description #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

    The number of JobListEntry objects to return.

  • :next_token (String)

    HTTP requests are stateless. To identify what object comes \"next\" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Returns:

See Also:

#update_cluster(options = {}) ⇒ Struct

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

Examples:

Example: To update a cluster


# This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.

resp = client.update_cluster({
  address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  cluster_id: "CID123e4567-e89b-12d3-a456-426655440000", 
  description: "Updated the address to send this to image processing - RJ", 
})

Request syntax with placeholder values


resp = client.update_cluster({
  cluster_id: "ClusterId", # required
  role_arn: "RoleARN",
  description: "String",
  resources: {
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  address_id: "AddressId",
  shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  forwarding_address_id: "AddressId",
})

Options Hash (options):

  • :cluster_id (required, String)

    The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

  • :role_arn (String)

    The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).

  • :description (String)

    The updated description of this cluster.

  • :resources (Types::JobResource)

    The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

  • :address_id (String)

    The ID of the updated Address object.

  • :shipping_option (String)

    The updated shipping option value of this cluster\'s ShippingDetails object.

  • :notification (Types::Notification)

    The new or updated Notification object.

  • :forwarding_address_id (String)

    The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_job(options = {}) ⇒ Struct

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Examples:

Example: To update a job


# This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

resp = client.update_job({
  address_id: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  description: "Upgraded to Edge, shipped to Finance Dept, and requested faster shipping speed - TS.", 
  job_id: "JID123e4567-e89b-12d3-a456-426655440000", 
  shipping_option: "NEXT_DAY", 
  snowball_capacity_preference: "T100", 
})

Request syntax with placeholder values


resp = client.update_job({
  job_id: "JobId", # required
  role_arn: "RoleARN",
  notification: {
    sns_topic_arn: "SnsTopicARN",
    job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  resources: {
    s3_resources: [
      {
        bucket_arn: "ResourceARN",
        key_range: {
          begin_marker: "String",
          end_marker: "String",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  address_id: "AddressId",
  shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
  description: "String",
  snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
  forwarding_address_id: "AddressId",
})

Options Hash (options):

  • :job_id (required, String)

    The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

  • :role_arn (String)

    The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleAWS Identity and Access Management (IAM) API action.

  • :notification (Types::Notification)

    The new or updated Notification object.

  • :resources (Types::JobResource)

    The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges).

  • :address_id (String)

    The ID of the updated Address object.

  • :shipping_option (String)

    The updated shipping option value of this job\'s ShippingDetails object.

  • :description (String)

    The updated description of this job\'s JobMetadata object.

  • :snowball_capacity_preference (String)

    The updated SnowballCapacityPreference of this job\'s JobMetadata object. The 50 TB Snowballs are only available in the US regions.

  • :forwarding_address_id (String)

    The updated ID for the forwarding address for a job. This field is not supported in most regions.

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_namesArray<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.