BackupStorage / Client / list_chunks

list_chunks#

BackupStorage.Client.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'
)
Parameters:
  • StorageJobId (string) – [REQUIRED] Storage job id

  • ObjectToken (string) – [REQUIRED] Object token

  • MaxResults (integer) – Maximum number of chunks

  • NextToken (string) – Pagination token

Return type:

dict

Returns:

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

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