Struct rusoto_glacier::JobParameters

pub struct JobParameters {
    pub archive_id: Option<String>,
    pub description: Option<String>,
    pub format: Option<String>,
    pub inventory_retrieval_parameters: Option<InventoryRetrievalJobInput>,
    pub retrieval_byte_range: Option<String>,
    pub sns_topic: Option<String>,
    pub tier: Option<String>,
    pub type_: Option<String>,
}

Provides options for defining a job.

Fields

archive_id: Option<String>

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: Option<String>

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: Option<String>

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".

inventory_retrieval_parameters: Option<InventoryRetrievalJobInput>

Input parameters used for range inventory retrieval.

retrieval_byte_range: Option<String>

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.

sns_topic: Option<String>

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.

tier: Option<String>

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

type_: Option<String>

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".

Trait Implementations

impl Default for JobParameters

fn default() -> JobParameters

Returns the "default value" for a type.

impl Debug for JobParameters

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for JobParameters

fn clone(&self) -> JobParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.