BackupStorage / Client / list_objects

list_objects#

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

  • StorageJobId (string) – [REQUIRED] Storage job id

  • StartingObjectName (string) – Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL

  • StartingObjectPrefix (string) – Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL

  • MaxResults (integer) – Maximum objects count

  • NextToken (string) – Pagination token

  • CreatedBefore (datetime) – (Optional) Created before filter

  • CreatedAfter (datetime) – (Optional) Created after filter

Return type:

dict

Returns:

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

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