AWS IoT Analytics

2019/10/10 - AWS IoT Analytics - 1 updated api methods

Changes  Update iotanalytics client to latest version

ListDatasetContents (updated) Link ΒΆ
Changes (response)
{'datasetContentSummaries': {'completionTime': 'timestamp'}}

Lists information about data set contents that have been created.

See also: AWS API Documentation

Request Syntax

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

string

param datasetName:

[REQUIRED]

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

type nextToken:

string

param nextToken:

The token for the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of results to return in this request.

type scheduledOnOrAfter:

datetime

param scheduledOnOrAfter:

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

type scheduledBefore:

datetime

param scheduledBefore:

A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

rtype:

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 data set contents that have been created.

      • (dict) --

        Summary information about data set contents.

        • version (string) --

          The version of the data set contents.

        • status (dict) --

          The status of the data set contents.

          • state (string) --

            The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".

          • reason (string) --

            The reason the data set contents are in this state.

        • creationTime (datetime) --

          The actual time the creation of the data set contents was started.

        • scheduleTime (datetime) --

          The time the creation of the data set 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.