IoTAnalytics / Client / list_datastores

list_datastores#

IoTAnalytics.Client.list_datastores(**kwargs)#

Retrieves a list of data stores.

See also: AWS API Documentation

Request Syntax

response = client.list_datastores(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) –

    The maximum number of results to return in this request.

    The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'datastoreSummaries': [
        {
            'datastoreName': 'string',
            'datastoreStorage': {
                'serviceManagedS3': {},
                'customerManagedS3': {
                    'bucket': 'string',
                    'keyPrefix': 'string',
                    'roleArn': 'string'
                },
                'iotSiteWiseMultiLayerStorage': {
                    'customerManagedS3Storage': {
                        'bucket': 'string',
                        'keyPrefix': 'string'
                    }
                }
            },
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'lastMessageArrivalTime': datetime(2015, 1, 1),
            'fileFormatType': 'JSON'|'PARQUET',
            'datastorePartitions': {
                'partitions': [
                    {
                        'attributePartition': {
                            'attributeName': 'string'
                        },
                        'timestampPartition': {
                            'attributeName': 'string',
                            'timestampFormat': 'string'
                        }
                    },
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • datastoreSummaries (list) –

      A list of DatastoreSummary objects.

      • (dict) –

        A summary of information about a data store.

        • datastoreName (string) –

          The name of the data store.

        • datastoreStorage (dict) –

          Where data in a data store is stored.

          • serviceManagedS3 (dict) –

            Used to store data in an Amazon S3 bucket managed by IoT Analytics.

          • customerManagedS3 (dict) –

            Used to store data in an Amazon S3 bucket managed by IoT Analytics.

            • bucket (string) –

              The name of the Amazon S3 bucket where your data is stored.

            • keyPrefix (string) –

              (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

            • roleArn (string) –

              The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

          • iotSiteWiseMultiLayerStorage (dict) –

            Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.

            • customerManagedS3Storage (dict) –

              Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.

              • bucket (string) –

                The name of the Amazon S3 bucket where your data is stored.

              • keyPrefix (string) –

                (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

        • status (string) –

          The status of the data store.

        • creationTime (datetime) –

          When the data store was created.

        • lastUpdateTime (datetime) –

          The last time the data store was updated.

        • lastMessageArrivalTime (datetime) –

          The last time when a new message arrived in the data store.

          IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.

          This feature only applies to messages that arrived in the data store after October 23, 2020.

        • fileFormatType (string) –

          The file format of the data in the data store.

        • datastorePartitions (dict) –

          Contains information about the partition dimensions in a data store.

          • partitions (list) –

            A list of partition dimensions in a data store.

            • (dict) –

              A single dimension to partition a data store. The dimension must be an AttributePartition or a TimestampPartition.

              • attributePartition (dict) –

                A partition dimension defined by an attributeName.

                • attributeName (string) –

                  The name of the attribute that defines a partition dimension.

              • timestampPartition (dict) –

                A partition dimension defined by a timestamp attribute.

                • attributeName (string) –

                  The attribute name of the partition defined by a timestamp.

                • timestampFormat (string) –

                  The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).

    • nextToken (string) –

      The token to retrieve the next set of results, or null if there are no more results.

Exceptions