AWS SDK for .NET Documentation
GlacierJobDescription Class
AmazonAmazon.Glacier.ModelGlacierJobDescription Did this page help you?   Yes   No    Tell us about it...

Describes an Amazon Glacier job.

Declaration Syntax
public class GlacierJobDescription
All MembersConstructorsMethodsProperties

Initializes a new instance of the GlacierJobDescription class

The job type. It is either ArchiveRetrieval or InventoryRetrieval.


Allowed Values
ArchiveRetrieval, InventoryRetrieval

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

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

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.

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

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

The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Serves as a hash function for a particular type.
(Inherited from Object.)
Gets the type of the current instance.
(Inherited from Object.)
Parameters used for range inventory retrieval.

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

The job description you provided when you initiated the job.

An opaque string that identifies an Amazon Glacier job.

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.

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.

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

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


Allowed Values
InProgress, Succeeded, Failed

A friendly message that describes the job status.

Returns a string that represents the current object.
(Inherited from Object.)
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

WithAction(String) Obsolete.
Sets the Action property

WithArchiveId(String) Obsolete.
Sets the ArchiveId property

WithArchiveSHA256TreeHash(String) Obsolete.
Sets the ArchiveSHA256TreeHash property

WithArchiveSizeInBytes(Int64) Obsolete.
Sets the ArchiveSizeInBytes property

WithCompleted(Boolean) Obsolete.
Sets the Completed property

WithCompletionDate(DateTime) Obsolete.
Sets the CompletionDate property

WithCreationDate(DateTime) Obsolete.
Sets the CreationDate property

WithInventoryRetrievalParameters(InventoryRetrievalJobDescription) Obsolete.
Sets the InventoryRetrievalParameters property

WithInventorySizeInBytes(Int64) Obsolete.
Sets the InventorySizeInBytes property

WithJobDescription(String) Obsolete.
Sets the JobDescription property

WithJobId(String) Obsolete.
Sets the JobId property

WithRetrievalByteRange(String) Obsolete.
Sets the RetrievalByteRange property

WithSHA256TreeHash(String) Obsolete.
Sets the SHA256TreeHash property

WithSNSTopic(String) Obsolete.
Sets the SNSTopic property

WithStatusCode(String) Obsolete.
Sets the StatusCode property

WithStatusMessage(String) Obsolete.
Sets the StatusMessage property

WithVaultARN(String) Obsolete.
Sets the VaultARN property

Inheritance Hierarchy

Assembly: AWSSDK (Module: AWSSDK) Version: (