glacier

package
v1.14.24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2018 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package glacier provides the client and types for making API requests to Amazon Glacier.

Amazon Glacier is a storage solution for "cold data."

Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.

Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3) (http://aws.amazon.com/s3/).

You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.

If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide:

See glacier package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/glacier/

Using the Client

To contact Amazon Glacier with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Glacier client Glacier for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/glacier/#New

Index

Examples

Constants

View Source 
const (
	// ActionCodeArchiveRetrieval is a ActionCode enum value
	ActionCodeArchiveRetrieval = "ArchiveRetrieval"

	// ActionCodeInventoryRetrieval is a ActionCode enum value
	ActionCodeInventoryRetrieval = "InventoryRetrieval"

	// ActionCodeSelect is a ActionCode enum value
	ActionCodeSelect = "Select"
)
View Source 
const (
	// CannedACLPrivate is a CannedACL enum value
	CannedACLPrivate = "private"

	// CannedACLPublicRead is a CannedACL enum value
	CannedACLPublicRead = "public-read"

	// CannedACLPublicReadWrite is a CannedACL enum value
	CannedACLPublicReadWrite = "public-read-write"

	// CannedACLAwsExecRead is a CannedACL enum value
	CannedACLAwsExecRead = "aws-exec-read"

	// CannedACLAuthenticatedRead is a CannedACL enum value
	CannedACLAuthenticatedRead = "authenticated-read"

	// CannedACLBucketOwnerRead is a CannedACL enum value
	CannedACLBucketOwnerRead = "bucket-owner-read"

	// CannedACLBucketOwnerFullControl is a CannedACL enum value
	CannedACLBucketOwnerFullControl = "bucket-owner-full-control"
)
View Source 
const (
	// EncryptionTypeAwsKms is a EncryptionType enum value
	EncryptionTypeAwsKms = "aws:kms"

	// EncryptionTypeAes256 is a EncryptionType enum value
	EncryptionTypeAes256 = "AES256"
)
View Source 
const (
	// FileHeaderInfoUse is a FileHeaderInfo enum value
	FileHeaderInfoUse = "USE"

	// FileHeaderInfoIgnore is a FileHeaderInfo enum value
	FileHeaderInfoIgnore = "IGNORE"

	// FileHeaderInfoNone is a FileHeaderInfo enum value
	FileHeaderInfoNone = "NONE"
)
View Source 
const (
	// PermissionFullControl is a Permission enum value
	PermissionFullControl = "FULL_CONTROL"

	// PermissionWrite is a Permission enum value
	PermissionWrite = "WRITE"

	// PermissionWriteAcp is a Permission enum value
	PermissionWriteAcp = "WRITE_ACP"

	// PermissionRead is a Permission enum value
	PermissionRead = "READ"

	// PermissionReadAcp is a Permission enum value
	PermissionReadAcp = "READ_ACP"
)
View Source 
const (
	// QuoteFieldsAlways is a QuoteFields enum value
	QuoteFieldsAlways = "ALWAYS"

	// QuoteFieldsAsneeded is a QuoteFields enum value
	QuoteFieldsAsneeded = "ASNEEDED"
)
View Source 
const (
	// StatusCodeInProgress is a StatusCode enum value
	StatusCodeInProgress = "InProgress"

	// StatusCodeSucceeded is a StatusCode enum value
	StatusCodeSucceeded = "Succeeded"

	// StatusCodeFailed is a StatusCode enum value
	StatusCodeFailed = "Failed"
)
View Source 
const (
	// StorageClassStandard is a StorageClass enum value
	StorageClassStandard = "STANDARD"

	// StorageClassReducedRedundancy is a StorageClass enum value
	StorageClassReducedRedundancy = "REDUCED_REDUNDANCY"

	// StorageClassStandardIa is a StorageClass enum value
	StorageClassStandardIa = "STANDARD_IA"
)
View Source 
const (
	// TypeAmazonCustomerByEmail is a Type enum value
	TypeAmazonCustomerByEmail = "AmazonCustomerByEmail"

	// TypeCanonicalUser is a Type enum value
	TypeCanonicalUser = "CanonicalUser"

	// TypeGroup is a Type enum value
	TypeGroup = "Group"
)
View Source 
const (

	// ErrCodeInsufficientCapacityException for service response error code
	// "InsufficientCapacityException".
	//
	// Returned if there is insufficient capacity to process this expedited request.
	// This error only applies to expedited retrievals and not to standard or bulk
	// retrievals.
	ErrCodeInsufficientCapacityException = "InsufficientCapacityException"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// Returned if a parameter of the request is incorrectly specified.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Returned if the request results in a vault or account limit being exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMissingParameterValueException for service response error code
	// "MissingParameterValueException".
	//
	// Returned if a required header or parameter is missing from the request.
	ErrCodeMissingParameterValueException = "MissingParameterValueException"

	// ErrCodePolicyEnforcedException for service response error code
	// "PolicyEnforcedException".
	//
	// Returned if a retrieval job would exceed the current data policy's retrieval
	// rate limit. For more information about data retrieval policies,
	ErrCodePolicyEnforcedException = "PolicyEnforcedException"

	// ErrCodeRequestTimeoutException for service response error code
	// "RequestTimeoutException".
	//
	// Returned if, when uploading an archive, Amazon Glacier times out while receiving
	// the upload.
	ErrCodeRequestTimeoutException = "RequestTimeoutException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Returned if the specified resource (such as a vault, upload ID, or job ID)
	// doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Returned if the service cannot complete the request.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
View Source 
const (
	ServiceName = "glacier"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Glacier"   // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// ExpressionTypeSql is a ExpressionType enum value
	ExpressionTypeSql = "SQL"
)

Variables

This section is empty.

Functions

func ComputeTreeHash added in v1.8.5 

func ComputeTreeHash(hashes [][]byte) []byte

ComputeTreeHash builds a tree hash root node given a slice of hashes. Glacier tree hash to be derived from SHA256 hashes of 1MB chucks of the data.

See http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html for more information.

Example 
package main

import (
	"bytes"
	"crypto/sha256"
	"fmt"
	"io"

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

func testCreateReader() io.ReadSeeker {
	buf := make([]byte, 5767168)
	for i := range buf {
		buf[i] = '0'
	}

	return bytes.NewReader(buf)
}

func main() {
	r := testCreateReader()

	const chunkSize = 1024 * 1024 // 1MB
	buf := make([]byte, chunkSize)
	hashes := [][]byte{}

	for {
		// Reach 1MB chunks from reader to generate hashes from
		n, err := io.ReadAtLeast(r, buf, chunkSize)
		if n == 0 {
			break
		}

		tmpHash := sha256.Sum256(buf[:n])
		hashes = append(hashes, tmpHash[:])
		if err != nil {
			break // last chunk
		}
	}

	treeHash := glacier.ComputeTreeHash(hashes)
	fmt.Printf("TreeHash: %x\n", treeHash)

}

Output:

TreeHash: 154e26c78fd74d0c2c9b3cc4644191619dc4f2cd539ae2a74d5fd07957a3ee6a

Types

type AbortMultipartUploadInput 

type AbortMultipartUploadInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The upload ID of the multipart upload to delete.
	//
	// UploadId is a required field
	UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options to abort a multipart upload identified by the upload ID.

For information about the underlying REST API, see Abort Multipart Upload (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html). For conceptual information, see Working with Archives in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html).

func (AbortMultipartUploadInput) GoString added in v0.6.6 

func (s AbortMultipartUploadInput) GoString() string

GoString returns the string representation

func (*AbortMultipartUploadInput) SetAccountId added in v1.5.1 

func (s *AbortMultipartUploadInput) SetAccountId(v string) *AbortMultipartUploadInput

SetAccountId sets the AccountId field's value.

func (*AbortMultipartUploadInput) SetUploadId added in v1.5.1 

func (s *AbortMultipartUploadInput) SetUploadId(v string) *AbortMultipartUploadInput

SetUploadId sets the UploadId field's value.

func (*AbortMultipartUploadInput) SetVaultName added in v1.5.1 

func (s *AbortMultipartUploadInput) SetVaultName(v string) *AbortMultipartUploadInput

SetVaultName sets the VaultName field's value.

func (AbortMultipartUploadInput) String added in v0.6.6 

func (s AbortMultipartUploadInput) String() string

String returns the string representation

func (*AbortMultipartUploadInput) Validate added in v1.1.24 

func (s *AbortMultipartUploadInput) Validate() error

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

type AbortMultipartUploadOutput 

type AbortMultipartUploadOutput struct {
	// contains filtered or unexported fields
}

func (AbortMultipartUploadOutput) GoString added in v0.6.6 

func (s AbortMultipartUploadOutput) GoString() string

GoString returns the string representation

func (AbortMultipartUploadOutput) String added in v0.6.6 

func (s AbortMultipartUploadOutput) String() string

String returns the string representation

type AbortVaultLockInput added in v0.7.0 

type AbortVaultLockInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input values for AbortVaultLock.

func (AbortVaultLockInput) GoString added in v0.7.0 

func (s AbortVaultLockInput) GoString() string

GoString returns the string representation

func (*AbortVaultLockInput) SetAccountId added in v1.5.1 

func (s *AbortVaultLockInput) SetAccountId(v string) *AbortVaultLockInput

SetAccountId sets the AccountId field's value.

func (*AbortVaultLockInput) SetVaultName added in v1.5.1 

func (s *AbortVaultLockInput) SetVaultName(v string) *AbortVaultLockInput

SetVaultName sets the VaultName field's value.

func (AbortVaultLockInput) String added in v0.7.0 

func (s AbortVaultLockInput) String() string

String returns the string representation

func (*AbortVaultLockInput) Validate added in v1.1.24 

func (s *AbortVaultLockInput) Validate() error

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

type AbortVaultLockOutput added in v0.7.0 

type AbortVaultLockOutput struct {
	// contains filtered or unexported fields
}

func (AbortVaultLockOutput) GoString added in v0.7.0 

func (s AbortVaultLockOutput) GoString() string

GoString returns the string representation

func (AbortVaultLockOutput) String added in v0.7.0 

func (s AbortVaultLockOutput) String() string

String returns the string representation

type AddTagsToVaultInput added in v0.6.6 

type AddTagsToVaultInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The tags to add to the vault. Each tag is composed of a key and a value.
	// The value can be an empty string.
	Tags map[string]*string `type:"map"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input values for AddTagsToVault.

func (AddTagsToVaultInput) GoString added in v0.6.6 

func (s AddTagsToVaultInput) GoString() string

GoString returns the string representation

func (*AddTagsToVaultInput) SetAccountId added in v1.5.1 

func (s *AddTagsToVaultInput) SetAccountId(v string) *AddTagsToVaultInput

SetAccountId sets the AccountId field's value.

func (*AddTagsToVaultInput) SetTags added in v1.5.1 

func (s *AddTagsToVaultInput) SetTags(v map[string]*string) *AddTagsToVaultInput

SetTags sets the Tags field's value.

func (*AddTagsToVaultInput) SetVaultName added in v1.5.1 

func (s *AddTagsToVaultInput) SetVaultName(v string) *AddTagsToVaultInput

SetVaultName sets the VaultName field's value.

func (AddTagsToVaultInput) String added in v0.6.6 

func (s AddTagsToVaultInput) String() string

String returns the string representation

func (*AddTagsToVaultInput) Validate added in v1.1.24 

func (s *AddTagsToVaultInput) Validate() error

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

type AddTagsToVaultOutput added in v0.6.6 

type AddTagsToVaultOutput struct {
	// contains filtered or unexported fields
}

func (AddTagsToVaultOutput) GoString added in v0.6.6 

func (s AddTagsToVaultOutput) GoString() string

GoString returns the string representation

func (AddTagsToVaultOutput) String added in v0.6.6 

func (s AddTagsToVaultOutput) String() string

String returns the string representation

type ArchiveCreationOutput 

type ArchiveCreationOutput struct {

	// The ID of the archive. This value is also included as part of the location.
	ArchiveId *string `location:"header" locationName:"x-amz-archive-id" type:"string"`

	// The checksum of the archive computed by Amazon Glacier.
	Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"`

	// The relative URI path of the newly added archive resource.
	Location *string `location:"header" locationName:"Location" type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

For information about the underlying REST API, see Upload Archive (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html). For conceptual information, see Working with Archives in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html).

func (ArchiveCreationOutput) GoString added in v0.6.6 

func (s ArchiveCreationOutput) GoString() string

GoString returns the string representation

func (*ArchiveCreationOutput) SetArchiveId added in v1.5.1 

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

SetArchiveId sets the ArchiveId field's value.

func (*ArchiveCreationOutput) SetChecksum added in v1.5.1 

func (s *ArchiveCreationOutput) SetChecksum(v string) *ArchiveCreationOutput

SetChecksum sets the Checksum field's value.

func (*ArchiveCreationOutput) SetLocation added in v1.5.1 

func (s *ArchiveCreationOutput) SetLocation(v string) *ArchiveCreationOutput

SetLocation sets the Location field's value.

func (ArchiveCreationOutput) String added in v0.6.6 

func (s ArchiveCreationOutput) String() string

String returns the string representation

type CSVInput added in v1.12.39 

type CSVInput struct {

	// A single character used to indicate that a row should be ignored when the
	// character is present at the start of that row.
	Comments *string `type:"string"`

	// A value used to separate individual fields from each other within a record.
	FieldDelimiter *string `type:"string"`

	// Describes the first line of input. Valid values are None, Ignore, and Use.
	FileHeaderInfo *string `type:"string" enum:"FileHeaderInfo"`

	// A value used as an escape character where the field delimiter is part of
	// the value.
	QuoteCharacter *string `type:"string"`

	// A single character used for escaping the quotation-mark character inside
	// an already escaped value.
	QuoteEscapeCharacter *string `type:"string"`

	// A value used to separate individual records from each other.
	RecordDelimiter *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the comma-separated value (CSV) file to select from.

func (CSVInput) GoString added in v1.12.39 

func (s CSVInput) GoString() string

GoString returns the string representation

func (*CSVInput) SetComments added in v1.12.39 

func (s *CSVInput) SetComments(v string) *CSVInput

SetComments sets the Comments field's value.

func (*CSVInput) SetFieldDelimiter added in v1.12.39 

func (s *CSVInput) SetFieldDelimiter(v string) *CSVInput

SetFieldDelimiter sets the FieldDelimiter field's value.

func (*CSVInput) SetFileHeaderInfo added in v1.12.39 

func (s *CSVInput) SetFileHeaderInfo(v string) *CSVInput

SetFileHeaderInfo sets the FileHeaderInfo field's value.

func (*CSVInput) SetQuoteCharacter added in v1.12.39 

func (s *CSVInput) SetQuoteCharacter(v string) *CSVInput

SetQuoteCharacter sets the QuoteCharacter field's value.

func (*CSVInput) SetQuoteEscapeCharacter added in v1.12.39 

func (s *CSVInput) SetQuoteEscapeCharacter(v string) *CSVInput

SetQuoteEscapeCharacter sets the QuoteEscapeCharacter field's value.

func (*CSVInput) SetRecordDelimiter added in v1.12.39 

func (s *CSVInput) SetRecordDelimiter(v string) *CSVInput

SetRecordDelimiter sets the RecordDelimiter field's value.

func (CSVInput) String added in v1.12.39 

func (s CSVInput) String() string

String returns the string representation

type CSVOutput added in v1.12.39 

type CSVOutput struct {

	// A value used to separate individual fields from each other within a record.
	FieldDelimiter *string `type:"string"`

	// A value used as an escape character where the field delimiter is part of
	// the value.
	QuoteCharacter *string `type:"string"`

	// A single character used for escaping the quotation-mark character inside
	// an already escaped value.
	QuoteEscapeCharacter *string `type:"string"`

	// A value that indicates whether all output fields should be contained within
	// quotation marks.
	QuoteFields *string `type:"string" enum:"QuoteFields"`

	// A value used to separate individual records from each other.
	RecordDelimiter *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the comma-separated value (CSV) file that the job results are stored in.

func (CSVOutput) GoString added in v1.12.39 

func (s CSVOutput) GoString() string

GoString returns the string representation

func (*CSVOutput) SetFieldDelimiter added in v1.12.39 

func (s *CSVOutput) SetFieldDelimiter(v string) *CSVOutput

SetFieldDelimiter sets the FieldDelimiter field's value.

func (*CSVOutput) SetQuoteCharacter added in v1.12.39 

func (s *CSVOutput) SetQuoteCharacter(v string) *CSVOutput

SetQuoteCharacter sets the QuoteCharacter field's value.

func (*CSVOutput) SetQuoteEscapeCharacter added in v1.12.39 

func (s *CSVOutput) SetQuoteEscapeCharacter(v string) *CSVOutput

SetQuoteEscapeCharacter sets the QuoteEscapeCharacter field's value.

func (*CSVOutput) SetQuoteFields added in v1.12.39 

func (s *CSVOutput) SetQuoteFields(v string) *CSVOutput

SetQuoteFields sets the QuoteFields field's value.

func (*CSVOutput) SetRecordDelimiter added in v1.12.39 

func (s *CSVOutput) SetRecordDelimiter(v string) *CSVOutput

SetRecordDelimiter sets the RecordDelimiter field's value.

func (CSVOutput) String added in v1.12.39 

func (s CSVOutput) String() string

String returns the string representation

type CompleteMultipartUploadInput 

type CompleteMultipartUploadInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The total size, in bytes, of the entire archive. This value should be the
	// sum of all the sizes of the individual parts that you uploaded.
	ArchiveSize *string `location:"header" locationName:"x-amz-archive-size" type:"string"`

	// The SHA256 tree hash of the entire archive. It is the tree hash of SHA256
	// tree hash of the individual parts. If the value you specify in the request
	// does not match the SHA256 tree hash of the final assembled archive as computed
	// by Amazon Glacier, Amazon Glacier returns an error and the request fails.
	Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"`

	// The upload ID of the multipart upload.
	//
	// UploadId is a required field
	UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.

func (CompleteMultipartUploadInput) GoString added in v0.6.6 

func (s CompleteMultipartUploadInput) GoString() string

GoString returns the string representation

func (*CompleteMultipartUploadInput) SetAccountId added in v1.5.1 

func (s *CompleteMultipartUploadInput) SetAccountId(v string) *CompleteMultipartUploadInput

SetAccountId sets the AccountId field's value.

func (*CompleteMultipartUploadInput) SetArchiveSize added in v1.5.1 

func (s *CompleteMultipartUploadInput) SetArchiveSize(v string) *CompleteMultipartUploadInput

SetArchiveSize sets the ArchiveSize field's value.

func (*CompleteMultipartUploadInput) SetChecksum added in v1.5.1 

func (s *CompleteMultipartUploadInput) SetChecksum(v string) *CompleteMultipartUploadInput

SetChecksum sets the Checksum field's value.

func (*CompleteMultipartUploadInput) SetUploadId added in v1.5.1 

func (s *CompleteMultipartUploadInput) SetUploadId(v string) *CompleteMultipartUploadInput

SetUploadId sets the UploadId field's value.

func (*CompleteMultipartUploadInput) SetVaultName added in v1.5.1 

func (s *CompleteMultipartUploadInput) SetVaultName(v string) *CompleteMultipartUploadInput

SetVaultName sets the VaultName field's value.

func (CompleteMultipartUploadInput) String added in v0.6.6 

func (s CompleteMultipartUploadInput) String() string

String returns the string representation

func (*CompleteMultipartUploadInput) Validate added in v1.1.24 

func (s *CompleteMultipartUploadInput) Validate() error

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

type CompleteVaultLockInput added in v0.7.0 

type CompleteVaultLockInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The lockId value is the lock ID obtained from a InitiateVaultLock request.
	//
	// LockId is a required field
	LockId *string `location:"uri" locationName:"lockId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input values for CompleteVaultLock.

func (CompleteVaultLockInput) GoString added in v0.7.0 

func (s CompleteVaultLockInput) GoString() string

GoString returns the string representation

func (*CompleteVaultLockInput) SetAccountId added in v1.5.1 

func (s *CompleteVaultLockInput) SetAccountId(v string) *CompleteVaultLockInput

SetAccountId sets the AccountId field's value.

func (*CompleteVaultLockInput) SetLockId added in v1.5.1 

func (s *CompleteVaultLockInput) SetLockId(v string) *CompleteVaultLockInput

SetLockId sets the LockId field's value.

func (*CompleteVaultLockInput) SetVaultName added in v1.5.1 

func (s *CompleteVaultLockInput) SetVaultName(v string) *CompleteVaultLockInput

SetVaultName sets the VaultName field's value.

func (CompleteVaultLockInput) String added in v0.7.0 

func (s CompleteVaultLockInput) String() string

String returns the string representation

func (*CompleteVaultLockInput) Validate added in v1.1.24 

func (s *CompleteVaultLockInput) Validate() error

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

type CompleteVaultLockOutput added in v0.7.0 

type CompleteVaultLockOutput struct {
	// contains filtered or unexported fields
}

func (CompleteVaultLockOutput) GoString added in v0.7.0 

func (s CompleteVaultLockOutput) GoString() string

GoString returns the string representation

func (CompleteVaultLockOutput) String added in v0.7.0 

func (s CompleteVaultLockOutput) String() string

String returns the string representation

type CreateVaultInput 

type CreateVaultInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options to create a vault.

func (CreateVaultInput) GoString added in v0.6.6 

func (s CreateVaultInput) GoString() string

GoString returns the string representation

func (*CreateVaultInput) SetAccountId added in v1.5.1 

func (s *CreateVaultInput) SetAccountId(v string) *CreateVaultInput

SetAccountId sets the AccountId field's value.

func (*CreateVaultInput) SetVaultName added in v1.5.1 

func (s *CreateVaultInput) SetVaultName(v string) *CreateVaultInput

SetVaultName sets the VaultName field's value.

func (CreateVaultInput) String added in v0.6.6 

func (s CreateVaultInput) String() string

String returns the string representation

func (*CreateVaultInput) Validate added in v1.1.24 

func (s *CreateVaultInput) Validate() error

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

type CreateVaultOutput 

type CreateVaultOutput struct {

	// The URI of the vault that was created.
	Location *string `location:"header" locationName:"Location" type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (CreateVaultOutput) GoString added in v0.6.6 

func (s CreateVaultOutput) GoString() string

GoString returns the string representation

func (*CreateVaultOutput) SetLocation added in v1.5.1 

func (s *CreateVaultOutput) SetLocation(v string) *CreateVaultOutput

SetLocation sets the Location field's value.

func (CreateVaultOutput) String added in v0.6.6 

func (s CreateVaultOutput) String() string

String returns the string representation

type DataRetrievalPolicy 

type DataRetrievalPolicy struct {

	// The policy rule. Although this is a list type, currently there must be only
	// one rule, which contains a Strategy field and optionally a BytesPerHour field.
	Rules []*DataRetrievalRule `type:"list"`
	// contains filtered or unexported fields
}

Data retrieval policy.

func (DataRetrievalPolicy) GoString added in v0.6.6 

func (s DataRetrievalPolicy) GoString() string

GoString returns the string representation

func (*DataRetrievalPolicy) SetRules added in v1.5.1 

func (s *DataRetrievalPolicy) SetRules(v []*DataRetrievalRule) *DataRetrievalPolicy

SetRules sets the Rules field's value.

func (DataRetrievalPolicy) String added in v0.6.6 

func (s DataRetrievalPolicy) String() string

String returns the string representation

type DataRetrievalRule 

type DataRetrievalRule struct {

	// The maximum number of bytes that can be retrieved in an hour.
	//
	// This field is required only if the value of the Strategy field is BytesPerHour.
	// Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour
	// and you set this field.
	BytesPerHour *int64 `type:"long"`

	// The type of data retrieval policy to set.
	//
	// Valid values: BytesPerHour|FreeTier|None
	Strategy *string `type:"string"`
	// contains filtered or unexported fields
}

Data retrieval policy rule.

func (DataRetrievalRule) GoString added in v0.6.6 

func (s DataRetrievalRule) GoString() string

GoString returns the string representation

func (*DataRetrievalRule) SetBytesPerHour added in v1.5.1 

func (s *DataRetrievalRule) SetBytesPerHour(v int64) *DataRetrievalRule

SetBytesPerHour sets the BytesPerHour field's value.

func (*DataRetrievalRule) SetStrategy added in v1.5.1 

func (s *DataRetrievalRule) SetStrategy(v string) *DataRetrievalRule

SetStrategy sets the Strategy field's value.

func (DataRetrievalRule) String added in v0.6.6 

func (s DataRetrievalRule) String() string

String returns the string representation

type DeleteArchiveInput 

type DeleteArchiveInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The ID of the archive to delete.
	//
	// ArchiveId is a required field
	ArchiveId *string `location:"uri" locationName:"archiveId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for deleting an archive from an Amazon Glacier vault.

func (DeleteArchiveInput) GoString added in v0.6.6 

func (s DeleteArchiveInput) GoString() string

GoString returns the string representation

func (*DeleteArchiveInput) SetAccountId added in v1.5.1 

func (s *DeleteArchiveInput) SetAccountId(v string) *DeleteArchiveInput

SetAccountId sets the AccountId field's value.

func (*DeleteArchiveInput) SetArchiveId added in v1.5.1 

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

SetArchiveId sets the ArchiveId field's value.

func (*DeleteArchiveInput) SetVaultName added in v1.5.1 

func (s *DeleteArchiveInput) SetVaultName(v string) *DeleteArchiveInput

SetVaultName sets the VaultName field's value.

func (DeleteArchiveInput) String added in v0.6.6 

func (s DeleteArchiveInput) String() string

String returns the string representation

func (*DeleteArchiveInput) Validate added in v1.1.24 

func (s *DeleteArchiveInput) Validate() error

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

type DeleteArchiveOutput 

type DeleteArchiveOutput struct {
	// contains filtered or unexported fields
}

func (DeleteArchiveOutput) GoString added in v0.6.6 

func (s DeleteArchiveOutput) GoString() string

GoString returns the string representation

func (DeleteArchiveOutput) String added in v0.6.6 

func (s DeleteArchiveOutput) String() string

String returns the string representation

type DeleteVaultAccessPolicyInput 

type DeleteVaultAccessPolicyInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

DeleteVaultAccessPolicy input.

func (DeleteVaultAccessPolicyInput) GoString added in v0.6.6 

func (s DeleteVaultAccessPolicyInput) GoString() string

GoString returns the string representation

func (*DeleteVaultAccessPolicyInput) SetAccountId added in v1.5.1 

func (s *DeleteVaultAccessPolicyInput) SetAccountId(v string) *DeleteVaultAccessPolicyInput

SetAccountId sets the AccountId field's value.

func (*DeleteVaultAccessPolicyInput) SetVaultName added in v1.5.1 

func (s *DeleteVaultAccessPolicyInput) SetVaultName(v string) *DeleteVaultAccessPolicyInput

SetVaultName sets the VaultName field's value.

func (DeleteVaultAccessPolicyInput) String added in v0.6.6 

func (s DeleteVaultAccessPolicyInput) String() string

String returns the string representation

func (*DeleteVaultAccessPolicyInput) Validate added in v1.1.24 

func (s *DeleteVaultAccessPolicyInput) Validate() error

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

type DeleteVaultAccessPolicyOutput 

type DeleteVaultAccessPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteVaultAccessPolicyOutput) GoString added in v0.6.6 

func (s DeleteVaultAccessPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteVaultAccessPolicyOutput) String added in v0.6.6 

func (s DeleteVaultAccessPolicyOutput) String() string

String returns the string representation

type DeleteVaultInput 

type DeleteVaultInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for deleting a vault from Amazon Glacier.

func (DeleteVaultInput) GoString added in v0.6.6 

func (s DeleteVaultInput) GoString() string

GoString returns the string representation

func (*DeleteVaultInput) SetAccountId added in v1.5.1 

func (s *DeleteVaultInput) SetAccountId(v string) *DeleteVaultInput

SetAccountId sets the AccountId field's value.

func (*DeleteVaultInput) SetVaultName added in v1.5.1 

func (s *DeleteVaultInput) SetVaultName(v string) *DeleteVaultInput

SetVaultName sets the VaultName field's value.

func (DeleteVaultInput) String added in v0.6.6 

func (s DeleteVaultInput) String() string

String returns the string representation

func (*DeleteVaultInput) Validate added in v1.1.24 

func (s *DeleteVaultInput) Validate() error

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

type DeleteVaultNotificationsInput 

type DeleteVaultNotificationsInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for deleting a vault notification configuration from an Amazon Glacier vault.

func (DeleteVaultNotificationsInput) GoString added in v0.6.6 

func (s DeleteVaultNotificationsInput) GoString() string

GoString returns the string representation

func (*DeleteVaultNotificationsInput) SetAccountId added in v1.5.1 

func (s *DeleteVaultNotificationsInput) SetAccountId(v string) *DeleteVaultNotificationsInput

SetAccountId sets the AccountId field's value.

func (*DeleteVaultNotificationsInput) SetVaultName added in v1.5.1 

func (s *DeleteVaultNotificationsInput) SetVaultName(v string) *DeleteVaultNotificationsInput

SetVaultName sets the VaultName field's value.

func (DeleteVaultNotificationsInput) String added in v0.6.6 

func (s DeleteVaultNotificationsInput) String() string

String returns the string representation

func (*DeleteVaultNotificationsInput) Validate added in v1.1.24 

func (s *DeleteVaultNotificationsInput) Validate() error

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

type DeleteVaultNotificationsOutput 

type DeleteVaultNotificationsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteVaultNotificationsOutput) GoString added in v0.6.6 

func (s DeleteVaultNotificationsOutput) GoString() string

GoString returns the string representation

func (DeleteVaultNotificationsOutput) String added in v0.6.6 

func (s DeleteVaultNotificationsOutput) String() string

String returns the string representation

type DeleteVaultOutput 

type DeleteVaultOutput struct {
	// contains filtered or unexported fields
}

func (DeleteVaultOutput) GoString added in v0.6.6 

func (s DeleteVaultOutput) GoString() string

GoString returns the string representation

func (DeleteVaultOutput) String added in v0.6.6 

func (s DeleteVaultOutput) String() string

String returns the string representation

type DescribeJobInput 

type DescribeJobInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The ID of the job to describe.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for retrieving a job description.

func (DescribeJobInput) GoString added in v0.6.6 

func (s DescribeJobInput) GoString() string

GoString returns the string representation

func (*DescribeJobInput) SetAccountId added in v1.5.1 

func (s *DescribeJobInput) SetAccountId(v string) *DescribeJobInput

SetAccountId sets the AccountId field's value.

func (*DescribeJobInput) SetJobId added in v1.5.1 

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

SetJobId sets the JobId field's value.

func (*DescribeJobInput) SetVaultName added in v1.5.1 

func (s *DescribeJobInput) SetVaultName(v string) *DescribeJobInput

SetVaultName sets the VaultName field's value.

func (DescribeJobInput) String added in v0.6.6 

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate added in v1.1.24 

func (s *DescribeJobInput) Validate() error

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

type DescribeVaultInput 

type DescribeVaultInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for retrieving metadata for a specific vault in Amazon Glacier.

func (DescribeVaultInput) GoString added in v0.6.6 

func (s DescribeVaultInput) GoString() string

GoString returns the string representation

func (*DescribeVaultInput) SetAccountId added in v1.5.1 

func (s *DescribeVaultInput) SetAccountId(v string) *DescribeVaultInput

SetAccountId sets the AccountId field's value.

func (*DescribeVaultInput) SetVaultName added in v1.5.1 

func (s *DescribeVaultInput) SetVaultName(v string) *DescribeVaultInput

SetVaultName sets the VaultName field's value.

func (DescribeVaultInput) String added in v0.6.6 

func (s DescribeVaultInput) String() string

String returns the string representation

func (*DescribeVaultInput) Validate added in v1.1.24 

func (s *DescribeVaultInput) Validate() error

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

type DescribeVaultOutput 

type DescribeVaultOutput struct {

	// The Universal Coordinated Time (UTC) date when the vault was created. This
	// value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.
	CreationDate *string `type:"string"`

	// The Universal Coordinated Time (UTC) date when Amazon Glacier completed the
	// last vault inventory. This value should be a string in the ISO 8601 date
	// format, for example 2012-03-20T17:03:43.221Z.
	LastInventoryDate *string `type:"string"`

	// The number of archives in the vault as of the last inventory date. This field
	// will return null if an inventory has not yet run on the vault, for example
	// if you just created the vault.
	NumberOfArchives *int64 `type:"long"`

	// Total size, in bytes, of the archives in the vault as of the last inventory
	// date. This field will return null if an inventory has not yet run on the
	// vault, for example if you just created the vault.
	SizeInBytes *int64 `type:"long"`

	// The Amazon Resource Name (ARN) of the vault.
	VaultARN *string `type:"string"`

	// The name of the vault.
	VaultName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (DescribeVaultOutput) GoString added in v0.6.6 

func (s DescribeVaultOutput) GoString() string

GoString returns the string representation

func (*DescribeVaultOutput) SetCreationDate added in v1.5.1 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeVaultOutput) SetLastInventoryDate added in v1.5.1 

func (s *DescribeVaultOutput) SetLastInventoryDate(v string) *DescribeVaultOutput

SetLastInventoryDate sets the LastInventoryDate field's value.

func (*DescribeVaultOutput) SetNumberOfArchives added in v1.5.1 

func (s *DescribeVaultOutput) SetNumberOfArchives(v int64) *DescribeVaultOutput

SetNumberOfArchives sets the NumberOfArchives field's value.

func (*DescribeVaultOutput) SetSizeInBytes added in v1.5.1 

func (s *DescribeVaultOutput) SetSizeInBytes(v int64) *DescribeVaultOutput

SetSizeInBytes sets the SizeInBytes field's value.

func (*DescribeVaultOutput) SetVaultARN added in v1.5.1 

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

SetVaultARN sets the VaultARN field's value.

func (*DescribeVaultOutput) SetVaultName added in v1.5.1 

func (s *DescribeVaultOutput) SetVaultName(v string) *DescribeVaultOutput

SetVaultName sets the VaultName field's value.

func (DescribeVaultOutput) String added in v0.6.6 

func (s DescribeVaultOutput) String() string

String returns the string representation

type Encryption added in v1.12.39 

type Encryption struct {

	// The server-side encryption algorithm used when storing job results in Amazon
	// S3, for example AES256 or aws:kms.
	EncryptionType *string `type:"string" enum:"EncryptionType"`

	// Optional. If the encryption type is aws:kms, you can use this value to specify
	// the encryption context for the job results.
	KMSContext *string `type:"string"`

	// The AWS KMS key ID to use for object encryption. All GET and PUT requests
	// for an object protected by AWS KMS fail if not made by using Secure Sockets
	// Layer (SSL) or Signature Version 4.
	KMSKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the encryption used to store the job results in Amazon S3.

func (Encryption) GoString added in v1.12.39 

func (s Encryption) GoString() string

GoString returns the string representation

func (*Encryption) SetEncryptionType added in v1.12.39 

func (s *Encryption) SetEncryptionType(v string) *Encryption

SetEncryptionType sets the EncryptionType field's value.

func (*Encryption) SetKMSContext added in v1.12.39 

func (s *Encryption) SetKMSContext(v string) *Encryption

SetKMSContext sets the KMSContext field's value.

func (*Encryption) SetKMSKeyId added in v1.12.39 

func (s *Encryption) SetKMSKeyId(v string) *Encryption

SetKMSKeyId sets the KMSKeyId field's value.

func (Encryption) String added in v1.12.39 

func (s Encryption) String() string

String returns the string representation

type GetDataRetrievalPolicyInput 

type GetDataRetrievalPolicyInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for GetDataRetrievalPolicy.

func (GetDataRetrievalPolicyInput) GoString added in v0.6.6 

func (s GetDataRetrievalPolicyInput) GoString() string

GoString returns the string representation

func (*GetDataRetrievalPolicyInput) SetAccountId added in v1.5.1 

func (s *GetDataRetrievalPolicyInput) SetAccountId(v string) *GetDataRetrievalPolicyInput

SetAccountId sets the AccountId field's value.

func (GetDataRetrievalPolicyInput) String added in v0.6.6 

func (s GetDataRetrievalPolicyInput) String() string

String returns the string representation

func (*GetDataRetrievalPolicyInput) Validate added in v1.1.24 

func (s *GetDataRetrievalPolicyInput) Validate() error

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

type GetDataRetrievalPolicyOutput 

type GetDataRetrievalPolicyOutput struct {

	// Contains the returned data retrieval policy in JSON format.
	Policy *DataRetrievalPolicy `type:"structure"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to the GetDataRetrievalPolicy request.

func (GetDataRetrievalPolicyOutput) GoString added in v0.6.6 

func (s GetDataRetrievalPolicyOutput) GoString() string

GoString returns the string representation

func (*GetDataRetrievalPolicyOutput) SetPolicy added in v1.5.1 

func (s *GetDataRetrievalPolicyOutput) SetPolicy(v *DataRetrievalPolicy) *GetDataRetrievalPolicyOutput

SetPolicy sets the Policy field's value.

func (GetDataRetrievalPolicyOutput) String added in v0.6.6 

func (s GetDataRetrievalPolicyOutput) String() string

String returns the string representation

type GetJobOutputInput 

type GetJobOutputInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The job ID whose data is downloaded.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// The range of bytes to retrieve from the output. For example, if you want
	// to download the first 1,048,576 bytes, specify the range as bytes=0-1048575.
	// By default, this operation downloads the entire output.
	//
	// If the job output is large, then you can use a range to retrieve a portion
	// of the output. This allows you to download the entire output in smaller chunks
	// of bytes. For example, suppose you have 1 GB of job output you want to download
	// and you decide to download 128 MB chunks of data at a time, which is a total
	// of eight Get Job Output requests. You use the following process to download
	// the job output:
	//
	// Download a 128 MB chunk of output by specifying the appropriate byte range.
	// Verify that all 128 MB of data was received.
	//
	// Along with the data, the response includes a SHA256 tree hash of the payload.
	// You compute the checksum of the payload on the client and compare it with
	// the checksum you received in the response to ensure you received all the
	// expected data.
	//
	// Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each
	// time specifying the appropriate byte range.
	//
	// After downloading all the parts of the job output, you have a list of eight
	// checksum values. Compute the tree hash of these values to find the checksum
	// of the entire output. Using the DescribeJob API, obtain job information of
	// the job that provided you the output. The response includes the checksum
	// of the entire archive stored in Amazon Glacier. You compare this value with
	// the checksum you computed to ensure you have downloaded the entire archive
	// content with no errors.
	Range *string `location:"header" locationName:"Range" type:"string"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for downloading output of an Amazon Glacier job.

func (GetJobOutputInput) GoString added in v0.6.6 

func (s GetJobOutputInput) GoString() string

GoString returns the string representation

func (*GetJobOutputInput) SetAccountId added in v1.5.1 

func (s *GetJobOutputInput) SetAccountId(v string) *GetJobOutputInput

SetAccountId sets the AccountId field's value.

func (*GetJobOutputInput) SetJobId added in v1.5.1 

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

SetJobId sets the JobId field's value.

func (*GetJobOutputInput) SetRange added in v1.5.1 

func (s *GetJobOutputInput) SetRange(v string) *GetJobOutputInput

SetRange sets the Range field's value.

func (*GetJobOutputInput) SetVaultName added in v1.5.1 

func (s *GetJobOutputInput) SetVaultName(v string) *GetJobOutputInput

SetVaultName sets the VaultName field's value.

func (GetJobOutputInput) String added in v0.6.6 

func (s GetJobOutputInput) String() string

String returns the string representation

func (*GetJobOutputInput) Validate added in v1.1.24 

func (s *GetJobOutputInput) Validate() error

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

type GetJobOutputOutput 

type GetJobOutputOutput struct {

	// Indicates the range units accepted. For more information, see RFC2616 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
	AcceptRanges *string `location:"header" locationName:"Accept-Ranges" type:"string"`

	// The description of an archive.
	ArchiveDescription *string `location:"header" locationName:"x-amz-archive-description" type:"string"`

	// The job data, either archive data or inventory data.
	Body io.ReadCloser `locationName:"body" type:"blob"`

	// The checksum of the data in the response. This header is returned only when
	// retrieving the output for an archive retrieval job. Furthermore, this header
	// appears only under the following conditions:
	//
	//    * You get the entire range of the archive.
	//
	//    * You request a range to return of the archive that starts and ends on
	//    a multiple of 1 MB. For example, if you have an 3.1 MB archive and you
	//    specify a range to return that starts at 1 MB and ends at 2 MB, then the
	//    x-amz-sha256-tree-hash is returned as a response header.
	//
	//    * You request a range of the archive to return that starts on a multiple
	//    of 1 MB and goes to the end of the archive. For example, if you have a
	//    3.1 MB archive and you specify a range that starts at 2 MB and ends at
	//    3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned
	//    as a response header.
	Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"`

	// The range of bytes returned by Amazon Glacier. If only partial output is
	// downloaded, the response provides the range of bytes Amazon Glacier returned.
	// For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
	ContentRange *string `location:"header" locationName:"Content-Range" type:"string"`

	// The Content-Type depends on whether the job output is an archive or a vault
	// inventory. For archive data, the Content-Type is application/octet-stream.
	// For vault inventory, if you requested CSV format when you initiated the job,
	// the Content-Type is text/csv. Otherwise, by default, vault inventory is returned
	// as JSON, and the Content-Type is application/json.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// The HTTP response code for a job output request. The value depends on whether
	// a range was specified in the request.
	Status *int64 `location:"statusCode" locationName:"status" type:"integer"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (GetJobOutputOutput) GoString added in v0.6.6 

func (s GetJobOutputOutput) GoString() string

GoString returns the string representation

func (*GetJobOutputOutput) SetAcceptRanges added in v1.5.1 

func (s *GetJobOutputOutput) SetAcceptRanges(v string) *GetJobOutputOutput

SetAcceptRanges sets the AcceptRanges field's value.

func (*GetJobOutputOutput) SetArchiveDescription added in v1.5.1 

func (s *GetJobOutputOutput) SetArchiveDescription(v string) *GetJobOutputOutput

SetArchiveDescription sets the ArchiveDescription field's value.

func (*GetJobOutputOutput) SetBody added in v1.5.1 

func (s *GetJobOutputOutput) SetBody(v io.ReadCloser) *GetJobOutputOutput

SetBody sets the Body field's value.

func (*GetJobOutputOutput) SetChecksum added in v1.5.1 

func (s *GetJobOutputOutput) SetChecksum(v string) *GetJobOutputOutput

SetChecksum sets the Checksum field's value.

func (*GetJobOutputOutput) SetContentRange added in v1.5.1 

func (s *GetJobOutputOutput) SetContentRange(v string) *GetJobOutputOutput

SetContentRange sets the ContentRange field's value.

func (*GetJobOutputOutput) SetContentType added in v1.5.1 

func (s *GetJobOutputOutput) SetContentType(v string) *GetJobOutputOutput

SetContentType sets the ContentType field's value.

func (*GetJobOutputOutput) SetStatus added in v1.5.1 

func (s *GetJobOutputOutput) SetStatus(v int64) *GetJobOutputOutput

SetStatus sets the Status field's value.

func (GetJobOutputOutput) String added in v0.6.6 

func (s GetJobOutputOutput) String() string

String returns the string representation

type GetVaultAccessPolicyInput 

type GetVaultAccessPolicyInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for GetVaultAccessPolicy.

func (GetVaultAccessPolicyInput) GoString added in v0.6.6 

func (s GetVaultAccessPolicyInput) GoString() string

GoString returns the string representation

func (*GetVaultAccessPolicyInput) SetAccountId added in v1.5.1 

func (s *GetVaultAccessPolicyInput) SetAccountId(v string) *GetVaultAccessPolicyInput

SetAccountId sets the AccountId field's value.

func (*GetVaultAccessPolicyInput) SetVaultName added in v1.5.1 

func (s *GetVaultAccessPolicyInput) SetVaultName(v string) *GetVaultAccessPolicyInput

SetVaultName sets the VaultName field's value.

func (GetVaultAccessPolicyInput) String added in v0.6.6 

func (s GetVaultAccessPolicyInput) String() string

String returns the string representation

func (*GetVaultAccessPolicyInput) Validate added in v1.1.24 

func (s *GetVaultAccessPolicyInput) Validate() error

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

type GetVaultAccessPolicyOutput 

type GetVaultAccessPolicyOutput struct {

	// Contains the returned vault access policy as a JSON string.
	Policy *VaultAccessPolicy `locationName:"policy" type:"structure"`
	// contains filtered or unexported fields
}

Output for GetVaultAccessPolicy.

func (GetVaultAccessPolicyOutput) GoString added in v0.6.6 

func (s GetVaultAccessPolicyOutput) GoString() string

GoString returns the string representation

func (*GetVaultAccessPolicyOutput) SetPolicy added in v1.5.1 

func (s *GetVaultAccessPolicyOutput) SetPolicy(v *VaultAccessPolicy) *GetVaultAccessPolicyOutput

SetPolicy sets the Policy field's value.

func (GetVaultAccessPolicyOutput) String added in v0.6.6 

func (s GetVaultAccessPolicyOutput) String() string

String returns the string representation

type GetVaultLockInput added in v0.7.0 

type GetVaultLockInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input values for GetVaultLock.

func (GetVaultLockInput) GoString added in v0.7.0 

func (s GetVaultLockInput) GoString() string

GoString returns the string representation

func (*GetVaultLockInput) SetAccountId added in v1.5.1 

func (s *GetVaultLockInput) SetAccountId(v string) *GetVaultLockInput

SetAccountId sets the AccountId field's value.

func (*GetVaultLockInput) SetVaultName added in v1.5.1 

func (s *GetVaultLockInput) SetVaultName(v string) *GetVaultLockInput

SetVaultName sets the VaultName field's value.

func (GetVaultLockInput) String added in v0.7.0 

func (s GetVaultLockInput) String() string

String returns the string representation

func (*GetVaultLockInput) Validate added in v1.1.24 

func (s *GetVaultLockInput) Validate() error

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

type GetVaultLockOutput added in v0.7.0 

type GetVaultLockOutput struct {

	// The UTC date and time at which the vault lock was put into the InProgress
	// state.
	CreationDate *string `type:"string"`

	// The UTC date and time at which the lock ID expires. This value can be null
	// if the vault lock is in a Locked state.
	ExpirationDate *string `type:"string"`

	// The vault lock policy as a JSON string, which uses "\" as an escape character.
	Policy *string `type:"string"`

	// The state of the vault lock. InProgress or Locked.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (GetVaultLockOutput) GoString added in v0.7.0 

func (s GetVaultLockOutput) GoString() string

GoString returns the string representation

func (*GetVaultLockOutput) SetCreationDate added in v1.5.1 

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

SetCreationDate sets the CreationDate field's value.

func (*GetVaultLockOutput) SetExpirationDate added in v1.5.1 

func (s *GetVaultLockOutput) SetExpirationDate(v string) *GetVaultLockOutput

SetExpirationDate sets the ExpirationDate field's value.

func (*GetVaultLockOutput) SetPolicy added in v1.5.1 

func (s *GetVaultLockOutput) SetPolicy(v string) *GetVaultLockOutput

SetPolicy sets the Policy field's value.

func (*GetVaultLockOutput) SetState added in v1.5.1 

func (s *GetVaultLockOutput) SetState(v string) *GetVaultLockOutput

SetState sets the State field's value.

func (GetVaultLockOutput) String added in v0.7.0 

func (s GetVaultLockOutput) String() string

String returns the string representation

type GetVaultNotificationsInput 

type GetVaultNotificationsInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for retrieving the notification configuration set on an Amazon Glacier vault.

func (GetVaultNotificationsInput) GoString added in v0.6.6 

func (s GetVaultNotificationsInput) GoString() string

GoString returns the string representation

func (*GetVaultNotificationsInput) SetAccountId added in v1.5.1 

func (s *GetVaultNotificationsInput) SetAccountId(v string) *GetVaultNotificationsInput

SetAccountId sets the AccountId field's value.

func (*GetVaultNotificationsInput) SetVaultName added in v1.5.1 

func (s *GetVaultNotificationsInput) SetVaultName(v string) *GetVaultNotificationsInput

SetVaultName sets the VaultName field's value.

func (GetVaultNotificationsInput) String added in v0.6.6 

func (s GetVaultNotificationsInput) String() string

String returns the string representation

func (*GetVaultNotificationsInput) Validate added in v1.1.24 

func (s *GetVaultNotificationsInput) Validate() error

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

type GetVaultNotificationsOutput 

type GetVaultNotificationsOutput struct {

	// Returns the notification configuration set on the vault.
	VaultNotificationConfig *VaultNotificationConfig `locationName:"vaultNotificationConfig" type:"structure"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (GetVaultNotificationsOutput) GoString added in v0.6.6 

func (s GetVaultNotificationsOutput) GoString() string

GoString returns the string representation

func (*GetVaultNotificationsOutput) SetVaultNotificationConfig added in v1.5.1 

func (s *GetVaultNotificationsOutput) SetVaultNotificationConfig(v *VaultNotificationConfig) *GetVaultNotificationsOutput

SetVaultNotificationConfig sets the VaultNotificationConfig field's value.

func (GetVaultNotificationsOutput) String added in v0.6.6 

func (s GetVaultNotificationsOutput) String() string

String returns the string representation

type Glacier 

type Glacier struct {
	*client.Client
}

Glacier provides the API operation methods for making requests to Amazon Glacier. See this package's package overview docs for details on the service.

Glacier methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Glacier

New creates a new instance of the Glacier client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a Glacier client from just a session.
svc := glacier.New(mySession)

// Create a Glacier client with additional configuration
svc := glacier.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Glacier) AbortMultipartUpload 

func (c *Glacier) AbortMultipartUpload(input *AbortMultipartUploadInput) (*AbortMultipartUploadOutput, error)

AbortMultipartUpload API operation for Amazon Glacier.

This operation aborts a multipart upload identified by the upload ID.

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Working with Archives in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) and Abort Multipart Upload (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation AbortMultipartUpload for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To abort a multipart upload identified by the upload ID

The example deletes an in-progress multipart upload to a vault named my-vault: 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.AbortMultipartUploadInput{
		AccountId: aws.String("-"),
		UploadId:  aws.String("19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.AbortMultipartUpload(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) AbortMultipartUploadRequest 

func (c *Glacier) AbortMultipartUploadRequest(input *AbortMultipartUploadInput) (req *request.Request, output *AbortMultipartUploadOutput)

AbortMultipartUploadRequest generates a "aws/request.Request" representing the client's request for the AbortMultipartUpload operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AbortMultipartUpload for more information on using the AbortMultipartUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AbortMultipartUploadRequest method.
req, resp := client.AbortMultipartUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) AbortMultipartUploadWithContext added in v1.8.0 

func (c *Glacier) AbortMultipartUploadWithContext(ctx aws.Context, input *AbortMultipartUploadInput, opts ...request.Option) (*AbortMultipartUploadOutput, error)

AbortMultipartUploadWithContext is the same as AbortMultipartUpload with the addition of the ability to pass a context and additional request options.

See AbortMultipartUpload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) AbortVaultLock added in v0.7.0 

func (c *Glacier) AbortVaultLock(input *AbortVaultLockInput) (*AbortVaultLockOutput, error)

AbortVaultLock API operation for Amazon Glacier.

This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html). For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html).

