backupstorage

package module
v1.9.10 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2024 License: Apache-2.0 Imports: 42 Imported by: 3

Documentation

Overview

Package backupstorage provides the API client, operations, and parameter types for AWS Backup Storage.

The frontend service for Cryo Storage.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-04-10"
View Source 
const ServiceID = "BackupStorage"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.2.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.6.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.6.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.6.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.6.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for AWS Backup Storage.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) DeleteObject 

func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error)

Delete Object from the incremental base Backup.

func (*Client) GetChunk 

func (c *Client) GetChunk(ctx context.Context, params *GetChunkInput, optFns ...func(*Options)) (*GetChunkOutput, error)

Gets the specified object's chunk.

func (*Client) GetObjectMetadata 

func (c *Client) GetObjectMetadata(ctx context.Context, params *GetObjectMetadataInput, optFns ...func(*Options)) (*GetObjectMetadataOutput, error)

Get metadata associated with an Object.

func (*Client) ListChunks 

func (c *Client) ListChunks(ctx context.Context, params *ListChunksInput, optFns ...func(*Options)) (*ListChunksOutput, error)

List chunks in a given Object

func (*Client) ListObjects 

func (c *Client) ListObjects(ctx context.Context, params *ListObjectsInput, optFns ...func(*Options)) (*ListObjectsOutput, error)

List all Objects in a given Backup.

func (*Client) NotifyObjectComplete 

func (c *Client) NotifyObjectComplete(ctx context.Context, params *NotifyObjectCompleteInput, optFns ...func(*Options)) (*NotifyObjectCompleteOutput, error)

Complete upload

func (*Client) Options added in v1.7.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutChunk 

func (c *Client) PutChunk(ctx context.Context, params *PutChunkInput, optFns ...func(*Options)) (*PutChunkOutput, error)

Upload chunk.

func (*Client) PutObject 

func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*Options)) (*PutObjectOutput, error)

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

func (*Client) StartObject 

func (c *Client) StartObject(ctx context.Context, params *StartObjectInput, optFns ...func(*Options)) (*StartObjectOutput, error)

Start upload containing one or many chunks.

type DeleteObjectInput 

type DeleteObjectInput struct {

	// Backup job Id for the in-progress backup.
	//
	// This member is required.
	BackupJobId *string

	// The name of the Object.
	//
	// This member is required.
	ObjectName *string
	// contains filtered or unexported fields
}

type DeleteObjectOutput 

type DeleteObjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.2.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.2.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.2.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.2.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.2.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetChunkInput 

type GetChunkInput struct {

	// Chunk token
	//
	// This member is required.
	ChunkToken *string

	// Storage job id
	//
	// This member is required.
	StorageJobId *string
	// contains filtered or unexported fields
}

type GetChunkOutput 

type GetChunkOutput struct {

	// Data checksum
	//
	// This member is required.
	Checksum *string

	// Checksum algorithm
	//
	// This member is required.
	ChecksumAlgorithm types.DataChecksumAlgorithm

	// Chunk data
	//
	// This member is required.
	Data io.ReadCloser

	// Data length
	//
	// This member is required.
	Length int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetObjectMetadataInput 

type GetObjectMetadataInput struct {

	// Object token.
	//
	// This member is required.
	ObjectToken *string

	// Backup job id for the in-progress backup.
	//
	// This member is required.
	StorageJobId *string
	// contains filtered or unexported fields
}

type GetObjectMetadataOutput 

type GetObjectMetadataOutput struct {

	// Metadata blob.
	MetadataBlob io.ReadCloser

	// MetadataBlob checksum.
	MetadataBlobChecksum *string

	// Checksum algorithm.
	MetadataBlobChecksumAlgorithm types.DataChecksumAlgorithm

	// The size of MetadataBlob.
	MetadataBlobLength int64

	// Metadata string.
	MetadataString *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListChunksAPIClient 

type ListChunksAPIClient interface {
	ListChunks(context.Context, *ListChunksInput, ...func(*Options)) (*ListChunksOutput, error)
}

ListChunksAPIClient is a client that implements the ListChunks operation.

type ListChunksInput 

type ListChunksInput struct {

	// Object token
	//
	// This member is required.
	ObjectToken *string

	// Storage job id
	//
	// This member is required.
	StorageJobId *string

	// Maximum number of chunks
	MaxResults *int32

	// Pagination token
	NextToken *string
	// contains filtered or unexported fields
}

type ListChunksOutput 

type ListChunksOutput struct {

	// List of chunks
	//
	// This member is required.
	ChunkList []types.Chunk

	// Pagination token
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListChunksPaginator 

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

ListChunksPaginator is a paginator for ListChunks

func NewListChunksPaginator 

func NewListChunksPaginator(client ListChunksAPIClient, params *ListChunksInput, optFns ...func(*ListChunksPaginatorOptions)) *ListChunksPaginator

NewListChunksPaginator returns a new ListChunksPaginator

func (*ListChunksPaginator) HasMorePages 

func (p *ListChunksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChunksPaginator) NextPage 

func (p *ListChunksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChunksOutput, error)

NextPage retrieves the next ListChunks page.

type ListChunksPaginatorOptions 

type ListChunksPaginatorOptions struct {
	// Maximum number of chunks
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListChunksPaginatorOptions is the paginator options for ListChunks

type ListObjectsAPIClient 

type ListObjectsAPIClient interface {
	ListObjects(context.Context, *ListObjectsInput, ...func(*Options)) (*ListObjectsOutput, error)
}

ListObjectsAPIClient is a client that implements the ListObjects operation.

type ListObjectsInput 

type ListObjectsInput struct {

	// Storage job id
	//
	// This member is required.
	StorageJobId *string

	// (Optional) Created after filter
	CreatedAfter *time.Time

	// (Optional) Created before filter
	CreatedBefore *time.Time

	// Maximum objects count
	MaxResults *int32

	// Pagination token
	NextToken *string

	// Optional, specifies the starting Object name to list from. Ignored if NextToken
	// is not NULL
	StartingObjectName *string

	// Optional, specifies the starting Object prefix to list from. Ignored if
	// NextToken is not NULL
	StartingObjectPrefix *string
	// contains filtered or unexported fields
}

type ListObjectsOutput 

type ListObjectsOutput struct {

	// Object list
	//
	// This member is required.
	ObjectList []types.BackupObject

	// Pagination token
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListObjectsPaginator 

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

ListObjectsPaginator is a paginator for ListObjects

func NewListObjectsPaginator 

func NewListObjectsPaginator(client ListObjectsAPIClient, params *ListObjectsInput, optFns ...func(*ListObjectsPaginatorOptions)) *ListObjectsPaginator

NewListObjectsPaginator returns a new ListObjectsPaginator

func (*ListObjectsPaginator) HasMorePages 

func (p *ListObjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListObjectsPaginator) NextPage 

func (p *ListObjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectsOutput, error)

NextPage retrieves the next ListObjects page.

type ListObjectsPaginatorOptions 

type ListObjectsPaginatorOptions struct {
	// Maximum objects count
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListObjectsPaginatorOptions is the paginator options for ListObjects

type NotifyObjectCompleteInput 

type NotifyObjectCompleteInput struct {

	// Backup job Id for the in-progress backup
	//
	// This member is required.
	BackupJobId *string

	// Object checksum
	//
	// This member is required.
	ObjectChecksum *string

	// Checksum algorithm
	//
	// This member is required.
	ObjectChecksumAlgorithm types.SummaryChecksumAlgorithm

	// Upload Id for the in-progress upload
	//
	// This member is required.
	UploadId *string

	// Optional metadata associated with an Object. Maximum length is 4MB.
	MetadataBlob io.Reader

	// Checksum of MetadataBlob.
	MetadataBlobChecksum *string

	// Checksum algorithm.
	MetadataBlobChecksumAlgorithm types.DataChecksumAlgorithm

	// The size of MetadataBlob.
	MetadataBlobLength int64

	// Optional metadata associated with an Object. Maximum string length is 256 bytes.
	MetadataString *string
	// contains filtered or unexported fields
}

type NotifyObjectCompleteOutput 

type NotifyObjectCompleteOutput struct {

	// Object checksum
	//
	// This member is required.
	ObjectChecksum *string

	// Checksum algorithm
	//
	// This member is required.
	ObjectChecksumAlgorithm types.SummaryChecksumAlgorithm

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.6.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutChunkInput 

type PutChunkInput struct {

	// Backup job Id for the in-progress backup.
	//
	// This member is required.
	BackupJobId *string

	// Data checksum
	//
	// This member is required.
	Checksum *string

	// Checksum algorithm
	//
	// This member is required.
	ChecksumAlgorithm types.DataChecksumAlgorithm

	// Describes this chunk's position relative to the other chunks
	//
	// This member is required.
	ChunkIndex *int64

	// Data to be uploaded
	//
	// This member is required.
	Data io.Reader

	// Data length
	//
	// This member is required.
	Length int64

	// Upload Id for the in-progress upload.
	//
	// This member is required.
	UploadId *string
	// contains filtered or unexported fields
}

type PutChunkOutput 

type PutChunkOutput struct {

	// Chunk checksum
	//
	// This member is required.
	ChunkChecksum *string

	// Checksum algorithm
	//
	// This member is required.
	ChunkChecksumAlgorithm types.DataChecksumAlgorithm

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutObjectInput 

type PutObjectInput struct {

	// Backup job Id for the in-progress backup.
	//
	// This member is required.
	BackupJobId *string

	// The name of the Object to be uploaded.
	//
	// This member is required.
	ObjectName *string

	// Inline chunk data to be uploaded.
	InlineChunk io.Reader

	// Inline chunk checksum
	InlineChunkChecksum *string

	// Inline chunk checksum algorithm
	InlineChunkChecksumAlgorithm *string

	// Length of the inline chunk data.
	InlineChunkLength int64

	// Store user defined metadata like backup checksum, disk ids, restore metadata
	// etc.
	MetadataString *string

	// object checksum
	ObjectChecksum *string

	// object checksum algorithm
	ObjectChecksumAlgorithm types.SummaryChecksumAlgorithm

	// Throw an exception if Object name is already exist.
	ThrowOnDuplicate bool
	// contains filtered or unexported fields
}

type PutObjectOutput 

type PutObjectOutput struct {

	// Inline chunk checksum
	//
	// This member is required.
	InlineChunkChecksum *string

	// Inline chunk checksum algorithm
	//
	// This member is required.
	InlineChunkChecksumAlgorithm types.DataChecksumAlgorithm

	// object checksum
	//
	// This member is required.
	ObjectChecksum *string

	// object checksum algorithm
	//
	// This member is required.
	ObjectChecksumAlgorithm types.SummaryChecksumAlgorithm

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartObjectInput 

type StartObjectInput struct {

	// Backup job Id for the in-progress backup
	//
	// This member is required.
	BackupJobId *string

	// Name for the object.
	//
	// This member is required.
	ObjectName *string

	// Throw an exception if Object name is already exist.
	ThrowOnDuplicate bool
	// contains filtered or unexported fields
}

type StartObjectOutput 

type StartObjectOutput struct {

	// Upload Id for a given upload.
	//
	// This member is required.
	UploadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.