class Aws::Snowball::Client

See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::Snowball::Client.new(
An API client for Snowball. To construct a client, you need to configure a ‘:region` and `:credentials`.

def build_request(operation_name, params = {})

Other tags:
    Api: - private

Parameters:
  • params ({}) --
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-snowball'
  context[:gem_version] = '1.52.0'
  Seahorse::Client::Request.new(handlers, context)
end

def cancel_cluster(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • cancel_cluster(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -
    Example: Example: To cancel a cluster job -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :cluster_id (required, String) --
def cancel_cluster(params = {}, options = {})
  req = build_request(:cancel_cluster, params)
  req.send_request(options)
end

def cancel_job(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • cancel_job(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJob - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -
    Example: Example: To cancel a job for a Snowball device -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :job_id (required, String) --
def cancel_job(params = {}, options = {})
  req = build_request(:cancel_job, params)
  req.send_request(options)
end

def create_address(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_address(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddress - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To create an address for a job -

Returns:
  • (Types::CreateAddressResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :address (required, Types::Address) --
def create_address(params = {}, options = {})
  req = build_request(:create_address, params)
  req.send_request(options)
end

def create_cluster(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_cluster(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To create a cluster -

Returns:
  • (Types::CreateClusterResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :remote_management (String) --
  • :tax_documents (Types::TaxDocuments) --
  • :forwarding_address_id (String) --
  • :notification (Types::Notification) --
  • :shipping_option (required, String) --
  • :snowball_type (required, String) --
  • :role_arn (required, String) --
  • :kms_key_arn (String) --
  • :address_id (required, String) --
  • :description (String) --
  • :on_device_service_configuration (Types::OnDeviceServiceConfiguration) --
  • :resources (required, Types::JobResource) --
  • :job_type (required, String) --
def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

def create_job(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_job(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To create a job -

Returns:
  • (Types::CreateJobResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :long_term_pricing_id (String) --
  • :remote_management (String) --
  • :device_configuration (Types::DeviceConfiguration) --
  • :tax_documents (Types::TaxDocuments) --
  • :forwarding_address_id (String) --
  • :snowball_type (String) --
  • :cluster_id (String) --
  • :notification (Types::Notification) --
  • :shipping_option (String) --
  • :snowball_capacity_preference (String) --
  • :role_arn (String) --
  • :kms_key_arn (String) --
  • :address_id (String) --
  • :description (String) --
  • :on_device_service_configuration (Types::OnDeviceServiceConfiguration) --
  • :resources (Types::JobResource) --
  • :job_type (String) --
def create_job(params = {}, options = {})
  req = build_request(:create_job, params)
  req.send_request(options)
end

def create_long_term_pricing(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_long_term_pricing(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateLongTermPricing - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateLongTermPricingResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :snowball_type (String) --
  • :is_long_term_pricing_auto_renew (Boolean) --
  • :long_term_pricing_type (required, String) --
def create_long_term_pricing(params = {}, options = {})
  req = build_request(:create_long_term_pricing, params)
  req.send_request(options)
end

def create_return_shipping_label(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_return_shipping_label(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateReturnShippingLabel - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateReturnShippingLabelResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :shipping_option (String) --
  • :job_id (required, String) --
def create_return_shipping_label(params = {}, options = {})
  req = build_request(:create_return_shipping_label, params)
  req.send_request(options)
end

def describe_address(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_address(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddress - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To describe an address for a job -

Returns:
  • (Types::DescribeAddressResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :address_id (required, String) --
def describe_address(params = {}, options = {})
  req = build_request(:describe_address, params)
  req.send_request(options)
end

def describe_addresses(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_addresses(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddresses - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To describe all the addresses you've created for AWS Snowball -

Returns:
  • (Types::DescribeAddressesResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
def describe_addresses(params = {}, options = {})
  req = build_request(:describe_addresses, params)
  req.send_request(options)
end

def describe_cluster(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_cluster(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeCluster - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To describe a cluster -

Returns:
  • (Types::DescribeClusterResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :cluster_id (required, String) --
def describe_cluster(params = {}, options = {})
  req = build_request(:describe_cluster, params)
  req.send_request(options)
end

def describe_job(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_job(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJob - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To describe a job you've created for AWS Snowball -

Returns:
  • (Types::DescribeJobResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :job_id (required, String) --
def describe_job(params = {}, options = {})
  req = build_request(:describe_job, params)
  req.send_request(options)
end

def describe_return_shipping_label(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_return_shipping_label(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeReturnShippingLabel - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeReturnShippingLabelResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :job_id (required, String) --
def describe_return_shipping_label(params = {}, options = {})
  req = build_request(:describe_return_shipping_label, params)
  req.send_request(options)
end

def errors_module

Other tags:
    Api: - private
def errors_module
  Errors
end

def get_job_manifest(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_job_manifest(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifest - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To get the manifest for a job you've created for AWS Snowball -

Returns:
  • (Types::GetJobManifestResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :job_id (required, String) --
def get_job_manifest(params = {}, options = {})
  req = build_request(:get_job_manifest, params)
  req.send_request(options)
end

def get_job_unlock_code(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_job_unlock_code(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCode - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To get the unlock code for a job you've created for AWS Snowball -

Returns:
  • (Types::GetJobUnlockCodeResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :job_id (required, String) --
def get_job_unlock_code(params = {}, options = {})
  req = build_request(:get_job_unlock_code, params)
  req.send_request(options)
end

def get_snowball_usage(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_snowball_usage(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsage - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Example: To see your Snowball service limit and the number of Snowballs you have in use -

Returns:
  • (Types::GetSnowballUsageResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def get_snowball_usage(params = {}, options = {})
  req = build_request(:get_snowball_usage, params)
  req.send_request(options)
end

def get_software_updates(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_software_updates(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSoftwareUpdates - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetSoftwareUpdatesResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :job_id (required, String) --
def get_software_updates(params = {}, options = {})
  req = build_request(:get_software_updates, params)
  req.send_request(options)
end

def initialize(*args)

Options Hash: (**options)
  • :ssl_ca_directory (String) -- Full path of the
  • :ssl_ca_bundle (String) -- Full path to the SSL
  • :ssl_verify_peer (Boolean) -- When `true`,
  • :http_wire_trace (Boolean) -- When `true`,
  • :ssl_timeout (Float) -- Sets the SSL timeout
  • :http_continue_timeout (Float) -- The number of
  • :http_idle_timeout (Float) -- The number of
  • :http_read_timeout (Float) -- The default
  • :http_open_timeout (Float) -- The number of
  • :http_proxy (URI::HTTP, String) -- A proxy to send
  • :endpoint_provider (Aws::Snowball::EndpointProvider) --
  • :validate_params (Boolean) --
  • :use_fips_endpoint (Boolean) --
  • :use_dualstack_endpoint (Boolean) --
  • :token_provider (Aws::TokenProvider) --
  • :stub_responses (Boolean) --
  • :simple_json (Boolean) --
  • :session_token (String) --
  • :secret_access_key (String) --
  • :retry_mode (String) --
  • :retry_max_delay (Integer) --
  • :retry_limit (Integer) --
  • :retry_jitter (Symbol) --
  • :retry_base_delay (Float) --
  • :retry_backoff (Proc) --
  • :profile (String) --
  • :max_attempts (Integer) --
  • :logger (Logger) --
  • :log_level (Symbol) --
  • :log_formatter (Aws::Log::Formatter) --
  • :endpoint_discovery (Boolean) --
  • :endpoint_cache_poll_interval (Integer) --
  • :endpoint_cache_max_threads (Integer) --
  • :endpoint_cache_max_entries (Integer) --
  • :endpoint (String) --
  • :disable_host_prefix_injection (Boolean) --
  • :defaults_mode (String) --
  • :correct_clock_skew (Boolean) --
  • :convert_params (Boolean) --
  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) --
  • :client_side_monitoring_port (Integer) --
  • :client_side_monitoring_host (String) --
  • :client_side_monitoring_client_id (String) --
  • :client_side_monitoring (Boolean) --
  • :adaptive_retry_wait_to_fill (Boolean) --
  • :active_endpoint_cache (Boolean) --
  • :access_key_id (String) --
  • :region (required, String) --
  • :credentials (required, Aws::CredentialProvider) --

Other tags:
    See: https://www.awsarchitectureblog.com/2015/03/backoff.html -

Parameters:
  • options (Hash) --

Overloads:
  • initialize(options)
def initialize(*args)
  super
end

def list_cluster_jobs(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_cluster_jobs(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobs - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To get a list of jobs in a cluster that you've created for AWS Snowball -

Returns:
  • (Types::ListClusterJobsResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :cluster_id (required, String) --
def list_cluster_jobs(params = {}, options = {})
  req = build_request(:list_cluster_jobs, params)
  req.send_request(options)
end

def list_clusters(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_clusters(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To get a list of clusters that you've created for AWS Snowball -

Returns:
  • (Types::ListClustersResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
def list_clusters(params = {}, options = {})
  req = build_request(:list_clusters, params)
  req.send_request(options)
end

def list_compatible_images(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_compatible_images(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListCompatibleImages - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListCompatibleImagesResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
def list_compatible_images(params = {}, options = {})
  req = build_request(:list_compatible_images, params)
  req.send_request(options)
end

def list_jobs(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_jobs(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobs - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To get a list of jobs that you've created for AWS Snowball -

Returns:
  • (Types::ListJobsResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
def list_jobs(params = {}, options = {})
  req = build_request(:list_jobs, params)
  req.send_request(options)
end

def list_long_term_pricing(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_long_term_pricing(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListLongTermPricing - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListLongTermPricingResult) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
def list_long_term_pricing(params = {}, options = {})
  req = build_request(:list_long_term_pricing, params)
  req.send_request(options)
end

def update_cluster(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_cluster(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -
    Example: Example: To update a cluster -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :forwarding_address_id (String) --
  • :notification (Types::Notification) --
  • :shipping_option (String) --
  • :address_id (String) --
  • :on_device_service_configuration (Types::OnDeviceServiceConfiguration) --
  • :resources (Types::JobResource) --
  • :description (String) --
  • :role_arn (String) --
  • :cluster_id (required, String) --
def update_cluster(params = {}, options = {})
  req = build_request(:update_cluster, params)
  req.send_request(options)
end

def update_job(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_job(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -
    Example: Example: To update a job -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :forwarding_address_id (String) --
  • :snowball_capacity_preference (String) --
  • :description (String) --
  • :shipping_option (String) --
  • :address_id (String) --
  • :on_device_service_configuration (Types::OnDeviceServiceConfiguration) --
  • :resources (Types::JobResource) --
  • :notification (Types::Notification) --
  • :role_arn (String) --
  • :job_id (required, String) --
def update_job(params = {}, options = {})
  req = build_request(:update_job, params)
  req.send_request(options)
end

def update_job_shipment_state(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_job_shipment_state(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobShipmentState - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :shipment_state (required, String) --
  • :job_id (required, String) --
def update_job_shipment_state(params = {}, options = {})
  req = build_request(:update_job_shipment_state, params)
  req.send_request(options)
end

def update_long_term_pricing(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_long_term_pricing(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateLongTermPricing - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :is_long_term_pricing_auto_renew (Boolean) --
  • :replacement_job (String) --
  • :long_term_pricing_id (required, String) --
def update_long_term_pricing(params = {}, options = {})
  req = build_request(:update_long_term_pricing, params)
  req.send_request(options)
end

def waiter_names

Deprecated:

Other tags:
    Api: - private
def waiter_names
  []
end