This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation AbortVaultLock for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To abort a vault lock

The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.AbortVaultLockInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.AbortVaultLock(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) AbortVaultLockRequest added in v0.7.0 

func (c *Glacier) AbortVaultLockRequest(input *AbortVaultLockInput) (req *request.Request, output *AbortVaultLockOutput)

AbortVaultLockRequest generates a "aws/request.Request" representing the client's request for the AbortVaultLock operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AbortVaultLock for more information on using the AbortVaultLock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AbortVaultLockRequest method.
req, resp := client.AbortVaultLockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) AbortVaultLockWithContext added in v1.8.0 

func (c *Glacier) AbortVaultLockWithContext(ctx aws.Context, input *AbortVaultLockInput, opts ...request.Option) (*AbortVaultLockOutput, error)

AbortVaultLockWithContext is the same as AbortVaultLock with the addition of the ability to pass a context and additional request options.

See AbortVaultLock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) AddTagsToVault added in v0.6.6 

func (c *Glacier) AddTagsToVault(input *AddTagsToVaultInput) (*AddTagsToVaultOutput, error)

AddTagsToVault API operation for Amazon Glacier.

This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon Glacier Resources (http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation AddTagsToVault for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeLimitExceededException "LimitExceededException" Returned if the request results in a vault or account limit being exceeded.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To add tags to a vault

The example adds two tags to a my-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.AddTagsToVaultInput{
		Tags: map[string]*string{
			"examplekey1": aws.String("examplevalue1"),
			"examplekey2": aws.String("examplevalue2"),
		},
		AccountId: aws.String("-"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.AddTagsToVault(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeLimitExceededException:
				fmt.Println(glacier.ErrCodeLimitExceededException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) AddTagsToVaultRequest added in v0.6.6 

func (c *Glacier) AddTagsToVaultRequest(input *AddTagsToVaultInput) (req *request.Request, output *AddTagsToVaultOutput)

AddTagsToVaultRequest generates a "aws/request.Request" representing the client's request for the AddTagsToVault operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToVault for more information on using the AddTagsToVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AddTagsToVaultRequest method.
req, resp := client.AddTagsToVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) AddTagsToVaultWithContext added in v1.8.0 

func (c *Glacier) AddTagsToVaultWithContext(ctx aws.Context, input *AddTagsToVaultInput, opts ...request.Option) (*AddTagsToVaultOutput, error)

AddTagsToVaultWithContext is the same as AddTagsToVault with the addition of the ability to pass a context and additional request options.

See AddTagsToVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) CompleteMultipartUpload 

func (c *Glacier) CompleteMultipartUpload(input *CompleteMultipartUploadInput) (*ArchiveCreationOutput, error)

CompleteMultipartUpload API operation for Amazon Glacier.

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums (http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html). On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) (http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) and Complete Multipart Upload (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation CompleteMultipartUpload for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To complete a multipart upload

The example completes a multipart upload for a 3 MiB archive. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.CompleteMultipartUploadInput{
		AccountId:   aws.String("-"),
		ArchiveSize: aws.String("3145728"),
		Checksum:    aws.String("9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67"),
		UploadId:    aws.String("19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"),
		VaultName:   aws.String("my-vault"),
	}

	result, err := svc.CompleteMultipartUpload(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) CompleteMultipartUploadRequest 

func (c *Glacier) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) (req *request.Request, output *ArchiveCreationOutput)

CompleteMultipartUploadRequest generates a "aws/request.Request" representing the client's request for the CompleteMultipartUpload operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CompleteMultipartUpload for more information on using the CompleteMultipartUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CompleteMultipartUploadRequest method.
req, resp := client.CompleteMultipartUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) CompleteMultipartUploadWithContext added in v1.8.0 

func (c *Glacier) CompleteMultipartUploadWithContext(ctx aws.Context, input *CompleteMultipartUploadInput, opts ...request.Option) (*ArchiveCreationOutput, error)

CompleteMultipartUploadWithContext is the same as CompleteMultipartUpload with the addition of the ability to pass a context and additional request options.

See CompleteMultipartUpload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) CompleteVaultLock added in v0.7.0 

func (c *Glacier) CompleteVaultLock(input *CompleteVaultLockInput) (*CompleteVaultLockOutput, error)

CompleteVaultLock API operation for Amazon Glacier.

This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html).

This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.

If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation CompleteVaultLock for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To complete a vault lock

The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.CompleteVaultLockInput{
		AccountId: aws.String("-"),
		LockId:    aws.String("AE863rKkWZU53SLW5be4DUcW"),
		VaultName: aws.String("example-vault"),
	}

	result, err := svc.CompleteVaultLock(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) CompleteVaultLockRequest added in v0.7.0 

func (c *Glacier) CompleteVaultLockRequest(input *CompleteVaultLockInput) (req *request.Request, output *CompleteVaultLockOutput)

CompleteVaultLockRequest generates a "aws/request.Request" representing the client's request for the CompleteVaultLock operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CompleteVaultLock for more information on using the CompleteVaultLock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CompleteVaultLockRequest method.
req, resp := client.CompleteVaultLockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) CompleteVaultLockWithContext added in v1.8.0 

func (c *Glacier) CompleteVaultLockWithContext(ctx aws.Context, input *CompleteVaultLockInput, opts ...request.Option) (*CompleteVaultLockOutput, error)

CompleteVaultLockWithContext is the same as CompleteVaultLock with the addition of the ability to pass a context and additional request options.

See CompleteVaultLock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) CreateVault 

func (c *Glacier) CreateVault(input *CreateVaultInput) (*CreateVaultOutput, error)

CreateVault API operation for Amazon Glacier.

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.

  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html) and Create Vault (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation CreateVault for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

  • ErrCodeLimitExceededException "LimitExceededException" Returned if the request results in a vault or account limit being exceeded.

Example (Shared00)

To create a new vault

The following example creates a new vault named my-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.CreateVaultInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.CreateVault(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			case glacier.ErrCodeLimitExceededException:
				fmt.Println(glacier.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) CreateVaultRequest 

func (c *Glacier) CreateVaultRequest(input *CreateVaultInput) (req *request.Request, output *CreateVaultOutput)

CreateVaultRequest generates a "aws/request.Request" representing the client's request for the CreateVault operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateVault for more information on using the CreateVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateVaultRequest method.
req, resp := client.CreateVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) CreateVaultWithContext added in v1.8.0 

func (c *Glacier) CreateVaultWithContext(ctx aws.Context, input *CreateVaultInput, opts ...request.Option) (*CreateVaultOutput, error)

CreateVaultWithContext is the same as CreateVault with the addition of the ability to pass a context and additional request options.

See CreateVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) DeleteArchive 

func (c *Glacier) DeleteArchive(input *DeleteArchiveInput) (*DeleteArchiveOutput, error)

DeleteArchive API operation for Amazon Glacier.

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.

  • If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html) and Delete Archive (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation DeleteArchive for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To delete an archive

The example deletes the archive specified by the archive ID. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.DeleteArchiveInput{
		AccountId: aws.String("-"),
		ArchiveId: aws.String("NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.DeleteArchive(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) DeleteArchiveRequest 

func (c *Glacier) DeleteArchiveRequest(input *DeleteArchiveInput) (req *request.Request, output *DeleteArchiveOutput)

DeleteArchiveRequest generates a "aws/request.Request" representing the client's request for the DeleteArchive operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteArchive for more information on using the DeleteArchive API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteArchiveRequest method.
req, resp := client.DeleteArchiveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) DeleteArchiveWithContext added in v1.8.0 

func (c *Glacier) DeleteArchiveWithContext(ctx aws.Context, input *DeleteArchiveInput, opts ...request.Option) (*DeleteArchiveOutput, error)

DeleteArchiveWithContext is the same as DeleteArchive with the addition of the ability to pass a context and additional request options.

See DeleteArchive for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) DeleteVault 

func (c *Glacier) DeleteVault(input *DeleteVaultInput) (*DeleteVaultOutput, error)

DeleteVault API operation for Amazon Glacier.

This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive) (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html) and Delete Vault (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation DeleteVault for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To delete a vault

The example deletes a vault named my-vault: 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.DeleteVaultInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.DeleteVault(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) DeleteVaultAccessPolicy 

func (c *Glacier) DeleteVaultAccessPolicy(input *DeleteVaultAccessPolicyInput) (*DeleteVaultAccessPolicyOutput, error)

DeleteVaultAccessPolicy API operation for Amazon Glacier.

This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.

This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation DeleteVaultAccessPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To delete the vault access policy

The example deletes the access policy associated with the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.DeleteVaultAccessPolicyInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.DeleteVaultAccessPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) DeleteVaultAccessPolicyRequest 

func (c *Glacier) DeleteVaultAccessPolicyRequest(input *DeleteVaultAccessPolicyInput) (req *request.Request, output *DeleteVaultAccessPolicyOutput)

DeleteVaultAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteVaultAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVaultAccessPolicy for more information on using the DeleteVaultAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteVaultAccessPolicyRequest method.
req, resp := client.DeleteVaultAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) DeleteVaultAccessPolicyWithContext added in v1.8.0 

