aws-sdk-go: github.com/aws/aws-sdk-go/service/ebs Index | Files | Directories

package ebs

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

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

You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.

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 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 AWS 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 AWS 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

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (

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

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // The input fails to satisfy the constraints of the EBS direct APIs.
    ErrCodeValidationException = "ValidationException"
)
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

const (
    // ChecksumAlgorithmSha256 is a ChecksumAlgorithm enum value
    ChecksumAlgorithmSha256 = "SHA256"
)

type Block Uses

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 Uses

func (s Block) GoString() string

GoString returns the string representation

func (*Block) SetBlockIndex Uses

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

SetBlockIndex sets the BlockIndex field's value.

func (*Block) SetBlockToken Uses

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

SetBlockToken sets the BlockToken field's value.

func (Block) String Uses

func (s Block) String() string

String returns the string representation

type ChangedBlock Uses

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 Uses

func (s ChangedBlock) GoString() string

GoString returns the string representation

func (*ChangedBlock) SetBlockIndex Uses

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

SetBlockIndex sets the BlockIndex field's value.

func (*ChangedBlock) SetFirstBlockToken Uses

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

SetFirstBlockToken sets the FirstBlockToken field's value.

func (*ChangedBlock) SetSecondBlockToken Uses

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

SetSecondBlockToken sets the SecondBlockToken field's value.

func (ChangedBlock) String Uses

func (s ChangedBlock) String() string

String returns the string representation

type EBS Uses

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 Uses

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) GetSnapshotBlock Uses

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:

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

* ResourceNotFoundException
The specified resource does not exist.

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

func (*EBS) GetSnapshotBlockRequest Uses

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 Uses

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 Uses

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

ListChangedBlocks API operation for Amazon Elastic Block Store.

Returns the block indexes and block tokens for 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:

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

* ResourceNotFoundException
The specified resource does not exist.

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

func (*EBS) ListChangedBlocksPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

ListSnapshotBlocks API operation for Amazon Elastic Block Store.

Returns the block indexes and block tokens for 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:

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

* ResourceNotFoundException
The specified resource does not exist.

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

func (*EBS) ListSnapshotBlocksPages Uses

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 Uses

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 Uses

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 Uses

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.

type GetSnapshotBlockInput Uses

type GetSnapshotBlockInput struct {

    // The block index of the block from which to get data.
    //
    // Obtain the BlockIndex by running the ListChangedBlocks or ListSnapshotBlocks
    // operations.
    //
    // 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.
    //
    // 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.
    //
    // 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 Uses

func (s GetSnapshotBlockInput) GoString() string

GoString returns the string representation

func (*GetSnapshotBlockInput) SetBlockIndex Uses

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

SetBlockIndex sets the BlockIndex field's value.

func (*GetSnapshotBlockInput) SetBlockToken Uses

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

SetBlockToken sets the BlockToken field's value.

func (*GetSnapshotBlockInput) SetSnapshotId Uses

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

SetSnapshotId sets the SnapshotId field's value.

func (GetSnapshotBlockInput) String Uses

func (s GetSnapshotBlockInput) String() string

String returns the string representation

func (*GetSnapshotBlockInput) Validate Uses

func (s *GetSnapshotBlockInput) Validate() error

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

type GetSnapshotBlockOutput Uses

type GetSnapshotBlockOutput struct {

    // The data content of the block.
    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 Uses

func (s GetSnapshotBlockOutput) GoString() string

GoString returns the string representation

func (*GetSnapshotBlockOutput) SetBlockData Uses

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

SetBlockData sets the BlockData field's value.

func (*GetSnapshotBlockOutput) SetChecksum Uses

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

SetChecksum sets the Checksum field's value.

func (*GetSnapshotBlockOutput) SetChecksumAlgorithm Uses

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

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*GetSnapshotBlockOutput) SetDataLength Uses

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

SetDataLength sets the DataLength field's value.

func (GetSnapshotBlockOutput) String Uses

func (s GetSnapshotBlockOutput) String() string

String returns the string representation

type ListChangedBlocksInput Uses

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 number of results to return.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"100" type:"integer"`

    // The token to request the next page of results.
    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.
    StartingBlockIndex *int64 `location:"querystring" locationName:"startingBlockIndex" type:"integer"`
    // contains filtered or unexported fields
}

func (ListChangedBlocksInput) GoString Uses

func (s ListChangedBlocksInput) GoString() string

GoString returns the string representation

func (*ListChangedBlocksInput) SetFirstSnapshotId Uses

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

SetFirstSnapshotId sets the FirstSnapshotId field's value.

func (*ListChangedBlocksInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListChangedBlocksInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListChangedBlocksInput) SetSecondSnapshotId Uses

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

SetSecondSnapshotId sets the SecondSnapshotId field's value.

func (*ListChangedBlocksInput) SetStartingBlockIndex Uses

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

SetStartingBlockIndex sets the StartingBlockIndex field's value.

func (ListChangedBlocksInput) String Uses

func (s ListChangedBlocksInput) String() string

String returns the string representation

func (*ListChangedBlocksInput) Validate Uses

func (s *ListChangedBlocksInput) Validate() error

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

type ListChangedBlocksOutput Uses

type ListChangedBlocksOutput struct {

    // The size of the block.
    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 `type:"long"`
    // contains filtered or unexported fields
}

func (ListChangedBlocksOutput) GoString Uses

func (s ListChangedBlocksOutput) GoString() string

GoString returns the string representation

func (*ListChangedBlocksOutput) SetBlockSize Uses

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

SetBlockSize sets the BlockSize field's value.

func (*ListChangedBlocksOutput) SetChangedBlocks Uses

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

SetChangedBlocks sets the ChangedBlocks field's value.

func (*ListChangedBlocksOutput) SetExpiryTime Uses

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

SetExpiryTime sets the ExpiryTime field's value.

func (*ListChangedBlocksOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListChangedBlocksOutput) SetVolumeSize Uses

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

SetVolumeSize sets the VolumeSize field's value.

func (ListChangedBlocksOutput) String Uses

func (s ListChangedBlocksOutput) String() string

String returns the string representation

type ListSnapshotBlocksInput Uses

type ListSnapshotBlocksInput struct {

    // The number of results to return.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"100" type:"integer"`

    // The token to request the next page of results.
    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.
    StartingBlockIndex *int64 `location:"querystring" locationName:"startingBlockIndex" type:"integer"`
    // contains filtered or unexported fields
}

