Class: Aws::ImportExport::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::ImportExport::Client

Includes:

ClientStubs

Defined in:

lib/aws-sdk-importexport/client.rb

Class Attribute Summary

• .identifier ⇒ Object readonly private

API Operations

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

  This operation cancels a specified job.

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

  This operation initiates the process of scheduling an upload or download of your data.

• #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.

• #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.

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

  This operation returns the jobs associated with the requester.

• #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.

Class Method Summary

• .errors_module ⇒ Object private

Instance Method Summary

• #build_request(operation_name, params = {}) ⇒ Object private
• #initialize(*args) ⇒ Client constructor

  A new instance of Client.

• #waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash) —

  a customizable set of options

# File 'lib/aws-sdk-importexport/client.rb', line 142

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-importexport/client.rb', line 510

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-importexport/client.rb', line 513

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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

# File 'lib/aws-sdk-importexport/client.rb', line 488

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.0.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

• (Types::CancelJobOutput) —

  Returns a response object which responds to the following methods:

  • #success => Boolean

# File 'lib/aws-sdk-importexport/client.rb', line 174

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:

• (Types::CreateJobOutput) —

  Returns a response object which responds to the following methods:

  • #job_id => String

  • #job_type => String

  • #signature => String

  • #signature_file_contents => String

  • #warning_message => String

  • #artifact_list => Array<Types::Artifact>

# File 'lib/aws-sdk-importexport/client.rb', line 234

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:

• (Types::GetShippingLabelOutput) —

  Returns a response object which responds to the following methods:

  • #shipping_label_url => String

  • #warning => String

# File 'lib/aws-sdk-importexport/client.rb', line 312

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:

• (Types::GetStatusOutput) —

  Returns a response object which responds to the following methods:

  • #job_id => String

  • #job_type => 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

  • #artifact_list => Array&lt;Types::Artifact&gt;

# File 'lib/aws-sdk-importexport/client.rb', line 377

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 &lt;IsTruncated&gt;true&lt;/IsTruncated&gt;. 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:

• (Types::ListJobsOutput) —

  Returns a response object which responds to the following methods:

  • #jobs => Array&lt;Types::Job&gt;

  • #is_truncated => Boolean

# File 'lib/aws-sdk-importexport/client.rb', line 426

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:

• (Types::UpdateJobOutput) —

  Returns a response object which responds to the following methods:

  • #success => Boolean

  • #warning_message => String

  • #artifact_list => Array&lt;Types::Artifact&gt;

# File 'lib/aws-sdk-importexport/client.rb', line 479

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

# File 'lib/aws-sdk-importexport/client.rb', line 503

def waiter_names
  []
end