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.
Namespace: Amazon.Glacier.Model
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z
public class JobParameters
The JobParameters type exposes the following members
Name | Description | |
---|---|---|
JobParameters() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
JobParameters(string, string, string, string) |
Instantiates JobParameters with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
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 |
|
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. |
|
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". |
|
InventoryRetrievalParameters | Amazon.Glacier.Model.InventoryRetrievalJobInput |
Gets and sets the property InventoryRetrievalParameters. Input parameters used for range inventory retrieval. |
|
OutputLocation | Amazon.Glacier.Model.OutputLocation |
Gets and sets the property OutputLocation. Contains information about the location where the select job results are stored. |
|
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. |
|
SelectParameters | Amazon.Glacier.Model.SelectParameters |
Gets and sets the property SelectParameters. Contains the parameters that define a job. |
|
SNSTopic | System.String |
Gets and sets the property SNSTopic. The Amazon SNS topic ARN to which Amazon S3 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. |
|
Tier | System.String |
Gets and sets the property Tier.
The tier to use for a select or an archive retrieval job. Valid values are |
|
Type | System.String |
Gets and sets the property Type. The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval". |
.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