2022/08/11 - AWS Backup Storage - 9 new api methods
Changes This is the first public release of AWS Backup Storage. We are exposing some previously-internal APIs for use by external services. These APIs are not meant to be used directly by customers.
Get metadata associated with an Object.
See also: AWS API Documentation
Request Syntax
client.get_object_metadata(
StorageJobId='string',
ObjectToken='string'
)
string
[REQUIRED] Backup job id for the in-progress backup.
string
[REQUIRED] Object token.
dict
Response Syntax
{
'MetadataString': 'string',
'MetadataBlob': StreamingBody(),
'MetadataBlobLength': 123,
'MetadataBlobChecksum': 'string',
'MetadataBlobChecksumAlgorithm': 'SHA256'
}
Response Structure
(dict) --
MetadataString (string) -- Metadata string.
MetadataBlob (:class:`.StreamingBody`) -- Metadata blob.
MetadataBlobLength (integer) -- The size of MetadataBlob.
MetadataBlobChecksum (string) -- MetadataBlob checksum.
MetadataBlobChecksumAlgorithm (string) -- Checksum algorithm.
Complete upload
See also: AWS API Documentation
Request Syntax
client.notify_object_complete(
BackupJobId='string',
UploadId='string',
ObjectChecksum='string',
ObjectChecksumAlgorithm='SUMMARY',
MetadataString='string',
MetadataBlob=b'bytes'|file,
MetadataBlobLength=123,
MetadataBlobChecksum='string',
MetadataBlobChecksumAlgorithm='SHA256'
)
string
[REQUIRED] Backup job Id for the in-progress backup
string
[REQUIRED] Upload Id for the in-progress upload
string
[REQUIRED] Object checksum
string
[REQUIRED] Checksum algorithm
string
Optional metadata associated with an Object. Maximum string length is 256 bytes.
bytes or seekable file-like object
Optional metadata associated with an Object. Maximum length is 4MB.
integer
The size of MetadataBlob.
string
Checksum of MetadataBlob.
string
Checksum algorithm.
dict
Response Syntax
{
'ObjectChecksum': 'string',
'ObjectChecksumAlgorithm': 'SUMMARY'
}
Response Structure
(dict) --
ObjectChecksum (string) -- Object checksum
ObjectChecksumAlgorithm (string) -- Checksum algorithm
Start upload containing one or many chunks.
See also: AWS API Documentation
Request Syntax
client.start_object(
BackupJobId='string',
ObjectName='string',
ThrowOnDuplicate=True|False
)
string
[REQUIRED] Backup job Id for the in-progress backup
string
[REQUIRED] Name for the object.
boolean
Throw an exception if Object name is already exist.
dict
Response Syntax
{
'UploadId': 'string'
}
Response Structure
(dict) --
UploadId (string) -- Upload Id for a given upload.
List chunks in a given Object
See also: AWS API Documentation
Request Syntax
client.list_chunks(
StorageJobId='string',
ObjectToken='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED] Storage job id
string
[REQUIRED] Object token
integer
Maximum number of chunks
string
Pagination token
dict
Response Syntax
{
'ChunkList': [
{
'Index': 123,
'Length': 123,
'Checksum': 'string',
'ChecksumAlgorithm': 'SHA256',
'ChunkToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChunkList (list) -- List of chunks
(dict) -- Chunk
Index (integer) -- Chunk index
Length (integer) -- Chunk length
Checksum (string) -- Chunk checksum
ChecksumAlgorithm (string) -- Checksum algorithm
ChunkToken (string) -- Chunk token
NextToken (string) -- Pagination token
List all Objects in a given Backup.
See also: AWS API Documentation
Request Syntax
client.list_objects(
StorageJobId='string',
StartingObjectName='string',
StartingObjectPrefix='string',
MaxResults=123,
NextToken='string',
CreatedBefore=datetime(2015, 1, 1),
CreatedAfter=datetime(2015, 1, 1)
)
string
[REQUIRED] Storage job id
string
Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL
string
Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL
integer
Maximum objects count
string
Pagination token
datetime
(Optional) Created before filter
datetime
(Optional) Created after filter
dict
Response Syntax
{
'ObjectList': [
{
'Name': 'string',
'ChunksCount': 123,
'MetadataString': 'string',
'ObjectChecksum': 'string',
'ObjectChecksumAlgorithm': 'SUMMARY',
'ObjectToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ObjectList (list) -- Object list
(dict) -- Object
Name (string) -- Object name
ChunksCount (integer) -- Number of chunks in object
MetadataString (string) -- Metadata string associated with the Object
ObjectChecksum (string) -- Object checksum
ObjectChecksumAlgorithm (string) -- Checksum algorithm
ObjectToken (string) -- Object token
NextToken (string) -- Pagination token
Upload chunk.
See also: AWS API Documentation
Request Syntax
client.put_chunk(
BackupJobId='string',
UploadId='string',
ChunkIndex=123,
Data=b'bytes'|file,
Length=123,
Checksum='string',
ChecksumAlgorithm='SHA256'
)
string
[REQUIRED] Backup job Id for the in-progress backup.
string
[REQUIRED] Upload Id for the in-progress upload.
integer
[REQUIRED] Describes this chunk's position relative to the other chunks
bytes or seekable file-like object
[REQUIRED] Data to be uploaded
integer
[REQUIRED] Data length
string
[REQUIRED] Data checksum
string
[REQUIRED] Checksum algorithm
dict
Response Syntax
{
'ChunkChecksum': 'string',
'ChunkChecksumAlgorithm': 'SHA256'
}
Response Structure
(dict) --
ChunkChecksum (string) -- Chunk checksum
ChunkChecksumAlgorithm (string) -- Checksum algorithm
Gets the specified object's chunk.
See also: AWS API Documentation
Request Syntax
client.get_chunk(
StorageJobId='string',
ChunkToken='string'
)
string
[REQUIRED] Storage job id
string
[REQUIRED] Chunk token
dict
Response Syntax
{
'Data': StreamingBody(),
'Length': 123,
'Checksum': 'string',
'ChecksumAlgorithm': 'SHA256'
}
Response Structure
(dict) --
Data (:class:`.StreamingBody`) -- Chunk data
Length (integer) -- Data length
Checksum (string) -- Data checksum
ChecksumAlgorithm (string) -- Checksum algorithm
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
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
)
string
[REQUIRED] Backup job Id for the in-progress backup.
string
[REQUIRED] The name of the Object to be uploaded.
string
Store user defined metadata like backup checksum, disk ids, restore metadata etc.
bytes or seekable file-like object
Inline chunk data to be uploaded.
integer
Length of the inline chunk data.
string
Inline chunk checksum
string
Inline chunk checksum algorithm
string
object checksum
string
object checksum algorithm
boolean
Throw an exception if Object name is already exist.
dict
Response Syntax
{
'InlineChunkChecksum': 'string',
'InlineChunkChecksumAlgorithm': 'SHA256',
'ObjectChecksum': 'string',
'ObjectChecksumAlgorithm': 'SUMMARY'
}
Response Structure
(dict) --
InlineChunkChecksum (string) -- Inline chunk checksum
InlineChunkChecksumAlgorithm (string) -- Inline chunk checksum algorithm
ObjectChecksum (string) -- object checksum
ObjectChecksumAlgorithm (string) -- object checksum algorithm
Delete Object from the incremental base Backup.
See also: AWS API Documentation
Request Syntax
client.delete_object(
BackupJobId='string',
ObjectName='string'
)
string
[REQUIRED] Backup job Id for the in-progress backup.
string
[REQUIRED] The name of the Object.
None