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 show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

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

Overloads:

  • #initialize(account_id, vault_name, id, options = {}) ⇒ Object

    Parameters:

    • account_id (String)
    • vault_name (String)
    • id (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :account_id (required, String)
    • :vault_name (required, String)
    • :id (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#account_idString (readonly)

Returns:

  • (String)

#actionString (readonly)

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

Possible values:

  • ArchiveRetrieval
  • InventoryRetrieval

Returns:

  • (String)

    The job type.

#archive_idString (readonly)

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

Returns:

  • (String)

    For an ArchiveRetrieval job, this is the archive ID requested for download.

#archive_sha256_tree_hashString (readonly)

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

Returns:

  • (String)

    The SHA256 tree hash of the entire archive for an archive retrieval.

#archive_size_in_bytesInteger (readonly)

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

Returns:

  • (Integer)

    For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.

#completedBoolean (readonly)

The job status. When a job is completed, you get the job\'s output.

Returns:

  • (Boolean)

    The job status.

#completion_dateTime (readonly)

Returns:

  • (Time)

#creation_dateTime (readonly)

Returns:

  • (Time)

#idString (readonly)

Returns:

  • (String)

#inventory_retrieval_parametersTypes::InventoryRetrievalJobDescription (readonly)

Parameters used for range inventory retrieval.

Returns:

#inventory_size_in_bytesInteger (readonly)

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

Returns:

  • (Integer)

    For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.

#job_descriptionString (readonly)

The job description you provided when you initiated the job.

Returns:

  • (String)

    The job description you provided when you initiated the job.

#job_idString (readonly)

An opaque string that identifies an Amazon Glacier job.

Returns:

  • (String)

    An opaque string that identifies an Amazon Glacier job.

#retrieval_byte_rangeString (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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

Returns:

  • (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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1.

#sha256_tree_hashString (readonly)

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null in the following situations:

  • 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 and the job status is InProgress.

^ ^

  • Inventory jobs.

^

Returns:

  • (String)

    For an ArchiveRetrieval job, it is the checksum of the archive.

#sns_topicString (readonly)

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

Returns:

  • (String)

    An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

#status_codeString (readonly)

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_messageString (readonly)

A friendly message that describes the job status.

Returns:

  • (String)

    A friendly message that describes the job status.

#tierString (readonly)

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Returns:

  • (String)

    The retrieval option to use for the archive retrieval.

#vault_arnString (readonly)

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

Returns:

  • (String)

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

#vault_nameString (readonly)

Returns:

  • (String)

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 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 Amazon 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 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, Amazon 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 Amazon 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

Examples:

Request syntax example with placeholder values


job.get_output({
  response_target: "/path/to/file", # where to write response data, file path, or IO object
  range: "string",
})

Options Hash (options):

  • :response_target (IO, String)

    Specifies where to stream response data. You can provide the path where a file will be created on disk, or you can provide an IO object. If omitted, the response data will be loaded into memory and written to a StringIO object.

  • :range (String)

    The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

    If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

    1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

    2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

    3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

    4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Returns:

See Also:

#vaultVault

Returns: