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

Inherits:

Struct

Object
Struct
Aws::Glacier::Types::GlacierJobDescription

show all

Includes:: Structure

Defined in:: lib/aws-sdk-glacier/types.rb

Overview

Contains the description of an Amazon Glacier job.

Instance Attribute Summary collapse

#action ⇒ String

The job type.
#archive_id ⇒ String

The archive ID requested for a select job or archive retrieval.
#archive_sha256_tree_hash ⇒ String

The SHA256 tree hash of the entire archive for an archive retrieval.
#archive_size_in_bytes ⇒ Integer

For an archive retrieval job, this value is the size in bytes of the archive being requested for download.
#completed ⇒ Boolean

The job status.
#completion_date ⇒ Time

The UTC time that the job request completed.
#creation_date ⇒ Time

The UTC date when the job was created.
#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobDescription

Parameters used for range inventory retrieval.
#inventory_size_in_bytes ⇒ Integer

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.
#job_description ⇒ String

The job description provided when initiating the job.
#job_id ⇒ String

An opaque string that identifies an Amazon Glacier job.
#job_output_path ⇒ String

Contains the job output location.
#output_location ⇒ Types::OutputLocation

Contains the location where the data from the select job is stored.
#retrieval_byte_range ⇒ String

The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
#select_parameters ⇒ Types::SelectParameters

Contains the parameters used for a select.
#sha256_tree_hash ⇒ String

For an archive retrieval job, this value is the checksum of the archive.
#sns_topic ⇒ String

An Amazon SNS topic that receives notification.
#status_code ⇒ String

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

A friendly message that describes the job status.
#tier ⇒ String

The tier to use for a select or an archive retrieval.
#vault_arn ⇒ String

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

Instance Attribute Details

#action ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#inventory_retrieval_parameters ⇒ `Types::InventoryRetrievalJobDescription`

Parameters used for range inventory retrieval.

Returns:

(Types::InventoryRetrievalJobDescription)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#job_description ⇒ `String`

The job description provided when initiating the job.

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#job_id ⇒ `String`

An opaque string that identifies an Amazon Glacier job.

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#job_output_path ⇒ `String`

Contains the job output location.

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#output_location ⇒ `Types::OutputLocation`

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

Returns:

(Types::OutputLocation)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#select_parameters ⇒ `Types::SelectParameters`

Contains the parameters used for a select.

Returns:

(Types::SelectParameters)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#sns_topic ⇒ `String`

An Amazon SNS topic that receives notification.

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#status_message ⇒ `String`

A friendly message that describes the job status.

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

#vault_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-glacier/types.rb', line 1162

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

#archive_id ⇒ String

#archive_sha256_tree_hash ⇒ String

#archive_size_in_bytes ⇒ Integer

#completed ⇒ Boolean

#completion_date ⇒ Time

#creation_date ⇒ Time

#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobDescription

#inventory_size_in_bytes ⇒ Integer

#job_description ⇒ String

#job_id ⇒ String

#job_output_path ⇒ String

#output_location ⇒ Types::OutputLocation

#retrieval_byte_range ⇒ String

#select_parameters ⇒ Types::SelectParameters

#sha256_tree_hash ⇒ String

#sns_topic ⇒ String

#status_code ⇒ String

#status_message ⇒ String

#tier ⇒ String

#vault_arn ⇒ String

#action ⇒ `String`

#archive_id ⇒ `String`

#archive_sha256_tree_hash ⇒ `String`

#archive_size_in_bytes ⇒ `Integer`

#completed ⇒ `Boolean`

#completion_date ⇒ `Time`

#creation_date ⇒ `Time`

#inventory_retrieval_parameters ⇒ `Types::InventoryRetrievalJobDescription`

#inventory_size_in_bytes ⇒ `Integer`

#job_description ⇒ `String`

#job_id ⇒ `String`

#job_output_path ⇒ `String`

#output_location ⇒ `Types::OutputLocation`

#retrieval_byte_range ⇒ `String`

#select_parameters ⇒ `Types::SelectParameters`

#sha256_tree_hash ⇒ `String`

#sns_topic ⇒ `String`

#status_code ⇒ `String`

#status_message ⇒ `String`

#tier ⇒ `String`

#vault_arn ⇒ `String`