func (c *Glacier) DeleteVaultAccessPolicyWithContext(ctx aws.Context, input *DeleteVaultAccessPolicyInput, opts ...request.Option) (*DeleteVaultAccessPolicyOutput, error)

DeleteVaultAccessPolicyWithContext is the same as DeleteVaultAccessPolicy with the addition of the ability to pass a context and additional request options.

See DeleteVaultAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) DeleteVaultNotifications 

func (c *Glacier) DeleteVaultNotifications(input *DeleteVaultNotificationsInput) (*DeleteVaultNotificationsOutput, error)

DeleteVaultNotifications API operation for Amazon Glacier.

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) and Delete Vault Notification Configuration (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation DeleteVaultNotifications for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To delete the notification configuration set for a vault

The example deletes the notification configuration set for the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.DeleteVaultNotificationsInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.DeleteVaultNotifications(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) DeleteVaultNotificationsRequest 

func (c *Glacier) DeleteVaultNotificationsRequest(input *DeleteVaultNotificationsInput) (req *request.Request, output *DeleteVaultNotificationsOutput)

DeleteVaultNotificationsRequest generates a "aws/request.Request" representing the client's request for the DeleteVaultNotifications operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVaultNotifications for more information on using the DeleteVaultNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteVaultNotificationsRequest method.
req, resp := client.DeleteVaultNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) DeleteVaultNotificationsWithContext added in v1.8.0 

func (c *Glacier) DeleteVaultNotificationsWithContext(ctx aws.Context, input *DeleteVaultNotificationsInput, opts ...request.Option) (*DeleteVaultNotificationsOutput, error)

DeleteVaultNotificationsWithContext is the same as DeleteVaultNotifications with the addition of the ability to pass a context and additional request options.

See DeleteVaultNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) DeleteVaultRequest 

func (c *Glacier) DeleteVaultRequest(input *DeleteVaultInput) (req *request.Request, output *DeleteVaultOutput)

DeleteVaultRequest generates a "aws/request.Request" representing the client's request for the DeleteVault operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVault for more information on using the DeleteVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteVaultRequest method.
req, resp := client.DeleteVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) DeleteVaultWithContext added in v1.8.0 

func (c *Glacier) DeleteVaultWithContext(ctx aws.Context, input *DeleteVaultInput, opts ...request.Option) (*DeleteVaultOutput, error)

DeleteVaultWithContext is the same as DeleteVault with the addition of the ability to pass a context and additional request options.

See DeleteVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) DescribeJob 

func (c *Glacier) DescribeJob(input *DescribeJobInput) (*JobDescription, error)

DescribeJob API operation for Amazon Glacier.

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob.

This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For more information about using this operation, see the documentation for the underlying REST API Describe Job (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation DescribeJob for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To get information about a previously initiated job

The example returns information about the previously initiated job specified by the job ID. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.DescribeJobInput{
		AccountId: aws.String("-"),
		JobId:     aws.String("zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.DescribeJob(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) DescribeJobRequest 

func (c *Glacier) DescribeJobRequest(input *DescribeJobInput) (req *request.Request, output *JobDescription)

DescribeJobRequest generates a "aws/request.Request" representing the client's request for the DescribeJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeJob for more information on using the DescribeJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeJobRequest method.
req, resp := client.DescribeJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) DescribeJobWithContext added in v1.8.0 

func (c *Glacier) DescribeJobWithContext(ctx aws.Context, input *DescribeJobInput, opts ...request.Option) (*JobDescription, error)

DescribeJobWithContext is the same as DescribeJob with the addition of the ability to pass a context and additional request options.

See DescribeJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) DescribeVault 

func (c *Glacier) DescribeVault(input *DescribeVaultInput) (*DescribeVaultOutput, error)

DescribeVault API operation for Amazon Glacier.

This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html).

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) and Describe Vault (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation DescribeVault for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To retrieve information about a vault

The example retrieves data about a vault named my-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.DescribeVaultInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.DescribeVault(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) DescribeVaultRequest 

func (c *Glacier) DescribeVaultRequest(input *DescribeVaultInput) (req *request.Request, output *DescribeVaultOutput)

DescribeVaultRequest generates a "aws/request.Request" representing the client's request for the DescribeVault operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeVault for more information on using the DescribeVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeVaultRequest method.
req, resp := client.DescribeVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) DescribeVaultWithContext added in v1.8.0 

func (c *Glacier) DescribeVaultWithContext(ctx aws.Context, input *DescribeVaultInput, opts ...request.Option) (*DescribeVaultOutput, error)

DescribeVaultWithContext is the same as DescribeVault with the addition of the ability to pass a context and additional request options.

See DescribeVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) GetDataRetrievalPolicy 

func (c *Glacier) GetDataRetrievalPolicy(input *GetDataRetrievalPolicyInput) (*GetDataRetrievalPolicyOutput, error)

GetDataRetrievalPolicy API operation for Amazon Glacier.

This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation GetDataRetrievalPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To get the current data retrieval policy for an account

The example returns the current data retrieval policy for the account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.GetDataRetrievalPolicyInput{
		AccountId: aws.String("-"),
	}

	result, err := svc.GetDataRetrievalPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) GetDataRetrievalPolicyRequest 

func (c *Glacier) GetDataRetrievalPolicyRequest(input *GetDataRetrievalPolicyInput) (req *request.Request, output *GetDataRetrievalPolicyOutput)

GetDataRetrievalPolicyRequest generates a "aws/request.Request" representing the client's request for the GetDataRetrievalPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDataRetrievalPolicy for more information on using the GetDataRetrievalPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDataRetrievalPolicyRequest method.
req, resp := client.GetDataRetrievalPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) GetDataRetrievalPolicyWithContext added in v1.8.0 

func (c *Glacier) GetDataRetrievalPolicyWithContext(ctx aws.Context, input *GetDataRetrievalPolicyInput, opts ...request.Option) (*GetDataRetrievalPolicyOutput, error)

GetDataRetrievalPolicyWithContext is the same as GetDataRetrievalPolicy with the addition of the ability to pass a context and additional request options.

See GetDataRetrievalPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) GetJobOutput 

func (c *Glacier) GetJobOutput(input *GetJobOutputInput) (*GetJobOutputOutput, error)

GetJobOutput API operation for Amazon Glacier.

This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.

For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.

A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and the underlying REST API, see Downloading a Vault Inventory (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html), Downloading an Archive (http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html), and Get Job Output (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation GetJobOutput for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To get the output of a previously initiated job

The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.GetJobOutputInput{
		AccountId: aws.String("-"),
		JobId:     aws.String("zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW"),
		Range:     aws.String(""),
		VaultName: aws.String("my-vaul"),
	}

	result, err := svc.GetJobOutput(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) GetJobOutputRequest 

func (c *Glacier) GetJobOutputRequest(input *GetJobOutputInput) (req *request.Request, output *GetJobOutputOutput)

GetJobOutputRequest generates a "aws/request.Request" representing the client's request for the GetJobOutput operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJobOutput for more information on using the GetJobOutput API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetJobOutputRequest method.
req, resp := client.GetJobOutputRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) GetJobOutputWithContext added in v1.8.0 

func (c *Glacier) GetJobOutputWithContext(ctx aws.Context, input *GetJobOutputInput, opts ...request.Option) (*GetJobOutputOutput, error)

GetJobOutputWithContext is the same as GetJobOutput with the addition of the ability to pass a context and additional request options.

See GetJobOutput for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) GetVaultAccessPolicy 

func (c *Glacier) GetVaultAccessPolicy(input *GetVaultAccessPolicyInput) (*GetVaultAccessPolicyOutput, error)

GetVaultAccessPolicy API operation for Amazon Glacier.

This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy) (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation GetVaultAccessPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To get the access-policy set on the vault

The example retrieves the access-policy set on the vault named example-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.GetVaultAccessPolicyInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("example-vault"),
	}

	result, err := svc.GetVaultAccessPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) GetVaultAccessPolicyRequest 

func (c *Glacier) GetVaultAccessPolicyRequest(input *GetVaultAccessPolicyInput) (req *request.Request, output *GetVaultAccessPolicyOutput)

GetVaultAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the GetVaultAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetVaultAccessPolicy for more information on using the GetVaultAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetVaultAccessPolicyRequest method.
req, resp := client.GetVaultAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) GetVaultAccessPolicyWithContext added in v1.8.0 

func (c *Glacier) GetVaultAccessPolicyWithContext(ctx aws.Context, input *GetVaultAccessPolicyInput, opts ...request.Option) (*GetVaultAccessPolicyOutput, error)

GetVaultAccessPolicyWithContext is the same as GetVaultAccessPolicy with the addition of the ability to pass a context and additional request options.

See GetVaultAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) GetVaultLock added in v0.7.0 

func (c *Glacier) GetVaultLock(input *GetVaultLockInput) (*GetVaultLockOutput, error)

GetVaultLock API operation for Amazon Glacier.

This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:

  • The vault lock policy set on the vault.

  • The state of the vault lock, which is either InProgess or Locked.

  • When the lock ID expires. The lock ID is used to complete the vault locking process.

  • When the vault lock was initiated and put into the InProgress state.

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html).

If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation GetVaultLock for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To retrieve vault lock-policy related attributes that are set on a vault

The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.GetVaultLockInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.GetVaultLock(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) GetVaultLockRequest added in v0.7.0 

func (c *Glacier) GetVaultLockRequest(input *GetVaultLockInput) (req *request.Request, output *GetVaultLockOutput)

GetVaultLockRequest generates a "aws/request.Request" representing the client's request for the GetVaultLock operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetVaultLock for more information on using the GetVaultLock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetVaultLockRequest method.
req, resp := client.GetVaultLockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) GetVaultLockWithContext added in v1.8.0 

func (c *Glacier) GetVaultLockWithContext(ctx aws.Context, input *GetVaultLockInput, opts ...request.Option) (*GetVaultLockOutput, error)

GetVaultLockWithContext is the same as GetVaultLock with the addition of the ability to pass a context and additional request options.

See GetVaultLock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) GetVaultNotifications 

func (c *Glacier) GetVaultNotifications(input *GetVaultNotificationsInput) (*GetVaultNotificationsOutput, error)

GetVaultNotifications API operation for Amazon Glacier.

This operation retrieves the notification-configuration subresource of the specified vault.

For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html).

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) and Get Vault Notification Configuration (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation GetVaultNotifications for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To get the notification-configuration for the specified vault

The example retrieves the notification-configuration for the vault named my-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.GetVaultNotificationsInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.GetVaultNotifications(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) GetVaultNotificationsRequest 

func (c *Glacier) GetVaultNotificationsRequest(input *GetVaultNotificationsInput) (req *request.Request, output *GetVaultNotificationsOutput)

GetVaultNotificationsRequest generates a "aws/request.Request" representing the client's request for the GetVaultNotifications operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetVaultNotifications for more information on using the GetVaultNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetVaultNotificationsRequest method.
req, resp := client.GetVaultNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) GetVaultNotificationsWithContext added in v1.8.0 

func (c *Glacier) GetVaultNotificationsWithContext(ctx aws.Context, input *GetVaultNotificationsInput, opts ...request.Option) (*GetVaultNotificationsOutput, error)

GetVaultNotificationsWithContext is the same as GetVaultNotifications with the addition of the ability to pass a context and additional request options.

See GetVaultNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) InitiateJob 

func (c *Glacier) InitiateJob(input *InitiateJobInput) (*InitiateJobOutput, error)

InitiateJob API operation for Amazon Glacier.

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation InitiateJob for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodePolicyEnforcedException "PolicyEnforcedException" Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeInsufficientCapacityException "InsufficientCapacityException" Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To initiate an inventory-retrieval job

The example initiates an inventory-retrieval job for the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.InitiateJobInput{
		AccountId: aws.String("-"),
		JobParameters: &glacier.JobParameters{
			Description: aws.String("My inventory job"),
			Format:      aws.String("CSV"),
			SNSTopic:    aws.String("arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example"),
			Type:        aws.String("inventory-retrieval"),
		},
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.InitiateJob(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodePolicyEnforcedException:
				fmt.Println(glacier.ErrCodePolicyEnforcedException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeInsufficientCapacityException:
				fmt.Println(glacier.ErrCodeInsufficientCapacityException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) InitiateJobRequest 

func (c *Glacier) InitiateJobRequest(input *InitiateJobInput) (req *request.Request, output *InitiateJobOutput)

InitiateJobRequest generates a "aws/request.Request" representing the client's request for the InitiateJob operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InitiateJob for more information on using the InitiateJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the InitiateJobRequest method.
req, resp := client.InitiateJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) InitiateJobWithContext added in v1.8.0 

func (c *Glacier) InitiateJobWithContext(ctx aws.Context, input *InitiateJobInput, opts ...request.Option) (*InitiateJobOutput, error)

InitiateJobWithContext is the same as InitiateJob with the addition of the ability to pass a context and additional request options.

See InitiateJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) InitiateMultipartUpload 

func (c *Glacier) InitiateMultipartUpload(input *InitiateMultipartUploadInput) (*InitiateMultipartUploadOutput, error)

InitiateMultipartUpload API operation for Amazon Glacier.

This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).

When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.

Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.

You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.

After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) (http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) and Initiate Multipart Upload (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation InitiateMultipartUpload for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To initiate a multipart upload

The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.InitiateMultipartUploadInput{
		AccountId: aws.String("-"),
		PartSize:  aws.String("1048576"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.InitiateMultipartUpload(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) InitiateMultipartUploadRequest 

func (c *Glacier) InitiateMultipartUploadRequest(input *InitiateMultipartUploadInput) (req *request.Request, output *InitiateMultipartUploadOutput)

InitiateMultipartUploadRequest generates a "aws/request.Request" representing the client's request for the InitiateMultipartUpload operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InitiateMultipartUpload for more information on using the InitiateMultipartUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the InitiateMultipartUploadRequest method.
req, resp := client.InitiateMultipartUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) InitiateMultipartUploadWithContext added in v1.8.0 

func (c *Glacier) InitiateMultipartUploadWithContext(ctx aws.Context, input *InitiateMultipartUploadInput, opts ...request.Option) (*InitiateMultipartUploadOutput, error)

InitiateMultipartUploadWithContext is the same as InitiateMultipartUpload with the addition of the ability to pass a context and additional request options.

See InitiateMultipartUpload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) InitiateVaultLock added in v0.7.0 

func (c *Glacier) InitiateVaultLock(input *InitiateVaultLockInput) (*InitiateVaultLockOutput, error)

InitiateVaultLock API operation for Amazon Glacier.

This operation initiates the vault locking process by doing the following:

  • Installing a vault lock policy on the specified vault.

  • Setting the lock state of vault lock to InProgress.

  • Returning a lock ID, which is used to complete the vault locking process.

You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html).

You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked.

After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.

You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html).

If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation InitiateVaultLock for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To initiate the vault locking process

The example initiates the vault locking process for the vault named my-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.InitiateVaultLockInput{
		AccountId: aws.String("-"),
		Policy: &glacier.VaultLockPolicy{
			Policy: aws.String("{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"),
		},
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.InitiateVaultLock(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) InitiateVaultLockRequest added in v0.7.0 

func (c *Glacier) InitiateVaultLockRequest(input *InitiateVaultLockInput) (req *request.Request, output *InitiateVaultLockOutput)

InitiateVaultLockRequest generates a "aws/request.Request" representing the client's request for the InitiateVaultLock operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InitiateVaultLock for more information on using the InitiateVaultLock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the InitiateVaultLockRequest method.
req, resp := client.InitiateVaultLockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) InitiateVaultLockWithContext added in v1.8.0 

func (c *Glacier) InitiateVaultLockWithContext(ctx aws.Context, input *InitiateVaultLockInput, opts ...request.Option) (*InitiateVaultLockOutput, error)

InitiateVaultLockWithContext is the same as InitiateVaultLock with the addition of the ability to pass a context and additional request options.

See InitiateVaultLock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListJobs 

func (c *Glacier) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)

ListJobs API operation for Amazon Glacier.

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.

Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.

Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false).

For more information about using this operation, see the documentation for the underlying REST API List Jobs (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation ListJobs for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To list jobs for a vault

The example lists jobs for the vault named my-vault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.ListJobsInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("my-vault"),
	}

	result, err := svc.ListJobs(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) ListJobsPages 

func (c *Glacier) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error

ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListJobs operation.
pageNum := 0
err := client.ListJobsPages(params,
    func(page *ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Glacier) ListJobsPagesWithContext added in v1.8.0 

func (c *Glacier) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error

ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListJobsRequest 

func (c *Glacier) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)

ListJobsRequest generates a "aws/request.Request" representing the client's request for the ListJobs operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJobs for more information on using the ListJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListJobsRequest method.
req, resp := client.ListJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) ListJobsWithContext added in v1.8.0 

func (c *Glacier) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)

ListJobsWithContext is the same as ListJobs with the addition of the ability to pass a context and additional request options.

See ListJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListMultipartUploads 

func (c *Glacier) ListMultipartUploads(input *ListMultipartUploadsInput) (*ListMultipartUploadsOutput, error)

ListMultipartUploads API operation for Amazon Glacier.

This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.

