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

Class: Aws::ImportExport::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

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

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

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

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

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

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

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

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

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

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

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

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

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

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

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

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



251
252
253
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#cancel_job(params = {}) ⇒ Types::CancelJobOutput

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Examples:

Request syntax with placeholder values


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

Response structure


resp.success #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    A unique identifier which refers to a particular job.

  • :api_version (String)

    Specifies the version of the client tool.

Returns:



283
284
285
286
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 283

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

#create_job(params = {}) ⇒ Types::CreateJobOutput

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

Examples:

Request syntax with placeholder values


resp = client.create_job({
  job_type: "Import", # required, accepts Import, Export
  manifest: "Manifest", # required
  manifest_addendum: "ManifestAddendum",
  validate_only: false, # required
  api_version: "APIVersion",
})

Response structure


resp.job_id #=> String
resp.job_type #=> String, one of "Import", "Export"
resp.signature #=> String
resp.signature_file_contents #=> String
resp.warning_message #=> String
resp.artifact_list #=> Array
resp.artifact_list[0].description #=> String
resp.artifact_list[0].url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_type (required, String)

    Specifies whether the job to initiate is an import or export job.

  • :manifest (required, String)

    The UTF-8 encoded text of the manifest file.

  • :manifest_addendum (String)

    For internal use only.

  • :validate_only (required, Boolean)

    Validate the manifest and parameter values in the request but do not actually create a job.

  • :api_version (String)

    Specifies the version of the client tool.

Returns:



343
344
345
346
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 343

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

#get_shipping_label(params = {}) ⇒ Types::GetShippingLabelOutput

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Examples:

Request syntax with placeholder values


resp = client.get_shipping_label({
  job_ids: ["GenericString"], # required
  name: "name",
  company: "company",
  phone_number: "phoneNumber",
  country: "country",
  state_or_province: "stateOrProvince",
  city: "city",
  postal_code: "postalCode",
  street1: "street1",
  street2: "street2",
  street3: "street3",
  api_version: "APIVersion",
})

Response structure


resp.shipping_label_url #=> String
resp.warning #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_ids (required, Array<String>)
  • :name (String)

    Specifies the name of the person responsible for shipping this package.

  • :company (String)

    Specifies the name of the company that will ship this package.

  • :phone_number (String)

    Specifies the phone number of the person responsible for shipping this package.

  • :country (String)

    Specifies the name of your country for the return address.

  • :state_or_province (String)

    Specifies the name of your state or your province for the return address.

  • :city (String)

    Specifies the name of your city for the return address.

  • :postal_code (String)

    Specifies the postal code for the return address.

  • :street1 (String)

    Specifies the first part of the street address for the return address, for example 1234 Main Street.

  • :street2 (String)

    Specifies the optional second part of the street address for the return address, for example Suite 100.

  • :street3 (String)

    Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.

  • :api_version (String)

    Specifies the version of the client tool.

Returns:



421
422
423
424
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 421

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

#get_status(params = {}) ⇒ Types::GetStatusOutput

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

Examples:

Request syntax with placeholder values


resp = client.get_status({
  job_id: "JobId", # required
  api_version: "APIVersion",
})

Response structure


resp.job_id #=> String
resp.job_type #=> String, one of "Import", "Export"
resp.location_code #=> String
resp.location_message #=> String
resp.progress_code #=> String
resp.progress_message #=> String
resp.carrier #=> String
resp.tracking_number #=> String
resp.log_bucket #=> String
resp.log_key #=> String
resp.error_count #=> Integer
resp.signature #=> String
resp.signature_file_contents #=> String
resp.current_manifest #=> String
resp.creation_date #=> Time
resp.artifact_list #=> Array
resp.artifact_list[0].description #=> String
resp.artifact_list[0].url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    A unique identifier which refers to a particular job.

  • :api_version (String)

    Specifies the version of the client tool.

Returns:



486
487
488
489
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 486

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

#list_jobs(params = {}) ⇒ Types::ListJobsOutput

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

Examples:

Request syntax with placeholder values


resp = client.list_jobs({
  max_jobs: 1,
  marker: "Marker",
  api_version: "APIVersion",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].creation_date #=> Time
resp.jobs[0].is_canceled #=> Boolean
resp.jobs[0].job_type #=> String, one of "Import", "Export"
resp.is_truncated #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :max_jobs (Integer)

    Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see Marker.

  • :marker (String)

    Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs.

  • :api_version (String)

    Specifies the version of the client tool.

Returns:



535
536
537
538
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 535

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

#update_job(params = {}) ⇒ Types::UpdateJobOutput

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

Examples:

Request syntax with placeholder values


resp = client.update_job({
  job_id: "JobId", # required
  manifest: "Manifest", # required
  job_type: "Import", # required, accepts Import, Export
  validate_only: false, # required
  api_version: "APIVersion",
})

Response structure


resp.success #=> Boolean
resp.warning_message #=> String
resp.artifact_list #=> Array
resp.artifact_list[0].description #=> String
resp.artifact_list[0].url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    A unique identifier which refers to a particular job.

  • :manifest (required, String)

    The UTF-8 encoded text of the manifest file.

  • :job_type (required, String)

    Specifies whether the job to initiate is an import or export job.

  • :validate_only (required, Boolean)

    Validate the manifest and parameter values in the request but do not actually create a job.

  • :api_version (String)

    Specifies the version of the client tool.

Returns:



588
589
590
591
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/client.rb', line 588

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