ebs

package
v1.44.137 Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2022 License: Apache-2.0 Imports: 11 Imported by: 22

Documentation

Overview

Package ebs provides the client and types for making API requests to Amazon Elastic Block Store.

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html) in the Amazon Elastic Compute Cloud User Guide. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/ebs-service.html) in the Amazon Web Services General Reference.

See https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02 for more information on this service.

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

Using the Client

To contact Amazon Elastic Block Store 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 Elastic Block Store client EBS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ebs/#New

Index

Constants

View Source 
const (
	// AccessDeniedExceptionReasonUnauthorizedAccount is a AccessDeniedExceptionReason enum value
	AccessDeniedExceptionReasonUnauthorizedAccount = "UNAUTHORIZED_ACCOUNT"

	// AccessDeniedExceptionReasonDependencyAccessDenied is a AccessDeniedExceptionReason enum value
	AccessDeniedExceptionReasonDependencyAccessDenied = "DEPENDENCY_ACCESS_DENIED"
)
View Source 
const (
	// RequestThrottledExceptionReasonAccountThrottled is a RequestThrottledExceptionReason enum value
	RequestThrottledExceptionReasonAccountThrottled = "ACCOUNT_THROTTLED"

	// RequestThrottledExceptionReasonDependencyRequestThrottled is a RequestThrottledExceptionReason enum value
	RequestThrottledExceptionReasonDependencyRequestThrottled = "DEPENDENCY_REQUEST_THROTTLED"

	// RequestThrottledExceptionReasonResourceLevelThrottle is a RequestThrottledExceptionReason enum value
	RequestThrottledExceptionReasonResourceLevelThrottle = "RESOURCE_LEVEL_THROTTLE"
)
View Source 
const (
	// ResourceNotFoundExceptionReasonSnapshotNotFound is a ResourceNotFoundExceptionReason enum value
	ResourceNotFoundExceptionReasonSnapshotNotFound = "SNAPSHOT_NOT_FOUND"

	// ResourceNotFoundExceptionReasonDependencyResourceNotFound is a ResourceNotFoundExceptionReason enum value
	ResourceNotFoundExceptionReasonDependencyResourceNotFound = "DEPENDENCY_RESOURCE_NOT_FOUND"
)
View Source 
const (
	// StatusCompleted is a Status enum value
	StatusCompleted = "completed"

	// StatusPending is a Status enum value
	StatusPending = "pending"

	// StatusError is a Status enum value
	StatusError = "error"
)
View Source 
const (
	// ValidationExceptionReasonInvalidCustomerKey is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidCustomerKey = "INVALID_CUSTOMER_KEY"

	// ValidationExceptionReasonInvalidPageToken is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidPageToken = "INVALID_PAGE_TOKEN"

	// ValidationExceptionReasonInvalidBlockToken is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidBlockToken = "INVALID_BLOCK_TOKEN"

	// ValidationExceptionReasonInvalidSnapshotId is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidSnapshotId = "INVALID_SNAPSHOT_ID"

	// ValidationExceptionReasonUnrelatedSnapshots is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnrelatedSnapshots = "UNRELATED_SNAPSHOTS"

	// ValidationExceptionReasonInvalidBlock is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidBlock = "INVALID_BLOCK"

	// ValidationExceptionReasonInvalidContentEncoding is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidContentEncoding = "INVALID_CONTENT_ENCODING"

	// ValidationExceptionReasonInvalidTag is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidTag = "INVALID_TAG"

	// ValidationExceptionReasonInvalidDependencyRequest is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidDependencyRequest = "INVALID_DEPENDENCY_REQUEST"

	// ValidationExceptionReasonInvalidParameterValue is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidParameterValue = "INVALID_PARAMETER_VALUE"

	// ValidationExceptionReasonInvalidVolumeSize is a ValidationExceptionReason enum value
	ValidationExceptionReasonInvalidVolumeSize = "INVALID_VOLUME_SIZE"

	// ValidationExceptionReasonConflictingBlockUpdate is a ValidationExceptionReason enum value
	ValidationExceptionReasonConflictingBlockUpdate = "CONFLICTING_BLOCK_UPDATE"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConcurrentLimitExceededException for service response error code
	// "ConcurrentLimitExceededException".
	//
	// You have reached the limit for concurrent API requests. For more information,
	// see Optimizing performance of the EBS direct APIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance)
	// in the Amazon Elastic Compute Cloud User Guide.
	ErrCodeConcurrentLimitExceededException = "ConcurrentLimitExceededException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request uses the same client token as a previous, but non-identical request.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal error has occurred.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeRequestThrottledException for service response error code
	// "RequestThrottledException".
	//
	// The number of API requests has exceed the maximum allowed API request throttling
	// limit.
	ErrCodeRequestThrottledException = "RequestThrottledException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// Your current service quotas do not allow you to perform this action.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints of the EBS direct APIs.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "EBS" // Name of service.
	EndpointsID = "ebs" // ID to lookup a service endpoint with.
	ServiceID   = "EBS" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ChecksumAggregationMethodLinear is a ChecksumAggregationMethod enum value
	ChecksumAggregationMethodLinear = "LINEAR"
)
View Source 
const (
	// ChecksumAlgorithmSha256 is a ChecksumAlgorithm enum value
	ChecksumAlgorithmSha256 = "SHA256"
)
View Source 
const (
	// ServiceQuotaExceededExceptionReasonDependencyServiceQuotaExceeded is a ServiceQuotaExceededExceptionReason enum value
	ServiceQuotaExceededExceptionReasonDependencyServiceQuotaExceeded = "DEPENDENCY_SERVICE_QUOTA_EXCEEDED"
)

Variables

This section is empty.

Functions

func AccessDeniedExceptionReason_Values added in v1.34.3 

func AccessDeniedExceptionReason_Values() []string

AccessDeniedExceptionReason_Values returns all elements of the AccessDeniedExceptionReason enum

func ChecksumAggregationMethod_Values added in v1.34.3 

func ChecksumAggregationMethod_Values() []string

ChecksumAggregationMethod_Values returns all elements of the ChecksumAggregationMethod enum

func ChecksumAlgorithm_Values added in v1.34.3 

func ChecksumAlgorithm_Values() []string

ChecksumAlgorithm_Values returns all elements of the ChecksumAlgorithm enum

func RequestThrottledExceptionReason_Values added in v1.34.3 

func RequestThrottledExceptionReason_Values() []string

RequestThrottledExceptionReason_Values returns all elements of the RequestThrottledExceptionReason enum

