AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

JobParameters

import "github.com/aws/aws-sdk-go/service/glacier"

type JobParameters struct { ArchiveId *string `type:"string"` Description *string `type:"string"` Format *string `type:"string"` InventoryRetrievalParameters *InventoryRetrievalJobInput `type:"structure"` OutputLocation *OutputLocation `type:"structure"` RetrievalByteRange *string `type:"string"` SNSTopic *string `type:"string"` SelectParameters *SelectParameters `type:"structure"` Tier *string `type:"string"` Type *string `type:"string"` }

Provides options for defining a job.

ArchiveId

Type: *string

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

Description

Type: *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

Type: *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".

InventoryRetrievalParameters

Provides options for specifying a range inventory retrieval job.

OutputLocation

Contains information about the location where the select job results are stored.

RetrievalByteRange

Type: *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.

SNSTopic

Type: *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.

SelectParameters

Contains information about the parameters used for a select.

Tier

Type: *string

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Type

Type: *string

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

Method

GoString

func (s JobParameters) GoString() string

GoString returns the string representation

SetArchiveId

func (s *JobParameters) SetArchiveId(v string) *JobParameters

SetArchiveId sets the ArchiveId field's value.

SetDescription

func (s *JobParameters) SetDescription(v string) *JobParameters

SetDescription sets the Description field's value.

SetFormat

func (s *JobParameters) SetFormat(v string) *JobParameters

SetFormat sets the Format field's value.

SetInventoryRetrievalParameters

func (s *JobParameters) SetInventoryRetrievalParameters(v *InventoryRetrievalJobInput) *JobParameters

SetInventoryRetrievalParameters sets the InventoryRetrievalParameters field's value.

SetOutputLocation

func (s *JobParameters) SetOutputLocation(v *OutputLocation) *JobParameters

SetOutputLocation sets the OutputLocation field's value.

SetRetrievalByteRange

func (s *JobParameters) SetRetrievalByteRange(v string) *JobParameters

SetRetrievalByteRange sets the RetrievalByteRange field's value.

SetSNSTopic

func (s *JobParameters) SetSNSTopic(v string) *JobParameters

SetSNSTopic sets the SNSTopic field's value.

SetSelectParameters

func (s *JobParameters) SetSelectParameters(v *SelectParameters) *JobParameters

SetSelectParameters sets the SelectParameters field's value.

SetTier

func (s *JobParameters) SetTier(v string) *JobParameters

SetTier sets the Tier field's value.

SetType

func (s *JobParameters) SetType(v string) *JobParameters

SetType sets the Type field's value.

String

func (s JobParameters) String() string

String returns the string representation

Validate

func (s *JobParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: