HealthImaging / Client / list_datastores

list_datastores#

HealthImaging.Client.list_datastores(**kwargs)#

List data stores.

See also: AWS API Documentation

Request Syntax

response = client.list_datastores(
    datastoreStatus='CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
    nextToken='string',
    maxResults=123
)
Parameters:
  • datastoreStatus (string) – The data store status.

  • nextToken (string) – The pagination token used to request the list of data stores on the next page.

  • maxResults (integer) – Valid Range: Minimum value of 1. Maximum value of 50.

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) –

      The pagination token used to retrieve the list of data stores on the next page.

Exceptions

  • HealthImaging.Client.exceptions.ThrottlingException

  • HealthImaging.Client.exceptions.AccessDeniedException

  • HealthImaging.Client.exceptions.ValidationException

  • HealthImaging.Client.exceptions.InternalServerException