Documentation
¶
Overview ¶
Package glacier provides a client for Amazon Glacier.
Index ¶
- Constants
- type AbortMultipartUploadInput
- type AbortMultipartUploadOutput
- type AbortVaultLockInput
- type AbortVaultLockOutput
- type AddTagsToVaultInput
- type AddTagsToVaultOutput
- type ArchiveCreationOutput
- type CompleteMultipartUploadInput
- type CompleteVaultLockInput
- type CompleteVaultLockOutput
- type CreateVaultInput
- type CreateVaultOutput
- type DataRetrievalPolicy
- type DataRetrievalRule
- type DeleteArchiveInput
- type DeleteArchiveOutput
- type DeleteVaultAccessPolicyInput
- type DeleteVaultAccessPolicyOutput
- type DeleteVaultInput
- type DeleteVaultNotificationsInput
- type DeleteVaultNotificationsOutput
- type DeleteVaultOutput
- type DescribeJobInput
- type DescribeVaultInput
- type DescribeVaultOutput
- type GetDataRetrievalPolicyInput
- type GetDataRetrievalPolicyOutput
- type GetJobOutputInput
- type GetJobOutputOutput
- type GetVaultAccessPolicyInput
- type GetVaultAccessPolicyOutput
- type GetVaultLockInput
- type GetVaultLockOutput
- type GetVaultNotificationsInput
- type GetVaultNotificationsOutput
- type Glacier
- func (c *Glacier) AbortMultipartUpload(input *AbortMultipartUploadInput) (*AbortMultipartUploadOutput, error)
- func (c *Glacier) AbortMultipartUploadRequest(input *AbortMultipartUploadInput) (req *request.Request, output *AbortMultipartUploadOutput)
- func (c *Glacier) AbortVaultLock(input *AbortVaultLockInput) (*AbortVaultLockOutput, error)
- func (c *Glacier) AbortVaultLockRequest(input *AbortVaultLockInput) (req *request.Request, output *AbortVaultLockOutput)
- func (c *Glacier) AddTagsToVault(input *AddTagsToVaultInput) (*AddTagsToVaultOutput, error)
- func (c *Glacier) AddTagsToVaultRequest(input *AddTagsToVaultInput) (req *request.Request, output *AddTagsToVaultOutput)
- func (c *Glacier) CompleteMultipartUpload(input *CompleteMultipartUploadInput) (*ArchiveCreationOutput, error)
- func (c *Glacier) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) (req *request.Request, output *ArchiveCreationOutput)
- func (c *Glacier) CompleteVaultLock(input *CompleteVaultLockInput) (*CompleteVaultLockOutput, error)
- func (c *Glacier) CompleteVaultLockRequest(input *CompleteVaultLockInput) (req *request.Request, output *CompleteVaultLockOutput)
- func (c *Glacier) CreateVault(input *CreateVaultInput) (*CreateVaultOutput, error)
- func (c *Glacier) CreateVaultRequest(input *CreateVaultInput) (req *request.Request, output *CreateVaultOutput)
- func (c *Glacier) DeleteArchive(input *DeleteArchiveInput) (*DeleteArchiveOutput, error)
- func (c *Glacier) DeleteArchiveRequest(input *DeleteArchiveInput) (req *request.Request, output *DeleteArchiveOutput)
- func (c *Glacier) DeleteVault(input *DeleteVaultInput) (*DeleteVaultOutput, error)
- func (c *Glacier) DeleteVaultAccessPolicy(input *DeleteVaultAccessPolicyInput) (*DeleteVaultAccessPolicyOutput, error)
- func (c *Glacier) DeleteVaultAccessPolicyRequest(input *DeleteVaultAccessPolicyInput) (req *request.Request, output *DeleteVaultAccessPolicyOutput)
- func (c *Glacier) DeleteVaultNotifications(input *DeleteVaultNotificationsInput) (*DeleteVaultNotificationsOutput, error)
- func (c *Glacier) DeleteVaultNotificationsRequest(input *DeleteVaultNotificationsInput) (req *request.Request, output *DeleteVaultNotificationsOutput)
- func (c *Glacier) DeleteVaultRequest(input *DeleteVaultInput) (req *request.Request, output *DeleteVaultOutput)
- func (c *Glacier) DescribeJob(input *DescribeJobInput) (*JobDescription, error)
- func (c *Glacier) DescribeJobRequest(input *DescribeJobInput) (req *request.Request, output *JobDescription)
- func (c *Glacier) DescribeVault(input *DescribeVaultInput) (*DescribeVaultOutput, error)
- func (c *Glacier) DescribeVaultRequest(input *DescribeVaultInput) (req *request.Request, output *DescribeVaultOutput)
- func (c *Glacier) GetDataRetrievalPolicy(input *GetDataRetrievalPolicyInput) (*GetDataRetrievalPolicyOutput, error)
- func (c *Glacier) GetDataRetrievalPolicyRequest(input *GetDataRetrievalPolicyInput) (req *request.Request, output *GetDataRetrievalPolicyOutput)
- func (c *Glacier) GetJobOutput(input *GetJobOutputInput) (*GetJobOutputOutput, error)
- func (c *Glacier) GetJobOutputRequest(input *GetJobOutputInput) (req *request.Request, output *GetJobOutputOutput)
- func (c *Glacier) GetVaultAccessPolicy(input *GetVaultAccessPolicyInput) (*GetVaultAccessPolicyOutput, error)
- func (c *Glacier) GetVaultAccessPolicyRequest(input *GetVaultAccessPolicyInput) (req *request.Request, output *GetVaultAccessPolicyOutput)
- func (c *Glacier) GetVaultLock(input *GetVaultLockInput) (*GetVaultLockOutput, error)
- func (c *Glacier) GetVaultLockRequest(input *GetVaultLockInput) (req *request.Request, output *GetVaultLockOutput)
- func (c *Glacier) GetVaultNotifications(input *GetVaultNotificationsInput) (*GetVaultNotificationsOutput, error)
- func (c *Glacier) GetVaultNotificationsRequest(input *GetVaultNotificationsInput) (req *request.Request, output *GetVaultNotificationsOutput)
- func (c *Glacier) InitiateJob(input *InitiateJobInput) (*InitiateJobOutput, error)
- func (c *Glacier) InitiateJobRequest(input *InitiateJobInput) (req *request.Request, output *InitiateJobOutput)
- func (c *Glacier) InitiateMultipartUpload(input *InitiateMultipartUploadInput) (*InitiateMultipartUploadOutput, error)
- func (c *Glacier) InitiateMultipartUploadRequest(input *InitiateMultipartUploadInput) (req *request.Request, output *InitiateMultipartUploadOutput)
- func (c *Glacier) InitiateVaultLock(input *InitiateVaultLockInput) (*InitiateVaultLockOutput, error)
- func (c *Glacier) InitiateVaultLockRequest(input *InitiateVaultLockInput) (req *request.Request, output *InitiateVaultLockOutput)
- func (c *Glacier) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)
- func (c *Glacier) ListJobsPages(input *ListJobsInput, ...) error
- func (c *Glacier) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)
- func (c *Glacier) ListMultipartUploads(input *ListMultipartUploadsInput) (*ListMultipartUploadsOutput, error)
- func (c *Glacier) ListMultipartUploadsPages(input *ListMultipartUploadsInput, ...) error
- func (c *Glacier) ListMultipartUploadsRequest(input *ListMultipartUploadsInput) (req *request.Request, output *ListMultipartUploadsOutput)
- func (c *Glacier) ListParts(input *ListPartsInput) (*ListPartsOutput, error)
- func (c *Glacier) ListPartsPages(input *ListPartsInput, ...) error
- func (c *Glacier) ListPartsRequest(input *ListPartsInput) (req *request.Request, output *ListPartsOutput)
- func (c *Glacier) ListTagsForVault(input *ListTagsForVaultInput) (*ListTagsForVaultOutput, error)
- func (c *Glacier) ListTagsForVaultRequest(input *ListTagsForVaultInput) (req *request.Request, output *ListTagsForVaultOutput)
- func (c *Glacier) ListVaults(input *ListVaultsInput) (*ListVaultsOutput, error)
- func (c *Glacier) ListVaultsPages(input *ListVaultsInput, ...) error
- func (c *Glacier) ListVaultsRequest(input *ListVaultsInput) (req *request.Request, output *ListVaultsOutput)
- func (c *Glacier) RemoveTagsFromVault(input *RemoveTagsFromVaultInput) (*RemoveTagsFromVaultOutput, error)
- func (c *Glacier) RemoveTagsFromVaultRequest(input *RemoveTagsFromVaultInput) (req *request.Request, output *RemoveTagsFromVaultOutput)
- func (c *Glacier) SetDataRetrievalPolicy(input *SetDataRetrievalPolicyInput) (*SetDataRetrievalPolicyOutput, error)
- func (c *Glacier) SetDataRetrievalPolicyRequest(input *SetDataRetrievalPolicyInput) (req *request.Request, output *SetDataRetrievalPolicyOutput)
- func (c *Glacier) SetVaultAccessPolicy(input *SetVaultAccessPolicyInput) (*SetVaultAccessPolicyOutput, error)
- func (c *Glacier) SetVaultAccessPolicyRequest(input *SetVaultAccessPolicyInput) (req *request.Request, output *SetVaultAccessPolicyOutput)
- func (c *Glacier) SetVaultNotifications(input *SetVaultNotificationsInput) (*SetVaultNotificationsOutput, error)
- func (c *Glacier) SetVaultNotificationsRequest(input *SetVaultNotificationsInput) (req *request.Request, output *SetVaultNotificationsOutput)
- func (c *Glacier) UploadArchive(input *UploadArchiveInput) (*ArchiveCreationOutput, error)
- func (c *Glacier) UploadArchiveRequest(input *UploadArchiveInput) (req *request.Request, output *ArchiveCreationOutput)
- func (c *Glacier) UploadMultipartPart(input *UploadMultipartPartInput) (*UploadMultipartPartOutput, error)
- func (c *Glacier) UploadMultipartPartRequest(input *UploadMultipartPartInput) (req *request.Request, output *UploadMultipartPartOutput)
- func (c *Glacier) WaitUntilVaultExists(input *DescribeVaultInput) error
- func (c *Glacier) WaitUntilVaultNotExists(input *DescribeVaultInput) error
- type Hash
- type InitiateJobInput
- type InitiateJobOutput
- type InitiateMultipartUploadInput
- type InitiateMultipartUploadOutput
- type InitiateVaultLockInput
- type InitiateVaultLockOutput
- type InventoryRetrievalJobDescription
- type InventoryRetrievalJobInput
- type JobDescription
- type JobParameters
- type ListJobsInput
- type ListJobsOutput
- type ListMultipartUploadsInput
- type ListMultipartUploadsOutput
- type ListPartsInput
- type ListPartsOutput
- type ListTagsForVaultInput
- type ListTagsForVaultOutput
- type ListVaultsInput
- type ListVaultsOutput
- type PartListElement
- type RemoveTagsFromVaultInput
- type RemoveTagsFromVaultOutput
- type SetDataRetrievalPolicyInput
- type SetDataRetrievalPolicyOutput
- type SetVaultAccessPolicyInput
- type SetVaultAccessPolicyOutput
- type SetVaultNotificationsInput
- type SetVaultNotificationsOutput
- type UploadArchiveInput
- type UploadListElement
- type UploadMultipartPartInput
- type UploadMultipartPartOutput
- type VaultAccessPolicy
- type VaultLockPolicy
- type VaultNotificationConfig
Examples ¶
- ComputeHashes
- Glacier.AbortMultipartUpload
- Glacier.AbortVaultLock
- Glacier.AddTagsToVault
- Glacier.CompleteMultipartUpload
- Glacier.CompleteVaultLock
- Glacier.CreateVault
- Glacier.DeleteArchive
- Glacier.DeleteVault
- Glacier.DeleteVaultAccessPolicy
- Glacier.DeleteVaultNotifications
- Glacier.DescribeJob
- Glacier.DescribeVault
- Glacier.GetDataRetrievalPolicy
- Glacier.GetJobOutput
- Glacier.GetVaultAccessPolicy
- Glacier.GetVaultLock
- Glacier.GetVaultNotifications
- Glacier.InitiateJob
- Glacier.InitiateMultipartUpload
- Glacier.InitiateVaultLock
- Glacier.ListJobs
- Glacier.ListMultipartUploads
- Glacier.ListParts
- Glacier.ListTagsForVault
- Glacier.ListVaults
- Glacier.RemoveTagsFromVault
- Glacier.SetDataRetrievalPolicy
- Glacier.SetVaultAccessPolicy
- Glacier.SetVaultNotifications
- Glacier.UploadArchive
- Glacier.UploadMultipartPart
Constants ¶
const ( // ActionCodeArchiveRetrieval is a ActionCode enum value ActionCodeArchiveRetrieval = "ArchiveRetrieval" // ActionCodeInventoryRetrieval is a ActionCode enum value ActionCodeInventoryRetrieval = "InventoryRetrieval" )
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" )
const ServiceName = "glacier"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 apos-apos // (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 (apos-apos) 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, go to Abort Multipart Upload (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html). For conceptual information, go to 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.5
func (s AbortMultipartUploadInput) GoString() string
GoString returns the string representation
func (AbortMultipartUploadInput) String ¶ added in v0.6.5
func (s AbortMultipartUploadInput) String() string
String returns the string representation
func (*AbortMultipartUploadInput) Validate ¶ added in v1.1.21
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.5
func (s AbortMultipartUploadOutput) GoString() string
GoString returns the string representation
func (AbortMultipartUploadOutput) String ¶ added in v0.6.5
func (s AbortMultipartUploadOutput) String() string
String returns the string representation
type AbortVaultLockInput ¶ added in v0.6.8
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 apos-apos (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 (apos-apos) 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.6.8
func (s AbortVaultLockInput) GoString() string
GoString returns the string representation
func (AbortVaultLockInput) String ¶ added in v0.6.8
func (s AbortVaultLockInput) String() string
String returns the string representation
func (*AbortVaultLockInput) Validate ¶ added in v1.1.21
func (s *AbortVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AbortVaultLockOutput ¶ added in v0.6.8
type AbortVaultLockOutput struct {
// contains filtered or unexported fields
}
func (AbortVaultLockOutput) GoString ¶ added in v0.6.8
func (s AbortVaultLockOutput) GoString() string
GoString returns the string representation
func (AbortVaultLockOutput) String ¶ added in v0.6.8
func (s AbortVaultLockOutput) String() string
String returns the string representation
type AddTagsToVaultInput ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s AddTagsToVaultInput) GoString() string
GoString returns the string representation
func (AddTagsToVaultInput) String ¶ added in v0.6.5
func (s AddTagsToVaultInput) String() string
String returns the string representation
func (*AddTagsToVaultInput) Validate ¶ added in v1.1.21
func (s *AddTagsToVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddTagsToVaultOutput ¶ added in v0.6.5
type AddTagsToVaultOutput struct {
// contains filtered or unexported fields
}
func (AddTagsToVaultOutput) GoString ¶ added in v0.6.5
func (s AddTagsToVaultOutput) GoString() string
GoString returns the string representation
func (AddTagsToVaultOutput) String ¶ added in v0.6.5
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, go to Upload Archive (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html). For conceptual information, go to 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.5
func (s ArchiveCreationOutput) GoString() string
GoString returns the string representation
func (ArchiveCreationOutput) String ¶ added in v0.6.5
func (s ArchiveCreationOutput) 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 apos-apos // (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 (apos-apos) 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.5
func (s CompleteMultipartUploadInput) GoString() string
GoString returns the string representation
func (CompleteMultipartUploadInput) String ¶ added in v0.6.5
func (s CompleteMultipartUploadInput) String() string
String returns the string representation
func (*CompleteMultipartUploadInput) Validate ¶ added in v1.1.21
func (s *CompleteMultipartUploadInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompleteVaultLockInput ¶ added in v0.6.8
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 apos-apos (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 (apos-apos) 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.6.8
func (s CompleteVaultLockInput) GoString() string
GoString returns the string representation
func (CompleteVaultLockInput) String ¶ added in v0.6.8
func (s CompleteVaultLockInput) String() string
String returns the string representation
func (*CompleteVaultLockInput) Validate ¶ added in v1.1.21
func (s *CompleteVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompleteVaultLockOutput ¶ added in v0.6.8
type CompleteVaultLockOutput struct {
// contains filtered or unexported fields
}
func (CompleteVaultLockOutput) GoString ¶ added in v0.6.8
func (s CompleteVaultLockOutput) GoString() string
GoString returns the string representation
func (CompleteVaultLockOutput) String ¶ added in v0.6.8
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 apos-apos (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 (apos-apos) 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.5
func (s CreateVaultInput) GoString() string
GoString returns the string representation
func (CreateVaultInput) String ¶ added in v0.6.5
func (s CreateVaultInput) String() string
String returns the string representation
func (*CreateVaultInput) Validate ¶ added in v1.1.21
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.5
func (s CreateVaultOutput) GoString() string
GoString returns the string representation
func (CreateVaultOutput) String ¶ added in v0.6.5
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.5
func (s DataRetrievalPolicy) GoString() string
GoString returns the string representation
func (DataRetrievalPolicy) String ¶ added in v0.6.5
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.5
func (s DataRetrievalRule) GoString() string
GoString returns the string representation
func (DataRetrievalRule) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s DeleteArchiveInput) GoString() string
GoString returns the string representation
func (DeleteArchiveInput) String ¶ added in v0.6.5
func (s DeleteArchiveInput) String() string
String returns the string representation
func (*DeleteArchiveInput) Validate ¶ added in v1.1.21
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.5
func (s DeleteArchiveOutput) GoString() string
GoString returns the string representation
func (DeleteArchiveOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s DeleteVaultAccessPolicyInput) GoString() string
GoString returns the string representation
func (DeleteVaultAccessPolicyInput) String ¶ added in v0.6.5
func (s DeleteVaultAccessPolicyInput) String() string
String returns the string representation
func (*DeleteVaultAccessPolicyInput) Validate ¶ added in v1.1.21
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.5
func (s DeleteVaultAccessPolicyOutput) GoString() string
GoString returns the string representation
func (DeleteVaultAccessPolicyOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s DeleteVaultInput) GoString() string
GoString returns the string representation
func (DeleteVaultInput) String ¶ added in v0.6.5
func (s DeleteVaultInput) String() string
String returns the string representation
func (*DeleteVaultInput) Validate ¶ added in v1.1.21
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 apos-apos // (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 (apos-apos) 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.5
func (s DeleteVaultNotificationsInput) GoString() string
GoString returns the string representation
func (DeleteVaultNotificationsInput) String ¶ added in v0.6.5
func (s DeleteVaultNotificationsInput) String() string
String returns the string representation
func (*DeleteVaultNotificationsInput) Validate ¶ added in v1.1.21
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.5
func (s DeleteVaultNotificationsOutput) GoString() string
GoString returns the string representation
func (DeleteVaultNotificationsOutput) String ¶ added in v0.6.5
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.5
func (s DeleteVaultOutput) GoString() string
GoString returns the string representation
func (DeleteVaultOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s DescribeJobInput) GoString() string
GoString returns the string representation
func (DescribeJobInput) String ¶ added in v0.6.5
func (s DescribeJobInput) String() string
String returns the string representation
func (*DescribeJobInput) Validate ¶ added in v1.1.21
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 apos-apos // (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 (apos-apos) 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.5
func (s DescribeVaultInput) GoString() string
GoString returns the string representation
func (DescribeVaultInput) String ¶ added in v0.6.5
func (s DescribeVaultInput) String() string
String returns the string representation
func (*DescribeVaultInput) Validate ¶ added in v1.1.21
func (s *DescribeVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeVaultOutput ¶
type DescribeVaultOutput struct { // The UTC date when the vault was created. A string representation of ISO 8601 // date format, for example, "2012-03-20T17:03:43.221Z". CreationDate *string `type:"string"` // The UTC date when Amazon Glacier completed the last vault inventory. A string // representation of 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.5
func (s DescribeVaultOutput) GoString() string
GoString returns the string representation
func (DescribeVaultOutput) String ¶ added in v0.6.5
func (s DescribeVaultOutput) 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 apos-apos (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 (apos-apos) 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.5
func (s GetDataRetrievalPolicyInput) GoString() string
GoString returns the string representation
func (GetDataRetrievalPolicyInput) String ¶ added in v0.6.5
func (s GetDataRetrievalPolicyInput) String() string
String returns the string representation
func (*GetDataRetrievalPolicyInput) Validate ¶ added in v1.1.21
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.5
func (s GetDataRetrievalPolicyOutput) GoString() string
GoString returns the string representation
func (GetDataRetrievalPolicyOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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 "Range: bytes=0-1048575". // By default, this operation downloads the entire output. 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.5
func (s GetJobOutputInput) GoString() string
GoString returns the string representation
func (GetJobOutputInput) String ¶ added in v0.6.5
func (s GetJobOutputInput) String() string
String returns the string representation
func (*GetJobOutputInput) Validate ¶ added in v1.1.21
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, go to 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.5
func (s GetJobOutputOutput) GoString() string
GoString returns the string representation
func (GetJobOutputOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s GetVaultAccessPolicyInput) GoString() string
GoString returns the string representation
func (GetVaultAccessPolicyInput) String ¶ added in v0.6.5
func (s GetVaultAccessPolicyInput) String() string
String returns the string representation
func (*GetVaultAccessPolicyInput) Validate ¶ added in v1.1.21
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.5
func (s GetVaultAccessPolicyOutput) GoString() string
GoString returns the string representation
func (GetVaultAccessPolicyOutput) String ¶ added in v0.6.5
func (s GetVaultAccessPolicyOutput) String() string
String returns the string representation
type GetVaultLockInput ¶ added in v0.6.8
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 apos-apos // (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 (apos-apos) 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.6.8
func (s GetVaultLockInput) GoString() string
GoString returns the string representation
func (GetVaultLockInput) String ¶ added in v0.6.8
func (s GetVaultLockInput) String() string
String returns the string representation
func (*GetVaultLockInput) Validate ¶ added in v1.1.21
func (s *GetVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetVaultLockOutput ¶ added in v0.6.8
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.6.8
func (s GetVaultLockOutput) GoString() string
GoString returns the string representation
func (GetVaultLockOutput) String ¶ added in v0.6.8
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 apos-apos // (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 (apos-apos) 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.5
func (s GetVaultNotificationsInput) GoString() string
GoString returns the string representation
func (GetVaultNotificationsInput) String ¶ added in v0.6.5
func (s GetVaultNotificationsInput) String() string
String returns the string representation
func (*GetVaultNotificationsInput) Validate ¶ added in v1.1.21
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.5
func (s GetVaultNotificationsOutput) GoString() string
GoString returns the string representation
func (GetVaultNotificationsOutput) String ¶ added in v0.6.5
func (s GetVaultNotificationsOutput) String() string
String returns the string representation
type 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, go to 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:
What is Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html)
- This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
Getting Started with Amazon Glacier (http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html) - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client'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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.AbortMultipartUploadInput{ AccountId: aws.String("string"), // Required UploadId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.AbortMultipartUpload(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See AbortMultipartUpload for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AbortMultipartUpload method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) AbortVaultLock ¶ added in v0.6.8
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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.AbortVaultLockInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.AbortVaultLock(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) AbortVaultLockRequest ¶ added in v0.6.8
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 can be used to capture response data after the request's "Send" method is called.
See AbortVaultLock for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AbortVaultLock method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) AddTagsToVault ¶ added in v0.6.5
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:
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
LimitExceededException Returned if the request results in a vault or account limit being exceeded.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.AddTagsToVaultInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Tags: map[string]*string{ "Key": aws.String("TagValue"), // Required // More values... }, } resp, err := svc.AddTagsToVault(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) AddTagsToVaultRequest ¶ added in v0.6.5
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 can be used to capture response data after the request's "Send" method is called.
See AddTagsToVault for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddTagsToVault method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.CompleteMultipartUploadInput{ AccountId: aws.String("string"), // Required UploadId: aws.String("string"), // Required VaultName: aws.String("string"), // Required ArchiveSize: aws.String("string"), Checksum: aws.String("string"), } resp, err := svc.CompleteMultipartUpload(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See CompleteMultipartUpload for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CompleteMultipartUpload method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) CompleteVaultLock ¶ added in v0.6.8
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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.CompleteVaultLockInput{ AccountId: aws.String("string"), // Required LockId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.CompleteVaultLock(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) CompleteVaultLockRequest ¶ added in v0.6.8
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 can be used to capture response data after the request's "Send" method is called.
See CompleteVaultLock for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CompleteVaultLock method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
LimitExceededException Returned if the request results in a vault or account limit being exceeded.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.CreateVaultInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.CreateVault(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See CreateVault for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateVault method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.DeleteArchiveInput{ AccountId: aws.String("string"), // Required ArchiveId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.DeleteArchive(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See DeleteArchive for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteArchive method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.DeleteVaultInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.DeleteVault(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.DeleteVaultAccessPolicyInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.DeleteVaultAccessPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See DeleteVaultAccessPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteVaultAccessPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.DeleteVaultNotificationsInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.DeleteVaultNotifications(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See DeleteVaultNotifications for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteVaultNotifications method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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 can be used to capture response data after the request's "Send" method is called.
See DeleteVault for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteVault method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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 information about the underlying REST API, go to Working with Archives
in Amazon Glacier (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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.DescribeJobInput{ AccountId: aws.String("string"), // Required JobId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.DescribeJob(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See DescribeJob for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeJob method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.DescribeVaultInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.DescribeVault(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See DescribeVault for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeVault method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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:
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.GetDataRetrievalPolicyInput{ AccountId: aws.String("string"), // Required } resp, err := svc.GetDataRetrievalPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See GetDataRetrievalPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDataRetrievalPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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.
A job ID will 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.
If the job output is large, then you can use the Range request header 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
using the Range header.
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.
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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.GetJobOutputInput{ AccountId: aws.String("string"), // Required JobId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Range: aws.String("string"), } resp, err := svc.GetJobOutput(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See GetJobOutput for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetJobOutput method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.GetVaultAccessPolicyInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.GetVaultAccessPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See GetVaultAccessPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetVaultAccessPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) GetVaultLock ¶ added in v0.6.8
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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.GetVaultLockInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.GetVaultLock(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) GetVaultLockRequest ¶ added in v0.6.8
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 can be used to capture response data after the request's "Send" method is called.
See GetVaultLock for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetVaultLock method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.GetVaultNotificationsInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.GetVaultNotifications(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See GetVaultNotifications for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetVaultNotifications method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) InitiateJob ¶
func (c *Glacier) InitiateJob(input *InitiateJobInput) (*InitiateJobOutput, error)
InitiateJob API operation for Amazon Glacier.
This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).
Retrieving data from Amazon Glacier is a two-step process:
Initiate a retrieval job.
A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. 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). For more information about the PolicyEnforcedException exception, see Error Responses (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-error-responses.html).
After the job completes, download the bytes. The retrieval request is executed asynchronously. When you initiate a retrieval
job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.
The job must complete before you can get its output. To determine when a job is complete, you have the following options:
Use Amazon SNS Notification You can specify an Amazon Simple Notification
Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications.
Get job details You can make a DescribeJob request to obtain job status
information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.
The information you get via notification is same that you get by calling
DescribeJob.
If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications.
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).
About the Vault Inventory ¶
Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.
Range Inventory Retrieval ¶
You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.
Filtering by Archive Creation Date ¶
You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate, you will retrieve the inventory for all archives created on or after the StartDate. If you only provide the EndDate without the StartDate, you will get back the inventory for all archives created before the EndDate.
Limiting Inventory Items per Retrieval ¶
You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit. If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.
You can use the Limit parameter together with the date range parameters.
About Ranged Archive Retrieval
You can initiate an archive retrieval for the whole archive or a range
of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.
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, go to Initiate a Job (http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html) and Downloading a Vault Inventory (http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
PolicyEnforcedException Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.InitiateJobInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required JobParameters: &glacier.JobParameters{ ArchiveId: aws.String("string"), Description: aws.String("string"), Format: aws.String("string"), InventoryRetrievalParameters: &glacier.InventoryRetrievalJobInput{ EndDate: aws.String("string"), Limit: aws.String("string"), Marker: aws.String("string"), StartDate: aws.String("string"), }, RetrievalByteRange: aws.String("string"), SNSTopic: aws.String("string"), Type: aws.String("string"), }, } resp, err := svc.InitiateJob(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See InitiateJob for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the InitiateJob method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.InitiateMultipartUploadInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required ArchiveDescription: aws.String("string"), PartSize: aws.String("string"), } resp, err := svc.InitiateMultipartUpload(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See InitiateMultipartUpload for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the InitiateMultipartUpload method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) InitiateVaultLock ¶ added in v0.6.8
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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.InitiateVaultLockInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Policy: &glacier.VaultLockPolicy{ Policy: aws.String("string"), }, } resp, err := svc.InitiateVaultLock(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) InitiateVaultLockRequest ¶ added in v0.6.8
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 can be used to capture response data after the request's "Send" method is called.
See InitiateVaultLock for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the InitiateVaultLock method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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.
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.
To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.
This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs 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 jobs that begins at a specific job, set the marker request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the limit parameter in the request.
Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.
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 the underlying REST API, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.ListJobsInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Completed: aws.String("string"), Limit: aws.String("string"), Marker: aws.String("string"), Statuscode: aws.String("string"), } resp, err := svc.ListJobs(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) ListJobsPages ¶
func (c *Glacier) ListJobsPages(input *ListJobsInput, fn func(p *ListJobsOutput, lastPage bool) (shouldContinue 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) 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 can be used to capture response data after the request's "Send" method is called.
See ListJobs for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListJobs method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.ListMultipartUploadsInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Limit: aws.String("string"), Marker: aws.String("string"), } resp, err := svc.ListMultipartUploads(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) ListMultipartUploadsPages ¶
func (c *Glacier) ListMultipartUploadsPages(input *ListMultipartUploadsInput, fn func(p *ListMultipartUploadsOutput, lastPage bool) (shouldContinue 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) 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 can be used to capture response data after the request's "Send" method is called.
See ListMultipartUploads for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListMultipartUploads method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.ListPartsInput{ AccountId: aws.String("string"), // Required UploadId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Limit: aws.String("string"), Marker: aws.String("string"), } resp, err := svc.ListParts(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) ListPartsPages ¶
func (c *Glacier) ListPartsPages(input *ListPartsInput, fn func(p *ListPartsOutput, lastPage bool) (shouldContinue 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) 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 can be used to capture response data after the request's "Send" method is called.
See ListParts for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListParts method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) ListTagsForVault ¶ added in v0.6.5
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:
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.ListTagsForVaultInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required } resp, err := svc.ListTagsForVault(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) ListTagsForVaultRequest ¶ added in v0.6.5
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 can be used to capture response data after the request's "Send" method is called.
See ListTagsForVault for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTagsForVault method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.ListVaultsInput{ AccountId: aws.String("string"), // Required Limit: aws.String("string"), Marker: aws.String("string"), } resp, err := svc.ListVaults(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) ListVaultsPages ¶
func (c *Glacier) ListVaultsPages(input *ListVaultsInput, fn func(p *ListVaultsOutput, lastPage bool) (shouldContinue 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) 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 can be used to capture response data after the request's "Send" method is called.
See ListVaults for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListVaults method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) RemoveTagsFromVault ¶ added in v0.6.5
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:
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.RemoveTagsFromVaultInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required TagKeys: []*string{ aws.String("string"), // Required // More values... }, } resp, err := svc.RemoveTagsFromVault(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*Glacier) RemoveTagsFromVaultRequest ¶ added in v0.6.5
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 can be used to capture response data after the request's "Send" method is called.
See RemoveTagsFromVault for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveTagsFromVault method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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:
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.SetDataRetrievalPolicyInput{ AccountId: aws.String("string"), // Required Policy: &glacier.DataRetrievalPolicy{ Rules: []*glacier.DataRetrievalRule{ { // Required BytesPerHour: aws.Int64(1), Strategy: aws.String("string"), }, // More values... }, }, } resp, err := svc.SetDataRetrievalPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See SetDataRetrievalPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetDataRetrievalPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.SetVaultAccessPolicyInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Policy: &glacier.VaultAccessPolicy{ Policy: aws.String("string"), }, } resp, err := svc.SetVaultAccessPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See SetVaultAccessPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetVaultAccessPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.SetVaultNotificationsInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required VaultNotificationConfig: &glacier.VaultNotificationConfig{ Events: []*string{ aws.String("string"), // Required // More values... }, SNSTopic: aws.String("string"), }, } resp, err := svc.SetVaultNotifications(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See SetVaultNotifications for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetVaultNotifications method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
RequestTimeoutException Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "bytes" "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.UploadArchiveInput{ AccountId: aws.String("string"), // Required VaultName: aws.String("string"), // Required ArchiveDescription: aws.String("string"), Body: bytes.NewReader([]byte("PAYLOAD")), Checksum: aws.String("string"), } resp, err := svc.UploadArchive(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See UploadArchive for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UploadArchive method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) 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, go to 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:
ResourceNotFoundException Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException Returned if a required header or parameter is missing from the request.
RequestTimeoutException Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
ServiceUnavailableException Returned if the service cannot complete the request.
Example ¶
package main import ( "bytes" "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := glacier.New(sess) params := &glacier.UploadMultipartPartInput{ AccountId: aws.String("string"), // Required UploadId: aws.String("string"), // Required VaultName: aws.String("string"), // Required Body: bytes.NewReader([]byte("PAYLOAD")), Checksum: aws.String("string"), Range: aws.String("string"), } resp, err := svc.UploadMultipartPart(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
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 can be used to capture response data after the request's "Send" method is called.
See UploadMultipartPart for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UploadMultipartPart method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) WaitUntilVaultExists ¶ added in v0.10.3
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 meet within the max attempt window an error will be returned.
func (*Glacier) WaitUntilVaultNotExists ¶ added in v0.10.3
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 meet within the max attempt window an error will be returned.
type Hash ¶
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.
Example ¶
package main import ( "bytes" "fmt" "github.com/aws/aws-sdk-go/service/glacier" ) func main() { buf := make([]byte, 5767168) // 5.5MB buffer for i := range buf { buf[i] = '0' // Fill with zero characters } r := bytes.NewReader(buf) 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) }
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 apos-apos // (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 (apos-apos) 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.5
func (s InitiateJobInput) GoString() string
GoString returns the string representation
func (InitiateJobInput) String ¶ added in v0.6.5
func (s InitiateJobInput) String() string
String returns the string representation
func (*InitiateJobInput) Validate ¶ added in v1.1.21
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 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.5
func (s InitiateJobOutput) GoString() string
GoString returns the string representation
func (InitiateJobOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s InitiateMultipartUploadInput) GoString() string
GoString returns the string representation
func (InitiateMultipartUploadInput) String ¶ added in v0.6.5
func (s InitiateMultipartUploadInput) String() string
String returns the string representation
func (*InitiateMultipartUploadInput) Validate ¶ added in v1.1.21
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.5
func (s InitiateMultipartUploadOutput) GoString() string
GoString returns the string representation
func (InitiateMultipartUploadOutput) String ¶ added in v0.6.5
func (s InitiateMultipartUploadOutput) String() string
String returns the string representation
type InitiateVaultLockInput ¶ added in v0.6.8
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 apos-apos (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 (apos-apos) 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.6.8
func (s InitiateVaultLockInput) GoString() string
GoString returns the string representation
func (InitiateVaultLockInput) String ¶ added in v0.6.8
func (s InitiateVaultLockInput) String() string
String returns the string representation
func (*InitiateVaultLockInput) Validate ¶ added in v1.1.21
func (s *InitiateVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InitiateVaultLockOutput ¶ added in v0.6.8
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.6.8
func (s InitiateVaultLockOutput) GoString() string
GoString returns the string representation
func (InitiateVaultLockOutput) String ¶ added in v0.6.8
func (s InitiateVaultLockOutput) 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. A string representation of 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"` // Specifies 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 UTC for vault inventory retrieval that includes // archives created on or after this date. A string representation of 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.5
func (s InventoryRetrievalJobDescription) GoString() string
GoString returns the string representation
func (InventoryRetrievalJobDescription) String ¶ added in v0.6.5
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. A string representation of 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. A string representation of 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.5
func (s InventoryRetrievalJobInput) GoString() string
GoString returns the string representation
func (InventoryRetrievalJobInput) String ¶ added in v0.6.5
func (s InventoryRetrievalJobInput) String() string
String returns the string representation
type JobDescription ¶
type JobDescription struct { // The job type. It is either ArchiveRetrieval or InventoryRetrieval. Action *string `type:"string" enum:"ActionCode"` // For an ArchiveRetrieval job, this is the archive ID requested for download. // Otherwise, this field is null. ArchiveId *string `type:"string"` // The SHA256 tree hash of the entire archive for an archive retrieval. For // inventory retrieval jobs, this field is null. ArchiveSHA256TreeHash *string `type:"string"` // For an ArchiveRetrieval job, this is the size in bytes of the archive being // requested for download. For the InventoryRetrieval job, the value is null. ArchiveSizeInBytes *int64 `type:"long"` // The job status. When a job is completed, you get the job's output. Completed *bool `type:"boolean"` // The UTC time that the archive retrieval request completed. While the job // is in progress, the value will be null. CompletionDate *string `type:"string"` // The UTC date when the job was created. 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 InventoryRetrieval job, this is the size in bytes of the inventory // requested for download. For the ArchiveRetrieval job, the value is null. InventorySizeInBytes *int64 `type:"long"` // The job description you provided when you initiated the job. JobDescription *string `type:"string"` // An opaque string that identifies an Amazon Glacier job. JobId *string `type:"string"` // The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" // If no range was specified in the archive retrieval, then the whole archive // is retrieved and StartByteValue equals 0 and EndByteValue equals the size // of the archive minus 1. For inventory retrieval jobs this field is null. RetrievalByteRange *string `type:"string"` // For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, // the value is null. // // The SHA256 tree hash value for the requested range of an archive. If the // Initiate a Job request for an archive specified a tree-hash aligned range, // then this field returns a value. // // For the specific case when the whole archive is retrieved, this value is // the same as the ArchiveSHA256TreeHash value. // // This field is null in the following situations: 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 // and the job status is InProgress. // // Inventory jobs. SHA256TreeHash *string `type:"string"` // An Amazon Simple Notification Service (Amazon SNS) topic that receives notification. SNSTopic *string `type:"string"` // 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 Amazon Resource Name (ARN) of the vault from which the archive retrieval // was requested. VaultARN *string `type:"string"` // contains filtered or unexported fields }
Describes an Amazon Glacier job.
func (JobDescription) GoString ¶ added in v0.6.5
func (s JobDescription) GoString() string
GoString returns the string representation
func (JobDescription) String ¶ added in v0.6.5
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 archive-retrieval. 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"` // 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"` // The job type. You can initiate a job to retrieve an archive or get an inventory // of a vault. Valid values are "archive-retrieval" and "inventory-retrieval". Type *string `type:"string"` // contains filtered or unexported fields }
Provides options for defining a job.
func (JobParameters) GoString ¶ added in v0.6.5
func (s JobParameters) GoString() string
GoString returns the string representation
func (JobParameters) String ¶ added in v0.6.5
func (s JobParameters) String() string
String returns the string representation
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 apos-apos // (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 (apos-apos) in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // Specifies the state of the jobs to return. You can specify true or false. Completed *string `location:"querystring" locationName:"completed" type:"string"` // Specifies that the response be limited to the specified number of items or // fewer. If not specified, the List Jobs operation returns up to 1,000 jobs. 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 need only 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"` // Specifies 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.5
func (s ListJobsInput) GoString() string
GoString returns the string representation
func (ListJobsInput) String ¶ added in v0.6.5
func (s ListJobsInput) String() string
String returns the string representation
func (*ListJobsInput) Validate ¶ added in v1.1.21
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 that represents where to continue pagination of the results. // You use this value in a new List Jobs request to obtain more jobs in the // list. If there are no more jobs, this value is null. Marker *string `type:"string"` // contains filtered or unexported fields }
Contains the Amazon Glacier response to your request.
func (ListJobsOutput) GoString ¶ added in v0.6.5
func (s ListJobsOutput) GoString() string
GoString returns the string representation
func (ListJobsOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s ListMultipartUploadsInput) GoString() string
GoString returns the string representation
func (ListMultipartUploadsInput) String ¶ added in v0.6.5
func (s ListMultipartUploadsInput) String() string
String returns the string representation
func (*ListMultipartUploadsInput) Validate ¶ added in v1.1.21
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.5
func (s ListMultipartUploadsOutput) GoString() string
GoString returns the string representation
func (ListMultipartUploadsOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // Specifies the maximum number of parts returned in the response body. If this // value is not specified, the List Parts 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 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.5
func (s ListPartsInput) GoString() string
GoString returns the string representation
func (ListPartsInput) String ¶ added in v0.6.5
func (s ListPartsInput) String() string
String returns the string representation
func (*ListPartsInput) Validate ¶ added in v1.1.21
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. PartSizeInBytes *int64 `type:"long"` // A list of the part sizes of the multipart upload. 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.5
func (s ListPartsOutput) GoString() string
GoString returns the string representation
func (ListPartsOutput) String ¶ added in v0.6.5
func (s ListPartsOutput) String() string
String returns the string representation
type ListTagsForVaultInput ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s ListTagsForVaultInput) GoString() string
GoString returns the string representation
func (ListTagsForVaultInput) String ¶ added in v0.6.5
func (s ListTagsForVaultInput) String() string
String returns the string representation
func (*ListTagsForVaultInput) Validate ¶ added in v1.1.21
func (s *ListTagsForVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForVaultOutput ¶ added in v0.6.5
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.5
func (s ListTagsForVaultOutput) GoString() string
GoString returns the string representation
func (ListTagsForVaultOutput) String ¶ added in v0.6.5
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 apos-apos (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 (apos-apos) in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The maximum number of items returned in the response. If you don't specify // a value, the List Vaults operation returns up to 1,000 items. 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.5
func (s ListVaultsInput) GoString() string
GoString returns the string representation
func (ListVaultsInput) String ¶ added in v0.6.5
func (s ListVaultsInput) String() string
String returns the string representation
func (*ListVaultsInput) Validate ¶ added in v1.1.21
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.5
func (s ListVaultsOutput) GoString() string
GoString returns the string representation
func (ListVaultsOutput) String ¶ added in v0.6.5
func (s ListVaultsOutput) 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.5
func (s PartListElement) GoString() string
GoString returns the string representation
func (PartListElement) String ¶ added in v0.6.5
func (s PartListElement) String() string
String returns the string representation
type RemoveTagsFromVaultInput ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s RemoveTagsFromVaultInput) GoString() string
GoString returns the string representation
func (RemoveTagsFromVaultInput) String ¶ added in v0.6.5
func (s RemoveTagsFromVaultInput) String() string
String returns the string representation
func (*RemoveTagsFromVaultInput) Validate ¶ added in v1.1.21
func (s *RemoveTagsFromVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveTagsFromVaultOutput ¶ added in v0.6.5
type RemoveTagsFromVaultOutput struct {
// contains filtered or unexported fields
}
func (RemoveTagsFromVaultOutput) GoString ¶ added in v0.6.5
func (s RemoveTagsFromVaultOutput) GoString() string
GoString returns the string representation
func (RemoveTagsFromVaultOutput) String ¶ added in v0.6.5
func (s RemoveTagsFromVaultOutput) 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 apos-apos (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 (apos-apos) 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.5
func (s SetDataRetrievalPolicyInput) GoString() string
GoString returns the string representation
func (SetDataRetrievalPolicyInput) String ¶ added in v0.6.5
func (s SetDataRetrievalPolicyInput) String() string
String returns the string representation
func (*SetDataRetrievalPolicyInput) Validate ¶ added in v1.1.21
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.5
func (s SetDataRetrievalPolicyOutput) GoString() string
GoString returns the string representation
func (SetDataRetrievalPolicyOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s SetVaultAccessPolicyInput) GoString() string
GoString returns the string representation
func (SetVaultAccessPolicyInput) String ¶ added in v0.6.5
func (s SetVaultAccessPolicyInput) String() string
String returns the string representation
func (*SetVaultAccessPolicyInput) Validate ¶ added in v1.1.21
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.5
func (s SetVaultAccessPolicyOutput) GoString() string
GoString returns the string representation
func (SetVaultAccessPolicyOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s SetVaultNotificationsInput) GoString() string
GoString returns the string representation
func (SetVaultNotificationsInput) String ¶ added in v0.6.5
func (s SetVaultNotificationsInput) String() string
String returns the string representation
func (*SetVaultNotificationsInput) Validate ¶ added in v1.1.21
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.5
func (s SetVaultNotificationsOutput) GoString() string
GoString returns the string representation
func (SetVaultNotificationsOutput) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s UploadArchiveInput) GoString() string
GoString returns the string representation
func (UploadArchiveInput) String ¶ added in v0.6.5
func (s UploadArchiveInput) String() string
String returns the string representation
func (*UploadArchiveInput) Validate ¶ added in v1.1.21
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.5
func (s UploadListElement) GoString() string
GoString returns the string representation
func (UploadListElement) String ¶ added in v0.6.5
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 apos-apos // (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 (apos-apos) 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.5
func (s UploadMultipartPartInput) GoString() string
GoString returns the string representation
func (UploadMultipartPartInput) String ¶ added in v0.6.5
func (s UploadMultipartPartInput) String() string
String returns the string representation
func (*UploadMultipartPartInput) Validate ¶ added in v1.1.21
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.5
func (s UploadMultipartPartOutput) GoString() string
GoString returns the string representation
func (UploadMultipartPartOutput) String ¶ added in v0.6.5
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.5
func (s VaultAccessPolicy) GoString() string
GoString returns the string representation
func (VaultAccessPolicy) String ¶ added in v0.6.5
func (s VaultAccessPolicy) String() string
String returns the string representation
type VaultLockPolicy ¶ added in v0.6.8
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.6.8
func (s VaultLockPolicy) GoString() string
GoString returns the string representation
func (VaultLockPolicy) String ¶ added in v0.6.8
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.5
func (s VaultNotificationConfig) GoString() string
GoString returns the string representation
func (VaultNotificationConfig) String ¶ added in v0.6.5
func (s VaultNotificationConfig) String() string
String returns the string representation
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. |