You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glacier::Types::GlacierJobDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an Amazon Glacier job.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

Possible values:

  • ArchiveRetrieval
  • InventoryRetrieval

Returns:

  • (String)

    The job type.

#archive_idString

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

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

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

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

Returns:

  • (Boolean)

    The job status.

#completion_dateTime

Returns:

  • (Time)

#creation_dateTime

Returns:

  • (Time)

#inventory_retrieval_parametersTypes::InventoryRetrievalJobDescription

Parameters used for range inventory retrieval.

Returns:

#inventory_size_in_bytesInteger

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

The job description you provided when you initiated the job.

Returns:

  • (String)

    The job description you provided when you initiated the job.

#job_idString

An opaque string that identifies an Amazon Glacier job.

Returns:

  • (String)

    An opaque string that identifies an Amazon Glacier job.

#retrieval_byte_rangeString

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

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

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

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

A friendly message that describes the job status.

Returns:

  • (String)

    A friendly message that describes the job status.

#tierString

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

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.