The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.

Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) and List Multipart Uploads (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation ListMultipartUploads for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To list all the in-progress multipart uploads for a vault

The example lists all the in-progress multipart uploads for the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.ListMultipartUploadsInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.ListMultipartUploads(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) ListMultipartUploadsPages 

func (c *Glacier) ListMultipartUploadsPages(input *ListMultipartUploadsInput, fn func(*ListMultipartUploadsOutput, bool) bool) error

ListMultipartUploadsPages iterates over the pages of a ListMultipartUploads operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMultipartUploads method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMultipartUploads operation.
pageNum := 0
err := client.ListMultipartUploadsPages(params,
    func(page *ListMultipartUploadsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Glacier) ListMultipartUploadsPagesWithContext added in v1.8.0 

func (c *Glacier) ListMultipartUploadsPagesWithContext(ctx aws.Context, input *ListMultipartUploadsInput, fn func(*ListMultipartUploadsOutput, bool) bool, opts ...request.Option) error

ListMultipartUploadsPagesWithContext same as ListMultipartUploadsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListMultipartUploadsRequest 

func (c *Glacier) ListMultipartUploadsRequest(input *ListMultipartUploadsInput) (req *request.Request, output *ListMultipartUploadsOutput)

ListMultipartUploadsRequest generates a "aws/request.Request" representing the client's request for the ListMultipartUploads operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMultipartUploads for more information on using the ListMultipartUploads API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMultipartUploadsRequest method.
req, resp := client.ListMultipartUploadsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) ListMultipartUploadsWithContext added in v1.8.0 

func (c *Glacier) ListMultipartUploadsWithContext(ctx aws.Context, input *ListMultipartUploadsInput, opts ...request.Option) (*ListMultipartUploadsOutput, error)

ListMultipartUploadsWithContext is the same as ListMultipartUploads with the addition of the ability to pass a context and additional request options.

See ListMultipartUploads for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListParts 

func (c *Glacier) ListParts(input *ListPartsInput) (*ListPartsOutput, error)

ListParts API operation for Amazon Glacier.

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) and List Parts (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation ListParts for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To list the parts of an archive that have been uploaded in a multipart upload

The example lists all the parts of a multipart upload. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.ListPartsInput{
		AccountId: aws.String("-"),
		UploadId:  aws.String("OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.ListParts(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) ListPartsPages 

func (c *Glacier) ListPartsPages(input *ListPartsInput, fn func(*ListPartsOutput, bool) bool) error

ListPartsPages iterates over the pages of a ListParts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListParts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListParts operation.
pageNum := 0
err := client.ListPartsPages(params,
    func(page *ListPartsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Glacier) ListPartsPagesWithContext added in v1.8.0 

func (c *Glacier) ListPartsPagesWithContext(ctx aws.Context, input *ListPartsInput, fn func(*ListPartsOutput, bool) bool, opts ...request.Option) error

ListPartsPagesWithContext same as ListPartsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListPartsRequest 

func (c *Glacier) ListPartsRequest(input *ListPartsInput) (req *request.Request, output *ListPartsOutput)

ListPartsRequest generates a "aws/request.Request" representing the client's request for the ListParts operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListParts for more information on using the ListParts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPartsRequest method.
req, resp := client.ListPartsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) ListPartsWithContext added in v1.8.0 

func (c *Glacier) ListPartsWithContext(ctx aws.Context, input *ListPartsInput, opts ...request.Option) (*ListPartsOutput, error)

ListPartsWithContext is the same as ListParts with the addition of the ability to pass a context and additional request options.

See ListParts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListProvisionedCapacity added in v1.5.12 

func (c *Glacier) ListProvisionedCapacity(input *ListProvisionedCapacityInput) (*ListProvisionedCapacityOutput, error)

ListProvisionedCapacity API operation for Amazon Glacier.

This operation lists the provisioned capacity units for the specified AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation ListProvisionedCapacity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To list the provisioned capacity units for an account

The example lists the provisioned capacity units for an account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.ListProvisionedCapacityInput{
		AccountId: aws.String("-"),
	}

	result, err := svc.ListProvisionedCapacity(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) ListProvisionedCapacityRequest added in v1.5.12 

func (c *Glacier) ListProvisionedCapacityRequest(input *ListProvisionedCapacityInput) (req *request.Request, output *ListProvisionedCapacityOutput)

ListProvisionedCapacityRequest generates a "aws/request.Request" representing the client's request for the ListProvisionedCapacity operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListProvisionedCapacity for more information on using the ListProvisionedCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListProvisionedCapacityRequest method.
req, resp := client.ListProvisionedCapacityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) ListProvisionedCapacityWithContext added in v1.8.0 

func (c *Glacier) ListProvisionedCapacityWithContext(ctx aws.Context, input *ListProvisionedCapacityInput, opts ...request.Option) (*ListProvisionedCapacityOutput, error)

ListProvisionedCapacityWithContext is the same as ListProvisionedCapacity with the addition of the ability to pass a context and additional request options.

See ListProvisionedCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListTagsForVault added in v0.6.6 

func (c *Glacier) ListTagsForVault(input *ListTagsForVaultInput) (*ListTagsForVaultOutput, error)

ListTagsForVault API operation for Amazon Glacier.

This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon Glacier Resources (http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation ListTagsForVault for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To list the tags for a vault

The example lists all the tags attached to the vault examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.ListTagsForVaultInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.ListTagsForVault(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) ListTagsForVaultRequest added in v0.6.6 

func (c *Glacier) ListTagsForVaultRequest(input *ListTagsForVaultInput) (req *request.Request, output *ListTagsForVaultOutput)

ListTagsForVaultRequest generates a "aws/request.Request" representing the client's request for the ListTagsForVault operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForVault for more information on using the ListTagsForVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForVaultRequest method.
req, resp := client.ListTagsForVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) ListTagsForVaultWithContext added in v1.8.0 

func (c *Glacier) ListTagsForVaultWithContext(ctx aws.Context, input *ListTagsForVaultInput, opts ...request.Option) (*ListTagsForVaultOutput, error)

ListTagsForVaultWithContext is the same as ListTagsForVault with the addition of the ability to pass a context and additional request options.

See ListTagsForVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListVaults 

func (c *Glacier) ListVaults(input *ListVaultsInput) (*ListVaultsOutput, error)

ListVaults API operation for Amazon Glacier.

This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 1,000 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) and List Vaults (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation ListVaults for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To list all vaults owned by the calling user's account

The example lists all vaults owned by the specified AWS account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.ListVaultsInput{
		AccountId: aws.String("-"),
		Limit:     aws.String(""),
		Marker:    aws.String(""),
	}

	result, err := svc.ListVaults(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) ListVaultsPages 

func (c *Glacier) ListVaultsPages(input *ListVaultsInput, fn func(*ListVaultsOutput, bool) bool) error

ListVaultsPages iterates over the pages of a ListVaults operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListVaults method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListVaults operation.
pageNum := 0
err := client.ListVaultsPages(params,
    func(page *ListVaultsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Glacier) ListVaultsPagesWithContext added in v1.8.0 

func (c *Glacier) ListVaultsPagesWithContext(ctx aws.Context, input *ListVaultsInput, fn func(*ListVaultsOutput, bool) bool, opts ...request.Option) error

ListVaultsPagesWithContext same as ListVaultsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) ListVaultsRequest 

func (c *Glacier) ListVaultsRequest(input *ListVaultsInput) (req *request.Request, output *ListVaultsOutput)

ListVaultsRequest generates a "aws/request.Request" representing the client's request for the ListVaults operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListVaults for more information on using the ListVaults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListVaultsRequest method.
req, resp := client.ListVaultsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) ListVaultsWithContext added in v1.8.0 

func (c *Glacier) ListVaultsWithContext(ctx aws.Context, input *ListVaultsInput, opts ...request.Option) (*ListVaultsOutput, error)

ListVaultsWithContext is the same as ListVaults with the addition of the ability to pass a context and additional request options.

See ListVaults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) PurchaseProvisionedCapacity added in v1.5.12 

func (c *Glacier) PurchaseProvisionedCapacity(input *PurchaseProvisionedCapacityInput) (*PurchaseProvisionedCapacityOutput, error)

PurchaseProvisionedCapacity API operation for Amazon Glacier.

This operation purchases a provisioned capacity unit for an AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation PurchaseProvisionedCapacity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeLimitExceededException "LimitExceededException" Returned if the request results in a vault or account limit being exceeded.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To purchases a provisioned capacity unit for an AWS account

The example purchases provisioned capacity unit for an AWS account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.PurchaseProvisionedCapacityInput{
		AccountId: aws.String("-"),
	}

	result, err := svc.PurchaseProvisionedCapacity(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeLimitExceededException:
				fmt.Println(glacier.ErrCodeLimitExceededException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) PurchaseProvisionedCapacityRequest added in v1.5.12 

func (c *Glacier) PurchaseProvisionedCapacityRequest(input *PurchaseProvisionedCapacityInput) (req *request.Request, output *PurchaseProvisionedCapacityOutput)

PurchaseProvisionedCapacityRequest generates a "aws/request.Request" representing the client's request for the PurchaseProvisionedCapacity operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PurchaseProvisionedCapacity for more information on using the PurchaseProvisionedCapacity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PurchaseProvisionedCapacityRequest method.
req, resp := client.PurchaseProvisionedCapacityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) PurchaseProvisionedCapacityWithContext added in v1.8.0 

func (c *Glacier) PurchaseProvisionedCapacityWithContext(ctx aws.Context, input *PurchaseProvisionedCapacityInput, opts ...request.Option) (*PurchaseProvisionedCapacityOutput, error)

PurchaseProvisionedCapacityWithContext is the same as PurchaseProvisionedCapacity with the addition of the ability to pass a context and additional request options.

See PurchaseProvisionedCapacity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) RemoveTagsFromVault added in v0.6.6 

func (c *Glacier) RemoveTagsFromVault(input *RemoveTagsFromVaultInput) (*RemoveTagsFromVaultOutput, error)

RemoveTagsFromVault API operation for Amazon Glacier.

This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources (http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html). This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation RemoveTagsFromVault for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To remove tags from a vault

The example removes two tags from the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.RemoveTagsFromVaultInput{
		TagKeys: []*string{
			aws.String("examplekey1"),
			aws.String("examplekey2"),
		},
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.RemoveTagsFromVault(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) RemoveTagsFromVaultRequest added in v0.6.6 

func (c *Glacier) RemoveTagsFromVaultRequest(input *RemoveTagsFromVaultInput) (req *request.Request, output *RemoveTagsFromVaultOutput)

RemoveTagsFromVaultRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromVault operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromVault for more information on using the RemoveTagsFromVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RemoveTagsFromVaultRequest method.
req, resp := client.RemoveTagsFromVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) RemoveTagsFromVaultWithContext added in v1.8.0 

func (c *Glacier) RemoveTagsFromVaultWithContext(ctx aws.Context, input *RemoveTagsFromVaultInput, opts ...request.Option) (*RemoveTagsFromVaultOutput, error)

RemoveTagsFromVaultWithContext is the same as RemoveTagsFromVault with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) SetDataRetrievalPolicy 

func (c *Glacier) SetDataRetrievalPolicy(input *SetDataRetrievalPolicyInput) (*SetDataRetrievalPolicyOutput, error)

SetDataRetrievalPolicy API operation for Amazon Glacier.

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation SetDataRetrievalPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To set and then enact a data retrieval policy

The example sets and then enacts a data retrieval policy. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.SetDataRetrievalPolicyInput{
		Policy: &glacier.DataRetrievalPolicy{
			Rules: []*glacier.DataRetrievalRule{
				{
					BytesPerHour: aws.Int64(10737418240),
					Strategy:     aws.String("BytesPerHour"),
				},
			},
		},
		AccountId: aws.String("-"),
	}

	result, err := svc.SetDataRetrievalPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) SetDataRetrievalPolicyRequest 

func (c *Glacier) SetDataRetrievalPolicyRequest(input *SetDataRetrievalPolicyInput) (req *request.Request, output *SetDataRetrievalPolicyOutput)

SetDataRetrievalPolicyRequest generates a "aws/request.Request" representing the client's request for the SetDataRetrievalPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetDataRetrievalPolicy for more information on using the SetDataRetrievalPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetDataRetrievalPolicyRequest method.
req, resp := client.SetDataRetrievalPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) SetDataRetrievalPolicyWithContext added in v1.8.0 

func (c *Glacier) SetDataRetrievalPolicyWithContext(ctx aws.Context, input *SetDataRetrievalPolicyInput, opts ...request.Option) (*SetDataRetrievalPolicyOutput, error)

SetDataRetrievalPolicyWithContext is the same as SetDataRetrievalPolicy with the addition of the ability to pass a context and additional request options.

See SetDataRetrievalPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) SetVaultAccessPolicy 

func (c *Glacier) SetVaultAccessPolicy(input *SetVaultAccessPolicyInput) (*SetVaultAccessPolicyOutput, error)

SetVaultAccessPolicy API operation for Amazon Glacier.

This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation SetVaultAccessPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To set the access-policy on a vault

The example configures an access policy for the vault named examplevault. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.SetVaultAccessPolicyInput{
		AccountId: aws.String("-"),
		Policy: &glacier.VaultAccessPolicy{
			Policy: aws.String("{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"),
		},
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.SetVaultAccessPolicy(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) SetVaultAccessPolicyRequest 

func (c *Glacier) SetVaultAccessPolicyRequest(input *SetVaultAccessPolicyInput) (req *request.Request, output *SetVaultAccessPolicyOutput)

SetVaultAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the SetVaultAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetVaultAccessPolicy for more information on using the SetVaultAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetVaultAccessPolicyRequest method.
req, resp := client.SetVaultAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) SetVaultAccessPolicyWithContext added in v1.8.0 

func (c *Glacier) SetVaultAccessPolicyWithContext(ctx aws.Context, input *SetVaultAccessPolicyInput, opts ...request.Option) (*SetVaultAccessPolicyOutput, error)

SetVaultAccessPolicyWithContext is the same as SetVaultAccessPolicy with the addition of the ability to pass a context and additional request options.

See SetVaultAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) SetVaultNotifications 

func (c *Glacier) SetVaultNotifications(input *SetVaultNotificationsInput) (*SetVaultNotificationsOutput, error)

SetVaultNotifications API operation for Amazon Glacier.

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.

  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) and Set Vault Notification Configuration (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation SetVaultNotifications for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To configure a vault to post a message to an Amazon SNS topic when jobs complete

The example sets the examplevault notification configuration. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.SetVaultNotificationsInput{
		AccountId: aws.String("-"),
		VaultName: aws.String("examplevault"),
		VaultNotificationConfig: &glacier.VaultNotificationConfig{
			Events: []*string{
				aws.String("ArchiveRetrievalCompleted"),
				aws.String("InventoryRetrievalCompleted"),
			},
			SNSTopic: aws.String("arn:aws:sns:us-west-2:012345678901:mytopic"),
		},
	}

	result, err := svc.SetVaultNotifications(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) SetVaultNotificationsRequest 

func (c *Glacier) SetVaultNotificationsRequest(input *SetVaultNotificationsInput) (req *request.Request, output *SetVaultNotificationsOutput)

SetVaultNotificationsRequest generates a "aws/request.Request" representing the client's request for the SetVaultNotifications operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetVaultNotifications for more information on using the SetVaultNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetVaultNotificationsRequest method.
req, resp := client.SetVaultNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) SetVaultNotificationsWithContext added in v1.8.0 

func (c *Glacier) SetVaultNotificationsWithContext(ctx aws.Context, input *SetVaultNotificationsInput, opts ...request.Option) (*SetVaultNotificationsOutput, error)

SetVaultNotificationsWithContext is the same as SetVaultNotifications with the addition of the ability to pass a context and additional request options.

See SetVaultNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) UploadArchive 

func (c *Glacier) UploadArchive(input *UploadArchiveInput) (*ArchiveCreationOutput, error)

UploadArchive API operation for Amazon Glacier.

This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums (http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html).

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html) and Upload Archive (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation UploadArchive for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeRequestTimeoutException "RequestTimeoutException" Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To upload an archive

The example adds an archive to a vault. 

package main

import (
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.UploadArchiveInput{
		AccountId:          aws.String("-"),
		ArchiveDescription: aws.String(""),
		Body:               aws.ReadSeekCloser(strings.NewReader("example-data-to-upload")),
		Checksum:           aws.String(""),
		VaultName:          aws.String("my-vault"),
	}

	result, err := svc.UploadArchive(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeRequestTimeoutException:
				fmt.Println(glacier.ErrCodeRequestTimeoutException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) UploadArchiveRequest 

func (c *Glacier) UploadArchiveRequest(input *UploadArchiveInput) (req *request.Request, output *ArchiveCreationOutput)

UploadArchiveRequest generates a "aws/request.Request" representing the client's request for the UploadArchive operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UploadArchive for more information on using the UploadArchive API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UploadArchiveRequest method.
req, resp := client.UploadArchiveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) UploadArchiveWithContext added in v1.8.0 

func (c *Glacier) UploadArchiveWithContext(ctx aws.Context, input *UploadArchiveInput, opts ...request.Option) (*ArchiveCreationOutput, error)

UploadArchiveWithContext is the same as UploadArchive with the addition of the ability to pass a context and additional request options.

See UploadArchive for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) UploadMultipartPart 

func (c *Glacier) UploadMultipartPart(input *UploadMultipartPartInput) (*UploadMultipartPartOutput, error)

UploadMultipartPart API operation for Amazon Glacier.

This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.

Amazon Glacier rejects your upload part request if any of the following conditions is true:

  • SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums (http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html).

  • Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.

If you upload a part whose size is smaller than the part size you specified 

in your initiate multipart upload request and that part is not the last
part, then the upload part request will succeed. However, the subsequent
Complete Multipart Upload request will fail.

* Range does not alignThe byte range value in the request does not align
with the part size specified in the corresponding initiate request. For
example, if you specify a part size of 4194304 bytes (4 MB), then 0 to
4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are
valid part ranges. However, if you set a range value of 2 MB to 6 MB,
the range does not align with the part size and the upload will fail.

This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) (http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) and Upload Part (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html) in the Amazon Glacier Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Glacier's API operation UploadMultipartPart for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" Returned if a parameter of the request is incorrectly specified.

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Returned if a required header or parameter is missing from the request.

  • ErrCodeRequestTimeoutException "RequestTimeoutException" Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" Returned if the service cannot complete the request.

Example (Shared00)

To upload the first part of an archive

The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive. 

package main

import (
	"fmt"
	"strings"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/glacier"
)

func main() {
	svc := glacier.New(session.New())
	input := &glacier.UploadMultipartPartInput{
		AccountId: aws.String("-"),
		Body:      aws.ReadSeekCloser(strings.NewReader("part1")),
		Checksum:  aws.String("c06f7cd4baacb087002a99a5f48bf953"),
		Range:     aws.String("bytes 0-1048575/*"),
		UploadId:  aws.String("19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"),
		VaultName: aws.String("examplevault"),
	}

	result, err := svc.UploadMultipartPart(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case glacier.ErrCodeResourceNotFoundException:
				fmt.Println(glacier.ErrCodeResourceNotFoundException, aerr.Error())
			case glacier.ErrCodeInvalidParameterValueException:
				fmt.Println(glacier.ErrCodeInvalidParameterValueException, aerr.Error())
			case glacier.ErrCodeMissingParameterValueException:
				fmt.Println(glacier.ErrCodeMissingParameterValueException, aerr.Error())
			case glacier.ErrCodeRequestTimeoutException:
				fmt.Println(glacier.ErrCodeRequestTimeoutException, aerr.Error())
			case glacier.ErrCodeServiceUnavailableException:
				fmt.Println(glacier.ErrCodeServiceUnavailableException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Glacier) UploadMultipartPartRequest 

func (c *Glacier) UploadMultipartPartRequest(input *UploadMultipartPartInput) (req *request.Request, output *UploadMultipartPartOutput)

UploadMultipartPartRequest generates a "aws/request.Request" representing the client's request for the UploadMultipartPart operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UploadMultipartPart for more information on using the UploadMultipartPart API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UploadMultipartPartRequest method.
req, resp := client.UploadMultipartPartRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Glacier) UploadMultipartPartWithContext added in v1.8.0 

func (c *Glacier) UploadMultipartPartWithContext(ctx aws.Context, input *UploadMultipartPartInput, opts ...request.Option) (*UploadMultipartPartOutput, error)

UploadMultipartPartWithContext is the same as UploadMultipartPart with the addition of the ability to pass a context and additional request options.

See UploadMultipartPart for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) WaitUntilVaultExists added in v1.0.0 

func (c *Glacier) WaitUntilVaultExists(input *DescribeVaultInput) error

WaitUntilVaultExists uses the Amazon Glacier API operation DescribeVault to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*Glacier) WaitUntilVaultExistsWithContext added in v1.8.0 

func (c *Glacier) WaitUntilVaultExistsWithContext(ctx aws.Context, input *DescribeVaultInput, opts ...request.WaiterOption) error

WaitUntilVaultExistsWithContext is an extended version of WaitUntilVaultExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Glacier) WaitUntilVaultNotExists added in v1.0.0 

func (c *Glacier) WaitUntilVaultNotExists(input *DescribeVaultInput) error

WaitUntilVaultNotExists uses the Amazon Glacier API operation DescribeVault to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*Glacier) WaitUntilVaultNotExistsWithContext added in v1.8.0 

func (c *Glacier) WaitUntilVaultNotExistsWithContext(ctx aws.Context, input *DescribeVaultInput, opts ...request.WaiterOption) error

WaitUntilVaultNotExistsWithContext is an extended version of WaitUntilVaultNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Grant added in v1.12.39 

type Grant struct {

	// The grantee.
	Grantee *Grantee `type:"structure"`

	// Specifies the permission given to the grantee.
	Permission *string `type:"string" enum:"Permission"`
	// contains filtered or unexported fields
}

Contains information about a grant.

func (Grant) GoString added in v1.12.39 

func (s Grant) GoString() string

GoString returns the string representation

func (*Grant) SetGrantee added in v1.12.39 

func (s *Grant) SetGrantee(v *Grantee) *Grant

SetGrantee sets the Grantee field's value.

func (*Grant) SetPermission added in v1.12.39 

func (s *Grant) SetPermission(v string) *Grant

SetPermission sets the Permission field's value.

func (Grant) String added in v1.12.39 

func (s Grant) String() string

String returns the string representation

func (*Grant) Validate added in v1.12.39 

func (s *Grant) Validate() error

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

type Grantee added in v1.12.39 