func (ListSnapshotBlocksInput) GoString Uses

func (s ListSnapshotBlocksInput) GoString() string

GoString returns the string representation

func (*ListSnapshotBlocksInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListSnapshotBlocksInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListSnapshotBlocksInput) SetSnapshotId Uses

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

SetSnapshotId sets the SnapshotId field's value.

func (*ListSnapshotBlocksInput) SetStartingBlockIndex Uses

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

SetStartingBlockIndex sets the StartingBlockIndex field's value.

func (ListSnapshotBlocksInput) String Uses

func (s ListSnapshotBlocksInput) String() string

String returns the string representation

func (*ListSnapshotBlocksInput) Validate Uses

func (s *ListSnapshotBlocksInput) Validate() error

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

type ListSnapshotBlocksOutput Uses

type ListSnapshotBlocksOutput struct {

    // The size of the block.
    BlockSize *int64 `type:"integer"`

    // An array of objects containing information about the blocks.
    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 `type:"long"`
    // contains filtered or unexported fields
}

func (ListSnapshotBlocksOutput) GoString Uses

func (s ListSnapshotBlocksOutput) GoString() string

GoString returns the string representation

func (*ListSnapshotBlocksOutput) SetBlockSize Uses

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

SetBlockSize sets the BlockSize field's value.

func (*ListSnapshotBlocksOutput) SetBlocks Uses

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

SetBlocks sets the Blocks field's value.

func (*ListSnapshotBlocksOutput) SetExpiryTime Uses

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

SetExpiryTime sets the ExpiryTime field's value.

func (*ListSnapshotBlocksOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListSnapshotBlocksOutput) SetVolumeSize Uses

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

SetVolumeSize sets the VolumeSize field's value.

func (ListSnapshotBlocksOutput) String Uses

func (s ListSnapshotBlocksOutput) String() string

String returns the string representation

type ResourceNotFoundException Uses

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

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

The specified resource does not exist.

func (*ResourceNotFoundException) Code Uses

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error Uses

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString Uses

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message Uses

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr Uses

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID Uses

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode Uses

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String Uses

func (s ResourceNotFoundException) String() string

String returns the string representation

type ValidationException Uses

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 Uses

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error Uses

func (s *ValidationException) Error() string

func (ValidationException) GoString Uses

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message Uses

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr Uses

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID Uses

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode Uses

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String Uses

func (s ValidationException) String() string

String returns the string representation

Directories

PathSynopsis
ebsifacePackage ebsiface provides an interface to enable mocking the Amazon Elastic Block Store service client for testing your code.

Package ebs imports 11 packages (graph) and is imported by 7 packages. Updated 2020-04-05. Refresh now. Tools for package owners.