Class: Aws::ImportExport::Types::GetStatusOutput

Inherits:

Struct

• Object
• Struct
• Aws::ImportExport::Types::GetStatusOutput

Defined in:

gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb

Overview

Output structure for the GetStatus operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #artifact_list ⇒ Array<Types::Artifact>

  A collection of artifacts.

• #carrier ⇒ String

  Name of the shipping company.

• #creation_date ⇒ Time

  Timestamp of the CreateJob request in ISO8601 date format.

• #current_manifest ⇒ String

  The last manifest submitted, which will be used to process the job.

• #error_count ⇒ Integer

  Number of errors.

• #job_id ⇒ String

  A unique identifier which refers to a particular job.

• #job_type ⇒ String

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

• #location_code ⇒ String

  A token representing the location of the storage device, such as "AtAWS".

• #location_message ⇒ String

  A more human readable form of the physical location of the storage device.

• #log_bucket ⇒ String

  Amazon S3 bucket for user logs.

• #log_key ⇒ String

  The key where the user logs were stored.

• #progress_code ⇒ String

  A token representing the state of the job, such as "Started".

• #progress_message ⇒ String

  A more human readable form of the job status.

• #signature ⇒ String

  An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=".

• #signature_file_contents ⇒ String

  An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=".

• #tracking_number ⇒ String

  The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you.

Instance Attribute Details

#artifact_list ⇒ Array<Types::Artifact>

A collection of artifacts.

Returns:

• (Array<Types::Artifact>)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#carrier ⇒ String

Name of the shipping company. This value is included when the LocationCode is "Returned".

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".

Returns:

• (Time)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#current_manifest ⇒ String

The last manifest submitted, which will be used to process the job.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#error_count ⇒ Integer

Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.

Returns:

• (Integer)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

A unique identifier which refers to a particular job.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#location_code ⇒ String

A token representing the location of the storage device, such as "AtAWS".

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#location_message ⇒ String

A more human readable form of the physical location of the storage device.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#log_bucket ⇒ String

Amazon S3 bucket for user logs.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#log_key ⇒ String

The key where the user logs were stored.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#progress_code ⇒ String

A token representing the state of the job, such as "Started".

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#progress_message ⇒ String

A more human readable form of the job status.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#signature ⇒ String

An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#signature_file_contents ⇒ String

An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end

#tracking_number ⇒ String

The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you. We return this value when the LocationCode is "Returned".

Returns:

• (String)

# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 365

class GetStatusOutput < Struct.new(
  :job_id,
  :job_type,
  :location_code,
  :location_message,
  :progress_code,
  :progress_message,
  :carrier,
  :tracking_number,
  :log_bucket,
  :log_key,
  :error_count,
  :signature,
  :signature_file_contents,
  :current_manifest,
  :creation_date,
  :artifact_list)
  SENSITIVE = []
  include Aws::Structure
end