Class: AWS::ImportExport::Client

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

Overview

Client class for AWS Import/Export.

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, 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)




# File 'lib/aws/import_export/client.rb', line 25

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

Calls the CreateJob API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :job_type - required - (String)

    • :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)




# File 'lib/aws/import_export/client.rb', line 34

#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)




# File 'lib/aws/import_export/client.rb', line 51

#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<Hash>)

      • :job_id - (String)

      • :creation_date - (Time)

      • :is_canceled - (Boolean)

      • :job_type - (String)

    • :is_truncated - (Boolean)




# File 'lib/aws/import_export/client.rb', line 75

#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)

    • :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)




# File 'lib/aws/import_export/client.rb', line 90