Class: Aws::Glacier::Types::GlacierJobDescription

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-glacier/types.rb

Overview

Contains the description of an Amazon S3 Glacier job.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The job type. This value is either ‘ArchiveRetrieval`, `InventoryRetrieval`, or `Select`.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#archive_id ⇒ String

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#archive_sha256_tree_hash ⇒ String

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#archive_size_in_bytes ⇒ Integer

For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

Returns:

  • (Integer) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#completed ⇒ Boolean

The job status. When a job is completed, you get the job’s output using Get Job Output (GET output).

Returns:

  • (Boolean) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#completion_date ⇒ Time

The UTC time that the job request completed. While the job is in progress, the value is null.

Returns:

  • (Time) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example ‘“2012-03-20T17:03:43.221Z”`.

Returns:

  • (Time) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobDescription

Parameters used for range inventory retrieval.

Returns:



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#inventory_size_in_bytes ⇒ Integer

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

Returns:

  • (Integer) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#job_description ⇒ String

The job description provided when initiating the job.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

An opaque string that identifies an Amazon S3 Glacier job.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#job_output_path ⇒ String

Contains the job output location.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#output_location ⇒ Types::OutputLocation

Contains the location where the data from the select job is stored.

Returns:



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#retrieval_byte_range ⇒ String

The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#select_parameters ⇒ Types::SelectParameters

Contains the parameters used for a select.

Returns:



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#sha256_tree_hash ⇒ String

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

  • Archive retrieval jobs that specify a range that is not tree-hash aligned

^ ^

  • Archival jobs that specify a range that is equal to the whole archive, when the job status is ‘InProgress`

^ ^

  • Inventory jobs

  • Select jobs

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic ⇒ String

An Amazon SNS topic that receives notification.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#status_code ⇒ String

The status code can be ‘InProgress`, `Succeeded`, or `Failed`, and indicates the status of the job.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A friendly message that describes the job status.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ String

The tier to use for a select or an archive retrieval. Valid values are ‘Expedited`, `Standard`, or `Bulk`. `Standard` is the default.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#vault_arn ⇒ String

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Returns:

  • (String) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/aws-sdk-glacier/types.rb', line 996

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end