DynamoDB / Paginator / ListBulkOperations

ListBulkOperations¶

class DynamoDB.Paginator.ListBulkOperations¶

paginator = client.get_paginator('list_bulk_operations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DynamoDB.Client.list_bulk_operations().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'BulkOperationsSummaryList': [
        {
            'BulkOperationArn': 'string',
            'BulkOperationStatus': 'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'CANCELLING'|'CANCELLED'|'FAILED',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) –
- BulkOperationsSummaryList (list) –
  
  A list of bulk operation summaries for the current Amazon Web Services account and Amazon Web Services Region.
  - (dict) –
    
    Contains summary information about a bulk operation.
    - BulkOperationArn (string) –
      
      The Amazon Resource Name (ARN) of the bulk operation.
    - BulkOperationStatus (string) –
      
      The current status of the bulk operation.
    - StartTime (datetime) –
      
      The time when DynamoDB accepted the start request.
    - EndTime (datetime) –
      
      The time when the operation reached a terminal status. DynamoDB omits this value while the operation remains in progress.