AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes an Amazon Glacier job.

Inheritance Hierarchy

System.Object
  Amazon.Glacier.Model.GlacierJobDescription

Namespace: Amazon.Glacier.Model
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z

Syntax

C#
public class GlacierJobDescription

The GlacierJobDescription type exposes the following members

Constructors

NameDescription
Public Method GlacierJobDescription()

Properties

NameTypeDescription
Public Property Action Amazon.Glacier.ActionCode

Gets and sets the property Action.

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

Public Property ArchiveId System.String

Gets and sets the property ArchiveId.

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

Public Property ArchiveSHA256TreeHash System.String

Gets and sets the property ArchiveSHA256TreeHash.

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

Public Property ArchiveSizeInBytes System.Int64

Gets and sets the property ArchiveSizeInBytes.

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.

Public Property Completed System.Boolean

Gets and sets the property Completed.

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

Public Property CompletionDate System.DateTime

Gets and sets the property CompletionDate.

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

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

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

Public Property InventoryRetrievalParameters Amazon.Glacier.Model.InventoryRetrievalJobDescription

Gets and sets the property InventoryRetrievalParameters.

Parameters used for range inventory retrieval.

Public Property InventorySizeInBytes System.Int64

Gets and sets the property InventorySizeInBytes.

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

Public Property JobDescription System.String

Gets and sets the property JobDescription.

The job description you provided when you initiated the job.

Public Property JobId System.String

Gets and sets the property JobId.

An opaque string that identifies an Amazon Glacier job.

Public Property RetrievalByteRange System.String

Gets and sets the property RetrievalByteRange.

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.

Public Property SHA256TreeHash System.String

Gets and sets the property SHA256TreeHash.

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.

Public Property SNSTopic System.String

Gets and sets the property SNSTopic.

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

Public Property StatusCode Amazon.Glacier.StatusCode

Gets and sets the property StatusCode.

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

Public Property StatusMessage System.String

Gets and sets the property StatusMessage.

A friendly message that describes the job status.

Public Property Tier System.String

Gets and sets the property Tier.

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

Public Property VaultARN System.String

Gets and sets the property VaultARN.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms