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

Inherits:

Struct

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

Defined in:

(unknown)

Overview

Contains the description of an Amazon S3 Glacier job.

Returned by:

• Client#describe_job

Instance Attribute Summary

• #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
• #creation_date ⇒ Time
• #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 S3 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.

Possible values:

• ArchiveRetrieval
• InventoryRetrieval
• Select

Returns:

• (String) —

  The job type.

#archive_id ⇒ String

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

Returns:

• (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. For inventory retrieval or select jobs, this field is null.

Returns:

• (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. For an inventory retrieval or select job, this value is null.

Returns:

• (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. When a job is completed, you get the job\'s output using Get Job Output (GET output).

Returns:

• (Boolean) —

  The job status.

#completion_date ⇒ Time

Returns:

• (Time)

#creation_date ⇒ Time

Returns:

• (Time)

#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobDescription

Parameters used for range inventory retrieval.

Returns:

• (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. For an archive retrieval or select job, this value is null.

Returns:

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

Returns:

• (String) —

  The job description provided when initiating the job.

#job_id ⇒ String

An opaque string that identifies an Amazon S3 Glacier job.

Returns:

• (String) —

  An opaque string that identifies an Amazon S3 Glacier job.

#job_output_path ⇒ String

Contains the job output location.

Returns:

• (String) —

  Contains the job output location.

#output_location ⇒ Types::OutputLocation

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

Returns:

• (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. 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) —

  The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.

#select_parameters ⇒ Types::SelectParameters

Contains the parameters used for a select.

Returns:

• (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. 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) —

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

#sns_topic ⇒ String

An Amazon SNS topic that receives notification.

Returns:

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

Possible values:

• InProgress
• Succeeded
• Failed

Returns:

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

Returns:

• (String) —

  A friendly message that describes the job status.

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

  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.

Returns:

• (String) —

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