type Grantee struct {

	// Screen name of the grantee.
	DisplayName *string `type:"string"`

	// Email address of the grantee.
	EmailAddress *string `type:"string"`

	// The canonical user ID of the grantee.
	ID *string `type:"string"`

	// Type of grantee
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"Type"`

	// URI of the grantee group.
	URI *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the grantee.

func (Grantee) GoString added in v1.12.39 

func (s Grantee) GoString() string

GoString returns the string representation

func (*Grantee) SetDisplayName added in v1.12.39 

func (s *Grantee) SetDisplayName(v string) *Grantee

SetDisplayName sets the DisplayName field's value.

func (*Grantee) SetEmailAddress added in v1.12.39 

func (s *Grantee) SetEmailAddress(v string) *Grantee

SetEmailAddress sets the EmailAddress field's value.

func (*Grantee) SetID added in v1.12.39 

func (s *Grantee) SetID(v string) *Grantee

SetID sets the ID field's value.

func (*Grantee) SetType added in v1.12.39 

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

SetType sets the Type field's value.

func (*Grantee) SetURI added in v1.12.39 

func (s *Grantee) SetURI(v string) *Grantee

SetURI sets the URI field's value.

func (Grantee) String added in v1.12.39 

func (s Grantee) String() string

String returns the string representation

func (*Grantee) Validate added in v1.12.39 

func (s *Grantee) Validate() error

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

type Hash 

type Hash struct {
	TreeHash   []byte
	LinearHash []byte
}

Hash contains information about the tree-hash and linear hash of a Glacier payload. This structure is generated by ComputeHashes().

func ComputeHashes 

func ComputeHashes(r io.ReadSeeker) Hash

ComputeHashes computes the tree-hash and linear hash of a seekable reader r.

See http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html for more information.

Example 
package main

import (
	"bytes"
	"fmt"
	"io"

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

func main() {
	r := testCreateReader()

	h := glacier.ComputeHashes(r)
	n, _ := r.Seek(0, 1) // Check position after checksumming

	fmt.Printf("linear: %x\n", h.LinearHash)
	fmt.Printf("tree: %x\n", h.TreeHash)
	fmt.Printf("pos: %d\n", n)

}

func testCreateReader() io.ReadSeeker {
	buf := make([]byte, 5767168)
	for i := range buf {
		buf[i] = '0'
	}

	return bytes.NewReader(buf)
}

Output:

linear: 68aff0c5a91aa0491752bfb96e3fef33eb74953804f6a2f7b708d5bcefa8ff6b
tree: 154e26c78fd74d0c2c9b3cc4644191619dc4f2cd539ae2a74d5fd07957a3ee6a
pos: 0

type InitiateJobInput 

type InitiateJobInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// Provides options for specifying job information.
	JobParameters *JobParameters `locationName:"jobParameters" type:"structure"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for initiating an Amazon Glacier job.

func (InitiateJobInput) GoString added in v0.6.6 

func (s InitiateJobInput) GoString() string

GoString returns the string representation

func (*InitiateJobInput) SetAccountId added in v1.5.1 

func (s *InitiateJobInput) SetAccountId(v string) *InitiateJobInput

SetAccountId sets the AccountId field's value.

func (*InitiateJobInput) SetJobParameters added in v1.5.1 

func (s *InitiateJobInput) SetJobParameters(v *JobParameters) *InitiateJobInput

SetJobParameters sets the JobParameters field's value.

func (*InitiateJobInput) SetVaultName added in v1.5.1 

func (s *InitiateJobInput) SetVaultName(v string) *InitiateJobInput

SetVaultName sets the VaultName field's value.

func (InitiateJobInput) String added in v0.6.6 

func (s InitiateJobInput) String() string

String returns the string representation

func (*InitiateJobInput) Validate added in v1.1.24 

func (s *InitiateJobInput) Validate() error

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

type InitiateJobOutput 

type InitiateJobOutput struct {

	// The ID of the job.
	JobId *string `location:"header" locationName:"x-amz-job-id" type:"string"`

	// The path to the location of where the select results are stored.
	JobOutputPath *string `location:"header" locationName:"x-amz-job-output-path" type:"string"`

	// The relative URI path of the job.
	Location *string `location:"header" locationName:"Location" type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (InitiateJobOutput) GoString added in v0.6.6 

func (s InitiateJobOutput) GoString() string

GoString returns the string representation

func (*InitiateJobOutput) SetJobId added in v1.5.1 

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

SetJobId sets the JobId field's value.

func (*InitiateJobOutput) SetJobOutputPath added in v1.12.39 

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

SetJobOutputPath sets the JobOutputPath field's value.

func (*InitiateJobOutput) SetLocation added in v1.5.1 

func (s *InitiateJobOutput) SetLocation(v string) *InitiateJobOutput

SetLocation sets the Location field's value.

func (InitiateJobOutput) String added in v0.6.6 

func (s InitiateJobOutput) String() string

String returns the string representation

type InitiateMultipartUploadInput 

type InitiateMultipartUploadInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The archive description that you are uploading in parts.
	//
	// The part size must be a megabyte (1024 KB) multiplied by a power of 2, for
	// example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and
	// so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096
	// MB).
	ArchiveDescription *string `location:"header" locationName:"x-amz-archive-description" type:"string"`

	// The size of each part except the last, in bytes. The last part can be smaller
	// than this part size.
	PartSize *string `location:"header" locationName:"x-amz-part-size" type:"string"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for initiating a multipart upload to an Amazon Glacier vault.

func (InitiateMultipartUploadInput) GoString added in v0.6.6 

func (s InitiateMultipartUploadInput) GoString() string

GoString returns the string representation

func (*InitiateMultipartUploadInput) SetAccountId added in v1.5.1 

func (s *InitiateMultipartUploadInput) SetAccountId(v string) *InitiateMultipartUploadInput

SetAccountId sets the AccountId field's value.

func (*InitiateMultipartUploadInput) SetArchiveDescription added in v1.5.1 

func (s *InitiateMultipartUploadInput) SetArchiveDescription(v string) *InitiateMultipartUploadInput

SetArchiveDescription sets the ArchiveDescription field's value.

func (*InitiateMultipartUploadInput) SetPartSize added in v1.5.1 

func (s *InitiateMultipartUploadInput) SetPartSize(v string) *InitiateMultipartUploadInput

SetPartSize sets the PartSize field's value.

func (*InitiateMultipartUploadInput) SetVaultName added in v1.5.1 

func (s *InitiateMultipartUploadInput) SetVaultName(v string) *InitiateMultipartUploadInput

SetVaultName sets the VaultName field's value.

func (InitiateMultipartUploadInput) String added in v0.6.6 

func (s InitiateMultipartUploadInput) String() string

String returns the string representation

func (*InitiateMultipartUploadInput) Validate added in v1.1.24 

func (s *InitiateMultipartUploadInput) Validate() error

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

type InitiateMultipartUploadOutput 

type InitiateMultipartUploadOutput struct {

	// The relative URI path of the multipart upload ID Amazon Glacier created.
	Location *string `location:"header" locationName:"Location" type:"string"`

	// The ID of the multipart upload. This value is also included as part of the
	// location.
	UploadId *string `location:"header" locationName:"x-amz-multipart-upload-id" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Glacier response to your request.

func (InitiateMultipartUploadOutput) GoString added in v0.6.6 

func (s InitiateMultipartUploadOutput) GoString() string

GoString returns the string representation

func (*InitiateMultipartUploadOutput) SetLocation added in v1.5.1 

func (s *InitiateMultipartUploadOutput) SetLocation(v string) *InitiateMultipartUploadOutput

SetLocation sets the Location field's value.

func (*InitiateMultipartUploadOutput) SetUploadId added in v1.5.1 

func (s *InitiateMultipartUploadOutput) SetUploadId(v string) *InitiateMultipartUploadOutput

SetUploadId sets the UploadId field's value.

func (InitiateMultipartUploadOutput) String added in v0.6.6 

func (s InitiateMultipartUploadOutput) String() string

String returns the string representation

type InitiateVaultLockInput added in v0.7.0 

type InitiateVaultLockInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The vault lock policy as a JSON string, which uses "\" as an escape character.
	Policy *VaultLockPolicy `locationName:"policy" type:"structure"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input values for InitiateVaultLock.

func (InitiateVaultLockInput) GoString added in v0.7.0 

func (s InitiateVaultLockInput) GoString() string

GoString returns the string representation

func (*InitiateVaultLockInput) SetAccountId added in v1.5.1 

func (s *InitiateVaultLockInput) SetAccountId(v string) *InitiateVaultLockInput

SetAccountId sets the AccountId field's value.

func (*InitiateVaultLockInput) SetPolicy added in v1.5.1 

func (s *InitiateVaultLockInput) SetPolicy(v *VaultLockPolicy) *InitiateVaultLockInput

SetPolicy sets the Policy field's value.

func (*InitiateVaultLockInput) SetVaultName added in v1.5.1 

func (s *InitiateVaultLockInput) SetVaultName(v string) *InitiateVaultLockInput

SetVaultName sets the VaultName field's value.

func (InitiateVaultLockInput) String added in v0.7.0 

func (s InitiateVaultLockInput) String() string

String returns the string representation

func (*InitiateVaultLockInput) Validate added in v1.1.24 

func (s *InitiateVaultLockInput) Validate() error

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

type InitiateVaultLockOutput added in v0.7.0 

type InitiateVaultLockOutput struct {

	// The lock ID, which is used to complete the vault locking process.
	LockId *string `location:"header" locationName:"x-amz-lock-id" type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (InitiateVaultLockOutput) GoString added in v0.7.0 

func (s InitiateVaultLockOutput) GoString() string

GoString returns the string representation

func (*InitiateVaultLockOutput) SetLockId added in v1.5.1 

func (s *InitiateVaultLockOutput) SetLockId(v string) *InitiateVaultLockOutput

SetLockId sets the LockId field's value.

func (InitiateVaultLockOutput) String added in v0.7.0 

func (s InitiateVaultLockOutput) String() string

String returns the string representation

type InputSerialization added in v1.12.39 

type InputSerialization struct {

	// Describes the serialization of a CSV-encoded object.
	Csv *CSVInput `locationName:"csv" type:"structure"`
	// contains filtered or unexported fields
}

Describes how the archive is serialized.

func (InputSerialization) GoString added in v1.12.39 

func (s InputSerialization) GoString() string

GoString returns the string representation

func (*InputSerialization) SetCsv added in v1.12.39 

func (s *InputSerialization) SetCsv(v *CSVInput) *InputSerialization

SetCsv sets the Csv field's value.

func (InputSerialization) String added in v1.12.39 

func (s InputSerialization) String() string

String returns the string representation

type InventoryRetrievalJobDescription 

type InventoryRetrievalJobDescription struct {

	// 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.
	EndDate *string `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.
	Format *string `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.
	Limit *string `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
	// (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering).
	Marker *string `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.
	StartDate *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the options for a range inventory retrieval job.

func (InventoryRetrievalJobDescription) GoString added in v0.6.6 

func (s InventoryRetrievalJobDescription) GoString() string

GoString returns the string representation

func (*InventoryRetrievalJobDescription) SetEndDate added in v1.5.1 

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

SetEndDate sets the EndDate field's value.

func (*InventoryRetrievalJobDescription) SetFormat added in v1.5.1 

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

SetFormat sets the Format field's value.

func (*InventoryRetrievalJobDescription) SetLimit added in v1.5.1 

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

SetLimit sets the Limit field's value.

func (*InventoryRetrievalJobDescription) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*InventoryRetrievalJobDescription) SetStartDate added in v1.5.1 

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

SetStartDate sets the StartDate field's value.

func (InventoryRetrievalJobDescription) String added in v0.6.6 

func (s InventoryRetrievalJobDescription) String() string

String returns the string representation

type InventoryRetrievalJobInput 

type InventoryRetrievalJobInput struct {

	// 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.
	EndDate *string `type:"string"`

	// Specifies the maximum number of inventory items returned per vault inventory
	// retrieval request. Valid values are greater than or equal to 1.
	Limit *string `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.
	Marker *string `type:"string"`

	// The start of the date range in 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.
	StartDate *string `type:"string"`
	// contains filtered or unexported fields
}

Provides options for specifying a range inventory retrieval job.

func (InventoryRetrievalJobInput) GoString added in v0.6.6 

func (s InventoryRetrievalJobInput) GoString() string

GoString returns the string representation

func (*InventoryRetrievalJobInput) SetEndDate added in v1.5.1 

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

SetEndDate sets the EndDate field's value.

func (*InventoryRetrievalJobInput) SetLimit added in v1.5.1 

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

SetLimit sets the Limit field's value.

func (*InventoryRetrievalJobInput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*InventoryRetrievalJobInput) SetStartDate added in v1.5.1 

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

SetStartDate sets the StartDate field's value.

func (InventoryRetrievalJobInput) String added in v0.6.6 

func (s InventoryRetrievalJobInput) String() string

String returns the string representation

type JobDescription 

type JobDescription struct {

	// The job type. This value is either ArchiveRetrieval, InventoryRetrieval,
	// or Select.
	Action *string `type:"string" enum:"ActionCode"`

	// The archive ID requested for a select job or archive retrieval. Otherwise,
	// this field is null.
	ArchiveId *string `type:"string"`

	// The SHA256 tree hash of the entire archive for an archive retrieval. For
	// inventory retrieval or select jobs, this field is null.
	ArchiveSHA256TreeHash *string `type:"string"`

	// 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.
	ArchiveSizeInBytes *int64 `type:"long"`

	// The job status. When a job is completed, you get the job's output using Get
	// Job Output (GET output).
	Completed *bool `type:"boolean"`

	// The UTC time that the job request completed. While the job is in progress,
	// the value is null.
	CompletionDate *string `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".
	CreationDate *string `type:"string"`

	// Parameters used for range inventory retrieval.
	InventoryRetrievalParameters *InventoryRetrievalJobDescription `type:"structure"`

	// 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.
	InventorySizeInBytes *int64 `type:"long"`

	// The job description provided when initiating the job.
	JobDescription *string `type:"string"`

	// An opaque string that identifies an Amazon Glacier job.
	JobId *string `type:"string"`

	// Contains the job output location.
	JobOutputPath *string `type:"string"`

	// Contains the location where the data from the select job is stored.
	OutputLocation *OutputLocation `type:"structure"`

	// 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.
	RetrievalByteRange *string `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
	SHA256TreeHash *string `type:"string"`

	// An Amazon SNS topic that receives notification.
	SNSTopic *string `type:"string"`

	// Contains the parameters used for a select.
	SelectParameters *SelectParameters `type:"structure"`

	// The status code can be InProgress, Succeeded, or Failed, and indicates the
	// status of the job.
	StatusCode *string `type:"string" enum:"StatusCode"`

	// A friendly message that describes the job status.
	StatusMessage *string `type:"string"`

	// The tier to use for a select or an archive retrieval. Valid values are Expedited,
	// Standard, or Bulk. Standard is the default.
	Tier *string `type:"string"`

	// The Amazon Resource Name (ARN) of the vault from which an archive retrieval
	// was requested.
	VaultARN *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the description of an Amazon Glacier job.

func (JobDescription) GoString added in v0.6.6 

func (s JobDescription) GoString() string

GoString returns the string representation

func (*JobDescription) SetAction added in v1.5.1 

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

SetAction sets the Action field's value.

func (*JobDescription) SetArchiveId added in v1.5.1 

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

SetArchiveId sets the ArchiveId field's value.

func (*JobDescription) SetArchiveSHA256TreeHash added in v1.5.1 

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

SetArchiveSHA256TreeHash sets the ArchiveSHA256TreeHash field's value.

func (*JobDescription) SetArchiveSizeInBytes added in v1.5.1 

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

SetArchiveSizeInBytes sets the ArchiveSizeInBytes field's value.

func (*JobDescription) SetCompleted added in v1.5.1 

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

SetCompleted sets the Completed field's value.

func (*JobDescription) SetCompletionDate added in v1.5.1 

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

SetCompletionDate sets the CompletionDate field's value.

func (*JobDescription) SetCreationDate added in v1.5.1 

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

SetCreationDate sets the CreationDate field's value.

func (*JobDescription) SetInventoryRetrievalParameters added in v1.5.1 

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

SetInventoryRetrievalParameters sets the InventoryRetrievalParameters field's value.

func (*JobDescription) SetInventorySizeInBytes added in v1.5.1 

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

SetInventorySizeInBytes sets the InventorySizeInBytes field's value.

func (*JobDescription) SetJobDescription added in v1.5.1 

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

SetJobDescription sets the JobDescription field's value.

func (*JobDescription) SetJobId added in v1.5.1 

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

SetJobId sets the JobId field's value.

func (*JobDescription) SetJobOutputPath added in v1.12.39 

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

SetJobOutputPath sets the JobOutputPath field's value.

func (*JobDescription) SetOutputLocation added in v1.12.39 

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

SetOutputLocation sets the OutputLocation field's value.

func (*JobDescription) SetRetrievalByteRange added in v1.5.1 

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

SetRetrievalByteRange sets the RetrievalByteRange field's value.

func (*JobDescription) SetSHA256TreeHash added in v1.5.1 

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

SetSHA256TreeHash sets the SHA256TreeHash field's value.

func (*JobDescription) SetSNSTopic added in v1.5.1 

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

SetSNSTopic sets the SNSTopic field's value.

func (*JobDescription) SetSelectParameters added in v1.12.39 

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

SetSelectParameters sets the SelectParameters field's value.

func (*JobDescription) SetStatusCode added in v1.5.1 

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

SetStatusCode sets the StatusCode field's value.

func (*JobDescription) SetStatusMessage added in v1.5.1 

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

SetStatusMessage sets the StatusMessage field's value.

func (*JobDescription) SetTier added in v1.5.12 

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

SetTier sets the Tier field's value.

func (*JobDescription) SetVaultARN added in v1.5.1 

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

SetVaultARN sets the VaultARN field's value.

func (JobDescription) String added in v0.6.6 

func (s JobDescription) String() string

String returns the string representation

type JobParameters 

type JobParameters struct {

	// 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.
	ArchiveId *string `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.
	Description *string `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".
	Format *string `type:"string"`

	// Input parameters used for range inventory retrieval.
	InventoryRetrievalParameters *InventoryRetrievalJobInput `type:"structure"`

	// Contains information about the location where the select job results are
	// stored.
	OutputLocation *OutputLocation `type:"structure"`

	// 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.
	RetrievalByteRange *string `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.
	SNSTopic *string `type:"string"`

	// Contains the parameters that define a job.
	SelectParameters *SelectParameters `type:"structure"`

	// The tier to use for a select or an archive retrieval job. Valid values are
	// Expedited, Standard, or Bulk. Standard is the default.
	Tier *string `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".
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides options for defining a job.

func (JobParameters) GoString added in v0.6.6 

func (s JobParameters) GoString() string

GoString returns the string representation

func (*JobParameters) SetArchiveId added in v1.5.1 

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

SetArchiveId sets the ArchiveId field's value.

func (*JobParameters) SetDescription added in v1.5.1 

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

SetDescription sets the Description field's value.

func (*JobParameters) SetFormat added in v1.5.1 

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

SetFormat sets the Format field's value.

func (*JobParameters) SetInventoryRetrievalParameters added in v1.5.1 

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

SetInventoryRetrievalParameters sets the InventoryRetrievalParameters field's value.

func (*JobParameters) SetOutputLocation added in v1.12.39 

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

SetOutputLocation sets the OutputLocation field's value.

func (*JobParameters) SetRetrievalByteRange added in v1.5.1 

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

SetRetrievalByteRange sets the RetrievalByteRange field's value.

func (*JobParameters) SetSNSTopic added in v1.5.1 

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

SetSNSTopic sets the SNSTopic field's value.

func (*JobParameters) SetSelectParameters added in v1.12.39 

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

SetSelectParameters sets the SelectParameters field's value.

func (*JobParameters) SetTier added in v1.5.12 

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

SetTier sets the Tier field's value.

func (*JobParameters) SetType added in v1.5.1 

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

SetType sets the Type field's value.

func (JobParameters) String added in v0.6.6 

func (s JobParameters) String() string

String returns the string representation

func (*JobParameters) Validate added in v1.12.39 

func (s *JobParameters) Validate() error

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

type ListJobsInput 

type ListJobsInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The state of the jobs to return. You can specify true or false.
	Completed *string `location:"querystring" locationName:"completed" type:"string"`

	// The maximum number of jobs to be returned. The default limit is 1000. The
	// number of jobs returned might be fewer than the specified limit, but the
	// number of returned jobs never exceeds the limit.
	Limit *string `location:"querystring" locationName:"limit" type:"string"`

	// An opaque string used for pagination. This value specifies the job at which
	// the listing of jobs should begin. Get the marker value from a previous List
	// Jobs response. You only need to include the marker if you are continuing
	// the pagination of results started in a previous List Jobs request.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The type of job status to return. You can specify the following values: InProgress,
	// Succeeded, or Failed.
	Statuscode *string `location:"querystring" locationName:"statuscode" type:"string"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for retrieving a job list for an Amazon Glacier vault.

func (ListJobsInput) GoString added in v0.6.6 

func (s ListJobsInput) GoString() string

GoString returns the string representation

func (*ListJobsInput) SetAccountId added in v1.5.1 

func (s *ListJobsInput) SetAccountId(v string) *ListJobsInput

SetAccountId sets the AccountId field's value.

func (*ListJobsInput) SetCompleted added in v1.5.1 

func (s *ListJobsInput) SetCompleted(v string) *ListJobsInput

SetCompleted sets the Completed field's value.

func (*ListJobsInput) SetLimit added in v1.5.1 

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

SetLimit sets the Limit field's value.

func (*ListJobsInput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*ListJobsInput) SetStatuscode added in v1.5.1 

func (s *ListJobsInput) SetStatuscode(v string) *ListJobsInput

SetStatuscode sets the Statuscode field's value.

func (*ListJobsInput) SetVaultName added in v1.5.1 

func (s *ListJobsInput) SetVaultName(v string) *ListJobsInput

SetVaultName sets the VaultName field's value.

func (ListJobsInput) String added in v0.6.6 

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate added in v1.1.24 

func (s *ListJobsInput) Validate() error

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

type ListJobsOutput 

type ListJobsOutput struct {

	// A list of job objects. Each job object contains metadata describing the job.
	JobList []*JobDescription `type:"list"`

	// An opaque string used for pagination that specifies the job at which the
	// listing of jobs should begin. You get the marker value from a previous List
	// Jobs response. You only need to include the marker if you are continuing
	// the pagination of the results started in a previous List Jobs request.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (ListJobsOutput) GoString added in v0.6.6 

func (s ListJobsOutput) GoString() string

GoString returns the string representation

func (*ListJobsOutput) SetJobList added in v1.5.1 

func (s *ListJobsOutput) SetJobList(v []*JobDescription) *ListJobsOutput

SetJobList sets the JobList field's value.

func (*ListJobsOutput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (ListJobsOutput) String added in v0.6.6 

func (s ListJobsOutput) String() string

String returns the string representation

type ListMultipartUploadsInput 

type ListMultipartUploadsInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// Specifies the maximum number of uploads returned in the response body. If
	// this value is not specified, the List Uploads operation returns up to 1,000
	// uploads.
	Limit *string `location:"querystring" locationName:"limit" type:"string"`

	// An opaque string used for pagination. This value specifies the upload at
	// which the listing of uploads should begin. Get the marker value from a previous
	// List Uploads response. You need only include the marker if you are continuing
	// the pagination of results started in a previous List Uploads request.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.

func (ListMultipartUploadsInput) GoString added in v0.6.6 

func (s ListMultipartUploadsInput) GoString() string

GoString returns the string representation

func (*ListMultipartUploadsInput) SetAccountId added in v1.5.1 

func (s *ListMultipartUploadsInput) SetAccountId(v string) *ListMultipartUploadsInput

SetAccountId sets the AccountId field's value.

func (*ListMultipartUploadsInput) SetLimit added in v1.5.1 

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

SetLimit sets the Limit field's value.

func (*ListMultipartUploadsInput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*ListMultipartUploadsInput) SetVaultName added in v1.5.1 

func (s *ListMultipartUploadsInput) SetVaultName(v string) *ListMultipartUploadsInput

SetVaultName sets the VaultName field's value.

func (ListMultipartUploadsInput) String added in v0.6.6 

func (s ListMultipartUploadsInput) String() string

String returns the string representation

func (*ListMultipartUploadsInput) Validate added in v1.1.24 

func (s *ListMultipartUploadsInput) Validate() error

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

type ListMultipartUploadsOutput 

type ListMultipartUploadsOutput struct {

	// An opaque string that represents where to continue pagination of the results.
	// You use the marker in a new List Multipart Uploads request to obtain more
	// uploads in the list. If there are no more uploads, this value is null.
	Marker *string `type:"string"`

	// A list of in-progress multipart uploads.
	UploadsList []*UploadListElement `type:"list"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (ListMultipartUploadsOutput) GoString added in v0.6.6 

func (s ListMultipartUploadsOutput) GoString() string

GoString returns the string representation

func (*ListMultipartUploadsOutput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*ListMultipartUploadsOutput) SetUploadsList added in v1.5.1 

func (s *ListMultipartUploadsOutput) SetUploadsList(v []*UploadListElement) *ListMultipartUploadsOutput

SetUploadsList sets the UploadsList field's value.

func (ListMultipartUploadsOutput) String added in v0.6.6 

func (s ListMultipartUploadsOutput) String() string

String returns the string representation

type ListPartsInput 

type ListPartsInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The maximum number of parts to be returned. The default limit is 1000. The
	// number of parts returned might be fewer than the specified limit, but the
	// number of returned parts never exceeds the limit.
	Limit *string `location:"querystring" locationName:"limit" type:"string"`

	// An opaque string used for pagination. This value specifies the part at which
	// the listing of parts should begin. Get the marker value from the response
	// of a previous List Parts response. You need only include the marker if you
	// are continuing the pagination of results started in a previous List Parts
	// request.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`

	// The upload ID of the multipart upload.
	//
	// UploadId is a required field
	UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

func (ListPartsInput) GoString added in v0.6.6 

func (s ListPartsInput) GoString() string

GoString returns the string representation

func (*ListPartsInput) SetAccountId added in v1.5.1 

func (s *ListPartsInput) SetAccountId(v string) *ListPartsInput

SetAccountId sets the AccountId field's value.

func (*ListPartsInput) SetLimit added in v1.5.1 

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

SetLimit sets the Limit field's value.

func (*ListPartsInput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*ListPartsInput) SetUploadId added in v1.5.1 

func (s *ListPartsInput) SetUploadId(v string) *ListPartsInput

SetUploadId sets the UploadId field's value.

func (*ListPartsInput) SetVaultName added in v1.5.1 

func (s *ListPartsInput) SetVaultName(v string) *ListPartsInput

SetVaultName sets the VaultName field's value.

func (ListPartsInput) String added in v0.6.6 

func (s ListPartsInput) String() string

String returns the string representation

func (*ListPartsInput) Validate added in v1.1.24 

func (s *ListPartsInput) Validate() error

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

type ListPartsOutput 

type ListPartsOutput struct {

	// The description of the archive that was specified in the Initiate Multipart
	// Upload request.
	ArchiveDescription *string `type:"string"`

	// The UTC time at which the multipart upload was initiated.
	CreationDate *string `type:"string"`

	// An opaque string that represents where to continue pagination of the results.
	// You use the marker in a new List Parts request to obtain more jobs in the
	// list. If there are no more parts, this value is null.
	Marker *string `type:"string"`

	// The ID of the upload to which the parts are associated.
	MultipartUploadId *string `type:"string"`

	// The part size in bytes. This is the same value that you specified in the
	// Initiate Multipart Upload request.
	PartSizeInBytes *int64 `type:"long"`

	// A list of the part sizes of the multipart upload. Each object in the array
	// contains a RangeBytes and sha256-tree-hash name/value pair.
	Parts []*PartListElement `type:"list"`

	// The Amazon Resource Name (ARN) of the vault to which the multipart upload
	// was initiated.
	VaultARN *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (ListPartsOutput) GoString added in v0.6.6 

func (s ListPartsOutput) GoString() string

GoString returns the string representation

func (*ListPartsOutput) SetArchiveDescription added in v1.5.1 

func (s *ListPartsOutput) SetArchiveDescription(v string) *ListPartsOutput

SetArchiveDescription sets the ArchiveDescription field's value.

func (*ListPartsOutput) SetCreationDate added in v1.5.1 

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

SetCreationDate sets the CreationDate field's value.

func (*ListPartsOutput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*ListPartsOutput) SetMultipartUploadId added in v1.5.1 

func (s *ListPartsOutput) SetMultipartUploadId(v string) *ListPartsOutput

SetMultipartUploadId sets the MultipartUploadId field's value.

func (*ListPartsOutput) SetPartSizeInBytes added in v1.5.1 

func (s *ListPartsOutput) SetPartSizeInBytes(v int64) *ListPartsOutput

SetPartSizeInBytes sets the PartSizeInBytes field's value.

func (*ListPartsOutput) SetParts added in v1.5.1 

func (s *ListPartsOutput) SetParts(v []*PartListElement) *ListPartsOutput

SetParts sets the Parts field's value.

func (*ListPartsOutput) SetVaultARN added in v1.5.1 

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

SetVaultARN sets the VaultARN field's value.

func (ListPartsOutput) String added in v0.6.6 

func (s ListPartsOutput) String() string

String returns the string representation

type ListProvisionedCapacityInput added in v1.5.12 

type ListProvisionedCapacityInput struct {

	// The AWS account ID of the account that owns the vault. You can either specify
	// an AWS account ID or optionally a single '-' (hyphen), in which case Amazon
	// Glacier uses the AWS account ID associated with the credentials used to sign
	// the request. If you use an account ID, don't include any hyphens ('-') in
	// the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListProvisionedCapacityInput) GoString added in v1.5.12 

func (s ListProvisionedCapacityInput) GoString() string

GoString returns the string representation

func (*ListProvisionedCapacityInput) SetAccountId added in v1.5.12 

func (s *ListProvisionedCapacityInput) SetAccountId(v string) *ListProvisionedCapacityInput

SetAccountId sets the AccountId field's value.

func (ListProvisionedCapacityInput) String added in v1.5.12 

func (s ListProvisionedCapacityInput) String() string

String returns the string representation

func (*ListProvisionedCapacityInput) Validate added in v1.5.12 

func (s *ListProvisionedCapacityInput) Validate() error

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

type ListProvisionedCapacityOutput added in v1.5.12 

type ListProvisionedCapacityOutput struct {

	// The response body contains the following JSON fields.
	ProvisionedCapacityList []*ProvisionedCapacityDescription `type:"list"`
	// contains filtered or unexported fields
}

func (ListProvisionedCapacityOutput) GoString added in v1.5.12 

func (s ListProvisionedCapacityOutput) GoString() string

GoString returns the string representation

func (*ListProvisionedCapacityOutput) SetProvisionedCapacityList added in v1.5.12 

func (s *ListProvisionedCapacityOutput) SetProvisionedCapacityList(v []*ProvisionedCapacityDescription) *ListProvisionedCapacityOutput

SetProvisionedCapacityList sets the ProvisionedCapacityList field's value.

func (ListProvisionedCapacityOutput) String added in v1.5.12 

func (s ListProvisionedCapacityOutput) String() string

String returns the string representation

type ListTagsForVaultInput added in v0.6.6 

type ListTagsForVaultInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input value for ListTagsForVaultInput.

func (ListTagsForVaultInput) GoString added in v0.6.6 

func (s ListTagsForVaultInput) GoString() string

GoString returns the string representation

func (*ListTagsForVaultInput) SetAccountId added in v1.5.1 

func (s *ListTagsForVaultInput) SetAccountId(v string) *ListTagsForVaultInput

SetAccountId sets the AccountId field's value.

func (*ListTagsForVaultInput) SetVaultName added in v1.5.1 

func (s *ListTagsForVaultInput) SetVaultName(v string) *ListTagsForVaultInput

SetVaultName sets the VaultName field's value.

func (ListTagsForVaultInput) String added in v0.6.6 

func (s ListTagsForVaultInput) String() string

String returns the string representation

func (*ListTagsForVaultInput) Validate added in v1.1.24 

func (s *ListTagsForVaultInput) Validate() error

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

type ListTagsForVaultOutput added in v0.6.6 

type ListTagsForVaultOutput struct {

	// The tags attached to the vault. Each tag is composed of a key and a value.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (ListTagsForVaultOutput) GoString added in v0.6.6 

func (s ListTagsForVaultOutput) GoString() string

GoString returns the string representation

func (*ListTagsForVaultOutput) SetTags added in v1.5.1 

func (s *ListTagsForVaultOutput) SetTags(v map[string]*string) *ListTagsForVaultOutput

SetTags sets the Tags field's value.

func (ListTagsForVaultOutput) String added in v0.6.6 

func (s ListTagsForVaultOutput) String() string

String returns the string representation

type ListVaultsInput 

type ListVaultsInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The maximum number of vaults to be returned. The default limit is 1000. The
	// number of vaults returned might be fewer than the specified limit, but the
	// number of returned vaults never exceeds the limit.
	Limit *string `location:"querystring" locationName:"limit" type:"string"`

	// A string used for pagination. The marker specifies the vault ARN after which
	// the listing of vaults should begin.
	Marker *string `location:"querystring" locationName:"marker" type:"string"`
	// contains filtered or unexported fields
}

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

func (ListVaultsInput) GoString added in v0.6.6 

func (s ListVaultsInput) GoString() string

GoString returns the string representation

func (*ListVaultsInput) SetAccountId added in v1.5.1 

func (s *ListVaultsInput) SetAccountId(v string) *ListVaultsInput

SetAccountId sets the AccountId field's value.

func (*ListVaultsInput) SetLimit added in v1.5.1 

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

SetLimit sets the Limit field's value.

func (*ListVaultsInput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (ListVaultsInput) String added in v0.6.6 

func (s ListVaultsInput) String() string

String returns the string representation

func (*ListVaultsInput) Validate added in v1.1.24 

func (s *ListVaultsInput) Validate() error

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

type ListVaultsOutput 

type ListVaultsOutput struct {

	// The vault ARN at which to continue pagination of the results. You use the
	// marker in another List Vaults request to obtain more vaults in the list.
	Marker *string `type:"string"`

	// List of vaults.
	VaultList []*DescribeVaultOutput `type:"list"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (ListVaultsOutput) GoString added in v0.6.6 

func (s ListVaultsOutput) GoString() string

GoString returns the string representation

func (*ListVaultsOutput) SetMarker added in v1.5.1 

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

SetMarker sets the Marker field's value.

func (*ListVaultsOutput) SetVaultList added in v1.5.1 

func (s *ListVaultsOutput) SetVaultList(v []*DescribeVaultOutput) *ListVaultsOutput

SetVaultList sets the VaultList field's value.

func (ListVaultsOutput) String added in v0.6.6 

func (s ListVaultsOutput) String() string

String returns the string representation

type OutputLocation added in v1.12.39 

type OutputLocation struct {

	// Describes an S3 location that will receive the results of the job request.
	S3 *S3Location `type:"structure"`
	// contains filtered or unexported fields
}

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

func (OutputLocation) GoString added in v1.12.39 

func (s OutputLocation) GoString() string

GoString returns the string representation

func (*OutputLocation) SetS3 added in v1.12.39 

func (s *OutputLocation) SetS3(v *S3Location) *OutputLocation

SetS3 sets the S3 field's value.

func (OutputLocation) String added in v1.12.39 

func (s OutputLocation) String() string

String returns the string representation

func (*OutputLocation) Validate added in v1.12.39 

func (s *OutputLocation) Validate() error

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

type OutputSerialization added in v1.12.39 

type OutputSerialization struct {

	// Describes the serialization of CSV-encoded query results.
	Csv *CSVOutput `locationName:"csv" type:"structure"`
	// contains filtered or unexported fields
}

Describes how the select output is serialized.

func (OutputSerialization) GoString added in v1.12.39 

func (s OutputSerialization) GoString() string

GoString returns the string representation

func (*OutputSerialization) SetCsv added in v1.12.39 

func (s *OutputSerialization) SetCsv(v *CSVOutput) *OutputSerialization

SetCsv sets the Csv field's value.

func (OutputSerialization) String added in v1.12.39 

func (s OutputSerialization) String() string

String returns the string representation

type PartListElement 

type PartListElement struct {

	// The byte range of a part, inclusive of the upper value of the range.
	RangeInBytes *string `type:"string"`

	// The SHA256 tree hash value that Amazon Glacier calculated for the part. This
	// field is never null.
	SHA256TreeHash *string `type:"string"`
	// contains filtered or unexported fields
}

A list of the part sizes of the multipart upload.

func (PartListElement) GoString added in v0.6.6 

func (s PartListElement) GoString() string

GoString returns the string representation

func (*PartListElement) SetRangeInBytes added in v1.5.1 

func (s *PartListElement) SetRangeInBytes(v string) *PartListElement

SetRangeInBytes sets the RangeInBytes field's value.

func (*PartListElement) SetSHA256TreeHash added in v1.5.1 

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

SetSHA256TreeHash sets the SHA256TreeHash field's value.

func (PartListElement) String added in v0.6.6 

func (s PartListElement) String() string

String returns the string representation

type ProvisionedCapacityDescription added in v1.5.12 

type ProvisionedCapacityDescription struct {

	// The ID that identifies the provisioned capacity unit.
	CapacityId *string `type:"string"`

	// The date that the provisioned capacity unit expires, in Universal Coordinated
	// Time (UTC).
	ExpirationDate *string `type:"string"`

	// The date that the provisioned capacity unit was purchased, in Universal Coordinated
	// Time (UTC).
	StartDate *string `type:"string"`
	// contains filtered or unexported fields
}

The definition for a provisioned capacity unit.

func (ProvisionedCapacityDescription) GoString added in v1.5.12 

func (s ProvisionedCapacityDescription) GoString() string

GoString returns the string representation

func (*ProvisionedCapacityDescription) SetCapacityId added in v1.5.12 

func (s *ProvisionedCapacityDescription) SetCapacityId(v string) *ProvisionedCapacityDescription

SetCapacityId sets the CapacityId field's value.

func (*ProvisionedCapacityDescription) SetExpirationDate added in v1.5.12 

func (s *ProvisionedCapacityDescription) SetExpirationDate(v string) *ProvisionedCapacityDescription

SetExpirationDate sets the ExpirationDate field's value.

func (*ProvisionedCapacityDescription) SetStartDate added in v1.5.12 

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

SetStartDate sets the StartDate field's value.

func (ProvisionedCapacityDescription) String added in v1.5.12 

func (s ProvisionedCapacityDescription) String() string

String returns the string representation

type PurchaseProvisionedCapacityInput added in v1.5.12 

type PurchaseProvisionedCapacityInput struct {

	// The AWS account ID of the account that owns the vault. You can either specify
	// an AWS account ID or optionally a single '-' (hyphen), in which case Amazon
	// Glacier uses the AWS account ID associated with the credentials used to sign
	// the request. If you use an account ID, don't include any hyphens ('-') in
	// the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PurchaseProvisionedCapacityInput) GoString added in v1.5.12 

func (s PurchaseProvisionedCapacityInput) GoString() string

GoString returns the string representation

func (*PurchaseProvisionedCapacityInput) SetAccountId added in v1.5.12 

func (s *PurchaseProvisionedCapacityInput) SetAccountId(v string) *PurchaseProvisionedCapacityInput

SetAccountId sets the AccountId field's value.

func (PurchaseProvisionedCapacityInput) String added in v1.5.12 

func (s PurchaseProvisionedCapacityInput) String() string

String returns the string representation

func (*PurchaseProvisionedCapacityInput) Validate added in v1.5.12 

func (s *PurchaseProvisionedCapacityInput) Validate() error

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

type PurchaseProvisionedCapacityOutput added in v1.5.12 

type PurchaseProvisionedCapacityOutput struct {

	// The ID that identifies the provisioned capacity unit.
	CapacityId *string `location:"header" locationName:"x-amz-capacity-id" type:"string"`
	// contains filtered or unexported fields
}

func (PurchaseProvisionedCapacityOutput) GoString added in v1.5.12 

func (s PurchaseProvisionedCapacityOutput) GoString() string

GoString returns the string representation

func (*PurchaseProvisionedCapacityOutput) SetCapacityId added in v1.5.12 

func (s *PurchaseProvisionedCapacityOutput) SetCapacityId(v string) *PurchaseProvisionedCapacityOutput

SetCapacityId sets the CapacityId field's value.

func (PurchaseProvisionedCapacityOutput) String added in v1.5.12 

func (s PurchaseProvisionedCapacityOutput) String() string

String returns the string representation

type RemoveTagsFromVaultInput added in v0.6.6 

type RemoveTagsFromVaultInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// A list of tag keys. Each corresponding tag is removed from the vault.
	TagKeys []*string `type:"list"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input value for RemoveTagsFromVaultInput.

func (RemoveTagsFromVaultInput) GoString added in v0.6.6 

func (s RemoveTagsFromVaultInput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromVaultInput) SetAccountId added in v1.5.1 

func (s *RemoveTagsFromVaultInput) SetAccountId(v string) *RemoveTagsFromVaultInput

SetAccountId sets the AccountId field's value.

func (*RemoveTagsFromVaultInput) SetTagKeys added in v1.5.1 

func (s *RemoveTagsFromVaultInput) SetTagKeys(v []*string) *RemoveTagsFromVaultInput

SetTagKeys sets the TagKeys field's value.

func (*RemoveTagsFromVaultInput) SetVaultName added in v1.5.1 

func (s *RemoveTagsFromVaultInput) SetVaultName(v string) *RemoveTagsFromVaultInput

SetVaultName sets the VaultName field's value.

func (RemoveTagsFromVaultInput) String added in v0.6.6 

func (s RemoveTagsFromVaultInput) String() string

String returns the string representation

func (*RemoveTagsFromVaultInput) Validate added in v1.1.24 

func (s *RemoveTagsFromVaultInput) Validate() error

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

type RemoveTagsFromVaultOutput added in v0.6.6 

type RemoveTagsFromVaultOutput struct {
	// contains filtered or unexported fields
}

func (RemoveTagsFromVaultOutput) GoString added in v0.6.6 

func (s RemoveTagsFromVaultOutput) GoString() string

GoString returns the string representation

func (RemoveTagsFromVaultOutput) String added in v0.6.6 

func (s RemoveTagsFromVaultOutput) String() string

String returns the string representation

type S3Location added in v1.12.39 

type S3Location struct {

	// A list of grants that control access to the staged results.
	AccessControlList []*Grant `type:"list"`

	// The name of the Amazon S3 bucket where the job results are stored.
	BucketName *string `type:"string"`

	// The canned access control list (ACL) to apply to the job results.
	CannedACL *string `type:"string" enum:"CannedACL"`

	// Contains information about the encryption used to store the job results in
	// Amazon S3.
	Encryption *Encryption `type:"structure"`

	// The prefix that is prepended to the results for this request.
	Prefix *string `type:"string"`

	// The storage class used to store the job results.
	StorageClass *string `type:"string" enum:"StorageClass"`

	// The tag-set that is applied to the job results.
	Tagging map[string]*string `type:"map"`

	// A map of metadata to store with the job results in Amazon S3.
	UserMetadata map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

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

func (S3Location) GoString added in v1.12.39 

func (s S3Location) GoString() string

GoString returns the string representation

func (*S3Location) SetAccessControlList added in v1.12.39 

func (s *S3Location) SetAccessControlList(v []*Grant) *S3Location

SetAccessControlList sets the AccessControlList field's value.

func (*S3Location) SetBucketName added in v1.12.39 

func (s *S3Location) SetBucketName(v string) *S3Location

SetBucketName sets the BucketName field's value.

func (*S3Location) SetCannedACL added in v1.12.39 

func (s *S3Location) SetCannedACL(v string) *S3Location

SetCannedACL sets the CannedACL field's value.

func (*S3Location) SetEncryption added in v1.12.39 

func (s *S3Location) SetEncryption(v *Encryption) *S3Location

SetEncryption sets the Encryption field's value.

func (*S3Location) SetPrefix added in v1.12.39 

func (s *S3Location) SetPrefix(v string) *S3Location

SetPrefix sets the Prefix field's value.

func (*S3Location) SetStorageClass added in v1.12.39 

func (s *S3Location) SetStorageClass(v string) *S3Location

SetStorageClass sets the StorageClass field's value.

func (*S3Location) SetTagging added in v1.12.39 

func (s *S3Location) SetTagging(v map[string]*string) *S3Location

SetTagging sets the Tagging field's value.

func (*S3Location) SetUserMetadata added in v1.12.39 

func (s *S3Location) SetUserMetadata(v map[string]*string) *S3Location

SetUserMetadata sets the UserMetadata field's value.

func (S3Location) String added in v1.12.39 

func (s S3Location) String() string

String returns the string representation

func (*S3Location) Validate added in v1.12.39 

func (s *S3Location) Validate() error

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

type SelectParameters added in v1.12.39 

type SelectParameters struct {

	// The expression that is used to select the object.
	Expression *string `type:"string"`

	// The type of the provided expression, for example SQL.
	ExpressionType *string `type:"string" enum:"ExpressionType"`

	// Describes the serialization format of the object.
	InputSerialization *InputSerialization `type:"structure"`

	// Describes how the results of the select job are serialized.
	OutputSerialization *OutputSerialization `type:"structure"`
	// contains filtered or unexported fields
}

Contains information about the parameters used for a select.

func (SelectParameters) GoString added in v1.12.39 

func (s SelectParameters) GoString() string

GoString returns the string representation

func (*SelectParameters) SetExpression added in v1.12.39 

func (s *SelectParameters) SetExpression(v string) *SelectParameters

SetExpression sets the Expression field's value.

func (*SelectParameters) SetExpressionType added in v1.12.39 

func (s *SelectParameters) SetExpressionType(v string) *SelectParameters

SetExpressionType sets the ExpressionType field's value.

func (*SelectParameters) SetInputSerialization added in v1.12.39 

func (s *SelectParameters) SetInputSerialization(v *InputSerialization) *SelectParameters

SetInputSerialization sets the InputSerialization field's value.

func (*SelectParameters) SetOutputSerialization added in v1.12.39 

func (s *SelectParameters) SetOutputSerialization(v *OutputSerialization) *SelectParameters

SetOutputSerialization sets the OutputSerialization field's value.

func (SelectParameters) String added in v1.12.39 

func (s SelectParameters) String() string

String returns the string representation

type SetDataRetrievalPolicyInput 

type SetDataRetrievalPolicyInput struct {

	// The AccountId value is the AWS account ID. This value must match the AWS
	// account ID associated with the credentials used to sign the request. You
	// can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you specify your account ID, do
	// not include any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The data retrieval policy in JSON format.
	Policy *DataRetrievalPolicy `type:"structure"`
	// contains filtered or unexported fields
}

SetDataRetrievalPolicy input.

func (SetDataRetrievalPolicyInput) GoString added in v0.6.6 

func (s SetDataRetrievalPolicyInput) GoString() string

GoString returns the string representation

func (*SetDataRetrievalPolicyInput) SetAccountId added in v1.5.1 

func (s *SetDataRetrievalPolicyInput) SetAccountId(v string) *SetDataRetrievalPolicyInput

SetAccountId sets the AccountId field's value.

func (*SetDataRetrievalPolicyInput) SetPolicy added in v1.5.1 

func (s *SetDataRetrievalPolicyInput) SetPolicy(v *DataRetrievalPolicy) *SetDataRetrievalPolicyInput

SetPolicy sets the Policy field's value.

func (SetDataRetrievalPolicyInput) String added in v0.6.6 

func (s SetDataRetrievalPolicyInput) String() string

String returns the string representation

func (*SetDataRetrievalPolicyInput) Validate added in v1.1.24 

func (s *SetDataRetrievalPolicyInput) Validate() error

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

type SetDataRetrievalPolicyOutput 

type SetDataRetrievalPolicyOutput struct {
	// contains filtered or unexported fields
}

func (SetDataRetrievalPolicyOutput) GoString added in v0.6.6 

func (s SetDataRetrievalPolicyOutput) GoString() string

GoString returns the string representation

func (SetDataRetrievalPolicyOutput) String added in v0.6.6 

func (s SetDataRetrievalPolicyOutput) String() string

String returns the string representation

type SetVaultAccessPolicyInput 

type SetVaultAccessPolicyInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The vault access policy as a JSON string.
	Policy *VaultAccessPolicy `locationName:"policy" type:"structure"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

SetVaultAccessPolicy input.

func (SetVaultAccessPolicyInput) GoString added in v0.6.6 

func (s SetVaultAccessPolicyInput) GoString() string

GoString returns the string representation

func (*SetVaultAccessPolicyInput) SetAccountId added in v1.5.1 

func (s *SetVaultAccessPolicyInput) SetAccountId(v string) *SetVaultAccessPolicyInput

SetAccountId sets the AccountId field's value.

func (*SetVaultAccessPolicyInput) SetPolicy added in v1.5.1 

func (s *SetVaultAccessPolicyInput) SetPolicy(v *VaultAccessPolicy) *SetVaultAccessPolicyInput

SetPolicy sets the Policy field's value.

func (*SetVaultAccessPolicyInput) SetVaultName added in v1.5.1 

func (s *SetVaultAccessPolicyInput) SetVaultName(v string) *SetVaultAccessPolicyInput

SetVaultName sets the VaultName field's value.

func (SetVaultAccessPolicyInput) String added in v0.6.6 

func (s SetVaultAccessPolicyInput) String() string

String returns the string representation

func (*SetVaultAccessPolicyInput) Validate added in v1.1.24 

func (s *SetVaultAccessPolicyInput) Validate() error

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

type SetVaultAccessPolicyOutput 

type SetVaultAccessPolicyOutput struct {
	// contains filtered or unexported fields
}

func (SetVaultAccessPolicyOutput) GoString added in v0.6.6 

func (s SetVaultAccessPolicyOutput) GoString() string

GoString returns the string representation

func (SetVaultAccessPolicyOutput) String added in v0.6.6 

func (s SetVaultAccessPolicyOutput) String() string

String returns the string representation

type SetVaultNotificationsInput 

type SetVaultNotificationsInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`

	// Provides options for specifying notification configuration.
	VaultNotificationConfig *VaultNotificationConfig `locationName:"vaultNotificationConfig" type:"structure"`
	// contains filtered or unexported fields
}

Provides options to configure notifications that will be sent when specific events happen to a vault.

func (SetVaultNotificationsInput) GoString added in v0.6.6 

func (s SetVaultNotificationsInput) GoString() string

GoString returns the string representation

func (*SetVaultNotificationsInput) SetAccountId added in v1.5.1 

func (s *SetVaultNotificationsInput) SetAccountId(v string) *SetVaultNotificationsInput

SetAccountId sets the AccountId field's value.

func (*SetVaultNotificationsInput) SetVaultName added in v1.5.1 

func (s *SetVaultNotificationsInput) SetVaultName(v string) *SetVaultNotificationsInput

SetVaultName sets the VaultName field's value.

func (*SetVaultNotificationsInput) SetVaultNotificationConfig added in v1.5.1 

func (s *SetVaultNotificationsInput) SetVaultNotificationConfig(v *VaultNotificationConfig) *SetVaultNotificationsInput

SetVaultNotificationConfig sets the VaultNotificationConfig field's value.

func (SetVaultNotificationsInput) String added in v0.6.6 

func (s SetVaultNotificationsInput) String() string

String returns the string representation

func (*SetVaultNotificationsInput) Validate added in v1.1.24 

func (s *SetVaultNotificationsInput) Validate() error

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

type SetVaultNotificationsOutput 

type SetVaultNotificationsOutput struct {
	// contains filtered or unexported fields
}

func (SetVaultNotificationsOutput) GoString added in v0.6.6 

func (s SetVaultNotificationsOutput) GoString() string

GoString returns the string representation

func (SetVaultNotificationsOutput) String added in v0.6.6 

func (s SetVaultNotificationsOutput) String() string

String returns the string representation

type UploadArchiveInput 

type UploadArchiveInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The optional description of the archive you are uploading.
	ArchiveDescription *string `location:"header" locationName:"x-amz-archive-description" type:"string"`

	// The data to upload.
	Body io.ReadSeeker `locationName:"body" type:"blob"`

	// The SHA256 tree hash of the data being uploaded.
	Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options to add an archive to a vault.

func (UploadArchiveInput) GoString added in v0.6.6 

func (s UploadArchiveInput) GoString() string

GoString returns the string representation

func (*UploadArchiveInput) SetAccountId added in v1.5.1 

func (s *UploadArchiveInput) SetAccountId(v string) *UploadArchiveInput

SetAccountId sets the AccountId field's value.

func (*UploadArchiveInput) SetArchiveDescription added in v1.5.1 

func (s *UploadArchiveInput) SetArchiveDescription(v string) *UploadArchiveInput

SetArchiveDescription sets the ArchiveDescription field's value.

func (*UploadArchiveInput) SetBody added in v1.5.1 

func (s *UploadArchiveInput) SetBody(v io.ReadSeeker) *UploadArchiveInput

SetBody sets the Body field's value.

func (*UploadArchiveInput) SetChecksum added in v1.5.1 

func (s *UploadArchiveInput) SetChecksum(v string) *UploadArchiveInput

SetChecksum sets the Checksum field's value.

func (*UploadArchiveInput) SetVaultName added in v1.5.1 

func (s *UploadArchiveInput) SetVaultName(v string) *UploadArchiveInput

SetVaultName sets the VaultName field's value.

func (UploadArchiveInput) String added in v0.6.6 

func (s UploadArchiveInput) String() string

String returns the string representation

func (*UploadArchiveInput) Validate added in v1.1.24 

func (s *UploadArchiveInput) Validate() error

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

type UploadListElement 

type UploadListElement struct {

	// The description of the archive that was specified in the Initiate Multipart
	// Upload request.
	ArchiveDescription *string `type:"string"`

	// The UTC time at which the multipart upload was initiated.
	CreationDate *string `type:"string"`

	// The ID of a multipart upload.
	MultipartUploadId *string `type:"string"`

	// The part size, in bytes, specified in the Initiate Multipart Upload request.
	// This is the size of all the parts in the upload except the last part, which
	// may be smaller than this size.
	PartSizeInBytes *int64 `type:"long"`

	// The Amazon Resource Name (ARN) of the vault that contains the archive.
	VaultARN *string `type:"string"`
	// contains filtered or unexported fields
}

A list of in-progress multipart uploads for a vault.

func (UploadListElement) GoString added in v0.6.6 

func (s UploadListElement) GoString() string

GoString returns the string representation

func (*UploadListElement) SetArchiveDescription added in v1.5.1 

func (s *UploadListElement) SetArchiveDescription(v string) *UploadListElement

SetArchiveDescription sets the ArchiveDescription field's value.

func (*UploadListElement) SetCreationDate added in v1.5.1 

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

SetCreationDate sets the CreationDate field's value.

func (*UploadListElement) SetMultipartUploadId added in v1.5.1 

func (s *UploadListElement) SetMultipartUploadId(v string) *UploadListElement

SetMultipartUploadId sets the MultipartUploadId field's value.

func (*UploadListElement) SetPartSizeInBytes added in v1.5.1 

func (s *UploadListElement) SetPartSizeInBytes(v int64) *UploadListElement

SetPartSizeInBytes sets the PartSizeInBytes field's value.

func (*UploadListElement) SetVaultARN added in v1.5.1 

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

SetVaultARN sets the VaultARN field's value.

func (UploadListElement) String added in v0.6.6 

func (s UploadListElement) String() string

String returns the string representation

type UploadMultipartPartInput 

type UploadMultipartPartInput struct {

	// The AccountId value is the AWS account ID of the account that owns the vault.
	// You can either specify an AWS account ID or optionally a single '-' (hyphen),
	// in which case Amazon Glacier uses the AWS account ID associated with the
	// credentials used to sign the request. If you use an account ID, do not include
	// any hyphens ('-') in the ID.
	//
	// AccountId is a required field
	AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`

	// The data to upload.
	Body io.ReadSeeker `locationName:"body" type:"blob"`

	// The SHA256 tree hash of the data being uploaded.
	Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"`

	// Identifies the range of bytes in the assembled archive that will be uploaded
	// in this part. Amazon Glacier uses this information to assemble the archive
	// in the proper sequence. The format of this header follows RFC 2616. An example
	// header is Content-Range:bytes 0-4194303/*.
	Range *string `location:"header" locationName:"Content-Range" type:"string"`

	// The upload ID of the multipart upload.
	//
	// UploadId is a required field
	UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"`

	// The name of the vault.
	//
	// VaultName is a required field
	VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides options to upload a part of an archive in a multipart upload operation.

func (UploadMultipartPartInput) GoString added in v0.6.6 

func (s UploadMultipartPartInput) GoString() string

GoString returns the string representation

func (*UploadMultipartPartInput) SetAccountId added in v1.5.1 

func (s *UploadMultipartPartInput) SetAccountId(v string) *UploadMultipartPartInput

SetAccountId sets the AccountId field's value.

func (*UploadMultipartPartInput) SetBody added in v1.5.1 

func (s *UploadMultipartPartInput) SetBody(v io.ReadSeeker) *UploadMultipartPartInput

SetBody sets the Body field's value.

func (*UploadMultipartPartInput) SetChecksum added in v1.5.1 

func (s *UploadMultipartPartInput) SetChecksum(v string) *UploadMultipartPartInput

SetChecksum sets the Checksum field's value.

func (*UploadMultipartPartInput) SetRange added in v1.5.1 

func (s *UploadMultipartPartInput) SetRange(v string) *UploadMultipartPartInput

SetRange sets the Range field's value.

func (*UploadMultipartPartInput) SetUploadId added in v1.5.1 

func (s *UploadMultipartPartInput) SetUploadId(v string) *UploadMultipartPartInput

SetUploadId sets the UploadId field's value.

func (*UploadMultipartPartInput) SetVaultName added in v1.5.1 

func (s *UploadMultipartPartInput) SetVaultName(v string) *UploadMultipartPartInput

SetVaultName sets the VaultName field's value.

func (UploadMultipartPartInput) String added in v0.6.6 

func (s UploadMultipartPartInput) String() string

String returns the string representation

func (*UploadMultipartPartInput) Validate added in v1.1.24 

func (s *UploadMultipartPartInput) Validate() error

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

type UploadMultipartPartOutput 

type UploadMultipartPartOutput struct {

	// The SHA256 tree hash that Amazon Glacier computed for the uploaded part.
	Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon Glacier response to your request.

func (UploadMultipartPartOutput) GoString added in v0.6.6 

func (s UploadMultipartPartOutput) GoString() string

GoString returns the string representation

func (*UploadMultipartPartOutput) SetChecksum added in v1.5.1 

func (s *UploadMultipartPartOutput) SetChecksum(v string) *UploadMultipartPartOutput

SetChecksum sets the Checksum field's value.

func (UploadMultipartPartOutput) String added in v0.6.6 

func (s UploadMultipartPartOutput) String() string

String returns the string representation

type VaultAccessPolicy 

type VaultAccessPolicy struct {

	// The vault access policy.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the vault access policy.

func (VaultAccessPolicy) GoString added in v0.6.6 

func (s VaultAccessPolicy) GoString() string

GoString returns the string representation

func (*VaultAccessPolicy) SetPolicy added in v1.5.1 

func (s *VaultAccessPolicy) SetPolicy(v string) *VaultAccessPolicy

SetPolicy sets the Policy field's value.

func (VaultAccessPolicy) String added in v0.6.6 

func (s VaultAccessPolicy) String() string

String returns the string representation

type VaultLockPolicy added in v0.7.0 

type VaultLockPolicy struct {

	// The vault lock policy.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the vault lock policy.

func (VaultLockPolicy) GoString added in v0.7.0 

func (s VaultLockPolicy) GoString() string

GoString returns the string representation

func (*VaultLockPolicy) SetPolicy added in v1.5.1 

func (s *VaultLockPolicy) SetPolicy(v string) *VaultLockPolicy

SetPolicy sets the Policy field's value.

func (VaultLockPolicy) String added in v0.7.0 

func (s VaultLockPolicy) String() string

String returns the string representation

type VaultNotificationConfig 

type VaultNotificationConfig struct {

	// A list of one or more events for which Amazon Glacier will send a notification
	// to the specified Amazon SNS topic.
	Events []*string `type:"list"`

	// The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource
	// Name (ARN).
	SNSTopic *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a vault's notification configuration.

func (VaultNotificationConfig) GoString added in v0.6.6 

func (s VaultNotificationConfig) GoString() string

GoString returns the string representation

func (*VaultNotificationConfig) SetEvents added in v1.5.1 

func (s *VaultNotificationConfig) SetEvents(v []*string) *VaultNotificationConfig

SetEvents sets the Events field's value.

func (*VaultNotificationConfig) SetSNSTopic added in v1.5.1 

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

SetSNSTopic sets the SNSTopic field's value.

func (VaultNotificationConfig) String added in v0.6.6 

func (s VaultNotificationConfig) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package glacieriface provides an interface to enable mocking the Amazon Glacier service client for testing your code.
 Package glacieriface provides an interface to enable mocking the Amazon Glacier service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.