@aws-sdk/client-glacier

DescribeJobCommandOutput Interface

The output of DescribeJobCommand.

Members

Name
Type
Details
$metadata RequiredResponseMetadata
Metadata pertaining to this request.
Action ActionCode | undefined

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

ArchiveId string | undefined

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

ArchiveSHA256TreeHash string | undefined

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

ArchiveSizeInBytes number | undefined

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.

Completed boolean | undefined

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

CompletionDate string | undefined

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

CreationDate string | undefined

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".

InventoryRetrievalParameters InventoryRetrievalJobDescription | undefined

Parameters used for range inventory retrieval.

InventorySizeInBytes number | undefined

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.

JobDescription string | undefined

The job description provided when initiating the job.

JobId string | undefined

An opaque string that identifies an Amazon S3 Glacier job.

JobOutputPath string | undefined

Contains the job output location.

OutputLocation OutputLocation | undefined

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

RetrievalByteRange string | undefined

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.

SHA256TreeHash string | undefined

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

SNSTopic string | undefined

An Amazon SNS topic that receives notification.

SelectParameters SelectParameters | undefined

Contains the parameters used for a select.

StatusCode StatusCode | undefined

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

StatusMessage string | undefined

A friendly message that describes the job status.

Tier string | undefined

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

VaultARN string | undefined

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

Full Signature

export interface DescribeJobCommandOutput extends GlacierJobDescription, MetadataBearer