put_object

BackupStorage.Client.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
)

Parameters

• BackupJobId (string) -- [REQUIRED] Backup job Id for the in-progress backup.
• ObjectName (string) -- [REQUIRED] The name of the Object to be uploaded.
• MetadataString (string) -- Store user defined metadata like backup checksum, disk ids, restore metadata etc.
• InlineChunk (bytes or seekable file-like object) -- Inline chunk data to be uploaded.
• InlineChunkLength (integer) -- Length of the inline chunk data.
• InlineChunkChecksum (string) -- Inline chunk checksum
• InlineChunkChecksumAlgorithm (string) -- Inline chunk checksum algorithm
• ObjectChecksum (string) -- object checksum
• ObjectChecksumAlgorithm (string) -- object checksum algorithm
• ThrowOnDuplicate (boolean) -- Throw an exception if Object name is already exist.

Return type

dict

Returns

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

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