func ResourceNotFoundExceptionReason_Values added in v1.34.3 

func ResourceNotFoundExceptionReason_Values() []string

ResourceNotFoundExceptionReason_Values returns all elements of the ResourceNotFoundExceptionReason enum

func ServiceQuotaExceededExceptionReason_Values added in v1.34.3 

func ServiceQuotaExceededExceptionReason_Values() []string

ServiceQuotaExceededExceptionReason_Values returns all elements of the ServiceQuotaExceededExceptionReason enum

func Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func ValidationExceptionReason_Values added in v1.34.3 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AccessDeniedException added in v1.33.5 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the exception.
	//
	// Reason is a required field
	Reason *string `type:"string" required:"true" enum:"AccessDeniedExceptionReason"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code added in v1.33.5 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.33.5 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.33.5 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.33.5 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.33.5 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.33.5 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.33.5 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.33.5 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Block 

type Block struct {

	// The block index.
	BlockIndex *int64 `type:"integer"`

	// The block token for the block index.
	BlockToken *string `type:"string"`
	// contains filtered or unexported fields
}

A block of data in an Amazon Elastic Block Store snapshot.

func (Block) GoString 

func (s Block) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Block) SetBlockIndex 

func (s *Block) SetBlockIndex(v int64) *Block

SetBlockIndex sets the BlockIndex field's value.

func (*Block) SetBlockToken 

func (s *Block) SetBlockToken(v string) *Block

SetBlockToken sets the BlockToken field's value.

func (Block) String 

func (s Block) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangedBlock 

type ChangedBlock struct {

	// The block index.
	BlockIndex *int64 `type:"integer"`

	// The block token for the block index of the FirstSnapshotId specified in the
	// ListChangedBlocks operation. This value is absent if the first snapshot does
	// not have the changed block that is on the second snapshot.
	FirstBlockToken *string `type:"string"`

	// The block token for the block index of the SecondSnapshotId specified in
	// the ListChangedBlocks operation.
	SecondBlockToken *string `type:"string"`
	// contains filtered or unexported fields
}

A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.

func (ChangedBlock) GoString 

func (s ChangedBlock) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangedBlock) SetBlockIndex 

func (s *ChangedBlock) SetBlockIndex(v int64) *ChangedBlock

SetBlockIndex sets the BlockIndex field's value.

func (*ChangedBlock) SetFirstBlockToken 

func (s *ChangedBlock) SetFirstBlockToken(v string) *ChangedBlock

SetFirstBlockToken sets the FirstBlockToken field's value.

func (*ChangedBlock) SetSecondBlockToken 

func (s *ChangedBlock) SetSecondBlockToken(v string) *ChangedBlock

SetSecondBlockToken sets the SecondBlockToken field's value.

func (ChangedBlock) String 

func (s ChangedBlock) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompleteSnapshotInput added in v1.33.5 

type CompleteSnapshotInput struct {

	// The number of blocks that were written to the snapshot.
	//
	// ChangedBlocksCount is a required field
	ChangedBlocksCount *int64 `location:"header" locationName:"x-amz-ChangedBlocksCount" type:"integer" required:"true"`

	// An aggregated Base-64 SHA256 checksum based on the checksums of each written
	// block.
	//
	// To generate the aggregated checksum using the linear aggregation method,
	// arrange the checksums for each written block in ascending order of their
	// block index, concatenate them to form a single string, and then generate
	// the checksum on the entire string using the SHA256 algorithm.
	Checksum *string `location:"header" locationName:"x-amz-Checksum" type:"string"`

	// The aggregation method used to generate the checksum. Currently, the only
	// supported aggregation method is LINEAR.
	ChecksumAggregationMethod *string `location:"header" locationName:"x-amz-Checksum-Aggregation-Method" type:"string" enum:"ChecksumAggregationMethod"`

	// The algorithm used to generate the checksum. Currently, the only supported
	// algorithm is SHA256.
	ChecksumAlgorithm *string `location:"header" locationName:"x-amz-Checksum-Algorithm" type:"string" enum:"ChecksumAlgorithm"`

	// The ID of the snapshot.
	//
	// SnapshotId is a required field
	SnapshotId *string `location:"uri" locationName:"snapshotId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CompleteSnapshotInput) GoString added in v1.33.5 

func (s CompleteSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteSnapshotInput) SetChangedBlocksCount added in v1.33.5 

func (s *CompleteSnapshotInput) SetChangedBlocksCount(v int64) *CompleteSnapshotInput

SetChangedBlocksCount sets the ChangedBlocksCount field's value.

func (*CompleteSnapshotInput) SetChecksum added in v1.33.5 

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

SetChecksum sets the Checksum field's value.

func (*CompleteSnapshotInput) SetChecksumAggregationMethod added in v1.33.5 

func (s *CompleteSnapshotInput) SetChecksumAggregationMethod(v string) *CompleteSnapshotInput

SetChecksumAggregationMethod sets the ChecksumAggregationMethod field's value.

func (*CompleteSnapshotInput) SetChecksumAlgorithm added in v1.33.5 

func (s *CompleteSnapshotInput) SetChecksumAlgorithm(v string) *CompleteSnapshotInput

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*CompleteSnapshotInput) SetSnapshotId added in v1.33.5 

func (s *CompleteSnapshotInput) SetSnapshotId(v string) *CompleteSnapshotInput

SetSnapshotId sets the SnapshotId field's value.

func (CompleteSnapshotInput) String added in v1.33.5 

func (s CompleteSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteSnapshotInput) Validate added in v1.33.5 

func (s *CompleteSnapshotInput) Validate() error

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

type CompleteSnapshotOutput added in v1.33.5 

type CompleteSnapshotOutput struct {

	// The status of the snapshot.
	Status *string `type:"string" enum:"Status"`
	// contains filtered or unexported fields
}

func (CompleteSnapshotOutput) GoString added in v1.33.5 

func (s CompleteSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompleteSnapshotOutput) SetStatus added in v1.33.5 

func (s *CompleteSnapshotOutput) SetStatus(v string) *CompleteSnapshotOutput

SetStatus sets the Status field's value.

func (CompleteSnapshotOutput) String added in v1.33.5 

func (s CompleteSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConcurrentLimitExceededException added in v1.33.5 

type ConcurrentLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You have reached the limit for concurrent API requests. For more information, see Optimizing performance of the EBS direct APIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance) in the Amazon Elastic Compute Cloud User Guide.

func (*ConcurrentLimitExceededException) Code added in v1.33.5 

func (s *ConcurrentLimitExceededException) Code() string

Code returns the exception type name.

func (*ConcurrentLimitExceededException) Error added in v1.33.5 

func (s *ConcurrentLimitExceededException) Error() string

func (ConcurrentLimitExceededException) GoString added in v1.33.5 

func (s ConcurrentLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentLimitExceededException) Message added in v1.33.5 

func (s *ConcurrentLimitExceededException) Message() string

Message returns the exception's message.

func (*ConcurrentLimitExceededException) OrigErr added in v1.33.5 

func (s *ConcurrentLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentLimitExceededException) RequestID added in v1.33.5 

func (s *ConcurrentLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentLimitExceededException) StatusCode added in v1.33.5 

func (s *ConcurrentLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentLimitExceededException) String added in v1.33.5 

func (s ConcurrentLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.33.5 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request uses the same client token as a previous, but non-identical request.

func (*ConflictException) Code added in v1.33.5 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.33.5 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.33.5 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.33.5 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.33.5 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.33.5 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.33.5 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.33.5 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EBS 

type EBS struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

mySession := session.Must(session.NewSession())

// Create a EBS client from just a session.
svc := ebs.New(mySession)

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

func (*EBS) CompleteSnapshot added in v1.33.5 

func (c *EBS) CompleteSnapshot(input *CompleteSnapshotInput) (*CompleteSnapshotOutput, error)

CompleteSnapshot API operation for Amazon Elastic Block Store.

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

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

See the AWS API reference guide for Amazon Elastic Block Store's API operation CompleteSnapshot for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ValidationException The input fails to satisfy the constraints of the EBS direct APIs.

  • ResourceNotFoundException The specified resource does not exist.

  • RequestThrottledException The number of API requests has exceed the maximum allowed API request throttling limit.

  • ServiceQuotaExceededException Your current service quotas do not allow you to perform this action.

  • InternalServerException An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/CompleteSnapshot

func (*EBS) CompleteSnapshotRequest added in v1.33.5 

func (c *EBS) CompleteSnapshotRequest(input *CompleteSnapshotInput) (req *request.Request, output *CompleteSnapshotOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/CompleteSnapshot

func (*EBS) CompleteSnapshotWithContext added in v1.33.5 

func (c *EBS) CompleteSnapshotWithContext(ctx aws.Context, input *CompleteSnapshotInput, opts ...request.Option) (*CompleteSnapshotOutput, error)

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

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

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

func (*EBS) GetSnapshotBlock 

func (c *EBS) GetSnapshotBlock(input *GetSnapshotBlockInput) (*GetSnapshotBlockOutput, error)

GetSnapshotBlock API operation for Amazon Elastic Block Store.

Returns the data in a block in an Amazon Elastic Block Store snapshot.

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

See the AWS API reference guide for Amazon Elastic Block Store's API operation GetSnapshotBlock for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ValidationException The input fails to satisfy the constraints of the EBS direct APIs.

  • ResourceNotFoundException The specified resource does not exist.

  • RequestThrottledException The number of API requests has exceed the maximum allowed API request throttling limit.

  • ServiceQuotaExceededException Your current service quotas do not allow you to perform this action.

  • InternalServerException An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/GetSnapshotBlock

func (*EBS) GetSnapshotBlockRequest 

func (c *EBS) GetSnapshotBlockRequest(input *GetSnapshotBlockInput) (req *request.Request, output *GetSnapshotBlockOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/GetSnapshotBlock

func (*EBS) GetSnapshotBlockWithContext 

func (c *EBS) GetSnapshotBlockWithContext(ctx aws.Context, input *GetSnapshotBlockInput, opts ...request.Option) (*GetSnapshotBlockOutput, error)

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

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

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

func (*EBS) ListChangedBlocks 

func (c *EBS) ListChangedBlocks(input *ListChangedBlocksInput) (*ListChangedBlocksOutput, error)

ListChangedBlocks API operation for Amazon Elastic Block Store.

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

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

See the AWS API reference guide for Amazon Elastic Block Store's API operation ListChangedBlocks for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ValidationException The input fails to satisfy the constraints of the EBS direct APIs.

  • ResourceNotFoundException The specified resource does not exist.

  • RequestThrottledException The number of API requests has exceed the maximum allowed API request throttling limit.

  • ServiceQuotaExceededException Your current service quotas do not allow you to perform this action.

  • InternalServerException An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/ListChangedBlocks

func (*EBS) ListChangedBlocksPages 

func (c *EBS) ListChangedBlocksPages(input *ListChangedBlocksInput, fn func(*ListChangedBlocksOutput, bool) bool) error

ListChangedBlocksPages iterates over the pages of a ListChangedBlocks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListChangedBlocks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListChangedBlocks operation.
pageNum := 0
err := client.ListChangedBlocksPages(params,
    func(page *ebs.ListChangedBlocksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EBS) ListChangedBlocksPagesWithContext 

func (c *EBS) ListChangedBlocksPagesWithContext(ctx aws.Context, input *ListChangedBlocksInput, fn func(*ListChangedBlocksOutput, bool) bool, opts ...request.Option) error

ListChangedBlocksPagesWithContext same as ListChangedBlocksPages except it takes a Context and allows setting request options on the pages.

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

func (*EBS) ListChangedBlocksRequest 

func (c *EBS) ListChangedBlocksRequest(input *ListChangedBlocksInput) (req *request.Request, output *ListChangedBlocksOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/ListChangedBlocks

func (*EBS) ListChangedBlocksWithContext 

func (c *EBS) ListChangedBlocksWithContext(ctx aws.Context, input *ListChangedBlocksInput, opts ...request.Option) (*ListChangedBlocksOutput, error)

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

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

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

func (*EBS) ListSnapshotBlocks 

func (c *EBS) ListSnapshotBlocks(input *ListSnapshotBlocksInput) (*ListSnapshotBlocksOutput, error)

ListSnapshotBlocks API operation for Amazon Elastic Block Store.

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

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

See the AWS API reference guide for Amazon Elastic Block Store's API operation ListSnapshotBlocks for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ValidationException The input fails to satisfy the constraints of the EBS direct APIs.

  • ResourceNotFoundException The specified resource does not exist.

  • RequestThrottledException The number of API requests has exceed the maximum allowed API request throttling limit.

  • ServiceQuotaExceededException Your current service quotas do not allow you to perform this action.

  • InternalServerException An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/ListSnapshotBlocks

func (*EBS) ListSnapshotBlocksPages 

func (c *EBS) ListSnapshotBlocksPages(input *ListSnapshotBlocksInput, fn func(*ListSnapshotBlocksOutput, bool) bool) error

ListSnapshotBlocksPages iterates over the pages of a ListSnapshotBlocks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSnapshotBlocks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSnapshotBlocks operation.
pageNum := 0
err := client.ListSnapshotBlocksPages(params,
    func(page *ebs.ListSnapshotBlocksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*EBS) ListSnapshotBlocksPagesWithContext 

func (c *EBS) ListSnapshotBlocksPagesWithContext(ctx aws.Context, input *ListSnapshotBlocksInput, fn func(*ListSnapshotBlocksOutput, bool) bool, opts ...request.Option) error

ListSnapshotBlocksPagesWithContext same as ListSnapshotBlocksPages except it takes a Context and allows setting request options on the pages.

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

func (*EBS) ListSnapshotBlocksRequest 

func (c *EBS) ListSnapshotBlocksRequest(input *ListSnapshotBlocksInput) (req *request.Request, output *ListSnapshotBlocksOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/ListSnapshotBlocks

func (*EBS) ListSnapshotBlocksWithContext 

func (c *EBS) ListSnapshotBlocksWithContext(ctx aws.Context, input *ListSnapshotBlocksInput, opts ...request.Option) (*ListSnapshotBlocksOutput, error)

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

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

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

func (*EBS) PutSnapshotBlock added in v1.33.5 

func (c *EBS) PutSnapshotBlock(input *PutSnapshotBlockInput) (*PutSnapshotBlockOutput, error)

PutSnapshotBlock API operation for Amazon Elastic Block Store.

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

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

See the AWS API reference guide for Amazon Elastic Block Store's API operation PutSnapshotBlock for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ValidationException The input fails to satisfy the constraints of the EBS direct APIs.

  • ResourceNotFoundException The specified resource does not exist.

  • RequestThrottledException The number of API requests has exceed the maximum allowed API request throttling limit.

  • ServiceQuotaExceededException Your current service quotas do not allow you to perform this action.

  • InternalServerException An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/PutSnapshotBlock

func (*EBS) PutSnapshotBlockRequest added in v1.33.5 

func (c *EBS) PutSnapshotBlockRequest(input *PutSnapshotBlockInput) (req *request.Request, output *PutSnapshotBlockOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/PutSnapshotBlock

func (*EBS) PutSnapshotBlockWithContext added in v1.33.5 

func (c *EBS) PutSnapshotBlockWithContext(ctx aws.Context, input *PutSnapshotBlockInput, opts ...request.Option) (*PutSnapshotBlockOutput, error)

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

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

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

func (*EBS) StartSnapshot added in v1.33.5 

func (c *EBS) StartSnapshot(input *StartSnapshotInput) (*StartSnapshotOutput, error)

StartSnapshot API operation for Amazon Elastic Block Store.

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock (https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html) to write blocks of data to the snapshot.

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

See the AWS API reference guide for Amazon Elastic Block Store's API operation StartSnapshot for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ValidationException The input fails to satisfy the constraints of the EBS direct APIs.

  • RequestThrottledException The number of API requests has exceed the maximum allowed API request throttling limit.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceQuotaExceededException Your current service quotas do not allow you to perform this action.

  • InternalServerException An internal error has occurred.

  • ConcurrentLimitExceededException You have reached the limit for concurrent API requests. For more information, see Optimizing performance of the EBS direct APIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance) in the Amazon Elastic Compute Cloud User Guide.

  • ConflictException The request uses the same client token as a previous, but non-identical request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/StartSnapshot

func (*EBS) StartSnapshotRequest added in v1.33.5 

func (c *EBS) StartSnapshotRequest(input *StartSnapshotInput) (req *request.Request, output *StartSnapshotOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/StartSnapshot

func (*EBS) StartSnapshotWithContext added in v1.33.5 

func (c *EBS) StartSnapshotWithContext(ctx aws.Context, input *StartSnapshotInput, opts ...request.Option) (*StartSnapshotOutput, error)

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

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

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

type GetSnapshotBlockInput 

type GetSnapshotBlockInput struct {

	// The block index of the block in which to read the data. A block index is
	// a logical index in units of 512 KiB blocks. To identify the block index,
	// divide the logical offset of the data in the logical volume by the block
	// size (logical offset of data/524288). The logical offset of the data must
	// be 512 KiB aligned.
	//
	// BlockIndex is a required field
	BlockIndex *int64 `location:"uri" locationName:"blockIndex" type:"integer" required:"true"`

	// The block token of the block from which to get data. You can obtain the BlockToken
	// by running the ListChangedBlocks or ListSnapshotBlocks operations.
	//
	// BlockToken is a required field
	BlockToken *string `location:"querystring" locationName:"blockToken" type:"string" required:"true"`

	// The ID of the snapshot containing the block from which to get data.
	//
	// If the specified snapshot is encrypted, you must have permission to use the
	// KMS key that was used to encrypt the snapshot. For more information, see
	// Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// SnapshotId is a required field
	SnapshotId *string `location:"uri" locationName:"snapshotId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSnapshotBlockInput) GoString 

func (s GetSnapshotBlockInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotBlockInput) SetBlockIndex 

func (s *GetSnapshotBlockInput) SetBlockIndex(v int64) *GetSnapshotBlockInput

SetBlockIndex sets the BlockIndex field's value.

func (*GetSnapshotBlockInput) SetBlockToken 

func (s *GetSnapshotBlockInput) SetBlockToken(v string) *GetSnapshotBlockInput

SetBlockToken sets the BlockToken field's value.

func (*GetSnapshotBlockInput) SetSnapshotId 

func (s *GetSnapshotBlockInput) SetSnapshotId(v string) *GetSnapshotBlockInput

SetSnapshotId sets the SnapshotId field's value.

func (GetSnapshotBlockInput) String 

func (s GetSnapshotBlockInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotBlockInput) Validate 

func (s *GetSnapshotBlockInput) Validate() error

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

type GetSnapshotBlockOutput 

type GetSnapshotBlockOutput struct {

	// The data content of the block.
	//
	// BlockData is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetSnapshotBlockOutput's
	// String and GoString methods.
	BlockData io.ReadCloser `type:"blob" sensitive:"true"`

	// The checksum generated for the block, which is Base64 encoded.
	Checksum *string `location:"header" locationName:"x-amz-Checksum" type:"string"`

	// The algorithm used to generate the checksum for the block, such as SHA256.
	ChecksumAlgorithm *string `location:"header" locationName:"x-amz-Checksum-Algorithm" type:"string" enum:"ChecksumAlgorithm"`

	// The size of the data in the block.
	DataLength *int64 `location:"header" locationName:"x-amz-Data-Length" type:"integer"`
	// contains filtered or unexported fields
}

func (GetSnapshotBlockOutput) GoString 

func (s GetSnapshotBlockOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotBlockOutput) SetBlockData 

func (s *GetSnapshotBlockOutput) SetBlockData(v io.ReadCloser) *GetSnapshotBlockOutput

SetBlockData sets the BlockData field's value.

func (*GetSnapshotBlockOutput) SetChecksum 

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

SetChecksum sets the Checksum field's value.

func (*GetSnapshotBlockOutput) SetChecksumAlgorithm 

func (s *GetSnapshotBlockOutput) SetChecksumAlgorithm(v string) *GetSnapshotBlockOutput

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*GetSnapshotBlockOutput) SetDataLength 

func (s *GetSnapshotBlockOutput) SetDataLength(v int64) *GetSnapshotBlockOutput

SetDataLength sets the DataLength field's value.

func (GetSnapshotBlockOutput) String 

func (s GetSnapshotBlockOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException added in v1.33.5 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An internal error has occurred.

func (*InternalServerException) Code added in v1.33.5 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.33.5 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.33.5 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message added in v1.33.5 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.33.5 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.33.5 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.33.5 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.33.5 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListChangedBlocksInput 

type ListChangedBlocksInput struct {

	// The ID of the first snapshot to use for the comparison.
	//
	// The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter;
	// otherwise, an error occurs.
	FirstSnapshotId *string `location:"querystring" locationName:"firstSnapshotId" min:"1" type:"string"`

	// The maximum number of blocks to be returned by the request.
	//
	// Even if additional blocks can be retrieved from the snapshot, the request
	// can return less blocks than MaxResults or an empty array of blocks.
	//
	// To retrieve the next set of blocks from the snapshot, make another request
	// with the returned NextToken value. The value of NextToken is null when there
	// are no more blocks to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"100" type:"integer"`

	// The token to request the next page of results.
	//
	// If you specify NextToken, then StartingBlockIndex is ignored.
	NextToken *string `location:"querystring" locationName:"pageToken" type:"string"`

	// The ID of the second snapshot to use for the comparison.
	//
	// The SecondSnapshotId parameter must be specified with a FirstSnapshotID parameter;
	// otherwise, an error occurs.
	//
	// SecondSnapshotId is a required field
	SecondSnapshotId *string `location:"uri" locationName:"secondSnapshotId" min:"1" type:"string" required:"true"`

	// The block index from which the comparison should start.
	//
	// The list in the response will start from this block index or the next valid
	// block index in the snapshots.
	//
	// If you specify NextToken, then StartingBlockIndex is ignored.
	StartingBlockIndex *int64 `location:"querystring" locationName:"startingBlockIndex" type:"integer"`
	// contains filtered or unexported fields
}

func (ListChangedBlocksInput) GoString 

func (s ListChangedBlocksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListChangedBlocksInput) SetFirstSnapshotId 

func (s *ListChangedBlocksInput) SetFirstSnapshotId(v string) *ListChangedBlocksInput

SetFirstSnapshotId sets the FirstSnapshotId field's value.

func (*ListChangedBlocksInput) SetMaxResults 

func (s *ListChangedBlocksInput) SetMaxResults(v int64) *ListChangedBlocksInput

SetMaxResults sets the MaxResults field's value.

func (*ListChangedBlocksInput) SetNextToken 

func (s *ListChangedBlocksInput) SetNextToken(v string) *ListChangedBlocksInput

SetNextToken sets the NextToken field's value.

func (*ListChangedBlocksInput) SetSecondSnapshotId 

func (s *ListChangedBlocksInput) SetSecondSnapshotId(v string) *ListChangedBlocksInput

SetSecondSnapshotId sets the SecondSnapshotId field's value.

func (*ListChangedBlocksInput) SetStartingBlockIndex 

func (s *ListChangedBlocksInput) SetStartingBlockIndex(v int64) *ListChangedBlocksInput

SetStartingBlockIndex sets the StartingBlockIndex field's value.

func (ListChangedBlocksInput) String 

func (s ListChangedBlocksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListChangedBlocksInput) Validate 

func (s *ListChangedBlocksInput) Validate() error

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

type ListChangedBlocksOutput 

type ListChangedBlocksOutput struct {

	// The size of the blocks in the snapshot, in bytes.
	BlockSize *int64 `type:"integer"`

	// An array of objects containing information about the changed blocks.
	ChangedBlocks []*ChangedBlock `type:"list"`

	// The time when the BlockToken expires.
	ExpiryTime *time.Time `type:"timestamp"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `type:"string"`

	// The size of the volume in GB.
	VolumeSize *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

func (ListChangedBlocksOutput) GoString 

func (s ListChangedBlocksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListChangedBlocksOutput) SetBlockSize 

func (s *ListChangedBlocksOutput) SetBlockSize(v int64) *ListChangedBlocksOutput

SetBlockSize sets the BlockSize field's value.

func (*ListChangedBlocksOutput) SetChangedBlocks 

func (s *ListChangedBlocksOutput) SetChangedBlocks(v []*ChangedBlock) *ListChangedBlocksOutput

SetChangedBlocks sets the ChangedBlocks field's value.

func (*ListChangedBlocksOutput) SetExpiryTime 

func (s *ListChangedBlocksOutput) SetExpiryTime(v time.Time) *ListChangedBlocksOutput

SetExpiryTime sets the ExpiryTime field's value.

func (*ListChangedBlocksOutput) SetNextToken 

func (s *ListChangedBlocksOutput) SetNextToken(v string) *ListChangedBlocksOutput

SetNextToken sets the NextToken field's value.

func (*ListChangedBlocksOutput) SetVolumeSize 

func (s *ListChangedBlocksOutput) SetVolumeSize(v int64) *ListChangedBlocksOutput

SetVolumeSize sets the VolumeSize field's value.

func (ListChangedBlocksOutput) String 

func (s ListChangedBlocksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSnapshotBlocksInput 

type ListSnapshotBlocksInput struct {

	// The maximum number of blocks to be returned by the request.
	//
	// Even if additional blocks can be retrieved from the snapshot, the request
	// can return less blocks than MaxResults or an empty array of blocks.
	//
	// To retrieve the next set of blocks from the snapshot, make another request
	// with the returned NextToken value. The value of NextToken is null when there
	// are no more blocks to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"100" type:"integer"`

	// The token to request the next page of results.
	//
	// If you specify NextToken, then StartingBlockIndex is ignored.
	NextToken *string `location:"querystring" locationName:"pageToken" type:"string"`

	// The ID of the snapshot from which to get block indexes and block tokens.
	//
	// SnapshotId is a required field
	SnapshotId *string `location:"uri" locationName:"snapshotId" min:"1" type:"string" required:"true"`

	// The block index from which the list should start. The list in the response
	// will start from this block index or the next valid block index in the snapshot.
	//
	// If you specify NextToken, then StartingBlockIndex is ignored.
	StartingBlockIndex *int64 `location:"querystring" locationName:"startingBlockIndex" type:"integer"`
	// contains filtered or unexported fields
}

func (ListSnapshotBlocksInput) GoString 

func (s ListSnapshotBlocksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSnapshotBlocksInput) SetMaxResults 

func (s *ListSnapshotBlocksInput) SetMaxResults(v int64) *ListSnapshotBlocksInput

SetMaxResults sets the MaxResults field's value.

func (*ListSnapshotBlocksInput) SetNextToken 

func (s *ListSnapshotBlocksInput) SetNextToken(v string) *ListSnapshotBlocksInput

SetNextToken sets the NextToken field's value.

func (*ListSnapshotBlocksInput) SetSnapshotId 

func (s *ListSnapshotBlocksInput) SetSnapshotId(v string) *ListSnapshotBlocksInput

SetSnapshotId sets the SnapshotId field's value.

func (*ListSnapshotBlocksInput) SetStartingBlockIndex 

func (s *ListSnapshotBlocksInput) SetStartingBlockIndex(v int64) *ListSnapshotBlocksInput

SetStartingBlockIndex sets the StartingBlockIndex field's value.

func (ListSnapshotBlocksInput) String 

func (s ListSnapshotBlocksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSnapshotBlocksInput) Validate 

func (s *ListSnapshotBlocksInput) Validate() error

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

type ListSnapshotBlocksOutput 

type ListSnapshotBlocksOutput struct {

	// The size of the blocks in the snapshot, in bytes.
	BlockSize *int64 `type:"integer"`

	// An array of objects containing information about the blocks.
	//
	// Blocks is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListSnapshotBlocksOutput's
	// String and GoString methods.
	Blocks []*Block `type:"list" sensitive:"true"`

	// The time when the BlockToken expires.
	ExpiryTime *time.Time `type:"timestamp"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `type:"string"`

	// The size of the volume in GB.
	VolumeSize *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

func (ListSnapshotBlocksOutput) GoString 

func (s ListSnapshotBlocksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSnapshotBlocksOutput) SetBlockSize 

func (s *ListSnapshotBlocksOutput) SetBlockSize(v int64) *ListSnapshotBlocksOutput

SetBlockSize sets the BlockSize field's value.

func (*ListSnapshotBlocksOutput) SetBlocks 

func (s *ListSnapshotBlocksOutput) SetBlocks(v []*Block) *ListSnapshotBlocksOutput

SetBlocks sets the Blocks field's value.

func (*ListSnapshotBlocksOutput) SetExpiryTime 

func (s *ListSnapshotBlocksOutput) SetExpiryTime(v time.Time) *ListSnapshotBlocksOutput

SetExpiryTime sets the ExpiryTime field's value.

func (*ListSnapshotBlocksOutput) SetNextToken 

func (s *ListSnapshotBlocksOutput) SetNextToken(v string) *ListSnapshotBlocksOutput

SetNextToken sets the NextToken field's value.

func (*ListSnapshotBlocksOutput) SetVolumeSize 

func (s *ListSnapshotBlocksOutput) SetVolumeSize(v int64) *ListSnapshotBlocksOutput

SetVolumeSize sets the VolumeSize field's value.

func (ListSnapshotBlocksOutput) String 

func (s ListSnapshotBlocksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutSnapshotBlockInput added in v1.33.5 

type PutSnapshotBlockInput struct {

	// The data to write to the block.
	//
	// The block data is not signed as part of the Signature Version 4 signing process.
	// As a result, you must generate and provide a Base64-encoded SHA256 checksum
	// for the block data using the x-amz-Checksum header. Also, you must specify
	// the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum
	// that you provide is part of the Signature Version 4 signing process. It is
	// validated against a checksum generated by Amazon EBS to ensure the validity
	// and authenticity of the data. If the checksums do not correspond, the request
	// fails. For more information, see Using checksums with the EBS direct APIs
	// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// To use an non-seekable io.Reader for this request wrap the io.Reader with
	// "aws.ReadSeekCloser". The SDK will not retry request errors for non-seekable
	// readers. This will allow the SDK to send the reader's payload as chunked
	// transfer encoding.
	//
	// BlockData is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PutSnapshotBlockInput's
	// String and GoString methods.
	//
	// BlockData is a required field
	BlockData io.ReadSeeker `type:"blob" required:"true" sensitive:"true"`

	// The block index of the block in which to write the data. A block index is
	// a logical index in units of 512 KiB blocks. To identify the block index,
	// divide the logical offset of the data in the logical volume by the block
	// size (logical offset of data/524288). The logical offset of the data must
	// be 512 KiB aligned.
	//
	// BlockIndex is a required field
	BlockIndex *int64 `location:"uri" locationName:"blockIndex" type:"integer" required:"true"`

	// A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.
	//
	// Checksum is a required field
	Checksum *string `location:"header" locationName:"x-amz-Checksum" type:"string" required:"true"`

	// The algorithm used to generate the checksum. Currently, the only supported
	// algorithm is SHA256.
	//
	// ChecksumAlgorithm is a required field
	ChecksumAlgorithm *string `location:"header" locationName:"x-amz-Checksum-Algorithm" type:"string" required:"true" enum:"ChecksumAlgorithm"`

	// The size of the data to write to the block, in bytes. Currently, the only
	// supported size is 524288 bytes.
	//
	// Valid values: 524288
	//
	// DataLength is a required field
	DataLength *int64 `location:"header" locationName:"x-amz-Data-Length" type:"integer" required:"true"`

	// The progress of the write process, as a percentage.
	Progress *int64 `location:"header" locationName:"x-amz-Progress" type:"integer"`

	// The ID of the snapshot.
	//
	// If the specified snapshot is encrypted, you must have permission to use the
	// KMS key that was used to encrypt the snapshot. For more information, see
	// Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html)
	// in the Amazon Elastic Compute Cloud User Guide..
	//
	// SnapshotId is a required field
	SnapshotId *string `location:"uri" locationName:"snapshotId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutSnapshotBlockInput) GoString added in v1.33.5 

func (s PutSnapshotBlockInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSnapshotBlockInput) SetBlockData added in v1.33.5 

func (s *PutSnapshotBlockInput) SetBlockData(v io.ReadSeeker) *PutSnapshotBlockInput

SetBlockData sets the BlockData field's value.

func (*PutSnapshotBlockInput) SetBlockIndex added in v1.33.5 

func (s *PutSnapshotBlockInput) SetBlockIndex(v int64) *PutSnapshotBlockInput

SetBlockIndex sets the BlockIndex field's value.

func (*PutSnapshotBlockInput) SetChecksum added in v1.33.5 

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

SetChecksum sets the Checksum field's value.

func (*PutSnapshotBlockInput) SetChecksumAlgorithm added in v1.33.5 

func (s *PutSnapshotBlockInput) SetChecksumAlgorithm(v string) *PutSnapshotBlockInput

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*PutSnapshotBlockInput) SetDataLength added in v1.33.5 

func (s *PutSnapshotBlockInput) SetDataLength(v int64) *PutSnapshotBlockInput

SetDataLength sets the DataLength field's value.

func (*PutSnapshotBlockInput) SetProgress added in v1.33.5 

func (s *PutSnapshotBlockInput) SetProgress(v int64) *PutSnapshotBlockInput

SetProgress sets the Progress field's value.

func (*PutSnapshotBlockInput) SetSnapshotId added in v1.33.5 

func (s *PutSnapshotBlockInput) SetSnapshotId(v string) *PutSnapshotBlockInput

SetSnapshotId sets the SnapshotId field's value.

func (PutSnapshotBlockInput) String added in v1.33.5 

func (s PutSnapshotBlockInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSnapshotBlockInput) Validate added in v1.33.5 

func (s *PutSnapshotBlockInput) Validate() error

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

type PutSnapshotBlockOutput added in v1.33.5 

type PutSnapshotBlockOutput struct {

	// The SHA256 checksum generated for the block data by Amazon EBS.
	Checksum *string `location:"header" locationName:"x-amz-Checksum" type:"string"`

	// The algorithm used by Amazon EBS to generate the checksum.
	ChecksumAlgorithm *string `location:"header" locationName:"x-amz-Checksum-Algorithm" type:"string" enum:"ChecksumAlgorithm"`
	// contains filtered or unexported fields
}

func (PutSnapshotBlockOutput) GoString added in v1.33.5 

func (s PutSnapshotBlockOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSnapshotBlockOutput) SetChecksum added in v1.33.5 

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

SetChecksum sets the Checksum field's value.

func (*PutSnapshotBlockOutput) SetChecksumAlgorithm added in v1.33.5 

func (s *PutSnapshotBlockOutput) SetChecksumAlgorithm(v string) *PutSnapshotBlockOutput

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (PutSnapshotBlockOutput) String added in v1.33.5 

func (s PutSnapshotBlockOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestThrottledException added in v1.33.5 

type RequestThrottledException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the exception.
	Reason *string `type:"string" enum:"RequestThrottledExceptionReason"`
	// contains filtered or unexported fields
}

The number of API requests has exceed the maximum allowed API request throttling limit.

func (*RequestThrottledException) Code added in v1.33.5 

func (s *RequestThrottledException) Code() string

Code returns the exception type name.

func (*RequestThrottledException) Error added in v1.33.5 

func (s *RequestThrottledException) Error() string

func (RequestThrottledException) GoString added in v1.33.5 

func (s RequestThrottledException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestThrottledException) Message added in v1.33.5 

func (s *RequestThrottledException) Message() string

Message returns the exception's message.

func (*RequestThrottledException) OrigErr added in v1.33.5 

func (s *RequestThrottledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestThrottledException) RequestID added in v1.33.5 

func (s *RequestThrottledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestThrottledException) StatusCode added in v1.33.5 

func (s *RequestThrottledException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestThrottledException) String added in v1.33.5 

func (s RequestThrottledException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the exception.
	Reason *string `type:"string" enum:"ResourceNotFoundExceptionReason"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException added in v1.33.5 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the exception.
	Reason *string `type:"string" enum:"ServiceQuotaExceededExceptionReason"`
	// contains filtered or unexported fields
}

Your current service quotas do not allow you to perform this action.

func (*ServiceQuotaExceededException) Code added in v1.33.5 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.33.5 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.33.5 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message added in v1.33.5 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.33.5 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.33.5 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.33.5 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.33.5 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSnapshotInput added in v1.33.5 

type StartSnapshotInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully.
	// The subsequent retries with the same client token return the result from
	// the original successful request and they have no additional effect.
	//
	// If you do not specify a client token, one is automatically generated by the
	// Amazon Web Services SDK.
	//
	// For more information, see Idempotency for StartSnapshot API (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// A description for the snapshot.
	Description *string `type:"string"`

	// Indicates whether to encrypt the snapshot.
	//
	// You can't specify Encrypted and ParentSnapshotId in the same request. If
	// you specify both parameters, the request fails with ValidationException.
	//
	// The encryption status of the snapshot depends on the values that you specify
	// for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web
	// Services account is enabled for encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default).
	// For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// To create an encrypted snapshot, you must have permission to use the KMS
	// key. For more information, see Permissions to use Key Management Service
	// keys (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions)
	// in the Amazon Elastic Compute Cloud User Guide.
	Encrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to
	// be used to encrypt the snapshot.
	//
	// The encryption status of the snapshot depends on the values that you specify
	// for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web
	// Services account is enabled for encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default).
	// For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// To create an encrypted snapshot, you must have permission to use the KMS
	// key. For more information, see Permissions to use Key Management Service
	// keys (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// KmsKeyArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSnapshotInput's
	// String and GoString methods.
	KmsKeyArn *string `min:"1" type:"string" sensitive:"true"`

	// The ID of the parent snapshot. If there is no parent snapshot, or if you
	// are creating the first snapshot for an on-premises volume, omit this parameter.
	//
	// You can't specify ParentSnapshotId and Encrypted in the same request. If
	// you specify both parameters, the request fails with ValidationException.
	//
	// The encryption status of the snapshot depends on the values that you specify
	// for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web
	// Services account is enabled for encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default).
	// For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	//
	// If you specify an encrypted parent snapshot, you must have permission to
	// use the KMS key that was used to encrypt the parent snapshot. For more information,
	// see Permissions to use Key Management Service keys (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions)
	// in the Amazon Elastic Compute Cloud User Guide.
	ParentSnapshotId *string `min:"1" type:"string"`

	// The tags to apply to the snapshot.
	Tags []*Tag `type:"list"`

	// The amount of time (in minutes) after which the snapshot is automatically
	// cancelled if:
	//
	//    * No blocks are written to the snapshot.
	//
	//    * The snapshot is not completed after writing the last block of data.
	//
	// If no value is specified, the timeout defaults to 60 minutes.
	Timeout *int64 `min:"10" type:"integer"`

	// The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).
	//
	// VolumeSize is a required field
	VolumeSize *int64 `min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (StartSnapshotInput) GoString added in v1.33.5 

func (s StartSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSnapshotInput) SetClientToken added in v1.33.5 

func (s *StartSnapshotInput) SetClientToken(v string) *StartSnapshotInput

SetClientToken sets the ClientToken field's value.

func (*StartSnapshotInput) SetDescription added in v1.33.5 

func (s *StartSnapshotInput) SetDescription(v string) *StartSnapshotInput

SetDescription sets the Description field's value.

func (*StartSnapshotInput) SetEncrypted added in v1.33.5 

func (s *StartSnapshotInput) SetEncrypted(v bool) *StartSnapshotInput

SetEncrypted sets the Encrypted field's value.

func (*StartSnapshotInput) SetKmsKeyArn added in v1.33.5 

func (s *StartSnapshotInput) SetKmsKeyArn(v string) *StartSnapshotInput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*StartSnapshotInput) SetParentSnapshotId added in v1.33.5 

func (s *StartSnapshotInput) SetParentSnapshotId(v string) *StartSnapshotInput

SetParentSnapshotId sets the ParentSnapshotId field's value.

func (*StartSnapshotInput) SetTags added in v1.33.5 

func (s *StartSnapshotInput) SetTags(v []*Tag) *StartSnapshotInput

SetTags sets the Tags field's value.

func (*StartSnapshotInput) SetTimeout added in v1.33.5 

func (s *StartSnapshotInput) SetTimeout(v int64) *StartSnapshotInput

SetTimeout sets the Timeout field's value.

func (*StartSnapshotInput) SetVolumeSize added in v1.33.5 

func (s *StartSnapshotInput) SetVolumeSize(v int64) *StartSnapshotInput

SetVolumeSize sets the VolumeSize field's value.

func (StartSnapshotInput) String added in v1.33.5 

func (s StartSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSnapshotInput) Validate added in v1.33.5 

func (s *StartSnapshotInput) Validate() error

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

type StartSnapshotOutput added in v1.33.5 

type StartSnapshotOutput struct {

	// The size of the blocks in the snapshot, in bytes.
	BlockSize *int64 `type:"integer"`

	// The description of the snapshot.
	Description *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used
	// to encrypt the snapshot.
	//
	// KmsKeyArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSnapshotOutput's
	// String and GoString methods.
	KmsKeyArn *string `min:"1" type:"string" sensitive:"true"`

	// The Amazon Web Services account ID of the snapshot owner.
	OwnerId *string `min:"1" type:"string"`

	// The ID of the parent snapshot.
	ParentSnapshotId *string `min:"1" type:"string"`

	// The ID of the snapshot.
	SnapshotId *string `min:"1" type:"string"`

	// The timestamp when the snapshot was created.
	StartTime *time.Time `type:"timestamp"`

	// The status of the snapshot.
	Status *string `type:"string" enum:"Status"`

	// The tags applied to the snapshot. You can specify up to 50 tags per snapshot.
	// For more information, see Tagging your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	Tags []*Tag `type:"list"`

	// The size of the volume, in GiB.
	VolumeSize *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

func (StartSnapshotOutput) GoString added in v1.33.5 

func (s StartSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSnapshotOutput) SetBlockSize added in v1.33.5 

func (s *StartSnapshotOutput) SetBlockSize(v int64) *StartSnapshotOutput

SetBlockSize sets the BlockSize field's value.

func (*StartSnapshotOutput) SetDescription added in v1.33.5 

func (s *StartSnapshotOutput) SetDescription(v string) *StartSnapshotOutput

SetDescription sets the Description field's value.

func (*StartSnapshotOutput) SetKmsKeyArn added in v1.33.5 

func (s *StartSnapshotOutput) SetKmsKeyArn(v string) *StartSnapshotOutput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*StartSnapshotOutput) SetOwnerId added in v1.33.5 

func (s *StartSnapshotOutput) SetOwnerId(v string) *StartSnapshotOutput

SetOwnerId sets the OwnerId field's value.

func (*StartSnapshotOutput) SetParentSnapshotId added in v1.33.5 

func (s *StartSnapshotOutput) SetParentSnapshotId(v string) *StartSnapshotOutput

SetParentSnapshotId sets the ParentSnapshotId field's value.

func (*StartSnapshotOutput) SetSnapshotId added in v1.33.5 

func (s *StartSnapshotOutput) SetSnapshotId(v string) *StartSnapshotOutput

SetSnapshotId sets the SnapshotId field's value.

func (*StartSnapshotOutput) SetStartTime added in v1.33.5 

func (s *StartSnapshotOutput) SetStartTime(v time.Time) *StartSnapshotOutput

SetStartTime sets the StartTime field's value.

func (*StartSnapshotOutput) SetStatus added in v1.33.5 

func (s *StartSnapshotOutput) SetStatus(v string) *StartSnapshotOutput

SetStatus sets the Status field's value.

func (*StartSnapshotOutput) SetTags added in v1.33.5 

func (s *StartSnapshotOutput) SetTags(v []*Tag) *StartSnapshotOutput

SetTags sets the Tags field's value.

func (*StartSnapshotOutput) SetVolumeSize added in v1.33.5 

func (s *StartSnapshotOutput) SetVolumeSize(v int64) *StartSnapshotOutput

SetVolumeSize sets the VolumeSize field's value.

func (StartSnapshotOutput) String added in v1.33.5 

func (s StartSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.33.5 

type Tag struct {

	// The key of the tag.
	Key *string `type:"string"`

	// The value of the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a tag.

func (Tag) GoString added in v1.33.5 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.33.5 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.33.5 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.33.5 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.28.0 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the validation exception.
	Reason *string `type:"string" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints of the EBS direct APIs.

func (*ValidationException) Code added in v1.28.0 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.28.0 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.28.0 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.28.0 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.28.0 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.28.0 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.28.0 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package ebsiface provides an interface to enable mocking the Amazon Elastic Block Store service client for testing your code.
 Package ebsiface provides an interface to enable mocking the Amazon Elastic Block Store service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.