backupstorage

package
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Jul 4, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package backupstorage provides the client and types for making API requests to AWS Backup Storage.

The frontend service for Cryo Storage.

See https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10 for more information on this service.

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

Using the Client

To contact AWS Backup Storage 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 AWS Backup Storage client BackupStorage for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/backupstorage/#New

Index

Constants

View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeDataAlreadyExistsException for service response error code
	// "DataAlreadyExistsException".
	//
	// Non-retryable exception. Attempted to create already existing object or chunk.
	// This message contains a checksum of already presented data.
	ErrCodeDataAlreadyExistsException = "DataAlreadyExistsException"

	// ErrCodeIllegalArgumentException for service response error code
	// "IllegalArgumentException".
	//
	// Non-retryable exception, indicates client error (wrong argument passed to
	// API). See exception message for details.
	ErrCodeIllegalArgumentException = "IllegalArgumentException"

	// ErrCodeKMSInvalidKeyUsageException for service response error code
	// "KMSInvalidKeyUsageException".
	//
	// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception
	// message for details.
	ErrCodeKMSInvalidKeyUsageException = "KMSInvalidKeyUsageException"

	// ErrCodeNotReadableInputStreamException for service response error code
	// "NotReadableInputStreamException".
	//
	// Retryalble exception. Indicated issues while reading an input stream due
	// to the networking issues or connection drop on the client side.
	ErrCodeNotReadableInputStreamException = "NotReadableInputStreamException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Non-retryable exception. Attempted to make an operation on non-existing or
	// expired resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeRetryableException for service response error code
	// "RetryableException".
	//
	// Retryable exception. In general indicates internal failure that can be fixed
	// by retry.
	ErrCodeRetryableException = "RetryableException"

	// ErrCodeServiceInternalException for service response error code
	// "ServiceInternalException".
	//
	// Deprecated. To be removed from the model.
	ErrCodeServiceInternalException = "ServiceInternalException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Retryable exception, indicates internal server error.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Increased rate over throttling limits. Can be retried with exponential backoff.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source 
const (
	ServiceName = "BackupStorage" // Name of service.
	EndpointsID = "backupstorage" // ID to lookup a service endpoint with.
	ServiceID   = "BackupStorage" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// DataChecksumAlgorithmSha256 is a DataChecksumAlgorithm enum value
	DataChecksumAlgorithmSha256 = "SHA256"
)
View Source 
const (
	// SummaryChecksumAlgorithmSummary is a SummaryChecksumAlgorithm enum value
	SummaryChecksumAlgorithmSummary = "SUMMARY"
)

Variables

This section is empty.

Functions

func DataChecksumAlgorithm_Values 

func DataChecksumAlgorithm_Values() []string

DataChecksumAlgorithm_Values returns all elements of the DataChecksumAlgorithm enum

func SummaryChecksumAlgorithm_Values 

func SummaryChecksumAlgorithm_Values() []string

SummaryChecksumAlgorithm_Values returns all elements of the SummaryChecksumAlgorithm enum

Types

type AccessDeniedException 

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

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

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

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 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

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 BackupObject 

type BackupObject struct {

	// Number of chunks in object
	ChunksCount *int64 `type:"long"`

	// Metadata string associated with the Object
	MetadataString *string `type:"string"`

	// Object name
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Object checksum
	//
	// ObjectChecksum is a required field
	ObjectChecksum *string `type:"string" required:"true"`

	// Checksum algorithm
	//
	// ObjectChecksumAlgorithm is a required field
	ObjectChecksumAlgorithm *string `type:"string" required:"true" enum:"SummaryChecksumAlgorithm"`

	// Object token
	//
	// ObjectToken is a required field
	ObjectToken *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Object

func (BackupObject) GoString 

func (s BackupObject) 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 (*BackupObject) SetChunksCount 

func (s *BackupObject) SetChunksCount(v int64) *BackupObject

SetChunksCount sets the ChunksCount field's value.

func (*BackupObject) SetMetadataString 

func (s *BackupObject) SetMetadataString(v string) *BackupObject

SetMetadataString sets the MetadataString field's value.

func (*BackupObject) SetName 

func (s *BackupObject) SetName(v string) *BackupObject

SetName sets the Name field's value.

func (*BackupObject) SetObjectChecksum 

func (s *BackupObject) SetObjectChecksum(v string) *BackupObject

SetObjectChecksum sets the ObjectChecksum field's value.

func (*BackupObject) SetObjectChecksumAlgorithm 

func (s *BackupObject) SetObjectChecksumAlgorithm(v string) *BackupObject

SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.

func (*BackupObject) SetObjectToken 

func (s *BackupObject) SetObjectToken(v string) *BackupObject

SetObjectToken sets the ObjectToken field's value.

func (BackupObject) String 

func (s BackupObject) 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 BackupStorage 

type BackupStorage struct {
	*client.Client
}

BackupStorage provides the API operation methods for making requests to AWS Backup Storage. See this package's package overview docs for details on the service.

BackupStorage 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) *BackupStorage

New creates a new instance of the BackupStorage 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 BackupStorage client from just a session.
svc := backupstorage.New(mySession)

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

func (*BackupStorage) DeleteObject 

func (c *BackupStorage) DeleteObject(input *DeleteObjectInput) (*DeleteObjectOutput, error)

DeleteObject API operation for AWS Backup Storage.

Delete Object from the incremental base Backup.

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 AWS Backup Storage's API operation DeleteObject for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/DeleteObject

func (*BackupStorage) DeleteObjectRequest 

func (c *BackupStorage) DeleteObjectRequest(input *DeleteObjectInput) (req *request.Request, output *DeleteObjectOutput)

DeleteObjectRequest generates a "aws/request.Request" representing the client's request for the DeleteObject 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 DeleteObject for more information on using the DeleteObject 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 DeleteObjectRequest method.
req, resp := client.DeleteObjectRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/DeleteObject

func (*BackupStorage) DeleteObjectWithContext 

func (c *BackupStorage) DeleteObjectWithContext(ctx aws.Context, input *DeleteObjectInput, opts ...request.Option) (*DeleteObjectOutput, error)

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

See DeleteObject 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 (*BackupStorage) GetChunk 

func (c *BackupStorage) GetChunk(input *GetChunkInput) (*GetChunkOutput, error)

GetChunk API operation for AWS Backup Storage.

Gets the specified object's chunk.

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 AWS Backup Storage's API operation GetChunk for usage and error information.

Returned Error Types:

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

  • ServiceInternalException Deprecated. To be removed from the model.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • KMSInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/GetChunk

func (*BackupStorage) GetChunkRequest 

func (c *BackupStorage) GetChunkRequest(input *GetChunkInput) (req *request.Request, output *GetChunkOutput)

GetChunkRequest generates a "aws/request.Request" representing the client's request for the GetChunk 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 GetChunk for more information on using the GetChunk 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 GetChunkRequest method.
req, resp := client.GetChunkRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/GetChunk

func (*BackupStorage) GetChunkWithContext 

func (c *BackupStorage) GetChunkWithContext(ctx aws.Context, input *GetChunkInput, opts ...request.Option) (*GetChunkOutput, error)

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

See GetChunk 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 (*BackupStorage) GetObjectMetadata 

func (c *BackupStorage) GetObjectMetadata(input *GetObjectMetadataInput) (*GetObjectMetadataOutput, error)

GetObjectMetadata API operation for AWS Backup Storage.

Get metadata associated with an Object.

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 AWS Backup Storage's API operation GetObjectMetadata for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • KMSInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/GetObjectMetadata

func (*BackupStorage) GetObjectMetadataRequest 

func (c *BackupStorage) GetObjectMetadataRequest(input *GetObjectMetadataInput) (req *request.Request, output *GetObjectMetadataOutput)

GetObjectMetadataRequest generates a "aws/request.Request" representing the client's request for the GetObjectMetadata 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 GetObjectMetadata for more information on using the GetObjectMetadata 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 GetObjectMetadataRequest method.
req, resp := client.GetObjectMetadataRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/GetObjectMetadata

func (*BackupStorage) GetObjectMetadataWithContext 

func (c *BackupStorage) GetObjectMetadataWithContext(ctx aws.Context, input *GetObjectMetadataInput, opts ...request.Option) (*GetObjectMetadataOutput, error)

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

See GetObjectMetadata 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 (*BackupStorage) ListChunks 

func (c *BackupStorage) ListChunks(input *ListChunksInput) (*ListChunksOutput, error)

ListChunks API operation for AWS Backup Storage.

List chunks in a given Object

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 AWS Backup Storage's API operation ListChunks for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

  • ServiceInternalException Deprecated. To be removed from the model.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/ListChunks

func (*BackupStorage) ListChunksPages 

func (c *BackupStorage) ListChunksPages(input *ListChunksInput, fn func(*ListChunksOutput, bool) bool) error

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

See ListChunks 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 ListChunks operation.
pageNum := 0
err := client.ListChunksPages(params,
    func(page *backupstorage.ListChunksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BackupStorage) ListChunksPagesWithContext 

func (c *BackupStorage) ListChunksPagesWithContext(ctx aws.Context, input *ListChunksInput, fn func(*ListChunksOutput, bool) bool, opts ...request.Option) error

ListChunksPagesWithContext same as ListChunksPages 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 (*BackupStorage) ListChunksRequest 

func (c *BackupStorage) ListChunksRequest(input *ListChunksInput) (req *request.Request, output *ListChunksOutput)

ListChunksRequest generates a "aws/request.Request" representing the client's request for the ListChunks 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 ListChunks for more information on using the ListChunks 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 ListChunksRequest method.
req, resp := client.ListChunksRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/ListChunks

func (*BackupStorage) ListChunksWithContext 

func (c *BackupStorage) ListChunksWithContext(ctx aws.Context, input *ListChunksInput, opts ...request.Option) (*ListChunksOutput, error)

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

See ListChunks 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 (*BackupStorage) ListObjects 

func (c *BackupStorage) ListObjects(input *ListObjectsInput) (*ListObjectsOutput, error)

ListObjects API operation for AWS Backup Storage.

List all Objects in a given Backup.

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 AWS Backup Storage's API operation ListObjects for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

  • KMSInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/ListObjects

func (*BackupStorage) ListObjectsPages 

func (c *BackupStorage) ListObjectsPages(input *ListObjectsInput, fn func(*ListObjectsOutput, bool) bool) error

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

See ListObjects 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 ListObjects operation.
pageNum := 0
err := client.ListObjectsPages(params,
    func(page *backupstorage.ListObjectsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BackupStorage) ListObjectsPagesWithContext 

func (c *BackupStorage) ListObjectsPagesWithContext(ctx aws.Context, input *ListObjectsInput, fn func(*ListObjectsOutput, bool) bool, opts ...request.Option) error

ListObjectsPagesWithContext same as ListObjectsPages 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 (*BackupStorage) ListObjectsRequest 

func (c *BackupStorage) ListObjectsRequest(input *ListObjectsInput) (req *request.Request, output *ListObjectsOutput)

ListObjectsRequest generates a "aws/request.Request" representing the client's request for the ListObjects 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 ListObjects for more information on using the ListObjects 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 ListObjectsRequest method.
req, resp := client.ListObjectsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/ListObjects

func (*BackupStorage) ListObjectsWithContext 

func (c *BackupStorage) ListObjectsWithContext(ctx aws.Context, input *ListObjectsInput, opts ...request.Option) (*ListObjectsOutput, error)

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

See ListObjects 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 (*BackupStorage) NotifyObjectComplete 

func (c *BackupStorage) NotifyObjectComplete(input *NotifyObjectCompleteInput) (*NotifyObjectCompleteOutput, error)

NotifyObjectComplete API operation for AWS Backup Storage.

Complete upload

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 AWS Backup Storage's API operation NotifyObjectComplete for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • KMSInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/NotifyObjectComplete

func (*BackupStorage) NotifyObjectCompleteRequest 

func (c *BackupStorage) NotifyObjectCompleteRequest(input *NotifyObjectCompleteInput) (req *request.Request, output *NotifyObjectCompleteOutput)

NotifyObjectCompleteRequest generates a "aws/request.Request" representing the client's request for the NotifyObjectComplete 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 NotifyObjectComplete for more information on using the NotifyObjectComplete 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 NotifyObjectCompleteRequest method.
req, resp := client.NotifyObjectCompleteRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/NotifyObjectComplete

func (*BackupStorage) NotifyObjectCompleteWithContext 

func (c *BackupStorage) NotifyObjectCompleteWithContext(ctx aws.Context, input *NotifyObjectCompleteInput, opts ...request.Option) (*NotifyObjectCompleteOutput, error)

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

See NotifyObjectComplete 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 (*BackupStorage) PutChunk 

func (c *BackupStorage) PutChunk(input *PutChunkInput) (*PutChunkOutput, error)

PutChunk API operation for AWS Backup Storage.

Upload chunk.

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 AWS Backup Storage's API operation PutChunk for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • KMSInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/PutChunk

func (*BackupStorage) PutChunkRequest 

func (c *BackupStorage) PutChunkRequest(input *PutChunkInput) (req *request.Request, output *PutChunkOutput)

PutChunkRequest generates a "aws/request.Request" representing the client's request for the PutChunk 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 PutChunk for more information on using the PutChunk 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 PutChunkRequest method.
req, resp := client.PutChunkRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/PutChunk

func (*BackupStorage) PutChunkWithContext 

func (c *BackupStorage) PutChunkWithContext(ctx aws.Context, input *PutChunkInput, opts ...request.Option) (*PutChunkOutput, error)

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

See PutChunk 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 (*BackupStorage) PutObject 

func (c *BackupStorage) PutObject(input *PutObjectInput) (*PutObjectOutput, error)

PutObject API operation for AWS Backup Storage.

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

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 AWS Backup Storage's API operation PutObject for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • NotReadableInputStreamException Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • KMSInvalidKeyUsageException Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/PutObject

func (*BackupStorage) PutObjectRequest 

func (c *BackupStorage) PutObjectRequest(input *PutObjectInput) (req *request.Request, output *PutObjectOutput)

PutObjectRequest generates a "aws/request.Request" representing the client's request for the PutObject 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 PutObject for more information on using the PutObject 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 PutObjectRequest method.
req, resp := client.PutObjectRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/PutObject

func (*BackupStorage) PutObjectWithContext 

func (c *BackupStorage) PutObjectWithContext(ctx aws.Context, input *PutObjectInput, opts ...request.Option) (*PutObjectOutput, error)

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

See PutObject 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 (*BackupStorage) StartObject 

func (c *BackupStorage) StartObject(input *StartObjectInput) (*StartObjectOutput, error)

StartObject API operation for AWS Backup Storage.

Start upload containing one or many chunks.

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 AWS Backup Storage's API operation StartObject for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Retryable exception, indicates internal server error.

  • ServiceInternalException Deprecated. To be removed from the model.

  • RetryableException Retryable exception. In general indicates internal failure that can be fixed by retry.

  • IllegalArgumentException Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

  • ResourceNotFoundException Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

  • DataAlreadyExistsException Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.

  • ThrottlingException Increased rate over throttling limits. Can be retried with exponential backoff.

  • AccessDeniedException

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/StartObject

func (*BackupStorage) StartObjectRequest 

func (c *BackupStorage) StartObjectRequest(input *StartObjectInput) (req *request.Request, output *StartObjectOutput)

StartObjectRequest generates a "aws/request.Request" representing the client's request for the StartObject 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 StartObject for more information on using the StartObject 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 StartObjectRequest method.
req, resp := client.StartObjectRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backupstorage-2018-04-10/StartObject

func (*BackupStorage) StartObjectWithContext 

func (c *BackupStorage) StartObjectWithContext(ctx aws.Context, input *StartObjectInput, opts ...request.Option) (*StartObjectOutput, error)

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

See StartObject 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 Chunk 

type Chunk struct {

	// Chunk checksum
	//
	// Checksum is a required field
	Checksum *string `type:"string" required:"true"`

	// Checksum algorithm
	//
	// ChecksumAlgorithm is a required field
	ChecksumAlgorithm *string `type:"string" required:"true" enum:"DataChecksumAlgorithm"`

	// Chunk token
	//
	// ChunkToken is a required field
	ChunkToken *string `type:"string" required:"true"`

	// Chunk index
	//
	// Index is a required field
	Index *int64 `type:"long" required:"true"`

	// Chunk length
	//
	// Length is a required field
	Length *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

Chunk

func (Chunk) GoString 

func (s Chunk) 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 (*Chunk) SetChecksum 

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

SetChecksum sets the Checksum field's value.

func (*Chunk) SetChecksumAlgorithm 

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

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*Chunk) SetChunkToken 

func (s *Chunk) SetChunkToken(v string) *Chunk

SetChunkToken sets the ChunkToken field's value.

func (*Chunk) SetIndex 

func (s *Chunk) SetIndex(v int64) *Chunk

SetIndex sets the Index field's value.

func (*Chunk) SetLength 

func (s *Chunk) SetLength(v int64) *Chunk

SetLength sets the Length field's value.

func (Chunk) String 

func (s Chunk) 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 DataAlreadyExistsException 

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

	// Data checksum used
	Checksum *string `type:"string"`

	// Checksum algorithm used
	ChecksumAlgorithm *string `type:"string"`

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

Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.

func (*DataAlreadyExistsException) Code 

func (s *DataAlreadyExistsException) Code() string

Code returns the exception type name.

func (*DataAlreadyExistsException) Error 

func (s *DataAlreadyExistsException) Error() string

func (DataAlreadyExistsException) GoString 

func (s DataAlreadyExistsException) 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 (*DataAlreadyExistsException) Message 

func (s *DataAlreadyExistsException) Message() string

Message returns the exception's message.

func (*DataAlreadyExistsException) OrigErr 

func (s *DataAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataAlreadyExistsException) RequestID 

func (s *DataAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataAlreadyExistsException) StatusCode 

func (s *DataAlreadyExistsException) StatusCode() int

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

func (DataAlreadyExistsException) String 

func (s DataAlreadyExistsException) 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 DeleteObjectInput 

type DeleteObjectInput struct {

	// Backup job Id for the in-progress backup.
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// The name of the Object.
	//
	// ObjectName is a required field
	ObjectName *string `location:"uri" locationName:"objectName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteObjectInput) GoString 

func (s DeleteObjectInput) 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 (*DeleteObjectInput) SetBackupJobId 

func (s *DeleteObjectInput) SetBackupJobId(v string) *DeleteObjectInput

SetBackupJobId sets the BackupJobId field's value.

func (*DeleteObjectInput) SetObjectName 

func (s *DeleteObjectInput) SetObjectName(v string) *DeleteObjectInput

SetObjectName sets the ObjectName field's value.

func (DeleteObjectInput) String 

func (s DeleteObjectInput) 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 (*DeleteObjectInput) Validate 

func (s *DeleteObjectInput) Validate() error

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

type DeleteObjectOutput 

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

func (DeleteObjectOutput) GoString 

func (s DeleteObjectOutput) 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 (DeleteObjectOutput) String 

func (s DeleteObjectOutput) 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 GetChunkInput 

type GetChunkInput struct {

	// Chunk token
	//
	// ChunkToken is a required field
	ChunkToken *string `location:"uri" locationName:"chunkToken" type:"string" required:"true"`

	// Storage job id
	//
	// StorageJobId is a required field
	StorageJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetChunkInput) GoString 

func (s GetChunkInput) 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 (*GetChunkInput) SetChunkToken 

func (s *GetChunkInput) SetChunkToken(v string) *GetChunkInput

SetChunkToken sets the ChunkToken field's value.

func (*GetChunkInput) SetStorageJobId 

func (s *GetChunkInput) SetStorageJobId(v string) *GetChunkInput

SetStorageJobId sets the StorageJobId field's value.

func (GetChunkInput) String 

func (s GetChunkInput) 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 (*GetChunkInput) Validate 

func (s *GetChunkInput) Validate() error

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

type GetChunkOutput 

type GetChunkOutput struct {

	// Data checksum
	//
	// Checksum is a required field
	Checksum *string `location:"header" locationName:"x-amz-checksum" type:"string" required:"true"`

	// Checksum algorithm
	//
	// ChecksumAlgorithm is a required field
	ChecksumAlgorithm *string `location:"header" locationName:"x-amz-checksum-algorithm" type:"string" required:"true" enum:"DataChecksumAlgorithm"`

	// Chunk data
	//
	// Data is a required field
	Data io.ReadCloser `type:"blob" required:"true"`

	// Data length
	//
	// Length is a required field
	Length *int64 `location:"header" locationName:"x-amz-data-length" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (GetChunkOutput) GoString 

func (s GetChunkOutput) 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 (*GetChunkOutput) SetChecksum 

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

SetChecksum sets the Checksum field's value.

func (*GetChunkOutput) SetChecksumAlgorithm 

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

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*GetChunkOutput) SetData 

func (s *GetChunkOutput) SetData(v io.ReadCloser) *GetChunkOutput

SetData sets the Data field's value.

func (*GetChunkOutput) SetLength 

func (s *GetChunkOutput) SetLength(v int64) *GetChunkOutput

SetLength sets the Length field's value.

func (GetChunkOutput) String 

func (s GetChunkOutput) 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 GetObjectMetadataInput 

type GetObjectMetadataInput struct {

	// Object token.
	//
	// ObjectToken is a required field
	ObjectToken *string `location:"uri" locationName:"objectToken" type:"string" required:"true"`

	// Backup job id for the in-progress backup.
	//
	// StorageJobId is a required field
	StorageJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetObjectMetadataInput) GoString 

func (s GetObjectMetadataInput) 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 (*GetObjectMetadataInput) SetObjectToken 

func (s *GetObjectMetadataInput) SetObjectToken(v string) *GetObjectMetadataInput

SetObjectToken sets the ObjectToken field's value.

func (*GetObjectMetadataInput) SetStorageJobId 

func (s *GetObjectMetadataInput) SetStorageJobId(v string) *GetObjectMetadataInput

SetStorageJobId sets the StorageJobId field's value.

func (GetObjectMetadataInput) String 

func (s GetObjectMetadataInput) 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 (*GetObjectMetadataInput) Validate 

func (s *GetObjectMetadataInput) Validate() error

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

type GetObjectMetadataOutput 

type GetObjectMetadataOutput struct {

	// Metadata blob.
	MetadataBlob io.ReadCloser `type:"blob"`

	// MetadataBlob checksum.
	MetadataBlobChecksum *string `location:"header" locationName:"x-amz-checksum" type:"string"`

	// Checksum algorithm.
	MetadataBlobChecksumAlgorithm *string `location:"header" locationName:"x-amz-checksum-algorithm" type:"string" enum:"DataChecksumAlgorithm"`

	// The size of MetadataBlob.
	MetadataBlobLength *int64 `location:"header" locationName:"x-amz-data-length" type:"long"`

	// Metadata string.
	MetadataString *string `location:"header" locationName:"x-amz-metadata-string" type:"string"`
	// contains filtered or unexported fields
}

func (GetObjectMetadataOutput) GoString 

func (s GetObjectMetadataOutput) 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 (*GetObjectMetadataOutput) SetMetadataBlob 

func (s *GetObjectMetadataOutput) SetMetadataBlob(v io.ReadCloser) *GetObjectMetadataOutput

SetMetadataBlob sets the MetadataBlob field's value.

func (*GetObjectMetadataOutput) SetMetadataBlobChecksum 

func (s *GetObjectMetadataOutput) SetMetadataBlobChecksum(v string) *GetObjectMetadataOutput

SetMetadataBlobChecksum sets the MetadataBlobChecksum field's value.

func (*GetObjectMetadataOutput) SetMetadataBlobChecksumAlgorithm 

func (s *GetObjectMetadataOutput) SetMetadataBlobChecksumAlgorithm(v string) *GetObjectMetadataOutput

SetMetadataBlobChecksumAlgorithm sets the MetadataBlobChecksumAlgorithm field's value.

func (*GetObjectMetadataOutput) SetMetadataBlobLength 

func (s *GetObjectMetadataOutput) SetMetadataBlobLength(v int64) *GetObjectMetadataOutput

SetMetadataBlobLength sets the MetadataBlobLength field's value.

func (*GetObjectMetadataOutput) SetMetadataString 

func (s *GetObjectMetadataOutput) SetMetadataString(v string) *GetObjectMetadataOutput

SetMetadataString sets the MetadataString field's value.

func (GetObjectMetadataOutput) String 

func (s GetObjectMetadataOutput) 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 IllegalArgumentException 

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

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

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

func (*IllegalArgumentException) Code 

func (s *IllegalArgumentException) Code() string

Code returns the exception type name.

func (*IllegalArgumentException) Error 

func (s *IllegalArgumentException) Error() string

func (IllegalArgumentException) GoString 

func (s IllegalArgumentException) 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 (*IllegalArgumentException) Message 

func (s *IllegalArgumentException) Message() string

Message returns the exception's message.

func (*IllegalArgumentException) OrigErr 

func (s *IllegalArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IllegalArgumentException) RequestID 

func (s *IllegalArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IllegalArgumentException) StatusCode 

func (s *IllegalArgumentException) StatusCode() int

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

func (IllegalArgumentException) String 

func (s IllegalArgumentException) 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 KMSInvalidKeyUsageException 

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

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

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

func (*KMSInvalidKeyUsageException) Code 

func (s *KMSInvalidKeyUsageException) Code() string

Code returns the exception type name.

func (*KMSInvalidKeyUsageException) Error 

func (s *KMSInvalidKeyUsageException) Error() string

func (KMSInvalidKeyUsageException) GoString 

func (s KMSInvalidKeyUsageException) 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 (*KMSInvalidKeyUsageException) Message 

func (s *KMSInvalidKeyUsageException) Message() string

Message returns the exception's message.

func (*KMSInvalidKeyUsageException) OrigErr 

func (s *KMSInvalidKeyUsageException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSInvalidKeyUsageException) RequestID 

func (s *KMSInvalidKeyUsageException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSInvalidKeyUsageException) StatusCode 

func (s *KMSInvalidKeyUsageException) StatusCode() int

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

func (KMSInvalidKeyUsageException) String 

func (s KMSInvalidKeyUsageException) 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 ListChunksInput 

type ListChunksInput struct {

	// Maximum number of chunks
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// Pagination token
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	// Object token
	//
	// ObjectToken is a required field
	ObjectToken *string `location:"uri" locationName:"objectToken" type:"string" required:"true"`

	// Storage job id
	//
	// StorageJobId is a required field
	StorageJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListChunksInput) GoString 

func (s ListChunksInput) 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 (*ListChunksInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListChunksInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListChunksInput) SetObjectToken 

func (s *ListChunksInput) SetObjectToken(v string) *ListChunksInput

SetObjectToken sets the ObjectToken field's value.

func (*ListChunksInput) SetStorageJobId 

func (s *ListChunksInput) SetStorageJobId(v string) *ListChunksInput

SetStorageJobId sets the StorageJobId field's value.

func (ListChunksInput) String 

func (s ListChunksInput) 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 (*ListChunksInput) Validate 

func (s *ListChunksInput) Validate() error

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

type ListChunksOutput 

type ListChunksOutput struct {

	// List of chunks
	//
	// ChunkList is a required field
	ChunkList []*Chunk `type:"list" required:"true"`

	// Pagination token
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListChunksOutput) GoString 

func (s ListChunksOutput) 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 (*ListChunksOutput) SetChunkList 

func (s *ListChunksOutput) SetChunkList(v []*Chunk) *ListChunksOutput

SetChunkList sets the ChunkList field's value.

func (*ListChunksOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListChunksOutput) String 

func (s ListChunksOutput) 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 ListObjectsInput 

type ListObjectsInput struct {

	// (Optional) Created after filter
	CreatedAfter *time.Time `location:"querystring" locationName:"created-after" type:"timestamp"`

	// (Optional) Created before filter
	CreatedBefore *time.Time `location:"querystring" locationName:"created-before" type:"timestamp"`

	// Maximum objects count
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// Pagination token
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	// Optional, specifies the starting Object name to list from. Ignored if NextToken
	// is not NULL
	StartingObjectName *string `location:"querystring" locationName:"starting-object-name" type:"string"`

	// Optional, specifies the starting Object prefix to list from. Ignored if NextToken
	// is not NULL
	StartingObjectPrefix *string `location:"querystring" locationName:"starting-object-prefix" type:"string"`

	// Storage job id
	//
	// StorageJobId is a required field
	StorageJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectsInput) GoString 

func (s ListObjectsInput) 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 (*ListObjectsInput) SetCreatedAfter 

func (s *ListObjectsInput) SetCreatedAfter(v time.Time) *ListObjectsInput

SetCreatedAfter sets the CreatedAfter field's value.

func (*ListObjectsInput) SetCreatedBefore 

func (s *ListObjectsInput) SetCreatedBefore(v time.Time) *ListObjectsInput

SetCreatedBefore sets the CreatedBefore field's value.

func (*ListObjectsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListObjectsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListObjectsInput) SetStartingObjectName 

func (s *ListObjectsInput) SetStartingObjectName(v string) *ListObjectsInput

SetStartingObjectName sets the StartingObjectName field's value.

func (*ListObjectsInput) SetStartingObjectPrefix 

func (s *ListObjectsInput) SetStartingObjectPrefix(v string) *ListObjectsInput

SetStartingObjectPrefix sets the StartingObjectPrefix field's value.

func (*ListObjectsInput) SetStorageJobId 

func (s *ListObjectsInput) SetStorageJobId(v string) *ListObjectsInput

SetStorageJobId sets the StorageJobId field's value.

func (ListObjectsInput) String 

func (s ListObjectsInput) 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 (*ListObjectsInput) Validate 

func (s *ListObjectsInput) Validate() error

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

type ListObjectsOutput 

type ListObjectsOutput struct {

	// Pagination token
	NextToken *string `type:"string"`

	// Object list
	//
	// ObjectList is a required field
	ObjectList []*BackupObject `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectsOutput) GoString 

func (s ListObjectsOutput) 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 (*ListObjectsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListObjectsOutput) SetObjectList 

func (s *ListObjectsOutput) SetObjectList(v []*BackupObject) *ListObjectsOutput

SetObjectList sets the ObjectList field's value.

func (ListObjectsOutput) String 

func (s ListObjectsOutput) 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 NotReadableInputStreamException 

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

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

Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

func (*NotReadableInputStreamException) Code 

func (s *NotReadableInputStreamException) Code() string

Code returns the exception type name.

func (*NotReadableInputStreamException) Error 

func (s *NotReadableInputStreamException) Error() string

func (NotReadableInputStreamException) GoString 

func (s NotReadableInputStreamException) 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 (*NotReadableInputStreamException) Message 

func (s *NotReadableInputStreamException) Message() string

Message returns the exception's message.

func (*NotReadableInputStreamException) OrigErr 

func (s *NotReadableInputStreamException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotReadableInputStreamException) RequestID 

func (s *NotReadableInputStreamException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotReadableInputStreamException) StatusCode 

func (s *NotReadableInputStreamException) StatusCode() int

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

func (NotReadableInputStreamException) String 

func (s NotReadableInputStreamException) 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 NotifyObjectCompleteInput 

type NotifyObjectCompleteInput struct {

	// Backup job Id for the in-progress backup
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// Optional metadata associated with an Object. Maximum length is 4MB.
	//
	// 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.
	MetadataBlob io.ReadSeeker `type:"blob"`

	// Checksum of MetadataBlob.
	MetadataBlobChecksum *string `location:"querystring" locationName:"metadata-checksum" type:"string"`

	// Checksum algorithm.
	MetadataBlobChecksumAlgorithm *string `location:"querystring" locationName:"metadata-checksum-algorithm" type:"string" enum:"DataChecksumAlgorithm"`

	// The size of MetadataBlob.
	MetadataBlobLength *int64 `location:"querystring" locationName:"metadata-blob-length" type:"long"`

	// Optional metadata associated with an Object. Maximum string length is 256
	// bytes.
	MetadataString *string `location:"querystring" locationName:"metadata-string" type:"string"`

	// Object checksum
	//
	// ObjectChecksum is a required field
	ObjectChecksum *string `location:"querystring" locationName:"checksum" type:"string" required:"true"`

	// Checksum algorithm
	//
	// ObjectChecksumAlgorithm is a required field
	ObjectChecksumAlgorithm *string `location:"querystring" locationName:"checksum-algorithm" type:"string" required:"true" enum:"SummaryChecksumAlgorithm"`

	// Upload Id for the in-progress upload
	//
	// UploadId is a required field
	UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (NotifyObjectCompleteInput) GoString 

func (s NotifyObjectCompleteInput) 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 (*NotifyObjectCompleteInput) SetBackupJobId 

func (s *NotifyObjectCompleteInput) SetBackupJobId(v string) *NotifyObjectCompleteInput

SetBackupJobId sets the BackupJobId field's value.

func (*NotifyObjectCompleteInput) SetMetadataBlob 

func (s *NotifyObjectCompleteInput) SetMetadataBlob(v io.ReadSeeker) *NotifyObjectCompleteInput

SetMetadataBlob sets the MetadataBlob field's value.

func (*NotifyObjectCompleteInput) SetMetadataBlobChecksum 

func (s *NotifyObjectCompleteInput) SetMetadataBlobChecksum(v string) *NotifyObjectCompleteInput

SetMetadataBlobChecksum sets the MetadataBlobChecksum field's value.

func (*NotifyObjectCompleteInput) SetMetadataBlobChecksumAlgorithm 

func (s *NotifyObjectCompleteInput) SetMetadataBlobChecksumAlgorithm(v string) *NotifyObjectCompleteInput

SetMetadataBlobChecksumAlgorithm sets the MetadataBlobChecksumAlgorithm field's value.

func (*NotifyObjectCompleteInput) SetMetadataBlobLength 

func (s *NotifyObjectCompleteInput) SetMetadataBlobLength(v int64) *NotifyObjectCompleteInput

SetMetadataBlobLength sets the MetadataBlobLength field's value.

func (*NotifyObjectCompleteInput) SetMetadataString 

func (s *NotifyObjectCompleteInput) SetMetadataString(v string) *NotifyObjectCompleteInput

SetMetadataString sets the MetadataString field's value.

func (*NotifyObjectCompleteInput) SetObjectChecksum 

func (s *NotifyObjectCompleteInput) SetObjectChecksum(v string) *NotifyObjectCompleteInput

SetObjectChecksum sets the ObjectChecksum field's value.

func (*NotifyObjectCompleteInput) SetObjectChecksumAlgorithm 

func (s *NotifyObjectCompleteInput) SetObjectChecksumAlgorithm(v string) *NotifyObjectCompleteInput

SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.

func (*NotifyObjectCompleteInput) SetUploadId 

func (s *NotifyObjectCompleteInput) SetUploadId(v string) *NotifyObjectCompleteInput

SetUploadId sets the UploadId field's value.

func (NotifyObjectCompleteInput) String 

func (s NotifyObjectCompleteInput) 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 (*NotifyObjectCompleteInput) Validate 

func (s *NotifyObjectCompleteInput) Validate() error

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

type NotifyObjectCompleteOutput 

type NotifyObjectCompleteOutput struct {

	// Object checksum
	//
	// ObjectChecksum is a required field
	ObjectChecksum *string `type:"string" required:"true"`

	// Checksum algorithm
	//
	// ObjectChecksumAlgorithm is a required field
	ObjectChecksumAlgorithm *string `type:"string" required:"true" enum:"SummaryChecksumAlgorithm"`
	// contains filtered or unexported fields
}

func (NotifyObjectCompleteOutput) GoString 

func (s NotifyObjectCompleteOutput) 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 (*NotifyObjectCompleteOutput) SetObjectChecksum 

func (s *NotifyObjectCompleteOutput) SetObjectChecksum(v string) *NotifyObjectCompleteOutput

SetObjectChecksum sets the ObjectChecksum field's value.

func (*NotifyObjectCompleteOutput) SetObjectChecksumAlgorithm 

func (s *NotifyObjectCompleteOutput) SetObjectChecksumAlgorithm(v string) *NotifyObjectCompleteOutput

SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.

func (NotifyObjectCompleteOutput) String 

func (s NotifyObjectCompleteOutput) 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 PutChunkInput 

type PutChunkInput struct {

	// Backup job Id for the in-progress backup.
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// Data checksum
	//
	// Checksum is a required field
	Checksum *string `location:"querystring" locationName:"checksum" type:"string" required:"true"`

	// Checksum algorithm
	//
	// ChecksumAlgorithm is a required field
	ChecksumAlgorithm *string `location:"querystring" locationName:"checksum-algorithm" type:"string" required:"true" enum:"DataChecksumAlgorithm"`

	// Describes this chunk's position relative to the other chunks
	//
	// ChunkIndex is a required field
	ChunkIndex *int64 `location:"uri" locationName:"chunkIndex" type:"long" required:"true"`

	// Data to be uploaded
	//
	// 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.
	//
	// Data is a required field
	Data io.ReadSeeker `type:"blob" required:"true"`

	// Data length
	//
	// Length is a required field
	Length *int64 `location:"querystring" locationName:"length" type:"long" required:"true"`

	// Upload Id for the in-progress upload.
	//
	// UploadId is a required field
	UploadId *string `location:"uri" locationName:"uploadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutChunkInput) GoString 

func (s PutChunkInput) 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 (*PutChunkInput) SetBackupJobId 

func (s *PutChunkInput) SetBackupJobId(v string) *PutChunkInput

SetBackupJobId sets the BackupJobId field's value.

func (*PutChunkInput) SetChecksum 

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

SetChecksum sets the Checksum field's value.

func (*PutChunkInput) SetChecksumAlgorithm 

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

SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.

func (*PutChunkInput) SetChunkIndex 

func (s *PutChunkInput) SetChunkIndex(v int64) *PutChunkInput

SetChunkIndex sets the ChunkIndex field's value.

func (*PutChunkInput) SetData 

func (s *PutChunkInput) SetData(v io.ReadSeeker) *PutChunkInput

SetData sets the Data field's value.

func (*PutChunkInput) SetLength 

func (s *PutChunkInput) SetLength(v int64) *PutChunkInput

SetLength sets the Length field's value.

func (*PutChunkInput) SetUploadId 

func (s *PutChunkInput) SetUploadId(v string) *PutChunkInput

SetUploadId sets the UploadId field's value.

func (PutChunkInput) String 

func (s PutChunkInput) 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 (*PutChunkInput) Validate 

func (s *PutChunkInput) Validate() error

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

type PutChunkOutput 

type PutChunkOutput struct {

	// Chunk checksum
	//
	// ChunkChecksum is a required field
	ChunkChecksum *string `type:"string" required:"true"`

	// Checksum algorithm
	//
	// ChunkChecksumAlgorithm is a required field
	ChunkChecksumAlgorithm *string `type:"string" required:"true" enum:"DataChecksumAlgorithm"`
	// contains filtered or unexported fields
}

func (PutChunkOutput) GoString 

func (s PutChunkOutput) 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 (*PutChunkOutput) SetChunkChecksum 

func (s *PutChunkOutput) SetChunkChecksum(v string) *PutChunkOutput

SetChunkChecksum sets the ChunkChecksum field's value.

func (*PutChunkOutput) SetChunkChecksumAlgorithm 

func (s *PutChunkOutput) SetChunkChecksumAlgorithm(v string) *PutChunkOutput

SetChunkChecksumAlgorithm sets the ChunkChecksumAlgorithm field's value.

func (PutChunkOutput) String 

func (s PutChunkOutput) 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 PutObjectInput 

type PutObjectInput struct {

	// Backup job Id for the in-progress backup.
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// Inline chunk data to be uploaded.
	//
	// 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.
	InlineChunk io.ReadSeeker `type:"blob"`

	// Inline chunk checksum
	InlineChunkChecksum *string `location:"querystring" locationName:"checksum" type:"string"`

	// Inline chunk checksum algorithm
	InlineChunkChecksumAlgorithm *string `location:"querystring" locationName:"checksum-algorithm" type:"string"`

	// Length of the inline chunk data.
	InlineChunkLength *int64 `location:"querystring" locationName:"length" type:"long"`

	// Store user defined metadata like backup checksum, disk ids, restore metadata
	// etc.
	MetadataString *string `location:"querystring" locationName:"metadata-string" type:"string"`

	// object checksum
	ObjectChecksum *string `location:"querystring" locationName:"object-checksum" type:"string"`

	// object checksum algorithm
	ObjectChecksumAlgorithm *string `location:"querystring" locationName:"object-checksum-algorithm" type:"string" enum:"SummaryChecksumAlgorithm"`

	// The name of the Object to be uploaded.
	//
	// ObjectName is a required field
	ObjectName *string `location:"uri" locationName:"objectName" type:"string" required:"true"`

	// Throw an exception if Object name is already exist.
	ThrowOnDuplicate *bool `location:"querystring" locationName:"throwOnDuplicate" type:"boolean"`
	// contains filtered or unexported fields
}

func (PutObjectInput) GoString 

func (s PutObjectInput) 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 (*PutObjectInput) SetBackupJobId 

func (s *PutObjectInput) SetBackupJobId(v string) *PutObjectInput

SetBackupJobId sets the BackupJobId field's value.

func (*PutObjectInput) SetInlineChunk 

func (s *PutObjectInput) SetInlineChunk(v io.ReadSeeker) *PutObjectInput

SetInlineChunk sets the InlineChunk field's value.

func (*PutObjectInput) SetInlineChunkChecksum 

func (s *PutObjectInput) SetInlineChunkChecksum(v string) *PutObjectInput

SetInlineChunkChecksum sets the InlineChunkChecksum field's value.

func (*PutObjectInput) SetInlineChunkChecksumAlgorithm 

func (s *PutObjectInput) SetInlineChunkChecksumAlgorithm(v string) *PutObjectInput

SetInlineChunkChecksumAlgorithm sets the InlineChunkChecksumAlgorithm field's value.

func (*PutObjectInput) SetInlineChunkLength 

func (s *PutObjectInput) SetInlineChunkLength(v int64) *PutObjectInput

SetInlineChunkLength sets the InlineChunkLength field's value.

func (*PutObjectInput) SetMetadataString 

func (s *PutObjectInput) SetMetadataString(v string) *PutObjectInput

SetMetadataString sets the MetadataString field's value.

func (*PutObjectInput) SetObjectChecksum 

func (s *PutObjectInput) SetObjectChecksum(v string) *PutObjectInput

SetObjectChecksum sets the ObjectChecksum field's value.

func (*PutObjectInput) SetObjectChecksumAlgorithm 

func (s *PutObjectInput) SetObjectChecksumAlgorithm(v string) *PutObjectInput

SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.

func (*PutObjectInput) SetObjectName 

func (s *PutObjectInput) SetObjectName(v string) *PutObjectInput

SetObjectName sets the ObjectName field's value.

func (*PutObjectInput) SetThrowOnDuplicate 

func (s *PutObjectInput) SetThrowOnDuplicate(v bool) *PutObjectInput

SetThrowOnDuplicate sets the ThrowOnDuplicate field's value.

func (PutObjectInput) String 

func (s PutObjectInput) 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 (*PutObjectInput) Validate 

func (s *PutObjectInput) Validate() error

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

type PutObjectOutput 

type PutObjectOutput struct {

	// Inline chunk checksum
	//
	// InlineChunkChecksum is a required field
	InlineChunkChecksum *string `type:"string" required:"true"`

	// Inline chunk checksum algorithm
	//
	// InlineChunkChecksumAlgorithm is a required field
	InlineChunkChecksumAlgorithm *string `type:"string" required:"true" enum:"DataChecksumAlgorithm"`

	// object checksum
	//
	// ObjectChecksum is a required field
	ObjectChecksum *string `type:"string" required:"true"`

	// object checksum algorithm
	//
	// ObjectChecksumAlgorithm is a required field
	ObjectChecksumAlgorithm *string `type:"string" required:"true" enum:"SummaryChecksumAlgorithm"`
	// contains filtered or unexported fields
}

func (PutObjectOutput) GoString 

func (s PutObjectOutput) 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 (*PutObjectOutput) SetInlineChunkChecksum 

func (s *PutObjectOutput) SetInlineChunkChecksum(v string) *PutObjectOutput

SetInlineChunkChecksum sets the InlineChunkChecksum field's value.

func (*PutObjectOutput) SetInlineChunkChecksumAlgorithm 

func (s *PutObjectOutput) SetInlineChunkChecksumAlgorithm(v string) *PutObjectOutput

SetInlineChunkChecksumAlgorithm sets the InlineChunkChecksumAlgorithm field's value.

func (*PutObjectOutput) SetObjectChecksum 

func (s *PutObjectOutput) SetObjectChecksum(v string) *PutObjectOutput

SetObjectChecksum sets the ObjectChecksum field's value.

func (*PutObjectOutput) SetObjectChecksumAlgorithm 

func (s *PutObjectOutput) SetObjectChecksumAlgorithm(v string) *PutObjectOutput

SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.

func (PutObjectOutput) String 

func (s PutObjectOutput) 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 

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

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

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

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 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

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 RetryableException 

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

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

Retryable exception. In general indicates internal failure that can be fixed by retry.

func (*RetryableException) Code 

func (s *RetryableException) Code() string

Code returns the exception type name.

func (*RetryableException) Error 

func (s *RetryableException) Error() string

func (RetryableException) GoString 

func (s RetryableException) 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 (*RetryableException) Message 

func (s *RetryableException) Message() string

Message returns the exception's message.

func (*RetryableException) OrigErr 

func (s *RetryableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RetryableException) RequestID 

func (s *RetryableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RetryableException) StatusCode 

func (s *RetryableException) StatusCode() int

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

func (RetryableException) String 

func (s RetryableException) 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 ServiceInternalException 

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

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

Deprecated. To be removed from the model.

func (*ServiceInternalException) Code 

func (s *ServiceInternalException) Code() string

Code returns the exception type name.

func (*ServiceInternalException) Error 

func (s *ServiceInternalException) Error() string

func (ServiceInternalException) GoString 

func (s ServiceInternalException) 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 (*ServiceInternalException) Message 

func (s *ServiceInternalException) Message() string

Message returns the exception's message.

func (*ServiceInternalException) OrigErr 

func (s *ServiceInternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceInternalException) RequestID 

func (s *ServiceInternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceInternalException) StatusCode 

func (s *ServiceInternalException) StatusCode() int

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

func (ServiceInternalException) String 

func (s ServiceInternalException) 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 ServiceUnavailableException 

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

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

Retryable exception, indicates internal server error.

func (*ServiceUnavailableException) Code 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString 

func (s ServiceUnavailableException) 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 (*ServiceUnavailableException) Message 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode 

func (s *ServiceUnavailableException) StatusCode() int

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

func (ServiceUnavailableException) String 

func (s ServiceUnavailableException) 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 StartObjectInput 

type StartObjectInput struct {

	// Backup job Id for the in-progress backup
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`

	// Name for the object.
	//
	// ObjectName is a required field
	ObjectName *string `location:"uri" locationName:"objectName" type:"string" required:"true"`

	// Throw an exception if Object name is already exist.
	ThrowOnDuplicate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (StartObjectInput) GoString 

func (s StartObjectInput) 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 (*StartObjectInput) SetBackupJobId 

func (s *StartObjectInput) SetBackupJobId(v string) *StartObjectInput

SetBackupJobId sets the BackupJobId field's value.

func (*StartObjectInput) SetObjectName 

func (s *StartObjectInput) SetObjectName(v string) *StartObjectInput

SetObjectName sets the ObjectName field's value.

func (*StartObjectInput) SetThrowOnDuplicate 

func (s *StartObjectInput) SetThrowOnDuplicate(v bool) *StartObjectInput

SetThrowOnDuplicate sets the ThrowOnDuplicate field's value.

func (StartObjectInput) String 

func (s StartObjectInput) 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 (*StartObjectInput) Validate 

func (s *StartObjectInput) Validate() error

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

type StartObjectOutput 

type StartObjectOutput struct {

	// Upload Id for a given upload.
	//
	// UploadId is a required field
	UploadId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartObjectOutput) GoString 

func (s StartObjectOutput) 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 (*StartObjectOutput) SetUploadId 

func (s *StartObjectOutput) SetUploadId(v string) *StartObjectOutput

SetUploadId sets the UploadId field's value.

func (StartObjectOutput) String 

func (s StartObjectOutput) 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 ThrottlingException 

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

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

Increased rate over throttling limits. Can be retried with exponential backoff.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) 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 (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) 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 backupstorageiface provides an interface to enable mocking the AWS Backup Storage service client for testing your code.
 Package backupstorageiface provides an interface to enable mocking the AWS Backup Storage 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.