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

Class: AWS::ImportExport::Client

Inherits:
Core::QueryClient show all
Defined in:
lib/aws/import_export/client.rb

Overview

Client class for AWS Import/Export.

Direct Known Subclasses

V20100601

Defined Under Namespace

Classes: V20100601

Constant Summary

API_VERSION = 
'2010-06-01'

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#cancel_job(options = {}) ⇒ Core::Response

Calls the CancelJob API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :job_id - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :success - (Boolean)

#create_job(options = {}) ⇒ Core::Response

Calls the CreateJob API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :job_type - required - (String) Valid values include:
      • Import
      • Export
    • :manifest - required - (String)
    • :manifest_addendum - (String)
    • :validate_only - required - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :job_id - (String)
    • :job_type - (String)
    • :aws_shipping_address - (String)
    • :signature - (String)
    • :signature_file_contents - (String)
    • :warning_message - (String)

#get_status(options = {}) ⇒ Core::Response

Calls the GetStatus API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :job_id - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :job_id - (String)
    • :job_type - (String)
    • :aws_shipping_address - (String)
    • :location_code - (String)
    • :location_message - (String)
    • :progress_code - (String)
    • :progress_message - (String)
    • :carrier - (String)
    • :tracking_number - (String)
    • :log_bucket - (String)
    • :log_key - (String)
    • :error_count - (Integer)
    • :signature - (String)
    • :signature_file_contents - (String)
    • :current_manifest - (String)
    • :creation_date - (Time)

#list_jobs(options = {}) ⇒ Core::Response

Calls the ListJobs API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :max_jobs - (Integer)
    • :marker - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :jobs - (Array)
      • :job_id - (String)
      • :creation_date - (Time)
      • :is_canceled - (Boolean)
      • :job_type - (String)
    • :is_truncated - (Boolean)

#update_job(options = {}) ⇒ Core::Response

Calls the UpdateJob API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :job_id - required - (String)
    • :manifest - required - (String)
    • :job_type - required - (String) Valid values include:
      • Import
      • Export
    • :validate_only - required - (Boolean)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :success - (Boolean)
    • :warning_message - (String)