class Aws::ImportExport::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::ImportExport::Client.new(
An API client for ImportExport. 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-importexport'
  context[:gem_version] = '1.33.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

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

Overloads:
  • cancel_job(params = {})

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

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

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

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

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

Overloads:
  • create_job(params = {})

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

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

Options Hash: (**params)
  • :api_version (String) --
  • :validate_only (required, Boolean) --
  • :manifest_addendum (String) --
  • :manifest (required, String) --
  • :job_type (required, String) -- 
def create_job(params = {}, options = {})
  req = build_request(:create_job, params)
  req.send_request(options)
end

def errors_module

Other tags:
    Api: - private 
def errors_module
  Errors
end

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

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

Overloads:
  • get_shipping_label(params = {})

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

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

Options Hash: (**params)
  • :api_version (String) --
  • :street3 (String) --
  • :street2 (String) --
  • :street1 (String) --
  • :postal_code (String) --
  • :city (String) --
  • :state_or_province (String) --
  • :country (String) --
  • :phone_number (String) --
  • :company (String) --
  • :name (String) --
  • :job_ids (required, Array) -- 
def get_shipping_label(params = {}, options = {})
  req = build_request(:get_shipping_label, params)
  req.send_request(options)
end

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

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

Overloads:
  • get_status(params = {})

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

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

Options Hash: (**params)
  • :api_version (String) --
  • :job_id (required, String) -- 
def get_status(params = {}, options = {})
  req = build_request(:get_status, 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
  • :validate_params (Boolean) --
  • :use_fips_endpoint (Boolean) --
  • :use_dualstack_endpoint (Boolean) --
  • :stub_responses (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_jobs(params = {}, options = {})

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

Overloads:
  • list_jobs(params = {})

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

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

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

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

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

Overloads:
  • update_job(params = {})

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

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

Options Hash: (**params)
  • :api_version (String) --
  • :validate_only (required, Boolean) --
  • :job_type (required, String) --
  • :manifest (required, String) --
  • :job_id (required, String) -- 
def update_job(params = {}, options = {})
  req = build_request(:update_job, params)
  req.send_request(options)
end

def waiter_names

Deprecated:

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