HealthImaging / Paginator / ListDatastores

ListDatastores#

class HealthImaging.Paginator.ListDatastores#
paginator = client.get_paginator('list_datastores')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from HealthImaging.Client.list_datastores().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datastoreStatus='CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • datastoreStatus (string) – The data store status.

  • 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

{
    'datastoreSummaries': [
        {
            'datastoreId': 'string',
            'datastoreName': 'string',
            'datastoreStatus': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
            'datastoreArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • datastoreSummaries (list) –

      The list of summaries of data stores.

      • (dict) –

        List of summaries of data stores.

        • datastoreId (string) –

          The data store identifier.

        • datastoreName (string) –

          The data store name.

        • datastoreStatus (string) –

          The data store status.

        • datastoreArn (string) –

          The Amazon Resource Name (ARN) for the data store.

        • createdAt (datetime) –

          The timestamp when the data store was created.

        • updatedAt (datetime) –

          The timestamp when the data store was last updated.

    • NextToken (string) –

      A token to resume pagination.