Table of Contents
BackupStorage.
Client
¶A low-level client representing AWS Backup Storage The frontend service for Cryo Storage.:
import boto3
client = boto3.client('backupstorage')
These are the available methods:
can_paginate()
close()
delete_object()
get_chunk()
get_object_metadata()
get_paginator()
get_waiter()
list_chunks()
list_objects()
notify_object_complete()
put_chunk()
put_object()
start_object()
can_paginate
(operation_name)¶Check if an operation can be paginated.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.True
if the operation can be paginated,
False
otherwise.close
()¶Closes underlying endpoint connections.
delete_object
(**kwargs)¶Delete Object from the incremental base Backup.
See also: AWS API Documentation
Request Syntax
response = client.delete_object(
BackupJobId='string',
ObjectName='string'
)
None
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ResourceNotFoundException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.AccessDeniedException
get_chunk
(**kwargs)¶Gets the specified object's chunk.
See also: AWS API Documentation
Request Syntax
response = client.get_chunk(
StorageJobId='string',
ChunkToken='string'
)
dict
Response Syntax
{
'Data': StreamingBody(),
'Length': 123,
'Checksum': 'string',
'ChecksumAlgorithm': 'SHA256'
}
Response Structure
StreamingBody
) -- Chunk dataExceptions
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.ResourceNotFoundException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.KMSInvalidKeyUsageException
BackupStorage.Client.exceptions.AccessDeniedException
get_object_metadata
(**kwargs)¶Get metadata associated with an Object.
See also: AWS API Documentation
Request Syntax
response = client.get_object_metadata(
StorageJobId='string',
ObjectToken='string'
)
dict
Response Syntax
{
'MetadataString': 'string',
'MetadataBlob': StreamingBody(),
'MetadataBlobLength': 123,
'MetadataBlobChecksum': 'string',
'MetadataBlobChecksumAlgorithm': 'SHA256'
}
Response Structure
StreamingBody
) -- Metadata blob.Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.ResourceNotFoundException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.KMSInvalidKeyUsageException
BackupStorage.Client.exceptions.AccessDeniedException
get_paginator
(operation_name)¶Create a paginator for an operation.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.client.can_paginate
method to
check if an operation is pageable.get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
list_chunks
(**kwargs)¶List chunks in a given Object
See also: AWS API Documentation
Request Syntax
response = client.list_chunks(
StorageJobId='string',
ObjectToken='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ChunkList': [
{
'Index': 123,
'Length': 123,
'Checksum': 'string',
'ChecksumAlgorithm': 'SHA256',
'ChunkToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ResourceNotFoundException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.AccessDeniedException
list_objects
(**kwargs)¶List all Objects in a given Backup.
See also: AWS API Documentation
Request Syntax
response = client.list_objects(
StorageJobId='string',
StartingObjectName='string',
StartingObjectPrefix='string',
MaxResults=123,
NextToken='string',
CreatedBefore=datetime(2015, 1, 1),
CreatedAfter=datetime(2015, 1, 1)
)
dict
Response Syntax
{
'ObjectList': [
{
'Name': 'string',
'ChunksCount': 123,
'MetadataString': 'string',
'ObjectChecksum': 'string',
'ObjectChecksumAlgorithm': 'SUMMARY',
'ObjectToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.ResourceNotFoundException
BackupStorage.Client.exceptions.KMSInvalidKeyUsageException
BackupStorage.Client.exceptions.AccessDeniedException
notify_object_complete
(**kwargs)¶Complete upload
See also: AWS API Documentation
Request Syntax
response = client.notify_object_complete(
BackupJobId='string',
UploadId='string',
ObjectChecksum='string',
ObjectChecksumAlgorithm='SUMMARY',
MetadataString='string',
MetadataBlob=b'bytes'|file,
MetadataBlobLength=123,
MetadataBlobChecksum='string',
MetadataBlobChecksumAlgorithm='SHA256'
)
dict
Response Syntax
{
'ObjectChecksum': 'string',
'ObjectChecksumAlgorithm': 'SUMMARY'
}
Response Structure
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.NotReadableInputStreamException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.KMSInvalidKeyUsageException
BackupStorage.Client.exceptions.AccessDeniedException
put_chunk
(**kwargs)¶Upload chunk.
See also: AWS API Documentation
Request Syntax
response = client.put_chunk(
BackupJobId='string',
UploadId='string',
ChunkIndex=123,
Data=b'bytes'|file,
Length=123,
Checksum='string',
ChecksumAlgorithm='SHA256'
)
dict
Response Syntax
{
'ChunkChecksum': 'string',
'ChunkChecksumAlgorithm': 'SHA256'
}
Response Structure
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.NotReadableInputStreamException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.KMSInvalidKeyUsageException
BackupStorage.Client.exceptions.AccessDeniedException
put_object
(**kwargs)¶Upload object that can store object metadata String and data blob in single API call using inline chunk field.
See also: AWS API Documentation
Request Syntax
response = client.put_object(
BackupJobId='string',
ObjectName='string',
MetadataString='string',
InlineChunk=b'bytes'|file,
InlineChunkLength=123,
InlineChunkChecksum='string',
InlineChunkChecksumAlgorithm='string',
ObjectChecksum='string',
ObjectChecksumAlgorithm='SUMMARY',
ThrowOnDuplicate=True|False
)
dict
Response Syntax
{
'InlineChunkChecksum': 'string',
'InlineChunkChecksumAlgorithm': 'SHA256',
'ObjectChecksum': 'string',
'ObjectChecksumAlgorithm': 'SUMMARY'
}
Response Structure
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.NotReadableInputStreamException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.KMSInvalidKeyUsageException
BackupStorage.Client.exceptions.AccessDeniedException
start_object
(**kwargs)¶Start upload containing one or many chunks.
See also: AWS API Documentation
Request Syntax
response = client.start_object(
BackupJobId='string',
ObjectName='string',
ThrowOnDuplicate=True|False
)
dict
Response Syntax
{
'UploadId': 'string'
}
Response Structure
Exceptions
BackupStorage.Client.exceptions.ServiceUnavailableException
BackupStorage.Client.exceptions.ServiceInternalException
BackupStorage.Client.exceptions.RetryableException
BackupStorage.Client.exceptions.IllegalArgumentException
BackupStorage.Client.exceptions.ResourceNotFoundException
BackupStorage.Client.exceptions.DataAlreadyExistsException
BackupStorage.Client.exceptions.ThrottlingException
BackupStorage.Client.exceptions.AccessDeniedException
The available paginators are: