IoTAnalytics / Client / list_dataset_contents

list_dataset_contents#

IoTAnalytics.Client.list_dataset_contents(**kwargs)#

Lists information about dataset contents that have been created.

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_contents(
    datasetName='string',
    nextToken='string',
    maxResults=123,
    scheduledOnOrAfter=datetime(2015, 1, 1),
    scheduledBefore=datetime(2015, 1, 1)
)
Parameters:

  • datasetName (string) –

    [REQUIRED]

    The name of the dataset whose contents information you want to list.

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

  • maxResults (integer) – The maximum number of results to return in this request.

  • scheduledOnOrAfter (datetime) – A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

  • scheduledBefore (datetime) – A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

Return type:

dict

Returns:

Response Syntax

{
    'datasetContentSummaries': [
        {
            'version': 'string',
            'status': {
                'state': 'CREATING'|'SUCCEEDED'|'FAILED',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'scheduleTime': datetime(2015, 1, 1),
            'completionTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • datasetContentSummaries (list) –

      Summary information about dataset contents that have been created.

      • (dict) –

        Summary information about dataset contents.

        • version (string) –

          The version of the dataset contents.

        • status (dict) –

          The status of the dataset contents.

          • state (string) –

            The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.

          • reason (string) –

            The reason the dataset contents are in this state.

        • creationTime (datetime) –

          The actual time the creation of the dataset contents was started.

        • scheduleTime (datetime) –

          The time the creation of the dataset contents was scheduled to start.

        • completionTime (datetime) –

          The time the dataset content status was updated to SUCCEEDED or FAILED.

    • 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

  • IoTAnalytics.Client.exceptions.ResourceNotFoundException