Get accountidvaultsvaultnamejobsjobid — glacier

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1433113159.9 KB

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob.

This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.

get/{accountId}/vaults/{vaultName}/jobs/{jobId}

Path parameters

accountIdstring required

The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

vaultNamestring required

The name of the vault.

jobIdstring required

The ID of the job to describe.

Response

Success

JobIdstring

An opaque string that identifies an Amazon S3 Glacier job.

JobDescriptionstring

The job description provided when initiating the job.

Action'ArchiveRetrieval' | 'InventoryRetrieval' | 'Select'

The job type. This value is either <code>ArchiveRetrieval</code>, <code>InventoryRetrieval</code>, or <code>Select</code>.

ArchiveIdstring

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

VaultARNstring

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

CreationDatestring

The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example <code>"2012-03-20T17:03:43.221Z"</code>.

Completedboolean

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

StatusCode'InProgress' | 'Succeeded' | 'Failed'

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

StatusMessagestring

A friendly message that describes the job status.

ArchiveSizeInBytesinteger

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.

InventorySizeInBytesinteger

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.

SNSTopicstring

An Amazon SNS topic that receives notification.

CompletionDatestring

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

SHA256TreeHashstring

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: <ul> <li> Archive retrieval jobs that specify a range that is not tree-hash aligned </li> </ul> <ul> <li> Archival jobs that specify a range that is equal to the whole archive, when the job status is <code>InProgress</code> </li> </ul> <ul> <li> Inventory jobs </li> <li> Select jobs </li> </ul>

ArchiveSHA256TreeHashstring

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

RetrievalByteRangestring

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.

Tierstring

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

JobOutputPathstring

Contains the job output location.

Example response

{
  "Action": "InventoryRetrieval",
  "Completed": false,
  "CreationDate": "2015-07-17T20:23:41.616Z",
  "InventoryRetrievalParameters": {
    "Format": "JSON"
  },
  "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
  "StatusCode": "InProgress",
  "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
}