Documentation ¶
Overview ¶
Package glacier provides the client and types for making API requests to Amazon Glacier.
Amazon S3 Glacier (Glacier) is a storage solution for "cold data."
Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. 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.
Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3) (http://aws.amazon.com/s3/).
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Glacier.
If you are a first-time user of Glacier, we recommend that you begin by reading the following sections in the Amazon S3 Glacier Developer Guide:
What is Amazon S3 Glacier (https://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 S3 Glacier (https://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.
See glacier package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/glacier/
Using the Client ¶
To use Amazon Glacier with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Glacier client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/glacier/#New
Index ¶
- Constants
- func ComputeTreeHash(hashes [][]byte) []byte
- type AbortMultipartUploadInput
- type AbortMultipartUploadOutput
- type AbortMultipartUploadRequest
- type AbortMultipartUploadResponse
- type AbortVaultLockInput
- type AbortVaultLockOutput
- type AbortVaultLockRequest
- type AbortVaultLockResponse
- type ActionCode
- type AddTagsToVaultInput
- type AddTagsToVaultOutput
- type AddTagsToVaultRequest
- type AddTagsToVaultResponse
- type CSVInput
- type CSVOutput
- type CannedACL
- type Client
- func (c *Client) AbortMultipartUploadRequest(input *AbortMultipartUploadInput) AbortMultipartUploadRequest
- func (c *Client) AbortVaultLockRequest(input *AbortVaultLockInput) AbortVaultLockRequest
- func (c *Client) AddTagsToVaultRequest(input *AddTagsToVaultInput) AddTagsToVaultRequest
- func (c *Client) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) CompleteMultipartUploadRequest
- func (c *Client) CompleteVaultLockRequest(input *CompleteVaultLockInput) CompleteVaultLockRequest
- func (c *Client) CreateVaultRequest(input *CreateVaultInput) CreateVaultRequest
- func (c *Client) DeleteArchiveRequest(input *DeleteArchiveInput) DeleteArchiveRequest
- func (c *Client) DeleteVaultAccessPolicyRequest(input *DeleteVaultAccessPolicyInput) DeleteVaultAccessPolicyRequest
- func (c *Client) DeleteVaultNotificationsRequest(input *DeleteVaultNotificationsInput) DeleteVaultNotificationsRequest
- func (c *Client) DeleteVaultRequest(input *DeleteVaultInput) DeleteVaultRequest
- func (c *Client) DescribeJobRequest(input *DescribeJobInput) DescribeJobRequest
- func (c *Client) DescribeVaultRequest(input *DescribeVaultInput) DescribeVaultRequest
- func (c *Client) GetDataRetrievalPolicyRequest(input *GetDataRetrievalPolicyInput) GetDataRetrievalPolicyRequest
- func (c *Client) GetJobOutputRequest(input *GetJobOutputInput) GetJobOutputRequest
- func (c *Client) GetVaultAccessPolicyRequest(input *GetVaultAccessPolicyInput) GetVaultAccessPolicyRequest
- func (c *Client) GetVaultLockRequest(input *GetVaultLockInput) GetVaultLockRequest
- func (c *Client) GetVaultNotificationsRequest(input *GetVaultNotificationsInput) GetVaultNotificationsRequest
- func (c *Client) InitiateJobRequest(input *InitiateJobInput) InitiateJobRequest
- func (c *Client) InitiateMultipartUploadRequest(input *InitiateMultipartUploadInput) InitiateMultipartUploadRequest
- func (c *Client) InitiateVaultLockRequest(input *InitiateVaultLockInput) InitiateVaultLockRequest
- func (c *Client) ListJobsRequest(input *ListJobsInput) ListJobsRequest
- func (c *Client) ListMultipartUploadsRequest(input *ListMultipartUploadsInput) ListMultipartUploadsRequest
- func (c *Client) ListPartsRequest(input *ListPartsInput) ListPartsRequest
- func (c *Client) ListProvisionedCapacityRequest(input *ListProvisionedCapacityInput) ListProvisionedCapacityRequest
- func (c *Client) ListTagsForVaultRequest(input *ListTagsForVaultInput) ListTagsForVaultRequest
- func (c *Client) ListVaultsRequest(input *ListVaultsInput) ListVaultsRequest
- func (c *Client) PurchaseProvisionedCapacityRequest(input *PurchaseProvisionedCapacityInput) PurchaseProvisionedCapacityRequest
- func (c *Client) RemoveTagsFromVaultRequest(input *RemoveTagsFromVaultInput) RemoveTagsFromVaultRequest
- func (c *Client) SetDataRetrievalPolicyRequest(input *SetDataRetrievalPolicyInput) SetDataRetrievalPolicyRequest
- func (c *Client) SetVaultAccessPolicyRequest(input *SetVaultAccessPolicyInput) SetVaultAccessPolicyRequest
- func (c *Client) SetVaultNotificationsRequest(input *SetVaultNotificationsInput) SetVaultNotificationsRequest
- func (c *Client) UploadArchiveRequest(input *UploadArchiveInput) UploadArchiveRequest
- func (c *Client) UploadMultipartPartRequest(input *UploadMultipartPartInput) UploadMultipartPartRequest
- func (c *Client) WaitUntilVaultExists(ctx context.Context, input *DescribeVaultInput, opts ...aws.WaiterOption) error
- func (c *Client) WaitUntilVaultNotExists(ctx context.Context, input *DescribeVaultInput, opts ...aws.WaiterOption) error
- type CompleteMultipartUploadInput
- type CompleteMultipartUploadOutput
- type CompleteMultipartUploadRequest
- type CompleteMultipartUploadResponse
- type CompleteVaultLockInput
- type CompleteVaultLockOutput
- type CompleteVaultLockRequest
- type CompleteVaultLockResponse
- type CreateVaultInput
- type CreateVaultOutput
- type CreateVaultRequest
- type CreateVaultResponse
- type DataRetrievalPolicy
- type DataRetrievalRule
- type DeleteArchiveInput
- type DeleteArchiveOutput
- type DeleteArchiveRequest
- type DeleteArchiveResponse
- type DeleteVaultAccessPolicyInput
- type DeleteVaultAccessPolicyOutput
- type DeleteVaultAccessPolicyRequest
- type DeleteVaultAccessPolicyResponse
- type DeleteVaultInput
- type DeleteVaultNotificationsInput
- type DeleteVaultNotificationsOutput
- type DeleteVaultNotificationsRequest
- type DeleteVaultNotificationsResponse
- type DeleteVaultOutput
- type DeleteVaultRequest
- type DeleteVaultResponse
- type DescribeJobInput
- type DescribeJobOutput
- type DescribeJobRequest
- type DescribeJobResponse
- type DescribeVaultInput
- type DescribeVaultOutput
- type DescribeVaultRequest
- type DescribeVaultResponse
- type Encryption
- type EncryptionType
- type ExpressionType
- type FileHeaderInfo
- type GetDataRetrievalPolicyInput
- type GetDataRetrievalPolicyOutput
- type GetDataRetrievalPolicyRequest
- type GetDataRetrievalPolicyResponse
- type GetJobOutputInput
- type GetJobOutputOutput
- type GetJobOutputRequest
- type GetJobOutputResponse
- type GetVaultAccessPolicyInput
- type GetVaultAccessPolicyOutput
- type GetVaultAccessPolicyRequest
- type GetVaultAccessPolicyResponse
- type GetVaultLockInput
- type GetVaultLockOutput
- type GetVaultLockRequest
- type GetVaultLockResponse
- type GetVaultNotificationsInput
- type GetVaultNotificationsOutput
- type GetVaultNotificationsRequest
- type GetVaultNotificationsResponse
- type GlacierJobDescription
- type Grant
- type Grantee
- type Hash
- type InitiateJobInput
- type InitiateJobOutput
- type InitiateJobRequest
- type InitiateJobResponse
- type InitiateMultipartUploadInput
- type InitiateMultipartUploadOutput
- type InitiateMultipartUploadRequest
- type InitiateMultipartUploadResponse
- type InitiateVaultLockInput
- type InitiateVaultLockOutput
- type InitiateVaultLockRequest
- type InitiateVaultLockResponse
- type InputSerialization
- type InventoryRetrievalJobDescription
- type InventoryRetrievalJobInput
- type JobParameters
- type ListJobsInput
- type ListJobsOutput
- type ListJobsPaginator
- type ListJobsRequest
- type ListJobsResponse
- type ListMultipartUploadsInput
- type ListMultipartUploadsOutput
- type ListMultipartUploadsPaginator
- type ListMultipartUploadsRequest
- type ListMultipartUploadsResponse
- type ListPartsInput
- type ListPartsOutput
- type ListPartsPaginator
- type ListPartsRequest
- type ListPartsResponse
- type ListProvisionedCapacityInput
- type ListProvisionedCapacityOutput
- type ListProvisionedCapacityRequest
- type ListProvisionedCapacityResponse
- type ListTagsForVaultInput
- type ListTagsForVaultOutput
- type ListTagsForVaultRequest
- type ListTagsForVaultResponse
- type ListVaultsInput
- type ListVaultsOutput
- type ListVaultsPaginator
- type ListVaultsRequest
- type ListVaultsResponse
- type OutputLocation
- type OutputSerialization
- type PartListElement
- type Permission
- type ProvisionedCapacityDescription
- type PurchaseProvisionedCapacityInput
- type PurchaseProvisionedCapacityOutput
- type PurchaseProvisionedCapacityRequest
- type PurchaseProvisionedCapacityResponse
- type QuoteFields
- type RemoveTagsFromVaultInput
- type RemoveTagsFromVaultOutput
- type RemoveTagsFromVaultRequest
- type RemoveTagsFromVaultResponse
- type S3Location
- type SelectParameters
- type SetDataRetrievalPolicyInput
- type SetDataRetrievalPolicyOutput
- type SetDataRetrievalPolicyRequest
- type SetDataRetrievalPolicyResponse
- type SetVaultAccessPolicyInput
- type SetVaultAccessPolicyOutput
- type SetVaultAccessPolicyRequest
- type SetVaultAccessPolicyResponse
- type SetVaultNotificationsInput
- type SetVaultNotificationsOutput
- type SetVaultNotificationsRequest
- type SetVaultNotificationsResponse
- type StatusCode
- type StorageClass
- type Type
- type UploadArchiveInput
- type UploadArchiveOutput
- type UploadArchiveRequest
- type UploadArchiveResponse
- type UploadListElement
- type UploadMultipartPartInput
- type UploadMultipartPartOutput
- type UploadMultipartPartRequest
- type UploadMultipartPartResponse
- type VaultAccessPolicy
- type VaultLockPolicy
- type VaultNotificationConfig
Examples ¶
- Client.AbortMultipartUploadRequest (Shared00)
- Client.AbortVaultLockRequest (Shared00)
- Client.AddTagsToVaultRequest (Shared00)
- Client.CompleteMultipartUploadRequest (Shared00)
- Client.CompleteVaultLockRequest (Shared00)
- Client.CreateVaultRequest (Shared00)
- Client.DeleteArchiveRequest (Shared00)
- Client.DeleteVaultAccessPolicyRequest (Shared00)
- Client.DeleteVaultNotificationsRequest (Shared00)
- Client.DeleteVaultRequest (Shared00)
- Client.DescribeJobRequest (Shared00)
- Client.DescribeVaultRequest (Shared00)
- Client.GetDataRetrievalPolicyRequest (Shared00)
- Client.GetJobOutputRequest (Shared00)
- Client.GetVaultAccessPolicyRequest (Shared00)
- Client.GetVaultLockRequest (Shared00)
- Client.GetVaultNotificationsRequest (Shared00)
- Client.InitiateJobRequest (Shared00)
- Client.InitiateMultipartUploadRequest (Shared00)
- Client.InitiateVaultLockRequest (Shared00)
- Client.ListJobsRequest (Shared00)
- Client.ListMultipartUploadsRequest (Shared00)
- Client.ListPartsRequest (Shared00)
- Client.ListProvisionedCapacityRequest (Shared00)
- Client.ListTagsForVaultRequest (Shared00)
- Client.ListVaultsRequest (Shared00)
- Client.PurchaseProvisionedCapacityRequest (Shared00)
- Client.RemoveTagsFromVaultRequest (Shared00)
- Client.SetDataRetrievalPolicyRequest (Shared00)
- Client.SetVaultAccessPolicyRequest (Shared00)
- Client.SetVaultNotificationsRequest (Shared00)
- Client.UploadArchiveRequest (Shared00)
- Client.UploadMultipartPartRequest (Shared00)
- ComputeHashes
- ComputeTreeHash
Constants ¶
const ( ServiceName = "Amazon Glacier" // Service's name ServiceID = "Glacier" // Service's identifier EndpointsID = "glacier" // Service's Endpoint identifier )
const ( // ErrCodeInsufficientCapacityException for service response error code // "InsufficientCapacityException". // // Returned if there is insufficient capacity to process this expedited request. // This error only applies to expedited retrievals and not to standard or bulk // retrievals. ErrCodeInsufficientCapacityException = "InsufficientCapacityException" // ErrCodeInvalidParameterValueException for service response error code // "InvalidParameterValueException". // // Returned if a parameter of the request is incorrectly specified. ErrCodeInvalidParameterValueException = "InvalidParameterValueException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // Returned if the request results in a vault or account limit being exceeded. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeMissingParameterValueException for service response error code // "MissingParameterValueException". // // Returned if a required header or parameter is missing from the request. ErrCodeMissingParameterValueException = "MissingParameterValueException" // ErrCodePolicyEnforcedException for service response error code // "PolicyEnforcedException". // // Returned if a retrieval job would exceed the current data policy's retrieval // rate limit. For more information about data retrieval policies, ErrCodePolicyEnforcedException = "PolicyEnforcedException" // ErrCodeRequestTimeoutException for service response error code // "RequestTimeoutException". // // Returned if, when uploading an archive, Amazon S3 Glacier times out while // receiving the upload. ErrCodeRequestTimeoutException = "RequestTimeoutException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // Returned if the specified resource (such as a vault, upload ID, or job ID) // doesn't exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // "ServiceUnavailableException". // // Returned if the service cannot complete the request. ErrCodeServiceUnavailableException = "ServiceUnavailableException" )
Variables ¶
This section is empty.
Functions ¶
func ComputeTreeHash ¶
ComputeTreeHash builds a tree hash root node given a slice of hashes. Glacier tree hash to be derived from SHA256 hashes of 1MB chucks of the data.
See http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html for more information.
Example ¶
package main import ( "bytes" "crypto/sha256" "fmt" "io" "github.com/aws/aws-sdk-go-v2/service/glacier" ) func testCreateReader() io.ReadSeeker { buf := make([]byte, 5767168) for i := range buf { buf[i] = '0' } return bytes.NewReader(buf) } func main() { r := testCreateReader() const chunkSize = 1024 * 1024 // 1MB buf := make([]byte, chunkSize) hashes := [][]byte{} for { // Reach 1MB chunks from reader to generate hashes from n, err := io.ReadAtLeast(r, buf, chunkSize) if n == 0 { break } tmpHash := sha256.Sum256(buf[:n]) hashes = append(hashes, tmpHash[:]) if err != nil { break // last chunk } } treeHash := glacier.ComputeTreeHash(hashes) fmt.Printf("TreeHash: %x\n", treeHash) }
Output: TreeHash: 154e26c78fd74d0c2c9b3cc4644191619dc4f2cd539ae2a74d5fd07957a3ee6a
Types ¶
type AbortMultipartUploadInput ¶
type AbortMultipartUploadInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The upload ID of the multipart upload to delete. // // UploadId is a required field UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options to abort a multipart upload identified by the upload ID.
For information about the underlying REST API, see Abort Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html). For conceptual information, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html).
func (AbortMultipartUploadInput) MarshalFields ¶ added in v0.3.0
func (s AbortMultipartUploadInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AbortMultipartUploadInput) String ¶
func (s AbortMultipartUploadInput) String() string
String returns the string representation
func (*AbortMultipartUploadInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s AbortMultipartUploadOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AbortMultipartUploadOutput) String ¶
func (s AbortMultipartUploadOutput) String() string
String returns the string representation
type AbortMultipartUploadRequest ¶
type AbortMultipartUploadRequest struct { *aws.Request Input *AbortMultipartUploadInput Copy func(*AbortMultipartUploadInput) AbortMultipartUploadRequest }
AbortMultipartUploadRequest is the request type for the AbortMultipartUpload API operation.
func (AbortMultipartUploadRequest) Send ¶
func (r AbortMultipartUploadRequest) Send(ctx context.Context) (*AbortMultipartUploadResponse, error)
Send marshals and sends the AbortMultipartUpload API request.
type AbortMultipartUploadResponse ¶ added in v0.9.0
type AbortMultipartUploadResponse struct { *AbortMultipartUploadOutput // contains filtered or unexported fields }
AbortMultipartUploadResponse is the response type for the AbortMultipartUpload API operation.
func (*AbortMultipartUploadResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AbortMultipartUploadResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AbortMultipartUpload request.
type AbortVaultLockInput ¶
type AbortVaultLockInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input values for AbortVaultLock.
func (AbortVaultLockInput) MarshalFields ¶ added in v0.3.0
func (s AbortVaultLockInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AbortVaultLockInput) String ¶
func (s AbortVaultLockInput) String() string
String returns the string representation
func (*AbortVaultLockInput) Validate ¶
func (s *AbortVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AbortVaultLockOutput ¶
type AbortVaultLockOutput struct {
// contains filtered or unexported fields
}
func (AbortVaultLockOutput) MarshalFields ¶ added in v0.3.0
func (s AbortVaultLockOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AbortVaultLockOutput) String ¶
func (s AbortVaultLockOutput) String() string
String returns the string representation
type AbortVaultLockRequest ¶
type AbortVaultLockRequest struct { *aws.Request Input *AbortVaultLockInput Copy func(*AbortVaultLockInput) AbortVaultLockRequest }
AbortVaultLockRequest is the request type for the AbortVaultLock API operation.
func (AbortVaultLockRequest) Send ¶
func (r AbortVaultLockRequest) Send(ctx context.Context) (*AbortVaultLockResponse, error)
Send marshals and sends the AbortVaultLock API request.
type AbortVaultLockResponse ¶ added in v0.9.0
type AbortVaultLockResponse struct { *AbortVaultLockOutput // contains filtered or unexported fields }
AbortVaultLockResponse is the response type for the AbortVaultLock API operation.
func (*AbortVaultLockResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AbortVaultLockResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AbortVaultLock request.
type ActionCode ¶
type ActionCode string
const ( ActionCodeArchiveRetrieval ActionCode = "ArchiveRetrieval" ActionCodeInventoryRetrieval ActionCode = "InventoryRetrieval" ActionCodeSelect ActionCode = "Select" )
Enum values for ActionCode
func (ActionCode) MarshalValue ¶ added in v0.3.0
func (enum ActionCode) MarshalValue() (string, error)
func (ActionCode) MarshalValueBuf ¶ added in v0.3.0
func (enum ActionCode) MarshalValueBuf(b []byte) ([]byte, error)
type AddTagsToVaultInput ¶
type AddTagsToVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The tags to add to the vault. Each tag is composed of a key and a value. // The value can be an empty string. Tags map[string]string `type:"map"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input values for AddTagsToVault.
func (AddTagsToVaultInput) MarshalFields ¶ added in v0.3.0
func (s AddTagsToVaultInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AddTagsToVaultInput) String ¶
func (s AddTagsToVaultInput) String() string
String returns the string representation
func (*AddTagsToVaultInput) Validate ¶
func (s *AddTagsToVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddTagsToVaultOutput ¶
type AddTagsToVaultOutput struct {
// contains filtered or unexported fields
}
func (AddTagsToVaultOutput) MarshalFields ¶ added in v0.3.0
func (s AddTagsToVaultOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AddTagsToVaultOutput) String ¶
func (s AddTagsToVaultOutput) String() string
String returns the string representation
type AddTagsToVaultRequest ¶
type AddTagsToVaultRequest struct { *aws.Request Input *AddTagsToVaultInput Copy func(*AddTagsToVaultInput) AddTagsToVaultRequest }
AddTagsToVaultRequest is the request type for the AddTagsToVault API operation.
func (AddTagsToVaultRequest) Send ¶
func (r AddTagsToVaultRequest) Send(ctx context.Context) (*AddTagsToVaultResponse, error)
Send marshals and sends the AddTagsToVault API request.
type AddTagsToVaultResponse ¶ added in v0.9.0
type AddTagsToVaultResponse struct { *AddTagsToVaultOutput // contains filtered or unexported fields }
AddTagsToVaultResponse is the response type for the AddTagsToVault API operation.
func (*AddTagsToVaultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddTagsToVaultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddTagsToVault request.
type CSVInput ¶ added in v0.2.0
type CSVInput struct { // A single character used to indicate that a row should be ignored when the // character is present at the start of that row. Comments *string `type:"string"` // A value used to separate individual fields from each other within a record. FieldDelimiter *string `type:"string"` // Describes the first line of input. Valid values are None, Ignore, and Use. FileHeaderInfo FileHeaderInfo `type:"string" enum:"true"` // A value used as an escape character where the field delimiter is part of // the value. QuoteCharacter *string `type:"string"` // A single character used for escaping the quotation-mark character inside // an already escaped value. QuoteEscapeCharacter *string `type:"string"` // A value used to separate individual records from each other. RecordDelimiter *string `type:"string"` // contains filtered or unexported fields }
Contains information about the comma-separated value (CSV) file to select from.
func (CSVInput) MarshalFields ¶ added in v0.3.0
func (s CSVInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type CSVOutput ¶ added in v0.2.0
type CSVOutput struct { // A value used to separate individual fields from each other within a record. FieldDelimiter *string `type:"string"` // A value used as an escape character where the field delimiter is part of // the value. QuoteCharacter *string `type:"string"` // A single character used for escaping the quotation-mark character inside // an already escaped value. QuoteEscapeCharacter *string `type:"string"` // A value that indicates whether all output fields should be contained within // quotation marks. QuoteFields QuoteFields `type:"string" enum:"true"` // A value used to separate individual records from each other. RecordDelimiter *string `type:"string"` // contains filtered or unexported fields }
Contains information about the comma-separated value (CSV) file that the job results are stored in.
func (CSVOutput) MarshalFields ¶ added in v0.3.0
func (s CSVOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type CannedACL ¶ added in v0.2.0
type CannedACL string
const ( CannedACLPrivate CannedACL = "private" CannedACLPublicRead CannedACL = "public-read" CannedACLPublicReadWrite CannedACL = "public-read-write" CannedACLAwsExecRead CannedACL = "aws-exec-read" CannedACLAuthenticatedRead CannedACL = "authenticated-read" CannedACLBucketOwnerRead CannedACL = "bucket-owner-read" CannedACLBucketOwnerFullControl CannedACL = "bucket-owner-full-control" )
Enum values for CannedACL
func (CannedACL) MarshalValue ¶ added in v0.3.0
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Amazon Glacier. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := glacier.New(myConfig)
func (*Client) AbortMultipartUploadRequest ¶ added in v0.9.0
func (c *Client) AbortMultipartUploadRequest(input *AbortMultipartUploadInput) AbortMultipartUploadRequest
AbortMultipartUploadRequest returns a request value for making 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) and Abort Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html) in the Amazon Glacier Developer Guide.
// Example sending a request using AbortMultipartUploadRequest. req := client.AbortMultipartUploadRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) AbortVaultLockRequest ¶ added in v0.9.0
func (c *Client) AbortVaultLockRequest(input *AbortVaultLockInput) AbortVaultLockRequest
AbortVaultLockRequest returns a request value for making 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 (https://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 (https://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.
// Example sending a request using AbortVaultLockRequest. req := client.AbortVaultLockRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) AddTagsToVaultRequest ¶ added in v0.9.0
func (c *Client) AddTagsToVaultRequest(input *AddTagsToVaultInput) AddTagsToVaultRequest
AddTagsToVaultRequest returns a request value for making 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 S3 Glacier Resources (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html).
// Example sending a request using AddTagsToVaultRequest. req := client.AddTagsToVaultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CompleteMultipartUploadRequest ¶ added in v0.9.0
func (c *Client) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) CompleteMultipartUploadRequest
CompleteMultipartUploadRequest returns a request value for making API operation for Amazon Glacier.
You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, 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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html). On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, 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, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) and Complete Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html) in the Amazon Glacier Developer Guide.
// Example sending a request using CompleteMultipartUploadRequest. req := client.CompleteMultipartUploadRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CompleteVaultLockRequest ¶ added in v0.9.0
func (c *Client) CompleteVaultLockRequest(input *CompleteVaultLockInput) CompleteVaultLockRequest
CompleteVaultLockRequest returns a request value for making 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 (https://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.
// Example sending a request using CompleteVaultLockRequest. req := client.CompleteVaultLockRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) CreateVaultRequest ¶ added in v0.9.0
func (c *Client) CreateVaultRequest(input *CreateVaultInput) CreateVaultRequest
CreateVaultRequest returns a request value for making 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 S3 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html) and Create Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html) in the Amazon Glacier Developer Guide.
// Example sending a request using CreateVaultRequest. req := client.CreateVaultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteArchiveRequest ¶ added in v0.9.0
func (c *Client) DeleteArchiveRequest(input *DeleteArchiveInput) DeleteArchiveRequest
DeleteArchiveRequest returns a request value for making 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 S3 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 S3 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html) and Delete Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html) in the Amazon Glacier Developer Guide.
// Example sending a request using DeleteArchiveRequest. req := client.DeleteArchiveRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteVaultAccessPolicyRequest ¶ added in v0.9.0
func (c *Client) DeleteVaultAccessPolicyRequest(input *DeleteVaultAccessPolicyInput) DeleteVaultAccessPolicyRequest
DeleteVaultAccessPolicyRequest returns a request value for making 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 S3 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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html).
// Example sending a request using DeleteVaultAccessPolicyRequest. req := client.DeleteVaultAccessPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteVaultNotificationsRequest ¶ added in v0.9.0
func (c *Client) DeleteVaultNotificationsRequest(input *DeleteVaultNotificationsInput) DeleteVaultNotificationsRequest
DeleteVaultNotificationsRequest returns a request value for making 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 S3 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) and Delete Vault Notification Configuration (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html) in the Amazon S3 Glacier Developer Guide.
// Example sending a request using DeleteVaultNotificationsRequest. req := client.DeleteVaultNotificationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DeleteVaultRequest ¶ added in v0.9.0
func (c *Client) DeleteVaultRequest(input *DeleteVaultInput) DeleteVaultRequest
DeleteVaultRequest returns a request value for making API operation for Amazon Glacier.
This operation deletes a vault. Amazon S3 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 S3 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) (https://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) (https://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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html) and Delete Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html) in the Amazon S3 Glacier Developer Guide.
// Example sending a request using DeleteVaultRequest. req := client.DeleteVaultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DescribeJobRequest ¶ added in v0.9.0
func (c *Client) DescribeJobRequest(input *DescribeJobInput) DescribeJobRequest
DescribeJobRequest returns a request value for making 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 S3 Glacier (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 Glacier can notify the topic after it completes the job.
A job ID will not expire for at least 24 hours after 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For more information about using this operation, see the documentation for the underlying REST API Describe Job (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html) in the Amazon Glacier Developer Guide.
// Example sending a request using DescribeJobRequest. req := client.DescribeJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) DescribeVaultRequest ¶ added in v0.9.0
func (c *Client) DescribeVaultRequest(input *DescribeVaultInput) DescribeVaultRequest
DescribeVaultRequest returns a request value for making 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 S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 Glacier (https://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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) and Describe Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html) in the Amazon Glacier Developer Guide.
// Example sending a request using DescribeVaultRequest. req := client.DescribeVaultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetDataRetrievalPolicyRequest ¶ added in v0.9.0
func (c *Client) GetDataRetrievalPolicyRequest(input *GetDataRetrievalPolicyInput) GetDataRetrievalPolicyRequest
GetDataRetrievalPolicyRequest returns a request value for making 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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html).
// Example sending a request using GetDataRetrievalPolicyRequest. req := client.GetDataRetrievalPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetJobOutputRequest ¶ added in v0.9.0
func (c *Client) GetJobOutputRequest(input *GetJobOutputInput) GetJobOutputRequest
GetJobOutputRequest returns a request value for making API operation for Amazon Glacier.
This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.
A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.
For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.
In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.
A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and the underlying REST API, see Downloading a Vault Inventory (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html), Downloading an Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html), and Get Job Output (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html)
// Example sending a request using GetJobOutputRequest. req := client.GetJobOutputRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetVaultAccessPolicyRequest ¶ added in v0.9.0
func (c *Client) GetVaultAccessPolicyRequest(input *GetVaultAccessPolicyInput) GetVaultAccessPolicyRequest
GetVaultAccessPolicyRequest returns a request value for making 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) (https://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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html).
// Example sending a request using GetVaultAccessPolicyRequest. req := client.GetVaultAccessPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetVaultLockRequest ¶ added in v0.9.0
func (c *Client) GetVaultLockRequest(input *GetVaultLockInput) GetVaultLockRequest
GetVaultLockRequest returns a request value for making 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 (https://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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html).
// Example sending a request using GetVaultLockRequest. req := client.GetVaultLockRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) GetVaultNotificationsRequest ¶ added in v0.9.0
func (c *Client) GetVaultNotificationsRequest(input *GetVaultNotificationsInput) GetVaultNotificationsRequest
GetVaultNotificationsRequest returns a request value for making 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 S3 Glacier (https://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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) and Get Vault Notification Configuration (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html) in the Amazon Glacier Developer Guide.
// Example sending a request using GetVaultNotificationsRequest. req := client.GetVaultNotificationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) InitiateJobRequest ¶ added in v0.9.0
func (c *Client) InitiateJobRequest(input *InitiateJobInput) InitiateJobRequest
InitiateJobRequest returns a request value for making API operation for Amazon Glacier.
This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html).
// Example sending a request using InitiateJobRequest. req := client.InitiateJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) InitiateMultipartUploadRequest ¶ added in v0.9.0
func (c *Client) InitiateMultipartUploadRequest(input *InitiateMultipartUploadInput) InitiateMultipartUploadRequest
InitiateMultipartUploadRequest returns a request value for making API operation for Amazon Glacier.
This operation initiates a multipart upload. Amazon S3 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 S3 Glacier does not require you to specify the overall archive size.
After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) and Initiate Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html) in the Amazon Glacier Developer Guide.
// Example sending a request using InitiateMultipartUploadRequest. req := client.InitiateMultipartUploadRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) InitiateVaultLockRequest ¶ added in v0.9.0
func (c *Client) InitiateVaultLockRequest(input *InitiateVaultLockInput) InitiateVaultLockRequest
InitiateVaultLockRequest returns a request value for making 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 (https://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 (https://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.
// Example sending a request using InitiateVaultLockRequest. req := client.InitiateVaultLockRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ListJobsRequest ¶ added in v0.9.0
func (c *Client) ListJobsRequest(input *ListJobsInput) ListJobsRequest
ListJobsRequest returns a request value for making API operation for Amazon Glacier.
This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.
Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.
The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.
You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.
Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false).
For more information about using this operation, see the documentation for the underlying REST API List Jobs (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html).
// Example sending a request using ListJobsRequest. req := client.ListJobsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ListMultipartUploadsRequest ¶ added in v0.9.0
func (c *Client) ListMultipartUploadsRequest(input *ListMultipartUploadsInput) ListMultipartUploadsRequest
ListMultipartUploadsRequest returns a request value for making 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 50 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) and List Multipart Uploads (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html) in the Amazon Glacier Developer Guide.
// Example sending a request using ListMultipartUploadsRequest. req := client.ListMultipartUploadsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ListPartsRequest ¶ added in v0.9.0
func (c *Client) ListPartsRequest(input *ListPartsInput) ListPartsRequest
ListPartsRequest returns a request value for making 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 50 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) and List Parts (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html) in the Amazon Glacier Developer Guide.
// Example sending a request using ListPartsRequest. req := client.ListPartsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ListProvisionedCapacityRequest ¶ added in v0.9.0
func (c *Client) ListProvisionedCapacityRequest(input *ListProvisionedCapacityInput) ListProvisionedCapacityRequest
ListProvisionedCapacityRequest returns a request value for making API operation for Amazon Glacier.
This operation lists the provisioned capacity units for the specified AWS account.
// Example sending a request using ListProvisionedCapacityRequest. req := client.ListProvisionedCapacityRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ListTagsForVaultRequest ¶ added in v0.9.0
func (c *Client) ListTagsForVaultRequest(input *ListTagsForVaultInput) ListTagsForVaultRequest
ListTagsForVaultRequest returns a request value for making 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 S3 Glacier Resources (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html).
// Example sending a request using ListTagsForVaultRequest. req := client.ListTagsForVaultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) ListVaultsRequest ¶ added in v0.9.0
func (c *Client) ListVaultsRequest(input *ListVaultsInput) ListVaultsRequest
ListVaultsRequest returns a request value for making 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 10 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) and List Vaults (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html) in the Amazon Glacier Developer Guide.
// Example sending a request using ListVaultsRequest. req := client.ListVaultsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) PurchaseProvisionedCapacityRequest ¶ added in v0.9.0
func (c *Client) PurchaseProvisionedCapacityRequest(input *PurchaseProvisionedCapacityInput) PurchaseProvisionedCapacityRequest
PurchaseProvisionedCapacityRequest returns a request value for making API operation for Amazon Glacier.
This operation purchases a provisioned capacity unit for an AWS account.
// Example sending a request using PurchaseProvisionedCapacityRequest. req := client.PurchaseProvisionedCapacityRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) RemoveTagsFromVaultRequest ¶ added in v0.9.0
func (c *Client) RemoveTagsFromVaultRequest(input *RemoveTagsFromVaultInput) RemoveTagsFromVaultRequest
RemoveTagsFromVaultRequest returns a request value for making 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 S3 Glacier Resources (https://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.
// Example sending a request using RemoveTagsFromVaultRequest. req := client.RemoveTagsFromVaultRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) SetDataRetrievalPolicyRequest ¶ added in v0.9.0
func (c *Client) SetDataRetrievalPolicyRequest(input *SetDataRetrievalPolicyInput) SetDataRetrievalPolicyRequest
SetDataRetrievalPolicyRequest returns a request value for making 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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html).
// Example sending a request using SetDataRetrievalPolicyRequest. req := client.SetDataRetrievalPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) SetVaultAccessPolicyRequest ¶ added in v0.9.0
func (c *Client) SetVaultAccessPolicyRequest(input *SetVaultAccessPolicyInput) SetVaultAccessPolicyRequest
SetVaultAccessPolicyRequest returns a request value for making 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 (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html).
// Example sending a request using SetVaultAccessPolicyRequest. req := client.SetVaultAccessPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) SetVaultNotificationsRequest ¶ added in v0.9.0
func (c *Client) SetVaultNotificationsRequest(input *SetVaultNotificationsInput) SetVaultNotificationsRequest
SetVaultNotificationsRequest returns a request value for making 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 S3 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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) and Set Vault Notification Configuration (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html) in the Amazon Glacier Developer Guide.
// Example sending a request using SetVaultNotificationsRequest. req := client.SetVaultNotificationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UploadArchiveRequest ¶ added in v0.9.0
func (c *Client) UploadArchiveRequest(input *UploadArchiveInput) UploadArchiveRequest
UploadArchiveRequest returns a request value for making 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 S3 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 S3 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 (https://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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html) and Upload Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html) in the Amazon Glacier Developer Guide.
// Example sending a request using UploadArchiveRequest. req := client.UploadArchiveRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) UploadMultipartPartRequest ¶ added in v0.9.0
func (c *Client) UploadMultipartPartRequest(input *UploadMultipartPartInput) UploadMultipartPartRequest
UploadMultipartPartRequest returns a request value for making 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 S3 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 (https://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) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) and Upload Part (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html) in the Amazon Glacier Developer Guide.
// Example sending a request using UploadMultipartPartRequest. req := client.UploadMultipartPartRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
func (*Client) WaitUntilVaultExists ¶ added in v0.9.0
func (c *Client) WaitUntilVaultExists(ctx context.Context, input *DescribeVaultInput, opts ...aws.WaiterOption) error
WaitUntilVaultExists uses the Amazon Glacier API operation DescribeVault to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Client) WaitUntilVaultNotExists ¶ added in v0.9.0
func (c *Client) WaitUntilVaultNotExists(ctx context.Context, input *DescribeVaultInput, opts ...aws.WaiterOption) error
WaitUntilVaultNotExists uses the Amazon Glacier API operation DescribeVault to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type CompleteMultipartUploadInput ¶
type CompleteMultipartUploadInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The total size, in bytes, of the entire archive. This value should be the // sum of all the sizes of the individual parts that you uploaded. ArchiveSize *string `location:"header" locationName:"x-amz-archive-size" type:"string"` // The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 // tree hash of the individual parts. If the value you specify in the request // does not match the SHA256 tree hash of the final assembled archive as computed // by Amazon S3 Glacier (Glacier), 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 S3 Glacier (Glacier) can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource.
func (CompleteMultipartUploadInput) MarshalFields ¶ added in v0.3.0
func (s CompleteMultipartUploadInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CompleteMultipartUploadInput) String ¶
func (s CompleteMultipartUploadInput) String() string
String returns the string representation
func (*CompleteMultipartUploadInput) Validate ¶
func (s *CompleteMultipartUploadInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompleteMultipartUploadOutput ¶ added in v0.9.0
type CompleteMultipartUploadOutput 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 S3 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 S3 Glacier response to your request.
For information about the underlying REST API, see Upload Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html). For conceptual information, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html).
func (CompleteMultipartUploadOutput) MarshalFields ¶ added in v0.9.0
func (s CompleteMultipartUploadOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CompleteMultipartUploadOutput) String ¶ added in v0.9.0
func (s CompleteMultipartUploadOutput) String() string
String returns the string representation
type CompleteMultipartUploadRequest ¶
type CompleteMultipartUploadRequest struct { *aws.Request Input *CompleteMultipartUploadInput Copy func(*CompleteMultipartUploadInput) CompleteMultipartUploadRequest }
CompleteMultipartUploadRequest is the request type for the CompleteMultipartUpload API operation.
func (CompleteMultipartUploadRequest) Send ¶
func (r CompleteMultipartUploadRequest) Send(ctx context.Context) (*CompleteMultipartUploadResponse, error)
Send marshals and sends the CompleteMultipartUpload API request.
type CompleteMultipartUploadResponse ¶ added in v0.9.0
type CompleteMultipartUploadResponse struct { *CompleteMultipartUploadOutput // contains filtered or unexported fields }
CompleteMultipartUploadResponse is the response type for the CompleteMultipartUpload API operation.
func (*CompleteMultipartUploadResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CompleteMultipartUploadResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CompleteMultipartUpload request.
type CompleteVaultLockInput ¶
type CompleteVaultLockInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The lockId value is the lock ID obtained from a InitiateVaultLock request. // // LockId is a required field LockId *string `location:"uri" locationName:"lockId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input values for CompleteVaultLock.
func (CompleteVaultLockInput) MarshalFields ¶ added in v0.3.0
func (s CompleteVaultLockInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CompleteVaultLockInput) String ¶
func (s CompleteVaultLockInput) String() string
String returns the string representation
func (*CompleteVaultLockInput) Validate ¶
func (s *CompleteVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompleteVaultLockOutput ¶
type CompleteVaultLockOutput struct {
// contains filtered or unexported fields
}
func (CompleteVaultLockOutput) MarshalFields ¶ added in v0.3.0
func (s CompleteVaultLockOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CompleteVaultLockOutput) String ¶
func (s CompleteVaultLockOutput) String() string
String returns the string representation
type CompleteVaultLockRequest ¶
type CompleteVaultLockRequest struct { *aws.Request Input *CompleteVaultLockInput Copy func(*CompleteVaultLockInput) CompleteVaultLockRequest }
CompleteVaultLockRequest is the request type for the CompleteVaultLock API operation.
func (CompleteVaultLockRequest) Send ¶
func (r CompleteVaultLockRequest) Send(ctx context.Context) (*CompleteVaultLockResponse, error)
Send marshals and sends the CompleteVaultLock API request.
type CompleteVaultLockResponse ¶ added in v0.9.0
type CompleteVaultLockResponse struct { *CompleteVaultLockOutput // contains filtered or unexported fields }
CompleteVaultLockResponse is the response type for the CompleteVaultLock API operation.
func (*CompleteVaultLockResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CompleteVaultLockResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CompleteVaultLock request.
type CreateVaultInput ¶
type CreateVaultInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options to create a vault.
func (CreateVaultInput) MarshalFields ¶ added in v0.3.0
func (s CreateVaultInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateVaultInput) String ¶
func (s CreateVaultInput) String() string
String returns the string representation
func (*CreateVaultInput) Validate ¶
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 S3 Glacier response to your request.
func (CreateVaultOutput) MarshalFields ¶ added in v0.3.0
func (s CreateVaultOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateVaultOutput) String ¶
func (s CreateVaultOutput) String() string
String returns the string representation
type CreateVaultRequest ¶
type CreateVaultRequest struct { *aws.Request Input *CreateVaultInput Copy func(*CreateVaultInput) CreateVaultRequest }
CreateVaultRequest is the request type for the CreateVault API operation.
func (CreateVaultRequest) Send ¶
func (r CreateVaultRequest) Send(ctx context.Context) (*CreateVaultResponse, error)
Send marshals and sends the CreateVault API request.
type CreateVaultResponse ¶ added in v0.9.0
type CreateVaultResponse struct { *CreateVaultOutput // contains filtered or unexported fields }
CreateVaultResponse is the response type for the CreateVault API operation.
func (*CreateVaultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateVaultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateVault request.
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) MarshalFields ¶ added in v0.3.0
func (s DataRetrievalPolicy) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DataRetrievalPolicy) String ¶
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) MarshalFields ¶ added in v0.3.0
func (s DataRetrievalRule) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DataRetrievalRule) String ¶
func (s DataRetrievalRule) String() string
String returns the string representation
type DeleteArchiveInput ¶
type DeleteArchiveInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The ID of the archive to delete. // // ArchiveId is a required field ArchiveId *string `location:"uri" locationName:"archiveId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for deleting an archive from an Amazon S3 Glacier vault.
func (DeleteArchiveInput) MarshalFields ¶ added in v0.3.0
func (s DeleteArchiveInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteArchiveInput) String ¶
func (s DeleteArchiveInput) String() string
String returns the string representation
func (*DeleteArchiveInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s DeleteArchiveOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteArchiveOutput) String ¶
func (s DeleteArchiveOutput) String() string
String returns the string representation
type DeleteArchiveRequest ¶
type DeleteArchiveRequest struct { *aws.Request Input *DeleteArchiveInput Copy func(*DeleteArchiveInput) DeleteArchiveRequest }
DeleteArchiveRequest is the request type for the DeleteArchive API operation.
func (DeleteArchiveRequest) Send ¶
func (r DeleteArchiveRequest) Send(ctx context.Context) (*DeleteArchiveResponse, error)
Send marshals and sends the DeleteArchive API request.
type DeleteArchiveResponse ¶ added in v0.9.0
type DeleteArchiveResponse struct { *DeleteArchiveOutput // contains filtered or unexported fields }
DeleteArchiveResponse is the response type for the DeleteArchive API operation.
func (*DeleteArchiveResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteArchiveResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteArchive request.
type DeleteVaultAccessPolicyInput ¶
type DeleteVaultAccessPolicyInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
DeleteVaultAccessPolicy input.
func (DeleteVaultAccessPolicyInput) MarshalFields ¶ added in v0.3.0
func (s DeleteVaultAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVaultAccessPolicyInput) String ¶
func (s DeleteVaultAccessPolicyInput) String() string
String returns the string representation
func (*DeleteVaultAccessPolicyInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s DeleteVaultAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVaultAccessPolicyOutput) String ¶
func (s DeleteVaultAccessPolicyOutput) String() string
String returns the string representation
type DeleteVaultAccessPolicyRequest ¶
type DeleteVaultAccessPolicyRequest struct { *aws.Request Input *DeleteVaultAccessPolicyInput Copy func(*DeleteVaultAccessPolicyInput) DeleteVaultAccessPolicyRequest }
DeleteVaultAccessPolicyRequest is the request type for the DeleteVaultAccessPolicy API operation.
func (DeleteVaultAccessPolicyRequest) Send ¶
func (r DeleteVaultAccessPolicyRequest) Send(ctx context.Context) (*DeleteVaultAccessPolicyResponse, error)
Send marshals and sends the DeleteVaultAccessPolicy API request.
type DeleteVaultAccessPolicyResponse ¶ added in v0.9.0
type DeleteVaultAccessPolicyResponse struct { *DeleteVaultAccessPolicyOutput // contains filtered or unexported fields }
DeleteVaultAccessPolicyResponse is the response type for the DeleteVaultAccessPolicy API operation.
func (*DeleteVaultAccessPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteVaultAccessPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteVaultAccessPolicy request.
type DeleteVaultInput ¶
type DeleteVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for deleting a vault from Amazon S3 Glacier.
func (DeleteVaultInput) MarshalFields ¶ added in v0.3.0
func (s DeleteVaultInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVaultInput) String ¶
func (s DeleteVaultInput) String() string
String returns the string representation
func (*DeleteVaultInput) Validate ¶
func (s *DeleteVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteVaultNotificationsInput ¶
type DeleteVaultNotificationsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for deleting a vault notification configuration from an Amazon Glacier vault.
func (DeleteVaultNotificationsInput) MarshalFields ¶ added in v0.3.0
func (s DeleteVaultNotificationsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVaultNotificationsInput) String ¶
func (s DeleteVaultNotificationsInput) String() string
String returns the string representation
func (*DeleteVaultNotificationsInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s DeleteVaultNotificationsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVaultNotificationsOutput) String ¶
func (s DeleteVaultNotificationsOutput) String() string
String returns the string representation
type DeleteVaultNotificationsRequest ¶
type DeleteVaultNotificationsRequest struct { *aws.Request Input *DeleteVaultNotificationsInput Copy func(*DeleteVaultNotificationsInput) DeleteVaultNotificationsRequest }
DeleteVaultNotificationsRequest is the request type for the DeleteVaultNotifications API operation.
func (DeleteVaultNotificationsRequest) Send ¶
func (r DeleteVaultNotificationsRequest) Send(ctx context.Context) (*DeleteVaultNotificationsResponse, error)
Send marshals and sends the DeleteVaultNotifications API request.
type DeleteVaultNotificationsResponse ¶ added in v0.9.0
type DeleteVaultNotificationsResponse struct { *DeleteVaultNotificationsOutput // contains filtered or unexported fields }
DeleteVaultNotificationsResponse is the response type for the DeleteVaultNotifications API operation.
func (*DeleteVaultNotificationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteVaultNotificationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteVaultNotifications request.
type DeleteVaultOutput ¶
type DeleteVaultOutput struct {
// contains filtered or unexported fields
}
func (DeleteVaultOutput) MarshalFields ¶ added in v0.3.0
func (s DeleteVaultOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteVaultOutput) String ¶
func (s DeleteVaultOutput) String() string
String returns the string representation
type DeleteVaultRequest ¶
type DeleteVaultRequest struct { *aws.Request Input *DeleteVaultInput Copy func(*DeleteVaultInput) DeleteVaultRequest }
DeleteVaultRequest is the request type for the DeleteVault API operation.
func (DeleteVaultRequest) Send ¶
func (r DeleteVaultRequest) Send(ctx context.Context) (*DeleteVaultResponse, error)
Send marshals and sends the DeleteVault API request.
type DeleteVaultResponse ¶ added in v0.9.0
type DeleteVaultResponse struct { *DeleteVaultOutput // contains filtered or unexported fields }
DeleteVaultResponse is the response type for the DeleteVault API operation.
func (*DeleteVaultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteVaultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteVault request.
type DescribeJobInput ¶
type DescribeJobInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The ID of the job to describe. // // JobId is a required field JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for retrieving a job description.
func (DescribeJobInput) MarshalFields ¶ added in v0.3.0
func (s DescribeJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeJobInput) String ¶
func (s DescribeJobInput) String() string
String returns the string representation
func (*DescribeJobInput) Validate ¶
func (s *DescribeJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeJobOutput ¶
type DescribeJobOutput struct { // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, // or Select. Action ActionCode `type:"string" enum:"true"` // The archive ID requested for a select job or archive retrieval. Otherwise, // this field is null. ArchiveId *string `type:"string"` // The SHA256 tree hash of the entire archive for an archive retrieval. For // inventory retrieval or select jobs, this field is null. ArchiveSHA256TreeHash *string `type:"string"` // For an archive retrieval job, this value is the size in bytes of the archive // being requested for download. For an inventory retrieval or select job, this // value is null. ArchiveSizeInBytes *int64 `type:"long"` // The job status. When a job is completed, you get the job's output using Get // Job Output (GET output). Completed *bool `type:"boolean"` // The UTC time that the job request completed. While the job is in progress, // the value is null. CompletionDate *string `type:"string"` // The UTC date when the job was created. This value is a string representation // of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". CreationDate *string `type:"string"` // Parameters used for range inventory retrieval. InventoryRetrievalParameters *InventoryRetrievalJobDescription `type:"structure"` // For an inventory retrieval job, this value is the size in bytes of the inventory // requested for download. For an archive retrieval or select job, this value // is null. InventorySizeInBytes *int64 `type:"long"` // The job description provided when initiating the job. JobDescription *string `type:"string"` // An opaque string that identifies an Amazon S3 Glacier job. JobId *string `type:"string"` // Contains the job output location. JobOutputPath *string `type:"string"` // Contains the location where the data from the select job is stored. OutputLocation *OutputLocation `type:"structure"` // The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. // If no range was specified in the archive retrieval, then the whole archive // is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals // the size of the archive minus 1. For inventory retrieval or select jobs, // this field is null. RetrievalByteRange *string `type:"string"` // For an archive retrieval job, this value is the checksum of the archive. // Otherwise, this value is null. // // The SHA256 tree hash value for the requested range of an archive. If the // InitiateJob request for an archive specified a tree-hash aligned range, then // this field returns a value. // // If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash // value. // // This field is null for the following: // // * Archive retrieval jobs that specify a range that is not tree-hash aligned // // * Archival jobs that specify a range that is equal to the whole archive, // when the job status is InProgress // // * Inventory jobs // // * Select jobs SHA256TreeHash *string `type:"string"` // An Amazon SNS topic that receives notification. SNSTopic *string `type:"string"` // Contains the parameters used for a select. SelectParameters *SelectParameters `type:"structure"` // The status code can be InProgress, Succeeded, or Failed, and indicates the // status of the job. StatusCode StatusCode `type:"string" enum:"true"` // A friendly message that describes the job status. StatusMessage *string `type:"string"` // The tier to use for a select or an archive retrieval. Valid values are Expedited, // Standard, or Bulk. Standard is the default. Tier *string `type:"string"` // The Amazon Resource Name (ARN) of the vault from which an archive retrieval // was requested. VaultARN *string `type:"string"` // contains filtered or unexported fields }
Contains the description of an Amazon S3 Glacier job.
func (DescribeJobOutput) MarshalFields ¶ added in v0.3.0
func (s DescribeJobOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeJobOutput) String ¶
func (s DescribeJobOutput) String() string
String returns the string representation
type DescribeJobRequest ¶
type DescribeJobRequest struct { *aws.Request Input *DescribeJobInput Copy func(*DescribeJobInput) DescribeJobRequest }
DescribeJobRequest is the request type for the DescribeJob API operation.
func (DescribeJobRequest) Send ¶
func (r DescribeJobRequest) Send(ctx context.Context) (*DescribeJobResponse, error)
Send marshals and sends the DescribeJob API request.
type DescribeJobResponse ¶ added in v0.9.0
type DescribeJobResponse struct { *DescribeJobOutput // contains filtered or unexported fields }
DescribeJobResponse is the response type for the DescribeJob API operation.
func (*DescribeJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeJob request.
type DescribeVaultInput ¶
type DescribeVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for retrieving metadata for a specific vault in Amazon Glacier.
func (DescribeVaultInput) MarshalFields ¶ added in v0.3.0
func (s DescribeVaultInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeVaultInput) String ¶
func (s DescribeVaultInput) String() string
String returns the string representation
func (*DescribeVaultInput) Validate ¶
func (s *DescribeVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeVaultOutput ¶
type DescribeVaultOutput struct { // The Universal Coordinated Time (UTC) date when the vault was created. This // value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z. CreationDate *string `type:"string"` // The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed // the last vault inventory. This value should be a string in the ISO 8601 date // format, for example 2012-03-20T17:03:43.221Z. LastInventoryDate *string `type:"string"` // The number of archives in the vault as of the last inventory date. This field // will return null if an inventory has not yet run on the vault, for example // if you just created the vault. NumberOfArchives *int64 `type:"long"` // Total size, in bytes, of the archives in the vault as of the last inventory // date. This field will return null if an inventory has not yet run on the // vault, for example if you just created the vault. SizeInBytes *int64 `type:"long"` // The Amazon Resource Name (ARN) of the vault. VaultARN *string `type:"string"` // The name of the vault. VaultName *string `type:"string"` // contains filtered or unexported fields }
Contains the Amazon S3 Glacier response to your request.
func (DescribeVaultOutput) MarshalFields ¶ added in v0.3.0
func (s DescribeVaultOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeVaultOutput) String ¶
func (s DescribeVaultOutput) String() string
String returns the string representation
type DescribeVaultRequest ¶
type DescribeVaultRequest struct { *aws.Request Input *DescribeVaultInput Copy func(*DescribeVaultInput) DescribeVaultRequest }
DescribeVaultRequest is the request type for the DescribeVault API operation.
func (DescribeVaultRequest) Send ¶
func (r DescribeVaultRequest) Send(ctx context.Context) (*DescribeVaultResponse, error)
Send marshals and sends the DescribeVault API request.
type DescribeVaultResponse ¶ added in v0.9.0
type DescribeVaultResponse struct { *DescribeVaultOutput // contains filtered or unexported fields }
DescribeVaultResponse is the response type for the DescribeVault API operation.
func (*DescribeVaultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeVaultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeVault request.
type Encryption ¶ added in v0.2.0
type Encryption struct { // The server-side encryption algorithm used when storing job results in Amazon // S3, for example AES256 or aws:kms. EncryptionType EncryptionType `type:"string" enum:"true"` // Optional. If the encryption type is aws:kms, you can use this value to specify // the encryption context for the job results. KMSContext *string `type:"string"` // The AWS KMS key ID to use for object encryption. All GET and PUT requests // for an object protected by AWS KMS fail if not made by using Secure Sockets // Layer (SSL) or Signature Version 4. KMSKeyId *string `type:"string"` // contains filtered or unexported fields }
Contains information about the encryption used to store the job results in Amazon S3.
func (Encryption) MarshalFields ¶ added in v0.3.0
func (s Encryption) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (Encryption) String ¶ added in v0.2.0
func (s Encryption) String() string
String returns the string representation
type EncryptionType ¶ added in v0.2.0
type EncryptionType string
const ( EncryptionTypeAwsKms EncryptionType = "aws:kms" EncryptionTypeAes256 EncryptionType = "AES256" )
Enum values for EncryptionType
func (EncryptionType) MarshalValue ¶ added in v0.3.0
func (enum EncryptionType) MarshalValue() (string, error)
func (EncryptionType) MarshalValueBuf ¶ added in v0.3.0
func (enum EncryptionType) MarshalValueBuf(b []byte) ([]byte, error)
type ExpressionType ¶ added in v0.2.0
type ExpressionType string
const (
ExpressionTypeSql ExpressionType = "SQL"
)
Enum values for ExpressionType
func (ExpressionType) MarshalValue ¶ added in v0.3.0
func (enum ExpressionType) MarshalValue() (string, error)
func (ExpressionType) MarshalValueBuf ¶ added in v0.3.0
func (enum ExpressionType) MarshalValueBuf(b []byte) ([]byte, error)
type FileHeaderInfo ¶ added in v0.2.0
type FileHeaderInfo string
const ( FileHeaderInfoUse FileHeaderInfo = "USE" FileHeaderInfoIgnore FileHeaderInfo = "IGNORE" FileHeaderInfoNone FileHeaderInfo = "NONE" )
Enum values for FileHeaderInfo
func (FileHeaderInfo) MarshalValue ¶ added in v0.3.0
func (enum FileHeaderInfo) MarshalValue() (string, error)
func (FileHeaderInfo) MarshalValueBuf ¶ added in v0.3.0
func (enum FileHeaderInfo) MarshalValueBuf(b []byte) ([]byte, error)
type GetDataRetrievalPolicyInput ¶
type GetDataRetrievalPolicyInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetDataRetrievalPolicy.
func (GetDataRetrievalPolicyInput) MarshalFields ¶ added in v0.3.0
func (s GetDataRetrievalPolicyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDataRetrievalPolicyInput) String ¶
func (s GetDataRetrievalPolicyInput) String() string
String returns the string representation
func (*GetDataRetrievalPolicyInput) Validate ¶
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 S3 Glacier response to the GetDataRetrievalPolicy request.
func (GetDataRetrievalPolicyOutput) MarshalFields ¶ added in v0.3.0
func (s GetDataRetrievalPolicyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDataRetrievalPolicyOutput) String ¶
func (s GetDataRetrievalPolicyOutput) String() string
String returns the string representation
type GetDataRetrievalPolicyRequest ¶
type GetDataRetrievalPolicyRequest struct { *aws.Request Input *GetDataRetrievalPolicyInput Copy func(*GetDataRetrievalPolicyInput) GetDataRetrievalPolicyRequest }
GetDataRetrievalPolicyRequest is the request type for the GetDataRetrievalPolicy API operation.
func (GetDataRetrievalPolicyRequest) Send ¶
func (r GetDataRetrievalPolicyRequest) Send(ctx context.Context) (*GetDataRetrievalPolicyResponse, error)
Send marshals and sends the GetDataRetrievalPolicy API request.
type GetDataRetrievalPolicyResponse ¶ added in v0.9.0
type GetDataRetrievalPolicyResponse struct { *GetDataRetrievalPolicyOutput // contains filtered or unexported fields }
GetDataRetrievalPolicyResponse is the response type for the GetDataRetrievalPolicy API operation.
func (*GetDataRetrievalPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetDataRetrievalPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDataRetrievalPolicy request.
type GetJobOutputInput ¶
type GetJobOutputInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The job ID whose data is downloaded. // // JobId is a required field JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"` // The range of bytes to retrieve from the output. For example, if you want // to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. // By default, this operation downloads the entire output. // // If the job output is large, then you can use a range to retrieve a portion // of the output. This allows you to download the entire output in smaller chunks // of bytes. For example, suppose you have 1 GB of job output you want to download // and you decide to download 128 MB chunks of data at a time, which is a total // of eight Get Job Output requests. You use the following process to download // the job output: // // Download a 128 MB chunk of output by specifying the appropriate byte range. // Verify that all 128 MB of data was received. // // Along with the data, the response includes a SHA256 tree hash of the payload. // You compute the checksum of the payload on the client and compare it with // the checksum you received in the response to ensure you received all the // expected data. // // Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each // time specifying the appropriate byte range. // // After downloading all the parts of the job output, you have a list of eight // checksum values. Compute the tree hash of these values to find the checksum // of the entire output. Using the DescribeJob API, obtain job information of // the job that provided you the output. The response includes the checksum // of the entire archive stored in Amazon S3 Glacier. You compare this value // with the checksum you computed to ensure you have downloaded the entire archive // content with no errors. Range *string `location:"header" locationName:"Range" type:"string"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for downloading output of an Amazon S3 Glacier job.
func (GetJobOutputInput) MarshalFields ¶ added in v0.3.0
func (s GetJobOutputInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetJobOutputInput) String ¶
func (s GetJobOutputInput) String() string
String returns the string representation
func (*GetJobOutputInput) Validate ¶
func (s *GetJobOutputInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetJobOutputOutput ¶
type GetJobOutputOutput struct { // Indicates the range units accepted. For more information, see RFC2616 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). AcceptRanges *string `location:"header" locationName:"Accept-Ranges" type:"string"` // The description of an archive. ArchiveDescription *string `location:"header" locationName:"x-amz-archive-description" type:"string"` // The job data, either archive data or inventory data. Body io.ReadCloser `locationName:"body" type:"blob"` // The checksum of the data in the response. This header is returned only when // retrieving the output for an archive retrieval job. Furthermore, this header // appears only under the following conditions: // // * You get the entire range of the archive. // // * You request a range to return of the archive that starts and ends on // a multiple of 1 MB. For example, if you have an 3.1 MB archive and you // specify a range to return that starts at 1 MB and ends at 2 MB, then the // x-amz-sha256-tree-hash is returned as a response header. // // * You request a range of the archive to return that starts on a multiple // of 1 MB and goes to the end of the archive. For example, if you have a // 3.1 MB archive and you specify a range that starts at 2 MB and ends at // 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned // as a response header. Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"` // The range of bytes returned by Amazon S3 Glacier. If only partial output // is downloaded, the response provides the range of bytes Amazon S3 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 S3 Glacier response to your request.
func (GetJobOutputOutput) MarshalFields ¶ added in v0.3.0
func (s GetJobOutputOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetJobOutputOutput) String ¶
func (s GetJobOutputOutput) String() string
String returns the string representation
type GetJobOutputRequest ¶
type GetJobOutputRequest struct { *aws.Request Input *GetJobOutputInput Copy func(*GetJobOutputInput) GetJobOutputRequest }
GetJobOutputRequest is the request type for the GetJobOutput API operation.
func (GetJobOutputRequest) Send ¶
func (r GetJobOutputRequest) Send(ctx context.Context) (*GetJobOutputResponse, error)
Send marshals and sends the GetJobOutput API request.
type GetJobOutputResponse ¶ added in v0.9.0
type GetJobOutputResponse struct { *GetJobOutputOutput // contains filtered or unexported fields }
GetJobOutputResponse is the response type for the GetJobOutput API operation.
func (*GetJobOutputResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetJobOutputResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetJobOutput request.
type GetVaultAccessPolicyInput ¶
type GetVaultAccessPolicyInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Input for GetVaultAccessPolicy.
func (GetVaultAccessPolicyInput) MarshalFields ¶ added in v0.3.0
func (s GetVaultAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVaultAccessPolicyInput) String ¶
func (s GetVaultAccessPolicyInput) String() string
String returns the string representation
func (*GetVaultAccessPolicyInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s GetVaultAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVaultAccessPolicyOutput) String ¶
func (s GetVaultAccessPolicyOutput) String() string
String returns the string representation
type GetVaultAccessPolicyRequest ¶
type GetVaultAccessPolicyRequest struct { *aws.Request Input *GetVaultAccessPolicyInput Copy func(*GetVaultAccessPolicyInput) GetVaultAccessPolicyRequest }
GetVaultAccessPolicyRequest is the request type for the GetVaultAccessPolicy API operation.
func (GetVaultAccessPolicyRequest) Send ¶
func (r GetVaultAccessPolicyRequest) Send(ctx context.Context) (*GetVaultAccessPolicyResponse, error)
Send marshals and sends the GetVaultAccessPolicy API request.
type GetVaultAccessPolicyResponse ¶ added in v0.9.0
type GetVaultAccessPolicyResponse struct { *GetVaultAccessPolicyOutput // contains filtered or unexported fields }
GetVaultAccessPolicyResponse is the response type for the GetVaultAccessPolicy API operation.
func (*GetVaultAccessPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetVaultAccessPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetVaultAccessPolicy request.
type GetVaultLockInput ¶
type GetVaultLockInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input values for GetVaultLock.
func (GetVaultLockInput) MarshalFields ¶ added in v0.3.0
func (s GetVaultLockInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVaultLockInput) String ¶
func (s GetVaultLockInput) String() string
String returns the string representation
func (*GetVaultLockInput) Validate ¶
func (s *GetVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetVaultLockOutput ¶
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 S3 Glacier response to your request.
func (GetVaultLockOutput) MarshalFields ¶ added in v0.3.0
func (s GetVaultLockOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVaultLockOutput) String ¶
func (s GetVaultLockOutput) String() string
String returns the string representation
type GetVaultLockRequest ¶
type GetVaultLockRequest struct { *aws.Request Input *GetVaultLockInput Copy func(*GetVaultLockInput) GetVaultLockRequest }
GetVaultLockRequest is the request type for the GetVaultLock API operation.
func (GetVaultLockRequest) Send ¶
func (r GetVaultLockRequest) Send(ctx context.Context) (*GetVaultLockResponse, error)
Send marshals and sends the GetVaultLock API request.
type GetVaultLockResponse ¶ added in v0.9.0
type GetVaultLockResponse struct { *GetVaultLockOutput // contains filtered or unexported fields }
GetVaultLockResponse is the response type for the GetVaultLock API operation.
func (*GetVaultLockResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetVaultLockResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetVaultLock request.
type GetVaultNotificationsInput ¶
type GetVaultNotificationsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for retrieving the notification configuration set on an Amazon Glacier vault.
func (GetVaultNotificationsInput) MarshalFields ¶ added in v0.3.0
func (s GetVaultNotificationsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVaultNotificationsInput) String ¶
func (s GetVaultNotificationsInput) String() string
String returns the string representation
func (*GetVaultNotificationsInput) Validate ¶
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 S3 Glacier response to your request.
func (GetVaultNotificationsOutput) MarshalFields ¶ added in v0.3.0
func (s GetVaultNotificationsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetVaultNotificationsOutput) String ¶
func (s GetVaultNotificationsOutput) String() string
String returns the string representation
type GetVaultNotificationsRequest ¶
type GetVaultNotificationsRequest struct { *aws.Request Input *GetVaultNotificationsInput Copy func(*GetVaultNotificationsInput) GetVaultNotificationsRequest }
GetVaultNotificationsRequest is the request type for the GetVaultNotifications API operation.
func (GetVaultNotificationsRequest) Send ¶
func (r GetVaultNotificationsRequest) Send(ctx context.Context) (*GetVaultNotificationsResponse, error)
Send marshals and sends the GetVaultNotifications API request.
type GetVaultNotificationsResponse ¶ added in v0.9.0
type GetVaultNotificationsResponse struct { *GetVaultNotificationsOutput // contains filtered or unexported fields }
GetVaultNotificationsResponse is the response type for the GetVaultNotifications API operation.
func (*GetVaultNotificationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetVaultNotificationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetVaultNotifications request.
type GlacierJobDescription ¶ added in v0.9.0
type GlacierJobDescription struct { // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, // or Select. Action ActionCode `type:"string" enum:"true"` // The archive ID requested for a select job or archive retrieval. Otherwise, // this field is null. ArchiveId *string `type:"string"` // The SHA256 tree hash of the entire archive for an archive retrieval. For // inventory retrieval or select jobs, this field is null. ArchiveSHA256TreeHash *string `type:"string"` // For an archive retrieval job, this value is the size in bytes of the archive // being requested for download. For an inventory retrieval or select job, this // value is null. ArchiveSizeInBytes *int64 `type:"long"` // The job status. When a job is completed, you get the job's output using Get // Job Output (GET output). Completed *bool `type:"boolean"` // The UTC time that the job request completed. While the job is in progress, // the value is null. CompletionDate *string `type:"string"` // The UTC date when the job was created. This value is a string representation // of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". CreationDate *string `type:"string"` // Parameters used for range inventory retrieval. InventoryRetrievalParameters *InventoryRetrievalJobDescription `type:"structure"` // For an inventory retrieval job, this value is the size in bytes of the inventory // requested for download. For an archive retrieval or select job, this value // is null. InventorySizeInBytes *int64 `type:"long"` // The job description provided when initiating the job. JobDescription *string `type:"string"` // An opaque string that identifies an Amazon S3 Glacier job. JobId *string `type:"string"` // Contains the job output location. JobOutputPath *string `type:"string"` // Contains the location where the data from the select job is stored. OutputLocation *OutputLocation `type:"structure"` // The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. // If no range was specified in the archive retrieval, then the whole archive // is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals // the size of the archive minus 1. For inventory retrieval or select jobs, // this field is null. RetrievalByteRange *string `type:"string"` // For an archive retrieval job, this value is the checksum of the archive. // Otherwise, this value is null. // // The SHA256 tree hash value for the requested range of an archive. If the // InitiateJob request for an archive specified a tree-hash aligned range, then // this field returns a value. // // If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash // value. // // This field is null for the following: // // * Archive retrieval jobs that specify a range that is not tree-hash aligned // // * Archival jobs that specify a range that is equal to the whole archive, // when the job status is InProgress // // * Inventory jobs // // * Select jobs SHA256TreeHash *string `type:"string"` // An Amazon SNS topic that receives notification. SNSTopic *string `type:"string"` // Contains the parameters used for a select. SelectParameters *SelectParameters `type:"structure"` // The status code can be InProgress, Succeeded, or Failed, and indicates the // status of the job. StatusCode StatusCode `type:"string" enum:"true"` // A friendly message that describes the job status. StatusMessage *string `type:"string"` // The tier to use for a select or an archive retrieval. Valid values are Expedited, // Standard, or Bulk. Standard is the default. Tier *string `type:"string"` // The Amazon Resource Name (ARN) of the vault from which an archive retrieval // was requested. VaultARN *string `type:"string"` // contains filtered or unexported fields }
Contains the description of an Amazon S3 Glacier job.
func (GlacierJobDescription) MarshalFields ¶ added in v0.9.0
func (s GlacierJobDescription) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GlacierJobDescription) String ¶ added in v0.9.0
func (s GlacierJobDescription) String() string
String returns the string representation
type Grant ¶ added in v0.2.0
type Grant struct { // The grantee. Grantee *Grantee `type:"structure"` // Specifies the permission given to the grantee. Permission Permission `type:"string" enum:"true"` // contains filtered or unexported fields }
Contains information about a grant.
func (Grant) MarshalFields ¶ added in v0.3.0
func (s Grant) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Grantee ¶ added in v0.2.0
type Grantee struct { // Screen name of the grantee. DisplayName *string `type:"string"` // Email address of the grantee. EmailAddress *string `type:"string"` // The canonical user ID of the grantee. ID *string `type:"string"` // Type of grantee // // Type is a required field Type Type `type:"string" required:"true" enum:"true"` // URI of the grantee group. URI *string `type:"string"` // contains filtered or unexported fields }
Contains information about the grantee.
func (Grantee) MarshalFields ¶ added in v0.3.0
func (s Grantee) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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.
See http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html for more information.
Example ¶
package main import ( "bytes" "fmt" "io" "github.com/aws/aws-sdk-go-v2/service/glacier" ) func main() { r := testCreateReader() h := glacier.ComputeHashes(r) n, _ := r.Seek(0, io.SeekCurrent) // Check position after checksumming fmt.Printf("linear: %x\n", h.LinearHash) fmt.Printf("tree: %x\n", h.TreeHash) fmt.Printf("pos: %d\n", n) } func testCreateReader() io.ReadSeeker { buf := make([]byte, 5767168) for i := range buf { buf[i] = '0' } return bytes.NewReader(buf) }
Output: linear: 68aff0c5a91aa0491752bfb96e3fef33eb74953804f6a2f7b708d5bcefa8ff6b tree: 154e26c78fd74d0c2c9b3cc4644191619dc4f2cd539ae2a74d5fd07957a3ee6a pos: 0
type InitiateJobInput ¶
type InitiateJobInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // Provides options for specifying job information. JobParameters *JobParameters `locationName:"jobParameters" type:"structure"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for initiating an Amazon S3 Glacier job.
func (InitiateJobInput) MarshalFields ¶ added in v0.3.0
func (s InitiateJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InitiateJobInput) String ¶
func (s InitiateJobInput) String() string
String returns the string representation
func (*InitiateJobInput) Validate ¶
func (s *InitiateJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InitiateJobOutput ¶
type InitiateJobOutput struct { // The ID of the job. JobId *string `location:"header" locationName:"x-amz-job-id" type:"string"` // The path to the location of where the select results are stored. JobOutputPath *string `location:"header" locationName:"x-amz-job-output-path" type:"string"` // The relative URI path of the job. Location *string `location:"header" locationName:"Location" type:"string"` // contains filtered or unexported fields }
Contains the Amazon S3 Glacier response to your request.
func (InitiateJobOutput) MarshalFields ¶ added in v0.3.0
func (s InitiateJobOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InitiateJobOutput) String ¶
func (s InitiateJobOutput) String() string
String returns the string representation
type InitiateJobRequest ¶
type InitiateJobRequest struct { *aws.Request Input *InitiateJobInput Copy func(*InitiateJobInput) InitiateJobRequest }
InitiateJobRequest is the request type for the InitiateJob API operation.
func (InitiateJobRequest) Send ¶
func (r InitiateJobRequest) Send(ctx context.Context) (*InitiateJobResponse, error)
Send marshals and sends the InitiateJob API request.
type InitiateJobResponse ¶ added in v0.9.0
type InitiateJobResponse struct { *InitiateJobOutput // contains filtered or unexported fields }
InitiateJobResponse is the response type for the InitiateJob API operation.
func (*InitiateJobResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *InitiateJobResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the InitiateJob request.
type InitiateMultipartUploadInput ¶
type InitiateMultipartUploadInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The archive description that you are uploading in parts. // // The part size must be a megabyte (1024 KB) multiplied by a power of 2, for // example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and // so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 // MB). ArchiveDescription *string `location:"header" locationName:"x-amz-archive-description" type:"string"` // The size of each part except the last, in bytes. The last part can be smaller // than this part size. PartSize *string `location:"header" locationName:"x-amz-part-size" type:"string"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for initiating a multipart upload to an Amazon S3 Glacier vault.
func (InitiateMultipartUploadInput) MarshalFields ¶ added in v0.3.0
func (s InitiateMultipartUploadInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InitiateMultipartUploadInput) String ¶
func (s InitiateMultipartUploadInput) String() string
String returns the string representation
func (*InitiateMultipartUploadInput) Validate ¶
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 S3 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 S3 Glacier response to your request.
func (InitiateMultipartUploadOutput) MarshalFields ¶ added in v0.3.0
func (s InitiateMultipartUploadOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InitiateMultipartUploadOutput) String ¶
func (s InitiateMultipartUploadOutput) String() string
String returns the string representation
type InitiateMultipartUploadRequest ¶
type InitiateMultipartUploadRequest struct { *aws.Request Input *InitiateMultipartUploadInput Copy func(*InitiateMultipartUploadInput) InitiateMultipartUploadRequest }
InitiateMultipartUploadRequest is the request type for the InitiateMultipartUpload API operation.
func (InitiateMultipartUploadRequest) Send ¶
func (r InitiateMultipartUploadRequest) Send(ctx context.Context) (*InitiateMultipartUploadResponse, error)
Send marshals and sends the InitiateMultipartUpload API request.
type InitiateMultipartUploadResponse ¶ added in v0.9.0
type InitiateMultipartUploadResponse struct { *InitiateMultipartUploadOutput // contains filtered or unexported fields }
InitiateMultipartUploadResponse is the response type for the InitiateMultipartUpload API operation.
func (*InitiateMultipartUploadResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *InitiateMultipartUploadResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the InitiateMultipartUpload request.
type InitiateVaultLockInput ¶
type InitiateVaultLockInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The vault lock policy as a JSON string, which uses "\" as an escape character. Policy *VaultLockPolicy `locationName:"policy" type:"structure"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input values for InitiateVaultLock.
func (InitiateVaultLockInput) MarshalFields ¶ added in v0.3.0
func (s InitiateVaultLockInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InitiateVaultLockInput) String ¶
func (s InitiateVaultLockInput) String() string
String returns the string representation
func (*InitiateVaultLockInput) Validate ¶
func (s *InitiateVaultLockInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InitiateVaultLockOutput ¶
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 S3 Glacier response to your request.
func (InitiateVaultLockOutput) MarshalFields ¶ added in v0.3.0
func (s InitiateVaultLockOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InitiateVaultLockOutput) String ¶
func (s InitiateVaultLockOutput) String() string
String returns the string representation
type InitiateVaultLockRequest ¶
type InitiateVaultLockRequest struct { *aws.Request Input *InitiateVaultLockInput Copy func(*InitiateVaultLockInput) InitiateVaultLockRequest }
InitiateVaultLockRequest is the request type for the InitiateVaultLock API operation.
func (InitiateVaultLockRequest) Send ¶
func (r InitiateVaultLockRequest) Send(ctx context.Context) (*InitiateVaultLockResponse, error)
Send marshals and sends the InitiateVaultLock API request.
type InitiateVaultLockResponse ¶ added in v0.9.0
type InitiateVaultLockResponse struct { *InitiateVaultLockOutput // contains filtered or unexported fields }
InitiateVaultLockResponse is the response type for the InitiateVaultLock API operation.
func (*InitiateVaultLockResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *InitiateVaultLockResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the InitiateVaultLock request.
type InputSerialization ¶ added in v0.2.0
type InputSerialization struct { // Describes the serialization of a CSV-encoded object. Csv *CSVInput `locationName:"csv" type:"structure"` // contains filtered or unexported fields }
Describes how the archive is serialized.
func (InputSerialization) MarshalFields ¶ added in v0.3.0
func (s InputSerialization) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InputSerialization) String ¶ added in v0.2.0
func (s InputSerialization) String() string
String returns the string representation
type InventoryRetrievalJobDescription ¶
type InventoryRetrievalJobDescription struct { // The end of the date range in UTC for vault inventory retrieval that includes // archives created before this date. This value should be a string in the ISO // 8601 date format, for example 2013-03-20T17:03:43Z. EndDate *string `type:"string"` // The output format for the vault inventory list, which is set by the InitiateJob // request when initiating a job to retrieve a vault inventory. Valid values // are CSV and JSON. Format *string `type:"string"` // The maximum number of inventory items returned per vault inventory retrieval // request. This limit is set when initiating the job with the a InitiateJob // request. Limit *string `type:"string"` // An opaque string that represents where to continue pagination of the vault // inventory retrieval results. You use the marker in a new InitiateJob request // to obtain additional inventory items. If there are no more inventory items, // this value is null. For more information, see Range Inventory Retrieval (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering). Marker *string `type:"string"` // The start of the date range in Universal Coordinated Time (UTC) for vault // inventory retrieval that includes archives created on or after this date. // This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z. StartDate *string `type:"string"` // contains filtered or unexported fields }
Describes the options for a range inventory retrieval job.
func (InventoryRetrievalJobDescription) MarshalFields ¶ added in v0.3.0
func (s InventoryRetrievalJobDescription) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InventoryRetrievalJobDescription) String ¶
func (s InventoryRetrievalJobDescription) String() string
String returns the string representation
type InventoryRetrievalJobInput ¶
type InventoryRetrievalJobInput struct { // The end of the date range in UTC for vault inventory retrieval that includes // archives created before this date. This value should be a string in the ISO // 8601 date format, for example 2013-03-20T17:03:43Z. EndDate *string `type:"string"` // Specifies the maximum number of inventory items returned per vault inventory // retrieval request. Valid values are greater than or equal to 1. Limit *string `type:"string"` // An opaque string that represents where to continue pagination of the vault // inventory retrieval results. You use the marker in a new InitiateJob request // to obtain additional inventory items. If there are no more inventory items, // this value is null. Marker *string `type:"string"` // The start of the date range in UTC for vault inventory retrieval that includes // archives created on or after this date. This value should be a string in // the ISO 8601 date format, for example 2013-03-20T17:03:43Z. StartDate *string `type:"string"` // contains filtered or unexported fields }
Provides options for specifying a range inventory retrieval job.
func (InventoryRetrievalJobInput) MarshalFields ¶ added in v0.3.0
func (s InventoryRetrievalJobInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (InventoryRetrievalJobInput) String ¶
func (s InventoryRetrievalJobInput) String() string
String returns the string representation
type JobParameters ¶
type JobParameters struct { // The ID of the archive that you want to retrieve. This field is required only // if Type is set to select or archive-retrievalcode>. An error occurs if you // specify this request parameter for an inventory retrieval job request. ArchiveId *string `type:"string"` // The optional description for the job. The description must be less than or // equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control // codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. Description *string `type:"string"` // When initiating a job to retrieve a vault inventory, you can optionally add // this parameter to your request to specify the output format. If you are initiating // an inventory job and do not specify a Format field, JSON is the default format. // Valid values are "CSV" and "JSON". Format *string `type:"string"` // Input parameters used for range inventory retrieval. InventoryRetrievalParameters *InventoryRetrievalJobInput `type:"structure"` // Contains information about the location where the select job results are // stored. OutputLocation *OutputLocation `type:"structure"` // The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" // If not specified, the whole archive is retrieved. If specified, the byte // range must be megabyte (1024*1024) aligned which means that StartByteValue // must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 // MB or be the end of the archive specified as the archive byte size value // minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns // a 400 response. // // An error occurs if you specify this field for an inventory retrieval job // request. RetrievalByteRange *string `type:"string"` // The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification // when the job is completed and the output is ready for you to download. The // specified topic publishes the notification to its subscribers. The SNS topic // must exist. SNSTopic *string `type:"string"` // Contains the parameters that define a job. SelectParameters *SelectParameters `type:"structure"` // The tier to use for a select or an archive retrieval job. Valid values are // Expedited, Standard, or Bulk. Standard is the default. Tier *string `type:"string"` // The job type. You can initiate a job to perform a select query on an archive, // retrieve an archive, or get an inventory of a vault. Valid values are "select", // "archive-retrieval" and "inventory-retrieval". Type *string `type:"string"` // contains filtered or unexported fields }
Provides options for defining a job.
func (JobParameters) MarshalFields ¶ added in v0.3.0
func (s JobParameters) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (JobParameters) String ¶
func (s JobParameters) String() string
String returns the string representation
func (*JobParameters) Validate ¶ added in v0.2.0
func (s *JobParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJobsInput ¶
type ListJobsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The state of the jobs to return. You can specify true or false. Completed *string `location:"querystring" locationName:"completed" type:"string"` // The maximum number of jobs to be returned. The default limit is 50. The number // of jobs returned might be fewer than the specified limit, but the number // of returned jobs never exceeds the limit. Limit *string `location:"querystring" locationName:"limit" type:"string"` // An opaque string used for pagination. This value specifies the job at which // the listing of jobs should begin. Get the marker value from a previous List // Jobs response. You only need to include the marker if you are continuing // the pagination of results started in a previous List Jobs request. Marker *string `location:"querystring" locationName:"marker" type:"string"` // The type of job status to return. You can specify the following values: InProgress, // Succeeded, or Failed. Statuscode *string `location:"querystring" locationName:"statuscode" type:"string"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for retrieving a job list for an Amazon S3 Glacier vault.
func (ListJobsInput) MarshalFields ¶ added in v0.3.0
func (s ListJobsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJobsInput) String ¶
func (s ListJobsInput) String() string
String returns the string representation
func (*ListJobsInput) Validate ¶
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 []GlacierJobDescription `type:"list"` // An opaque string used for pagination that specifies the job at which the // listing of jobs should begin. You get the marker value from a previous List // Jobs response. You only need to include the marker if you are continuing // the pagination of the results started in a previous List Jobs request. Marker *string `type:"string"` // contains filtered or unexported fields }
Contains the Amazon S3 Glacier response to your request.
func (ListJobsOutput) MarshalFields ¶ added in v0.3.0
func (s ListJobsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListJobsOutput) String ¶
func (s ListJobsOutput) String() string
String returns the string representation
type ListJobsPaginator ¶ added in v0.9.0
ListJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListJobsPaginator ¶ added in v0.9.0
func NewListJobsPaginator(req ListJobsRequest) ListJobsPaginator
NewListJobsRequestPaginator returns a paginator for ListJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListJobsRequest(input) p := glacier.NewListJobsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListJobsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListJobsPaginator) CurrentPage() *ListJobsOutput
type ListJobsRequest ¶
type ListJobsRequest struct { *aws.Request Input *ListJobsInput Copy func(*ListJobsInput) ListJobsRequest }
ListJobsRequest is the request type for the ListJobs API operation.
func (ListJobsRequest) Send ¶
func (r ListJobsRequest) Send(ctx context.Context) (*ListJobsResponse, error)
Send marshals and sends the ListJobs API request.
type ListJobsResponse ¶ added in v0.9.0
type ListJobsResponse struct { *ListJobsOutput // contains filtered or unexported fields }
ListJobsResponse is the response type for the ListJobs API operation.
func (*ListJobsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListJobsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListJobs request.
type ListMultipartUploadsInput ¶
type ListMultipartUploadsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // Specifies the maximum number of uploads returned in the response body. If // this value is not specified, the List Uploads operation returns up to 50 // 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) MarshalFields ¶ added in v0.3.0
func (s ListMultipartUploadsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListMultipartUploadsInput) String ¶
func (s ListMultipartUploadsInput) String() string
String returns the string representation
func (*ListMultipartUploadsInput) Validate ¶
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 S3 Glacier response to your request.
func (ListMultipartUploadsOutput) MarshalFields ¶ added in v0.3.0
func (s ListMultipartUploadsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListMultipartUploadsOutput) String ¶
func (s ListMultipartUploadsOutput) String() string
String returns the string representation
type ListMultipartUploadsPaginator ¶ added in v0.9.0
ListMultipartUploadsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListMultipartUploadsPaginator ¶ added in v0.9.0
func NewListMultipartUploadsPaginator(req ListMultipartUploadsRequest) ListMultipartUploadsPaginator
NewListMultipartUploadsRequestPaginator returns a paginator for ListMultipartUploads. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListMultipartUploadsRequest(input) p := glacier.NewListMultipartUploadsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListMultipartUploadsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListMultipartUploadsPaginator) CurrentPage() *ListMultipartUploadsOutput
type ListMultipartUploadsRequest ¶
type ListMultipartUploadsRequest struct { *aws.Request Input *ListMultipartUploadsInput Copy func(*ListMultipartUploadsInput) ListMultipartUploadsRequest }
ListMultipartUploadsRequest is the request type for the ListMultipartUploads API operation.
func (ListMultipartUploadsRequest) Send ¶
func (r ListMultipartUploadsRequest) Send(ctx context.Context) (*ListMultipartUploadsResponse, error)
Send marshals and sends the ListMultipartUploads API request.
type ListMultipartUploadsResponse ¶ added in v0.9.0
type ListMultipartUploadsResponse struct { *ListMultipartUploadsOutput // contains filtered or unexported fields }
ListMultipartUploadsResponse is the response type for the ListMultipartUploads API operation.
func (*ListMultipartUploadsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListMultipartUploadsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListMultipartUploads request.
type ListPartsInput ¶
type ListPartsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The maximum number of parts to be returned. The default limit is 50. The // number of parts returned might be fewer than the specified limit, but the // number of returned parts never exceeds the limit. Limit *string `location:"querystring" locationName:"limit" type:"string"` // An opaque string used for pagination. This value specifies the part at which // the listing of parts should begin. Get the marker value from the response // of a previous List Parts response. You need only include the marker if you // are continuing the pagination of results started in a previous List Parts // request. Marker *string `location:"querystring" locationName:"marker" type:"string"` // The upload ID of the multipart upload. // // UploadId is a required field UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
func (ListPartsInput) MarshalFields ¶ added in v0.3.0
func (s ListPartsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListPartsInput) String ¶
func (s ListPartsInput) String() string
String returns the string representation
func (*ListPartsInput) Validate ¶
func (s *ListPartsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPartsOutput ¶
type ListPartsOutput struct { // The description of the archive that was specified in the Initiate Multipart // Upload request. ArchiveDescription *string `type:"string"` // The UTC time at which the multipart upload was initiated. CreationDate *string `type:"string"` // An opaque string that represents where to continue pagination of the results. // You use the marker in a new List Parts request to obtain more jobs in the // list. If there are no more parts, this value is null. Marker *string `type:"string"` // The ID of the upload to which the parts are associated. MultipartUploadId *string `type:"string"` // The part size in bytes. This is the same value that you specified in the // Initiate Multipart Upload request. PartSizeInBytes *int64 `type:"long"` // A list of the part sizes of the multipart upload. Each object in the array // contains a RangeBytes and sha256-tree-hash name/value pair. Parts []PartListElement `type:"list"` // The Amazon Resource Name (ARN) of the vault to which the multipart upload // was initiated. VaultARN *string `type:"string"` // contains filtered or unexported fields }
Contains the Amazon S3 Glacier response to your request.
func (ListPartsOutput) MarshalFields ¶ added in v0.3.0
func (s ListPartsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListPartsOutput) String ¶
func (s ListPartsOutput) String() string
String returns the string representation
type ListPartsPaginator ¶ added in v0.9.0
ListPartsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListPartsPaginator ¶ added in v0.9.0
func NewListPartsPaginator(req ListPartsRequest) ListPartsPaginator
NewListPartsRequestPaginator returns a paginator for ListParts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListPartsRequest(input) p := glacier.NewListPartsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListPartsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListPartsPaginator) CurrentPage() *ListPartsOutput
type ListPartsRequest ¶
type ListPartsRequest struct { *aws.Request Input *ListPartsInput Copy func(*ListPartsInput) ListPartsRequest }
ListPartsRequest is the request type for the ListParts API operation.
func (ListPartsRequest) Send ¶
func (r ListPartsRequest) Send(ctx context.Context) (*ListPartsResponse, error)
Send marshals and sends the ListParts API request.
type ListPartsResponse ¶ added in v0.9.0
type ListPartsResponse struct { *ListPartsOutput // contains filtered or unexported fields }
ListPartsResponse is the response type for the ListParts API operation.
func (*ListPartsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListPartsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListParts request.
type ListProvisionedCapacityInput ¶
type ListProvisionedCapacityInput struct { // The AWS account ID of the account that owns the vault. You can either specify // an AWS account ID or optionally a single '-' (hyphen), in which case Amazon // S3 Glacier uses the AWS account ID associated with the credentials used to // sign the request. If you use an account ID, don't include any hyphens ('-') // in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListProvisionedCapacityInput) MarshalFields ¶ added in v0.3.0
func (s ListProvisionedCapacityInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListProvisionedCapacityInput) String ¶
func (s ListProvisionedCapacityInput) String() string
String returns the string representation
func (*ListProvisionedCapacityInput) Validate ¶
func (s *ListProvisionedCapacityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListProvisionedCapacityOutput ¶
type ListProvisionedCapacityOutput struct { // The response body contains the following JSON fields. ProvisionedCapacityList []ProvisionedCapacityDescription `type:"list"` // contains filtered or unexported fields }
func (ListProvisionedCapacityOutput) MarshalFields ¶ added in v0.3.0
func (s ListProvisionedCapacityOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListProvisionedCapacityOutput) String ¶
func (s ListProvisionedCapacityOutput) String() string
String returns the string representation
type ListProvisionedCapacityRequest ¶
type ListProvisionedCapacityRequest struct { *aws.Request Input *ListProvisionedCapacityInput Copy func(*ListProvisionedCapacityInput) ListProvisionedCapacityRequest }
ListProvisionedCapacityRequest is the request type for the ListProvisionedCapacity API operation.
func (ListProvisionedCapacityRequest) Send ¶
func (r ListProvisionedCapacityRequest) Send(ctx context.Context) (*ListProvisionedCapacityResponse, error)
Send marshals and sends the ListProvisionedCapacity API request.
type ListProvisionedCapacityResponse ¶ added in v0.9.0
type ListProvisionedCapacityResponse struct { *ListProvisionedCapacityOutput // contains filtered or unexported fields }
ListProvisionedCapacityResponse is the response type for the ListProvisionedCapacity API operation.
func (*ListProvisionedCapacityResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListProvisionedCapacityResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListProvisionedCapacity request.
type ListTagsForVaultInput ¶
type ListTagsForVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input value for ListTagsForVaultInput.
func (ListTagsForVaultInput) MarshalFields ¶ added in v0.3.0
func (s ListTagsForVaultInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForVaultInput) String ¶
func (s ListTagsForVaultInput) String() string
String returns the string representation
func (*ListTagsForVaultInput) Validate ¶
func (s *ListTagsForVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForVaultOutput ¶
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 S3 Glacier response to your request.
func (ListTagsForVaultOutput) MarshalFields ¶ added in v0.3.0
func (s ListTagsForVaultOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForVaultOutput) String ¶
func (s ListTagsForVaultOutput) String() string
String returns the string representation
type ListTagsForVaultRequest ¶
type ListTagsForVaultRequest struct { *aws.Request Input *ListTagsForVaultInput Copy func(*ListTagsForVaultInput) ListTagsForVaultRequest }
ListTagsForVaultRequest is the request type for the ListTagsForVault API operation.
func (ListTagsForVaultRequest) Send ¶
func (r ListTagsForVaultRequest) Send(ctx context.Context) (*ListTagsForVaultResponse, error)
Send marshals and sends the ListTagsForVault API request.
type ListTagsForVaultResponse ¶ added in v0.9.0
type ListTagsForVaultResponse struct { *ListTagsForVaultOutput // contains filtered or unexported fields }
ListTagsForVaultResponse is the response type for the ListTagsForVault API operation.
func (*ListTagsForVaultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListTagsForVaultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForVault request.
type ListVaultsInput ¶
type ListVaultsInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The maximum number of vaults to be returned. The default limit is 10. The // number of vaults returned might be fewer than the specified limit, but the // number of returned vaults never exceeds the limit. Limit *string `location:"querystring" locationName:"limit" type:"string"` // A string used for pagination. The marker specifies the vault ARN after which // the listing of vaults should begin. Marker *string `location:"querystring" locationName:"marker" type:"string"` // contains filtered or unexported fields }
Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
func (ListVaultsInput) MarshalFields ¶ added in v0.3.0
func (s ListVaultsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListVaultsInput) String ¶
func (s ListVaultsInput) String() string
String returns the string representation
func (*ListVaultsInput) Validate ¶
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 S3 Glacier response to your request.
func (ListVaultsOutput) MarshalFields ¶ added in v0.3.0
func (s ListVaultsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListVaultsOutput) String ¶
func (s ListVaultsOutput) String() string
String returns the string representation
type ListVaultsPaginator ¶ added in v0.9.0
ListVaultsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListVaultsPaginator ¶ added in v0.9.0
func NewListVaultsPaginator(req ListVaultsRequest) ListVaultsPaginator
NewListVaultsRequestPaginator returns a paginator for ListVaults. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListVaultsRequest(input) p := glacier.NewListVaultsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListVaultsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListVaultsPaginator) CurrentPage() *ListVaultsOutput
type ListVaultsRequest ¶
type ListVaultsRequest struct { *aws.Request Input *ListVaultsInput Copy func(*ListVaultsInput) ListVaultsRequest }
ListVaultsRequest is the request type for the ListVaults API operation.
func (ListVaultsRequest) Send ¶
func (r ListVaultsRequest) Send(ctx context.Context) (*ListVaultsResponse, error)
Send marshals and sends the ListVaults API request.
type ListVaultsResponse ¶ added in v0.9.0
type ListVaultsResponse struct { *ListVaultsOutput // contains filtered or unexported fields }
ListVaultsResponse is the response type for the ListVaults API operation.
func (*ListVaultsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListVaultsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListVaults request.
type OutputLocation ¶ added in v0.2.0
type OutputLocation struct { // Describes an S3 location that will receive the results of the job request. S3 *S3Location `type:"structure"` // contains filtered or unexported fields }
Contains information about the location where the select job results are stored.
func (OutputLocation) MarshalFields ¶ added in v0.3.0
func (s OutputLocation) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (OutputLocation) String ¶ added in v0.2.0
func (s OutputLocation) String() string
String returns the string representation
func (*OutputLocation) Validate ¶ added in v0.2.0
func (s *OutputLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OutputSerialization ¶ added in v0.2.0
type OutputSerialization struct { // Describes the serialization of CSV-encoded query results. Csv *CSVOutput `locationName:"csv" type:"structure"` // contains filtered or unexported fields }
Describes how the select output is serialized.
func (OutputSerialization) MarshalFields ¶ added in v0.3.0
func (s OutputSerialization) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (OutputSerialization) String ¶ added in v0.2.0
func (s OutputSerialization) String() string
String returns the string representation
type PartListElement ¶
type PartListElement struct { // The byte range of a part, inclusive of the upper value of the range. RangeInBytes *string `type:"string"` // The SHA256 tree hash value that Amazon S3 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) MarshalFields ¶ added in v0.3.0
func (s PartListElement) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PartListElement) String ¶
func (s PartListElement) String() string
String returns the string representation
type Permission ¶ added in v0.2.0
type Permission string
const ( PermissionFullControl Permission = "FULL_CONTROL" PermissionWrite Permission = "WRITE" PermissionWriteAcp Permission = "WRITE_ACP" PermissionRead Permission = "READ" PermissionReadAcp Permission = "READ_ACP" )
Enum values for Permission
func (Permission) MarshalValue ¶ added in v0.3.0
func (enum Permission) MarshalValue() (string, error)
func (Permission) MarshalValueBuf ¶ added in v0.3.0
func (enum Permission) MarshalValueBuf(b []byte) ([]byte, error)
type ProvisionedCapacityDescription ¶
type ProvisionedCapacityDescription struct { // The ID that identifies the provisioned capacity unit. CapacityId *string `type:"string"` // The date that the provisioned capacity unit expires, in Universal Coordinated // Time (UTC). ExpirationDate *string `type:"string"` // The date that the provisioned capacity unit was purchased, in Universal Coordinated // Time (UTC). StartDate *string `type:"string"` // contains filtered or unexported fields }
The definition for a provisioned capacity unit.
func (ProvisionedCapacityDescription) MarshalFields ¶ added in v0.3.0
func (s ProvisionedCapacityDescription) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ProvisionedCapacityDescription) String ¶
func (s ProvisionedCapacityDescription) String() string
String returns the string representation
type PurchaseProvisionedCapacityInput ¶
type PurchaseProvisionedCapacityInput struct { // The AWS account ID of the account that owns the vault. You can either specify // an AWS account ID or optionally a single '-' (hyphen), in which case Amazon // S3 Glacier uses the AWS account ID associated with the credentials used to // sign the request. If you use an account ID, don't include any hyphens ('-') // in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // contains filtered or unexported fields }
func (PurchaseProvisionedCapacityInput) MarshalFields ¶ added in v0.3.0
func (s PurchaseProvisionedCapacityInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PurchaseProvisionedCapacityInput) String ¶
func (s PurchaseProvisionedCapacityInput) String() string
String returns the string representation
func (*PurchaseProvisionedCapacityInput) Validate ¶
func (s *PurchaseProvisionedCapacityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PurchaseProvisionedCapacityOutput ¶
type PurchaseProvisionedCapacityOutput struct { // The ID that identifies the provisioned capacity unit. CapacityId *string `location:"header" locationName:"x-amz-capacity-id" type:"string"` // contains filtered or unexported fields }
func (PurchaseProvisionedCapacityOutput) MarshalFields ¶ added in v0.3.0
func (s PurchaseProvisionedCapacityOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PurchaseProvisionedCapacityOutput) String ¶
func (s PurchaseProvisionedCapacityOutput) String() string
String returns the string representation
type PurchaseProvisionedCapacityRequest ¶
type PurchaseProvisionedCapacityRequest struct { *aws.Request Input *PurchaseProvisionedCapacityInput Copy func(*PurchaseProvisionedCapacityInput) PurchaseProvisionedCapacityRequest }
PurchaseProvisionedCapacityRequest is the request type for the PurchaseProvisionedCapacity API operation.
func (PurchaseProvisionedCapacityRequest) Send ¶
func (r PurchaseProvisionedCapacityRequest) Send(ctx context.Context) (*PurchaseProvisionedCapacityResponse, error)
Send marshals and sends the PurchaseProvisionedCapacity API request.
type PurchaseProvisionedCapacityResponse ¶ added in v0.9.0
type PurchaseProvisionedCapacityResponse struct { *PurchaseProvisionedCapacityOutput // contains filtered or unexported fields }
PurchaseProvisionedCapacityResponse is the response type for the PurchaseProvisionedCapacity API operation.
func (*PurchaseProvisionedCapacityResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PurchaseProvisionedCapacityResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PurchaseProvisionedCapacity request.
type QuoteFields ¶ added in v0.2.0
type QuoteFields string
const ( QuoteFieldsAlways QuoteFields = "ALWAYS" QuoteFieldsAsneeded QuoteFields = "ASNEEDED" )
Enum values for QuoteFields
func (QuoteFields) MarshalValue ¶ added in v0.3.0
func (enum QuoteFields) MarshalValue() (string, error)
func (QuoteFields) MarshalValueBuf ¶ added in v0.3.0
func (enum QuoteFields) MarshalValueBuf(b []byte) ([]byte, error)
type RemoveTagsFromVaultInput ¶
type RemoveTagsFromVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // A list of tag keys. Each corresponding tag is removed from the vault. TagKeys []string `type:"list"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
The input value for RemoveTagsFromVaultInput.
func (RemoveTagsFromVaultInput) MarshalFields ¶ added in v0.3.0
func (s RemoveTagsFromVaultInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RemoveTagsFromVaultInput) String ¶
func (s RemoveTagsFromVaultInput) String() string
String returns the string representation
func (*RemoveTagsFromVaultInput) Validate ¶
func (s *RemoveTagsFromVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveTagsFromVaultOutput ¶
type RemoveTagsFromVaultOutput struct {
// contains filtered or unexported fields
}
func (RemoveTagsFromVaultOutput) MarshalFields ¶ added in v0.3.0
func (s RemoveTagsFromVaultOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RemoveTagsFromVaultOutput) String ¶
func (s RemoveTagsFromVaultOutput) String() string
String returns the string representation
type RemoveTagsFromVaultRequest ¶
type RemoveTagsFromVaultRequest struct { *aws.Request Input *RemoveTagsFromVaultInput Copy func(*RemoveTagsFromVaultInput) RemoveTagsFromVaultRequest }
RemoveTagsFromVaultRequest is the request type for the RemoveTagsFromVault API operation.
func (RemoveTagsFromVaultRequest) Send ¶
func (r RemoveTagsFromVaultRequest) Send(ctx context.Context) (*RemoveTagsFromVaultResponse, error)
Send marshals and sends the RemoveTagsFromVault API request.
type RemoveTagsFromVaultResponse ¶ added in v0.9.0
type RemoveTagsFromVaultResponse struct { *RemoveTagsFromVaultOutput // contains filtered or unexported fields }
RemoveTagsFromVaultResponse is the response type for the RemoveTagsFromVault API operation.
func (*RemoveTagsFromVaultResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *RemoveTagsFromVaultResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RemoveTagsFromVault request.
type S3Location ¶ added in v0.2.0
type S3Location struct { // A list of grants that control access to the staged results. AccessControlList []Grant `type:"list"` // The name of the Amazon S3 bucket where the job results are stored. BucketName *string `type:"string"` // The canned access control list (ACL) to apply to the job results. CannedACL CannedACL `type:"string" enum:"true"` // Contains information about the encryption used to store the job results in // Amazon S3. Encryption *Encryption `type:"structure"` // The prefix that is prepended to the results for this request. Prefix *string `type:"string"` // The storage class used to store the job results. StorageClass StorageClass `type:"string" enum:"true"` // The tag-set that is applied to the job results. Tagging map[string]string `type:"map"` // A map of metadata to store with the job results in Amazon S3. UserMetadata map[string]string `type:"map"` // contains filtered or unexported fields }
Contains information about the location in Amazon S3 where the select job results are stored.
func (S3Location) MarshalFields ¶ added in v0.3.0
func (s S3Location) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (S3Location) String ¶ added in v0.2.0
func (s S3Location) String() string
String returns the string representation
func (*S3Location) Validate ¶ added in v0.2.0
func (s *S3Location) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SelectParameters ¶ added in v0.2.0
type SelectParameters struct { // The expression that is used to select the object. Expression *string `type:"string"` // The type of the provided expression, for example SQL. ExpressionType ExpressionType `type:"string" enum:"true"` // Describes the serialization format of the object. InputSerialization *InputSerialization `type:"structure"` // Describes how the results of the select job are serialized. OutputSerialization *OutputSerialization `type:"structure"` // contains filtered or unexported fields }
Contains information about the parameters used for a select.
func (SelectParameters) MarshalFields ¶ added in v0.3.0
func (s SelectParameters) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SelectParameters) String ¶ added in v0.2.0
func (s SelectParameters) String() string
String returns the string representation
type SetDataRetrievalPolicyInput ¶
type SetDataRetrievalPolicyInput struct { // The AccountId value is the AWS account ID. This value must match the AWS // account ID associated with the credentials used to sign the request. You // can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you specify your account ID, do // not include any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The data retrieval policy in JSON format. Policy *DataRetrievalPolicy `type:"structure"` // contains filtered or unexported fields }
SetDataRetrievalPolicy input.
func (SetDataRetrievalPolicyInput) MarshalFields ¶ added in v0.3.0
func (s SetDataRetrievalPolicyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SetDataRetrievalPolicyInput) String ¶
func (s SetDataRetrievalPolicyInput) String() string
String returns the string representation
func (*SetDataRetrievalPolicyInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s SetDataRetrievalPolicyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SetDataRetrievalPolicyOutput) String ¶
func (s SetDataRetrievalPolicyOutput) String() string
String returns the string representation
type SetDataRetrievalPolicyRequest ¶
type SetDataRetrievalPolicyRequest struct { *aws.Request Input *SetDataRetrievalPolicyInput Copy func(*SetDataRetrievalPolicyInput) SetDataRetrievalPolicyRequest }
SetDataRetrievalPolicyRequest is the request type for the SetDataRetrievalPolicy API operation.
func (SetDataRetrievalPolicyRequest) Send ¶
func (r SetDataRetrievalPolicyRequest) Send(ctx context.Context) (*SetDataRetrievalPolicyResponse, error)
Send marshals and sends the SetDataRetrievalPolicy API request.
type SetDataRetrievalPolicyResponse ¶ added in v0.9.0
type SetDataRetrievalPolicyResponse struct { *SetDataRetrievalPolicyOutput // contains filtered or unexported fields }
SetDataRetrievalPolicyResponse is the response type for the SetDataRetrievalPolicy API operation.
func (*SetDataRetrievalPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetDataRetrievalPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetDataRetrievalPolicy request.
type SetVaultAccessPolicyInput ¶
type SetVaultAccessPolicyInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The vault access policy as a JSON string. Policy *VaultAccessPolicy `locationName:"policy" type:"structure"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
SetVaultAccessPolicy input.
func (SetVaultAccessPolicyInput) MarshalFields ¶ added in v0.3.0
func (s SetVaultAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SetVaultAccessPolicyInput) String ¶
func (s SetVaultAccessPolicyInput) String() string
String returns the string representation
func (*SetVaultAccessPolicyInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s SetVaultAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SetVaultAccessPolicyOutput) String ¶
func (s SetVaultAccessPolicyOutput) String() string
String returns the string representation
type SetVaultAccessPolicyRequest ¶
type SetVaultAccessPolicyRequest struct { *aws.Request Input *SetVaultAccessPolicyInput Copy func(*SetVaultAccessPolicyInput) SetVaultAccessPolicyRequest }
SetVaultAccessPolicyRequest is the request type for the SetVaultAccessPolicy API operation.
func (SetVaultAccessPolicyRequest) Send ¶
func (r SetVaultAccessPolicyRequest) Send(ctx context.Context) (*SetVaultAccessPolicyResponse, error)
Send marshals and sends the SetVaultAccessPolicy API request.
type SetVaultAccessPolicyResponse ¶ added in v0.9.0
type SetVaultAccessPolicyResponse struct { *SetVaultAccessPolicyOutput // contains filtered or unexported fields }
SetVaultAccessPolicyResponse is the response type for the SetVaultAccessPolicy API operation.
func (*SetVaultAccessPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetVaultAccessPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetVaultAccessPolicy request.
type SetVaultNotificationsInput ¶
type SetVaultNotificationsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // Provides options for specifying notification configuration. VaultNotificationConfig *VaultNotificationConfig `locationName:"vaultNotificationConfig" type:"structure"` // contains filtered or unexported fields }
Provides options to configure notifications that will be sent when specific events happen to a vault.
func (SetVaultNotificationsInput) MarshalFields ¶ added in v0.3.0
func (s SetVaultNotificationsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SetVaultNotificationsInput) String ¶
func (s SetVaultNotificationsInput) String() string
String returns the string representation
func (*SetVaultNotificationsInput) Validate ¶
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) MarshalFields ¶ added in v0.3.0
func (s SetVaultNotificationsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SetVaultNotificationsOutput) String ¶
func (s SetVaultNotificationsOutput) String() string
String returns the string representation
type SetVaultNotificationsRequest ¶
type SetVaultNotificationsRequest struct { *aws.Request Input *SetVaultNotificationsInput Copy func(*SetVaultNotificationsInput) SetVaultNotificationsRequest }
SetVaultNotificationsRequest is the request type for the SetVaultNotifications API operation.
func (SetVaultNotificationsRequest) Send ¶
func (r SetVaultNotificationsRequest) Send(ctx context.Context) (*SetVaultNotificationsResponse, error)
Send marshals and sends the SetVaultNotifications API request.
type SetVaultNotificationsResponse ¶ added in v0.9.0
type SetVaultNotificationsResponse struct { *SetVaultNotificationsOutput // contains filtered or unexported fields }
SetVaultNotificationsResponse is the response type for the SetVaultNotifications API operation.
func (*SetVaultNotificationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetVaultNotificationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetVaultNotifications request.
type StatusCode ¶
type StatusCode string
const ( StatusCodeInProgress StatusCode = "InProgress" StatusCodeSucceeded StatusCode = "Succeeded" StatusCodeFailed StatusCode = "Failed" )
Enum values for StatusCode
func (StatusCode) MarshalValue ¶ added in v0.3.0
func (enum StatusCode) MarshalValue() (string, error)
func (StatusCode) MarshalValueBuf ¶ added in v0.3.0
func (enum StatusCode) MarshalValueBuf(b []byte) ([]byte, error)
type StorageClass ¶ added in v0.2.0
type StorageClass string
const ( StorageClassStandard StorageClass = "STANDARD" StorageClassReducedRedundancy StorageClass = "REDUCED_REDUNDANCY" StorageClassStandardIa StorageClass = "STANDARD_IA" )
Enum values for StorageClass
func (StorageClass) MarshalValue ¶ added in v0.3.0
func (enum StorageClass) MarshalValue() (string, error)
func (StorageClass) MarshalValueBuf ¶ added in v0.3.0
func (enum StorageClass) MarshalValueBuf(b []byte) ([]byte, error)
type Type ¶ added in v0.2.0
type Type string
const ( TypeAmazonCustomerByEmail Type = "AmazonCustomerByEmail" TypeCanonicalUser Type = "CanonicalUser" TypeGroup Type = "Group" )
Enum values for Type
func (Type) MarshalValue ¶ added in v0.3.0
type UploadArchiveInput ¶
type UploadArchiveInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The optional description of the archive you are uploading. ArchiveDescription *string `location:"header" locationName:"x-amz-archive-description" type:"string"` // The data to upload. Body io.ReadSeeker `locationName:"body" type:"blob"` // The SHA256 tree hash of the data being uploaded. Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"` // The name of the vault. // // VaultName is a required field VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"` // contains filtered or unexported fields }
Provides options to add an archive to a vault.
func (UploadArchiveInput) MarshalFields ¶ added in v0.3.0
func (s UploadArchiveInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UploadArchiveInput) String ¶
func (s UploadArchiveInput) String() string
String returns the string representation
func (*UploadArchiveInput) Validate ¶
func (s *UploadArchiveInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UploadArchiveOutput ¶
type UploadArchiveOutput 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 S3 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 S3 Glacier response to your request.
For information about the underlying REST API, see Upload Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html). For conceptual information, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html).
func (UploadArchiveOutput) MarshalFields ¶ added in v0.3.0
func (s UploadArchiveOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UploadArchiveOutput) String ¶
func (s UploadArchiveOutput) String() string
String returns the string representation
type UploadArchiveRequest ¶
type UploadArchiveRequest struct { *aws.Request Input *UploadArchiveInput Copy func(*UploadArchiveInput) UploadArchiveRequest }
UploadArchiveRequest is the request type for the UploadArchive API operation.
func (UploadArchiveRequest) Send ¶
func (r UploadArchiveRequest) Send(ctx context.Context) (*UploadArchiveResponse, error)
Send marshals and sends the UploadArchive API request.
type UploadArchiveResponse ¶ added in v0.9.0
type UploadArchiveResponse struct { *UploadArchiveOutput // contains filtered or unexported fields }
UploadArchiveResponse is the response type for the UploadArchive API operation.
func (*UploadArchiveResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UploadArchiveResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UploadArchive request.
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) MarshalFields ¶ added in v0.3.0
func (s UploadListElement) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UploadListElement) String ¶
func (s UploadListElement) String() string
String returns the string representation
type UploadMultipartPartInput ¶
type UploadMultipartPartInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. // You can either specify an AWS account ID or optionally a single '-' (hyphen), // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // // AccountId is a required field AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"` // The data to upload. Body io.ReadSeeker `locationName:"body" type:"blob"` // The SHA256 tree hash of the data being uploaded. Checksum *string `location:"header" locationName:"x-amz-sha256-tree-hash" type:"string"` // Identifies the range of bytes in the assembled archive that will be uploaded // in this part. Amazon S3 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) MarshalFields ¶ added in v0.3.0
func (s UploadMultipartPartInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UploadMultipartPartInput) String ¶
func (s UploadMultipartPartInput) String() string
String returns the string representation
func (*UploadMultipartPartInput) Validate ¶
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 S3 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 S3 Glacier response to your request.
func (UploadMultipartPartOutput) MarshalFields ¶ added in v0.3.0
func (s UploadMultipartPartOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UploadMultipartPartOutput) String ¶
func (s UploadMultipartPartOutput) String() string
String returns the string representation
type UploadMultipartPartRequest ¶
type UploadMultipartPartRequest struct { *aws.Request Input *UploadMultipartPartInput Copy func(*UploadMultipartPartInput) UploadMultipartPartRequest }
UploadMultipartPartRequest is the request type for the UploadMultipartPart API operation.
func (UploadMultipartPartRequest) Send ¶
func (r UploadMultipartPartRequest) Send(ctx context.Context) (*UploadMultipartPartResponse, error)
Send marshals and sends the UploadMultipartPart API request.
type UploadMultipartPartResponse ¶ added in v0.9.0
type UploadMultipartPartResponse struct { *UploadMultipartPartOutput // contains filtered or unexported fields }
UploadMultipartPartResponse is the response type for the UploadMultipartPart API operation.
func (*UploadMultipartPartResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UploadMultipartPartResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UploadMultipartPart request.
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) MarshalFields ¶ added in v0.3.0
func (s VaultAccessPolicy) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (VaultAccessPolicy) String ¶
func (s VaultAccessPolicy) String() string
String returns the string representation
type VaultLockPolicy ¶
type VaultLockPolicy struct { // The vault lock policy. Policy *string `type:"string"` // contains filtered or unexported fields }
Contains the vault lock policy.
func (VaultLockPolicy) MarshalFields ¶ added in v0.3.0
func (s VaultLockPolicy) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (VaultLockPolicy) String ¶
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 S3 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) MarshalFields ¶ added in v0.3.0
func (s VaultNotificationConfig) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (VaultNotificationConfig) String ¶
func (s VaultNotificationConfig) String() string
String returns the string representation
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_AbortMultipartUpload.go
- api_op_AbortVaultLock.go
- api_op_AddTagsToVault.go
- api_op_CompleteMultipartUpload.go
- api_op_CompleteVaultLock.go
- api_op_CreateVault.go
- api_op_DeleteArchive.go
- api_op_DeleteVault.go
- api_op_DeleteVaultAccessPolicy.go
- api_op_DeleteVaultNotifications.go
- api_op_DescribeJob.go
- api_op_DescribeVault.go
- api_op_GetDataRetrievalPolicy.go
- api_op_GetJobOutput.go
- api_op_GetVaultAccessPolicy.go
- api_op_GetVaultLock.go
- api_op_GetVaultNotifications.go
- api_op_InitiateJob.go
- api_op_InitiateMultipartUpload.go
- api_op_InitiateVaultLock.go
- api_op_ListJobs.go
- api_op_ListMultipartUploads.go
- api_op_ListParts.go
- api_op_ListProvisionedCapacity.go
- api_op_ListTagsForVault.go
- api_op_ListVaults.go
- api_op_PurchaseProvisionedCapacity.go
- api_op_RemoveTagsFromVault.go
- api_op_SetDataRetrievalPolicy.go
- api_op_SetVaultAccessPolicy.go
- api_op_SetVaultNotifications.go
- api_op_UploadArchive.go
- api_op_UploadMultipartPart.go
- api_types.go
- api_waiters.go
- customizations.go
- treehash.go
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. |