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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb

Overview

Output structure for the GetStatus operation.

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_listArray<Types::Artifact>

A collection of artifacts.

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#carrierString

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

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#creation_dateTime

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

Returns:

  • (Time)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#current_manifestString

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

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#error_countInteger

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

Returns:

  • (Integer)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#job_idString

A unique identifier which refers to a particular job.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#job_typeString

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

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#location_codeString

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

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#location_messageString

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

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#log_bucketString

Amazon S3 bucket for user logs.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#log_keyString

The key where the user logs were stored.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#progress_codeString

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

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#progress_messageString

A more human readable form of the job status.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#signatureString

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)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#signature_file_contentsString

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)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end

#tracking_numberString

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)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'gems/aws-sdk-importexport/lib/aws-sdk-importexport/types.rb', line 349

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)
  include Aws::Structure
end