IoTAnalytics / Client / list_datasets

list_datasets

IoTAnalytics.Client.list_datasets(**kwargs)

Retrieves information about datasets.

See also: AWS API Documentation

Request Syntax

response = client.list_datasets(
    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

{
    'datasetSummaries': [
        {
            'datasetName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'triggers': [
                {
                    'schedule': {
                        'expression': 'string'
                    },
                    'dataset': {
                        'name': 'string'
                    }
                },
            ],
            'actions': [
                {
                    'actionName': 'string',
                    'actionType': 'QUERY'|'CONTAINER'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • datasetSummaries (list) –

    A list of DatasetSummary objects.

    • (dict) –

      A summary of information about a dataset.

      • datasetName (string) –

        The name of the dataset.

      • status (string) –

        The status of the dataset.

      • creationTime (datetime) –

        The time the dataset was created.

      • lastUpdateTime (datetime) –

        The last time the dataset was updated.

      • triggers (list) –

        A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects

        • (dict) –

          The DatasetTrigger that specifies when the dataset is automatically updated.

          • schedule (dict) –

            The Schedule when the trigger is initiated.

            • expression (string) –

              The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

          • dataset (dict) –

            The dataset whose content creation triggers the creation of this dataset’s contents.

            • name (string) –

              The name of the dataset whose content generation triggers the new dataset content generation.

      • actions (list) –

        A list of DataActionSummary objects.

        • (dict) –

          Information about the action that automatically creates the dataset’s contents.

          • actionName (string) –

            The name of the action that automatically creates the dataset’s contents.

          • actionType (string) –

            The type of action by which the dataset’s contents are automatically created.

  • nextToken (string) –

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

Exceptions

• IoTAnalytics.Client.exceptions.InvalidRequestException

• IoTAnalytics.Client.exceptions.InternalFailureException

• IoTAnalytics.Client.exceptions.ServiceUnavailableException

• IoTAnalytics.Client.exceptions.ThrottlingException