IoTSiteWise / Paginator / ListDatasets

ListDatasets

class IoTSiteWise.Paginator.ListDatasets

paginator = client.get_paginator('list_datasets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_datasets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sourceType='KENDRA'|'SITEWISE',
    workspaceName='string',
    datasetType='SESSION'|'CURATED'|'EXTERNAL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• sourceType (string) –

  [REQUIRED]

  The type of data source for the dataset.

• workspaceName (string) – The name of the workspace to filter datasets by.

• datasetType (string) – The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'datasetSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'sourceType': 'KENDRA'|'SITEWISE',
            'datasetType': 'SESSION'|'CURATED'|'EXTERNAL',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'status': {
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                            'message': 'string'
                        },
                    ]
                }
            },
            'enrichmentStatus': {
                'video': {
                    'status': 'FULLY_ENRICHED'|'PARTIALLY_ENRICHED'|'NOT_ENRICHED',
                    'lastEnrichedAt': datetime(2015, 1, 1)
                }
            }
        },
    ],
    'workspaceName': 'string',
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • datasetSummaries (list) –

    A list that summarizes the dataset response.

    • (dict) –

      The summary details for the dataset.

      • id (string) –

        The ID of the dataset.

      • arn (string) –

        The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

      • name (string) –

        The name of the dataset.

      • description (string) –

        A description about the dataset, and its functionality.

      • sourceType (string) –

        The data source type of the dataset.

      • datasetType (string) –

        The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

      • creationDate (datetime) –

        The dataset creation date, in Unix epoch time.

      • lastUpdateDate (datetime) –

        The date the dataset was last updated, in Unix epoch time.

      • status (dict) –

        The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

        • state (string) –

          The current status of the dataset.

        • error (dict) –

          Contains the details of an IoT SiteWise error.

          • code (string) –

            The error code.

          • message (string) –

            The error message.

          • details (list) –

            A list of detailed errors.

            • (dict) –

              Contains detailed error information.

              • code (string) –

                The error code.

              • message (string) –

                The error message.

      • enrichmentStatus (dict) –

        The enrichment status of the dataset.

        • video (dict) –

          The enrichment status for video data in the dataset.

          • status (string) –

            The enrichment status of the data type in the dataset.

          • lastEnrichedAt (datetime) –

            The date the data was last enriched, in Unix epoch time.

  • workspaceName (string) –

    The name of the workspace.

  • NextToken (string) –

    A token to resume pagination.