get_object_metadata

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

Parameters

• StorageJobId (string) -- [REQUIRED] Backup job id for the in-progress backup.
• ObjectToken (string) -- [REQUIRED] Object token.

Return type

dict

Returns

Response Syntax

{
    'MetadataString': 'string',
    'MetadataBlob': StreamingBody(),
    'MetadataBlobLength': 123,
    'MetadataBlobChecksum': 'string',
    'MetadataBlobChecksumAlgorithm': 'SHA256'
}

Response Structure

• (dict) --
  • MetadataString (string) -- Metadata string.
  • MetadataBlob (StreamingBody) -- Metadata blob.
  • MetadataBlobLength (integer) -- The size of MetadataBlob.
  • MetadataBlobChecksum (string) -- MetadataBlob checksum.
  • MetadataBlobChecksumAlgorithm (string) -- Checksum algorithm.

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