Provides options for defining a job.
Declaration Syntax
C# |
public class JobParameters
Members
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
JobParameters()()()() | Initializes a new instance of the JobParameters class | |
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.
| |
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.
| |
Equals(Object) | (Inherited from Object.) | |
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".
| |
GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |
InventoryRetrievalParameters |
Input parameters used for range inventory retrieval.
| |
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.
| |
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.
| |
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | |
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".
| |
WithArchiveId(String) | Obsolete.
Sets the ArchiveId property
| |
WithDescription(String) | Obsolete.
Sets the Description property
| |
WithFormat(String) | Obsolete.
Sets the Format property
| |
WithInventoryRetrievalParameters(InventoryRetrievalJobInput) | Obsolete.
Sets the InventoryRetrievalParameters property
| |
WithRetrievalByteRange(String) | Obsolete.
Sets the RetrievalByteRange property
| |
WithSNSTopic(String) | Obsolete.
Sets the SNSTopic property
| |
WithType(String) | Obsolete.
Sets the Type property
|
Inheritance Hierarchy
Object | |
JobParameters |