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.

InventoryRetrievalJobDescription

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

type InventoryRetrievalJobDescription struct { EndDate *string `type:"string"` Format *string `type:"string"` Limit *string `type:"string"` Marker *string `type:"string"` StartDate *string `type:"string"` }

Describes the options for a range inventory retrieval job.

EndDate

Type: *string

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Format

Type: *string

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Limit

Type: *string

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Marker

Type: *string

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering).

StartDate

Type: *string

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Method

GoString

func (s InventoryRetrievalJobDescription) GoString() string

GoString returns the string representation

SetEndDate

func (s *InventoryRetrievalJobDescription) SetEndDate(v string) *InventoryRetrievalJobDescription

SetEndDate sets the EndDate field's value.

SetFormat

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

SetFormat sets the Format field's value.

SetLimit

func (s *InventoryRetrievalJobDescription) SetLimit(v string) *InventoryRetrievalJobDescription

SetLimit sets the Limit field's value.

SetMarker

func (s *InventoryRetrievalJobDescription) SetMarker(v string) *InventoryRetrievalJobDescription

SetMarker sets the Marker field's value.

SetStartDate

func (s *InventoryRetrievalJobDescription) SetStartDate(v string) *InventoryRetrievalJobDescription

SetStartDate sets the StartDate field's value.

String

func (s InventoryRetrievalJobDescription) String() string

String returns the string representation

On this page: