func DataChecksumAlgorithm_Values() []string
DataChecksumAlgorithm_Values returns all elements of the DataChecksumAlgorithm enum
func SummaryChecksumAlgorithm_Values() []string
SummaryChecksumAlgorithm_Values returns all elements of the SummaryChecksumAlgorithm enum
type AccessDeniedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
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 (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *BackupObject) SetChunksCount(v int64) *BackupObject
SetChunksCount sets the ChunksCount field's value.
func (s *BackupObject) SetMetadataString(v string) *BackupObject
SetMetadataString sets the MetadataString field's value.
func (s *BackupObject) SetName(v string) *BackupObject
SetName sets the Name field's value.
func (s *BackupObject) SetObjectChecksum(v string) *BackupObject
SetObjectChecksum sets the ObjectChecksum field's value.
func (s *BackupObject) SetObjectChecksumAlgorithm(v string) *BackupObject
SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.
func (s *BackupObject) SetObjectToken(v string) *BackupObject
SetObjectToken sets the ObjectToken field's value.
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 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(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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (c *BackupStorage) ListChunks(input *ListChunksInput) (*ListChunksOutput, error)
ListChunks API operation for AWS Backup Storage.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (c *BackupStorage) NotifyObjectComplete(input *NotifyObjectCompleteInput) (*NotifyObjectCompleteOutput, error)
NotifyObjectComplete API operation for AWS Backup Storage.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 (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 (s *Chunk) SetChecksum(v string) *Chunk
SetChecksum sets the Checksum field's value.
func (s *Chunk) SetChecksumAlgorithm(v string) *Chunk
SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.
func (s *Chunk) SetChunkToken(v string) *Chunk
SetChunkToken sets the ChunkToken field's value.
func (s *Chunk) SetIndex(v int64) *Chunk
SetIndex sets the Index field's value.
func (s *Chunk) SetLength(v int64) *Chunk
SetLength sets the Length field's value.
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 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 (s *DataAlreadyExistsException) Code() string
Code returns the exception type name.
func (s *DataAlreadyExistsException) Error() string
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 (s *DataAlreadyExistsException) Message() string
Message returns the exception's message.
func (s *DataAlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *DataAlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *DataAlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *DeleteObjectInput) SetBackupJobId(v string) *DeleteObjectInput
SetBackupJobId sets the BackupJobId field's value.
func (s *DeleteObjectInput) SetObjectName(v string) *DeleteObjectInput
SetObjectName sets the ObjectName field's value.
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 (s *DeleteObjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteObjectOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *GetChunkInput) SetChunkToken(v string) *GetChunkInput
SetChunkToken sets the ChunkToken field's value.
func (s *GetChunkInput) SetStorageJobId(v string) *GetChunkInput
SetStorageJobId sets the StorageJobId field's value.
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 (s *GetChunkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetChunkOutput) SetChecksum(v string) *GetChunkOutput
SetChecksum sets the Checksum field's value.
func (s *GetChunkOutput) SetChecksumAlgorithm(v string) *GetChunkOutput
SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.
func (s *GetChunkOutput) SetData(v io.ReadCloser) *GetChunkOutput
SetData sets the Data field's value.
func (s *GetChunkOutput) SetLength(v int64) *GetChunkOutput
SetLength sets the Length field's value.
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 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 (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 (s *GetObjectMetadataInput) SetObjectToken(v string) *GetObjectMetadataInput
SetObjectToken sets the ObjectToken field's value.
func (s *GetObjectMetadataInput) SetStorageJobId(v string) *GetObjectMetadataInput
SetStorageJobId sets the StorageJobId field's value.
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 (s *GetObjectMetadataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetObjectMetadataOutput) SetMetadataBlob(v io.ReadCloser) *GetObjectMetadataOutput
SetMetadataBlob sets the MetadataBlob field's value.
func (s *GetObjectMetadataOutput) SetMetadataBlobChecksum(v string) *GetObjectMetadataOutput
SetMetadataBlobChecksum sets the MetadataBlobChecksum field's value.
func (s *GetObjectMetadataOutput) SetMetadataBlobChecksumAlgorithm(v string) *GetObjectMetadataOutput
SetMetadataBlobChecksumAlgorithm sets the MetadataBlobChecksumAlgorithm field's value.
func (s *GetObjectMetadataOutput) SetMetadataBlobLength(v int64) *GetObjectMetadataOutput
SetMetadataBlobLength sets the MetadataBlobLength field's value.
func (s *GetObjectMetadataOutput) SetMetadataString(v string) *GetObjectMetadataOutput
SetMetadataString sets the MetadataString field's value.
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 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 (s *IllegalArgumentException) Code() string
Code returns the exception type name.
func (s *IllegalArgumentException) Error() string
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 (s *IllegalArgumentException) Message() string
Message returns the exception's message.
func (s *IllegalArgumentException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *IllegalArgumentException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *IllegalArgumentException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *KMSInvalidKeyUsageException) Code() string
Code returns the exception type name.
func (s *KMSInvalidKeyUsageException) Error() string
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 (s *KMSInvalidKeyUsageException) Message() string
Message returns the exception's message.
func (s *KMSInvalidKeyUsageException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *KMSInvalidKeyUsageException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *KMSInvalidKeyUsageException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ListChunksInput) SetMaxResults(v int64) *ListChunksInput
SetMaxResults sets the MaxResults field's value.
func (s *ListChunksInput) SetNextToken(v string) *ListChunksInput
SetNextToken sets the NextToken field's value.
func (s *ListChunksInput) SetObjectToken(v string) *ListChunksInput
SetObjectToken sets the ObjectToken field's value.
func (s *ListChunksInput) SetStorageJobId(v string) *ListChunksInput
SetStorageJobId sets the StorageJobId field's value.
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 (s *ListChunksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListChunksOutput) SetChunkList(v []*Chunk) *ListChunksOutput
SetChunkList sets the ChunkList field's value.
func (s *ListChunksOutput) SetNextToken(v string) *ListChunksOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListObjectsInput) SetCreatedAfter(v time.Time) *ListObjectsInput
SetCreatedAfter sets the CreatedAfter field's value.
func (s *ListObjectsInput) SetCreatedBefore(v time.Time) *ListObjectsInput
SetCreatedBefore sets the CreatedBefore field's value.
func (s *ListObjectsInput) SetMaxResults(v int64) *ListObjectsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListObjectsInput) SetNextToken(v string) *ListObjectsInput
SetNextToken sets the NextToken field's value.
func (s *ListObjectsInput) SetStartingObjectName(v string) *ListObjectsInput
SetStartingObjectName sets the StartingObjectName field's value.
func (s *ListObjectsInput) SetStartingObjectPrefix(v string) *ListObjectsInput
SetStartingObjectPrefix sets the StartingObjectPrefix field's value.
func (s *ListObjectsInput) SetStorageJobId(v string) *ListObjectsInput
SetStorageJobId sets the StorageJobId field's value.
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 (s *ListObjectsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListObjectsOutput) SetNextToken(v string) *ListObjectsOutput
SetNextToken sets the NextToken field's value.
func (s *ListObjectsOutput) SetObjectList(v []*BackupObject) *ListObjectsOutput
SetObjectList sets the ObjectList field's value.
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 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 (s *NotReadableInputStreamException) Code() string
Code returns the exception type name.
func (s *NotReadableInputStreamException) Error() string
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 (s *NotReadableInputStreamException) Message() string
Message returns the exception's message.
func (s *NotReadableInputStreamException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *NotReadableInputStreamException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *NotReadableInputStreamException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *NotifyObjectCompleteInput) SetBackupJobId(v string) *NotifyObjectCompleteInput
SetBackupJobId sets the BackupJobId field's value.
func (s *NotifyObjectCompleteInput) SetMetadataBlob(v io.ReadSeeker) *NotifyObjectCompleteInput
SetMetadataBlob sets the MetadataBlob field's value.
func (s *NotifyObjectCompleteInput) SetMetadataBlobChecksum(v string) *NotifyObjectCompleteInput
SetMetadataBlobChecksum sets the MetadataBlobChecksum field's value.
func (s *NotifyObjectCompleteInput) SetMetadataBlobChecksumAlgorithm(v string) *NotifyObjectCompleteInput
SetMetadataBlobChecksumAlgorithm sets the MetadataBlobChecksumAlgorithm field's value.
func (s *NotifyObjectCompleteInput) SetMetadataBlobLength(v int64) *NotifyObjectCompleteInput
SetMetadataBlobLength sets the MetadataBlobLength field's value.
func (s *NotifyObjectCompleteInput) SetMetadataString(v string) *NotifyObjectCompleteInput
SetMetadataString sets the MetadataString field's value.
func (s *NotifyObjectCompleteInput) SetObjectChecksum(v string) *NotifyObjectCompleteInput
SetObjectChecksum sets the ObjectChecksum field's value.
func (s *NotifyObjectCompleteInput) SetObjectChecksumAlgorithm(v string) *NotifyObjectCompleteInput
SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.
func (s *NotifyObjectCompleteInput) SetUploadId(v string) *NotifyObjectCompleteInput
SetUploadId sets the UploadId field's value.
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 (s *NotifyObjectCompleteInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *NotifyObjectCompleteOutput) SetObjectChecksum(v string) *NotifyObjectCompleteOutput
SetObjectChecksum sets the ObjectChecksum field's value.
func (s *NotifyObjectCompleteOutput) SetObjectChecksumAlgorithm(v string) *NotifyObjectCompleteOutput
SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.
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 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 (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 (s *PutChunkInput) SetBackupJobId(v string) *PutChunkInput
SetBackupJobId sets the BackupJobId field's value.
func (s *PutChunkInput) SetChecksum(v string) *PutChunkInput
SetChecksum sets the Checksum field's value.
func (s *PutChunkInput) SetChecksumAlgorithm(v string) *PutChunkInput
SetChecksumAlgorithm sets the ChecksumAlgorithm field's value.
func (s *PutChunkInput) SetChunkIndex(v int64) *PutChunkInput
SetChunkIndex sets the ChunkIndex field's value.
func (s *PutChunkInput) SetData(v io.ReadSeeker) *PutChunkInput
SetData sets the Data field's value.
func (s *PutChunkInput) SetLength(v int64) *PutChunkInput
SetLength sets the Length field's value.
func (s *PutChunkInput) SetUploadId(v string) *PutChunkInput
SetUploadId sets the UploadId field's value.
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 (s *PutChunkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *PutChunkOutput) SetChunkChecksum(v string) *PutChunkOutput
SetChunkChecksum sets the ChunkChecksum field's value.
func (s *PutChunkOutput) SetChunkChecksumAlgorithm(v string) *PutChunkOutput
SetChunkChecksumAlgorithm sets the ChunkChecksumAlgorithm field's value.
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 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 (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 (s *PutObjectInput) SetBackupJobId(v string) *PutObjectInput
SetBackupJobId sets the BackupJobId field's value.
func (s *PutObjectInput) SetInlineChunk(v io.ReadSeeker) *PutObjectInput
SetInlineChunk sets the InlineChunk field's value.
func (s *PutObjectInput) SetInlineChunkChecksum(v string) *PutObjectInput
SetInlineChunkChecksum sets the InlineChunkChecksum field's value.
func (s *PutObjectInput) SetInlineChunkChecksumAlgorithm(v string) *PutObjectInput
SetInlineChunkChecksumAlgorithm sets the InlineChunkChecksumAlgorithm field's value.
func (s *PutObjectInput) SetInlineChunkLength(v int64) *PutObjectInput
SetInlineChunkLength sets the InlineChunkLength field's value.
func (s *PutObjectInput) SetMetadataString(v string) *PutObjectInput
SetMetadataString sets the MetadataString field's value.
func (s *PutObjectInput) SetObjectChecksum(v string) *PutObjectInput
SetObjectChecksum sets the ObjectChecksum field's value.
func (s *PutObjectInput) SetObjectChecksumAlgorithm(v string) *PutObjectInput
SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.
func (s *PutObjectInput) SetObjectName(v string) *PutObjectInput
SetObjectName sets the ObjectName field's value.
func (s *PutObjectInput) SetThrowOnDuplicate(v bool) *PutObjectInput
SetThrowOnDuplicate sets the ThrowOnDuplicate field's value.
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 (s *PutObjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *PutObjectOutput) SetInlineChunkChecksum(v string) *PutObjectOutput
SetInlineChunkChecksum sets the InlineChunkChecksum field's value.
func (s *PutObjectOutput) SetInlineChunkChecksumAlgorithm(v string) *PutObjectOutput
SetInlineChunkChecksumAlgorithm sets the InlineChunkChecksumAlgorithm field's value.
func (s *PutObjectOutput) SetObjectChecksum(v string) *PutObjectOutput
SetObjectChecksum sets the ObjectChecksum field's value.
func (s *PutObjectOutput) SetObjectChecksumAlgorithm(v string) *PutObjectOutput
SetObjectChecksumAlgorithm sets the ObjectChecksumAlgorithm field's value.
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 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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *RetryableException) Code() string
Code returns the exception type name.
func (s *RetryableException) Error() string
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 (s *RetryableException) Message() string
Message returns the exception's message.
func (s *RetryableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *RetryableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *RetryableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ServiceInternalException) Code() string
Code returns the exception type name.
func (s *ServiceInternalException) Error() string
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 (s *ServiceInternalException) Message() string
Message returns the exception's message.
func (s *ServiceInternalException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceInternalException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceInternalException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
Retryable exception, indicates internal server error.
func (s *ServiceUnavailableException) Code() string
Code returns the exception type name.
func (s *ServiceUnavailableException) Error() string
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 (s *ServiceUnavailableException) Message() string
Message returns the exception's message.
func (s *ServiceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *StartObjectInput) SetBackupJobId(v string) *StartObjectInput
SetBackupJobId sets the BackupJobId field's value.
func (s *StartObjectInput) SetObjectName(v string) *StartObjectInput
SetObjectName sets the ObjectName field's value.
func (s *StartObjectInput) SetThrowOnDuplicate(v bool) *StartObjectInput
SetThrowOnDuplicate sets the ThrowOnDuplicate field's value.
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 (s *StartObjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *StartObjectOutput) SetUploadId(v string) *StartObjectOutput
SetUploadId sets the UploadId field's value.
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 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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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".