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.

Contains the Amazon S3 Glacier response to your request.

Inheritance Hierarchy

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

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

Syntax

C#
public class GetJobOutputResponse : AmazonWebServiceResponse
         IDisposable

The GetJobOutputResponse type exposes the following members

Constructors

NameDescription
Public Method GetJobOutputResponse()

Properties

NameTypeDescription
Public Property AcceptRanges System.String

Gets and sets the property AcceptRanges.

Indicates the range units accepted. For more information, see RFC2616.

Public Property ArchiveDescription System.String

Gets and sets the property ArchiveDescription.

The description of an archive.

Public Property Body System.IO.Stream

Gets and sets the property Body.

The job data, either archive data or inventory data.

Public Property Checksum System.String

Gets and sets the property Checksum.

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ContentRange System.String

Gets and sets the property ContentRange.

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Public Property ContentType System.String

Gets and sets the property ContentType.

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Status System.Int32

Gets and sets the property Status.

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method Dispose()

Disposes of all managed and unmanaged resources.

Examples

The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.

To get the output of a previously initiated job


var client = new AmazonGlacierClient();
var response = client.GetJobOutput(new GetJobOutputRequest 
{
    AccountId = "-",
    JobId = "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
    Range = "",
    VaultName = "my-vaul"
});

string acceptRanges = response.AcceptRanges;
MemoryStream body = response.Body;
string contentType = response.ContentType;
int status = response.Status;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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