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.

JobDescription

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

type JobDescription struct { Action *string `type:"string" enum:"ActionCode"` ArchiveId *string `type:"string"` ArchiveSHA256TreeHash *string `type:"string"` ArchiveSizeInBytes *int64 `type:"long"` Completed *bool `type:"boolean"` CompletionDate *string `type:"string"` CreationDate *string `type:"string"` InventoryRetrievalParameters *InventoryRetrievalJobDescription `type:"structure"` InventorySizeInBytes *int64 `type:"long"` JobDescription *string `type:"string"` JobId *string `type:"string"` JobOutputPath *string `type:"string"` OutputLocation *OutputLocation `type:"structure"` RetrievalByteRange *string `type:"string"` SHA256TreeHash *string `type:"string"` SNSTopic *string `type:"string"` SelectParameters *SelectParameters `type:"structure"` StatusCode *string `type:"string" enum:"StatusCode"` StatusMessage *string `type:"string"` Tier *string `type:"string"` VaultARN *string `type:"string"` }

Contains the description of an Amazon Glacier job.

Action

Type: *string

The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

ArchiveId

Type: *string

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

ArchiveSHA256TreeHash

Type: *string

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

ArchiveSizeInBytes

Type: *int64

For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

Completed

Type: *bool

The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

CompletionDate

Type: *string

The UTC time that the job request completed. While the job is in progress, the value is null.

CreationDate

Type: *string

The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

InventoryRetrievalParameters

Describes the options for a range inventory retrieval job.

InventorySizeInBytes

Type: *int64

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

JobDescription

Type: *string

The job description provided when initiating the job.

JobId

Type: *string

An opaque string that identifies an Amazon Glacier job.

JobOutputPath

Type: *string

Contains the job output location.

OutputLocation

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

RetrievalByteRange

Type: *string

The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

SHA256TreeHash

Type: *string

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

  • Archive retrieval jobs that specify a range that is not tree-hash aligned

  • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

  • Inventory jobs

  • Select jobs

SNSTopic

Type: *string

An Amazon SNS topic that receives notification.

SelectParameters

Contains information about the parameters used for a select.

StatusCode

Type: *string

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

StatusMessage

Type: *string

A friendly message that describes the job status.

Tier

Type: *string

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

VaultARN

Type: *string

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Method

GoString

func (s JobDescription) GoString() string

GoString returns the string representation

SetAction

func (s *JobDescription) SetAction(v string) *JobDescription

SetAction sets the Action field's value.

SetArchiveId

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

SetArchiveId sets the ArchiveId field's value.

SetArchiveSHA256TreeHash

func (s *JobDescription) SetArchiveSHA256TreeHash(v string) *JobDescription

SetArchiveSHA256TreeHash sets the ArchiveSHA256TreeHash field's value.

SetArchiveSizeInBytes

func (s *JobDescription) SetArchiveSizeInBytes(v int64) *JobDescription

SetArchiveSizeInBytes sets the ArchiveSizeInBytes field's value.

SetCompleted

func (s *JobDescription) SetCompleted(v bool) *JobDescription

SetCompleted sets the Completed field's value.

SetCompletionDate

func (s *JobDescription) SetCompletionDate(v string) *JobDescription

SetCompletionDate sets the CompletionDate field's value.

SetCreationDate

func (s *JobDescription) SetCreationDate(v string) *JobDescription

SetCreationDate sets the CreationDate field's value.

SetInventoryRetrievalParameters

func (s *JobDescription) SetInventoryRetrievalParameters(v *InventoryRetrievalJobDescription) *JobDescription

SetInventoryRetrievalParameters sets the InventoryRetrievalParameters field's value.

SetInventorySizeInBytes

func (s *JobDescription) SetInventorySizeInBytes(v int64) *JobDescription

SetInventorySizeInBytes sets the InventorySizeInBytes field's value.

SetJobDescription

func (s *JobDescription) SetJobDescription(v string) *JobDescription

SetJobDescription sets the JobDescription field's value.

SetJobId

func (s *JobDescription) SetJobId(v string) *JobDescription

SetJobId sets the JobId field's value.

SetJobOutputPath

func (s *JobDescription) SetJobOutputPath(v string) *JobDescription

SetJobOutputPath sets the JobOutputPath field's value.

SetOutputLocation

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

SetOutputLocation sets the OutputLocation field's value.

SetRetrievalByteRange

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

SetRetrievalByteRange sets the RetrievalByteRange field's value.

SetSHA256TreeHash

func (s *JobDescription) SetSHA256TreeHash(v string) *JobDescription

SetSHA256TreeHash sets the SHA256TreeHash field's value.

SetSNSTopic

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

SetSNSTopic sets the SNSTopic field's value.

SetSelectParameters

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

SetSelectParameters sets the SelectParameters field's value.

SetStatusCode

func (s *JobDescription) SetStatusCode(v string) *JobDescription

SetStatusCode sets the StatusCode field's value.

SetStatusMessage

func (s *JobDescription) SetStatusMessage(v string) *JobDescription

SetStatusMessage sets the StatusMessage field's value.

SetTier

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

SetTier sets the Tier field's value.

SetVaultARN

func (s *JobDescription) SetVaultARN(v string) *JobDescription

SetVaultARN sets the VaultARN field's value.

String

func (s JobDescription) String() string

String returns the string representation

On this page: