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.

Provides options for defining a job.

Inheritance Hierarchy

System.Object
  Amazon.Glacier.Model.JobParameters

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

Syntax

C#
public class JobParameters

The JobParameters type exposes the following members

Constructors

NameDescription
Public Method JobParameters()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method JobParameters(string, string, string, string)

Instantiates JobParameters with the parameterized properties

Properties

NameTypeDescription
Public Property ArchiveId System.String

Gets and sets the property ArchiveId.

The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

Public Property Description System.String

Gets and sets the property Description.

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Public Property Format System.String

Gets and sets the property Format.

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

Public Property InventoryRetrievalParameters Amazon.Glacier.Model.InventoryRetrievalJobInput

Gets and sets the property InventoryRetrievalParameters.

Input parameters used for range inventory retrieval.

Public Property RetrievalByteRange System.String

Gets and sets the property RetrievalByteRange.

The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Public Property SNSTopic System.String

Gets and sets the property SNSTopic.

The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

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 Type System.String

Gets and sets the property Type.

The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".

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