DescribeJobResponse Class | AWS SDK for .NET V3

Contains the description of an Amazon S3 Glacier job.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.Glacier.Model.DescribeJobResponse

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

Syntax

public class DescribeJobResponse : AmazonWebServiceResponse

The DescribeJobResponse type exposes the following members

Constructors

	Name	Description
	DescribeJobResponse()

Properties

Name	Type	Description
Action	Amazon.Glacier.ActionCode	Gets and sets the property Action. The job type. This value is either `ArchiveRetrieval`, `InventoryRetrieval`, or `Select`.
ArchiveId	System.String	Gets and sets the property ArchiveId. The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
ArchiveSHA256TreeHash	System.String	Gets and sets the property ArchiveSHA256TreeHash. The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
ArchiveSizeInBytes	System.Int64	Gets and sets the property ArchiveSizeInBytes. 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	System.Boolean	Gets and sets the property Completed. The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
CompletionDate	System.DateTime	Gets and sets the property CompletionDate. The UTC time that the job request completed. While the job is in progress, the value is null.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
CreationDate	System.DateTime	Gets and sets the property CreationDate. The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example `"2012-03-20T17:03:43.221Z"`.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
InventoryRetrievalParameters	Amazon.Glacier.Model.InventoryRetrievalJobDescription	Gets and sets the property InventoryRetrievalParameters. Parameters used for range inventory retrieval.
InventorySizeInBytes	System.Int64	Gets and sets the property InventorySizeInBytes. 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.
JobDescription	System.String	Gets and sets the property JobDescription. The job description provided when initiating the job.
JobId	System.String	Gets and sets the property JobId. An opaque string that identifies an Amazon S3 Glacier job.
JobOutputPath	System.String	Gets and sets the property JobOutputPath. Contains the job output location.
OutputLocation	Amazon.Glacier.Model.OutputLocation	Gets and sets the property OutputLocation. Contains the location where the data from the select job is stored.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
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. 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.
SelectParameters	Amazon.Glacier.Model.SelectParameters	Gets and sets the property SelectParameters. Contains the parameters used for a select.
SHA256TreeHash	System.String	Gets and sets the property SHA256TreeHash. 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
SNSTopic	System.String	Gets and sets the property SNSTopic. An Amazon SNS topic that receives notification.
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.
StatusMessage	System.String	Gets and sets the property StatusMessage. A friendly message that describes the job status.
Tier	System.String	Gets and sets the property Tier. The tier to use for a select or an archive retrieval. Valid values are `Expedited`, `Standard`, or `Bulk`. `Standard` is the default.
VaultARN	System.String	Gets and sets the property VaultARN. The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Examples

The example returns information about the previously initiated job specified by the job ID.

To get information about a previously initiated job


var client = new AmazonGlacierClient();
var response = client.DescribeJob(new DescribeJobRequest 
{
    AccountId = "-",
    JobId = "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",
    VaultName = "my-vault"
});

string action = response.Action;
bool completed = response.Completed;
string creationDate = response.CreationDate;
InventoryRetrievalJobDescription inventoryRetrievalParameters = response.InventoryRetrievalParameters;
string jobId = response.JobId;
string statusCode = response.StatusCode;
string vaultARN = response.VaultARN;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5