class Aws::Glacier::Types::GlacierJobDescription

Contains the description of an Amazon S3 Glacier job.

@!attribute [rw] job_id

An opaque string that identifies an Amazon S3 Glacier job.
@return [String]

@!attribute [rw] job_description

The job description provided when initiating the job.
@return [String]

@!attribute [rw] action

The job type. This value is either `ArchiveRetrieval`,
`InventoryRetrieval`, or `Select`.
@return [String]

@!attribute [rw] archive_id

The archive ID requested for a select job or archive retrieval.
Otherwise, this field is null.
@return [String]

@!attribute [rw] vault_arn

The Amazon Resource Name (ARN) of the vault from which an archive
retrieval was requested.
@return [String]

@!attribute [rw] creation_date

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"`.
@return [Time]

@!attribute [rw] completed

The job status. When a job is completed, you get the job's output
using Get Job Output (GET output).
@return [Boolean]

@!attribute [rw] status_code

The status code can be `InProgress`, `Succeeded`, or `Failed`, and
indicates the status of the job.
@return [String]

@!attribute [rw] status_message

A friendly message that describes the job status.
@return [String]

@!attribute [rw] archive_size_in_bytes

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.
@return [Integer]

@!attribute [rw] inventory_size_in_bytes

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.
@return [Integer]

@!attribute [rw] sns_topic

An Amazon SNS topic that receives notification.
@return [String]

@!attribute [rw] completion_date

The UTC time that the job request completed. While the job is in
progress, the value is null.
@return [Time]

@!attribute [rw] sha256_tree_hash

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
@return [String]

@!attribute [rw] archive_sha256_tree_hash

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

@!attribute [rw] retrieval_byte_range

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.
@return [String]

@!attribute [rw] tier

The tier to use for a select or an archive retrieval. Valid values
are `Expedited`, `Standard`, or `Bulk`. `Standard` is the default.
@return [String]

@!attribute [rw] inventory_retrieval_parameters

Parameters used for range inventory retrieval.
@return [Types::InventoryRetrievalJobDescription]

@!attribute [rw] job_output_path

Contains the job output location.
@return [String]

@!attribute [rw] select_parameters

Contains the parameters used for a select.
@return [Types::SelectParameters]

@!attribute [rw] output_location

Contains the location where the data from the select job is stored.
@return [Types::OutputLocation]

Constants

SENSITIVE