You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Glacier::Job
- Inherits:
-
Resources::Resource
- Object
- Resources::Resource
- Aws::Glacier::Job
- Defined in:
- (unknown)
Instance Attribute Summary collapse
-
#account_id ⇒ String
readonly
-
#action ⇒ String
readonly
The job type.
-
#archive_id ⇒ String
readonly
The archive ID requested for a select job or archive retrieval.
-
#archive_sha256_tree_hash ⇒ String
readonly
The SHA256 tree hash of the entire archive for an archive retrieval.
-
#archive_size_in_bytes ⇒ Integer
readonly
For an archive retrieval job, this value is the size in bytes of the archive being requested for download.
-
#completed ⇒ Boolean
readonly
The job status.
-
#completion_date ⇒ Time
readonly
-
#creation_date ⇒ Time
readonly
-
#id ⇒ String
readonly
-
#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobDescription
readonly
Parameters used for range inventory retrieval.
-
#inventory_size_in_bytes ⇒ Integer
readonly
For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.
-
#job_description ⇒ String
readonly
The job description provided when initiating the job.
-
#job_id ⇒ String
readonly
An opaque string that identifies an Amazon S3 Glacier job.
-
#job_output_path ⇒ String
readonly
Contains the job output location.
-
#output_location ⇒ Types::OutputLocation
readonly
Contains the location where the data from the select job is stored.
-
#retrieval_byte_range ⇒ String
readonly
The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
-
#select_parameters ⇒ Types::SelectParameters
readonly
Contains the parameters used for a select.
-
#sha256_tree_hash ⇒ String
readonly
For an archive retrieval job, this value is the checksum of the archive.
-
#sns_topic ⇒ String
readonly
An Amazon SNS topic that receives notification.
-
#status_code ⇒ String
readonly
The status code can be
InProgress
,Succeeded
, orFailed
, and indicates the status of the job. -
#status_message ⇒ String
readonly
A friendly message that describes the job status.
-
#tier ⇒ String
readonly
The tier to use for a select or an archive retrieval.
-
#vault_arn ⇒ String
readonly
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
-
#vault_name ⇒ String
readonly
Attributes inherited from Resources::Resource
Instance Method Summary collapse
-
#get_output(options = {}) ⇒ Types::GetJobOutputOutput
This operation downloads the output of the job you initiated using InitiateJob.
-
#initialize ⇒ Object
constructor
-
#vault ⇒ Vault
Methods inherited from Resources::Resource
add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until
Methods included from Resources::OperationMethods
#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations
Constructor Details
#initialize(account_id, vault_name, id, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object
Instance Attribute Details
#account_id ⇒ String (readonly)
#action ⇒ String (readonly)
The job type. This value is either ArchiveRetrieval
,
InventoryRetrieval
, or Select
.
Possible values:
- ArchiveRetrieval
- InventoryRetrieval
- Select
#archive_id ⇒ String (readonly)
The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
#archive_sha256_tree_hash ⇒ String (readonly)
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
#archive_size_in_bytes ⇒ Integer (readonly)
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 (readonly)
The job status. When a job is completed, you get the job\'s output using Get Job Output (GET output).
#completion_date ⇒ Time (readonly)
#creation_date ⇒ Time (readonly)
#id ⇒ String (readonly)
#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobDescription (readonly)
Parameters used for range inventory retrieval.
#inventory_size_in_bytes ⇒ Integer (readonly)
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.
#job_description ⇒ String (readonly)
The job description provided when initiating the job.
#job_id ⇒ String (readonly)
An opaque string that identifies an Amazon S3 Glacier job.
#job_output_path ⇒ String (readonly)
Contains the job output location.
#output_location ⇒ Types::OutputLocation (readonly)
Contains the location where the data from the select job is stored.
#retrieval_byte_range ⇒ String (readonly)
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.
#select_parameters ⇒ Types::SelectParameters (readonly)
Contains the parameters used for a select.
#sha256_tree_hash ⇒ String (readonly)
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
#sns_topic ⇒ String (readonly)
An Amazon SNS topic that receives notification.
#status_code ⇒ String (readonly)
The status code can be InProgress
, Succeeded
, or Failed
, and
indicates the status of the job.
Possible values:
- InProgress
- Succeeded
- Failed
#status_message ⇒ String (readonly)
A friendly message that describes the job status.
#tier ⇒ String (readonly)
The tier to use for a select or an archive retrieval. Valid values are
Expedited
, Standard
, or Bulk
. Standard
is the default.
#vault_arn ⇒ String (readonly)
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
#vault_name ⇒ String (readonly)
Instance Method Details
#get_output(options = {}) ⇒ Types::GetJobOutputOutput
This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.
A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.
For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575
, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.
In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.
A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon 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 conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output