IoTSiteWise / Client / list_datasets

list_datasets

IoTSiteWise.Client.list_datasets(**kwargs)

Retrieves a paginated list of datasets for a specific target resource.

See also: AWS API Documentation

Request Syntax

response = client.list_datasets(
    sourceType='KENDRA',
    nextToken='string',
    maxResults=123
)
Parameters:

  • sourceType (string) –

    [REQUIRED]

    The type of data source for the dataset.

  • nextToken (string) – The token for the next set of results, or null if there are no additional results.

  • maxResults (integer) – The maximum number of results to return for each paginated request.

Return type:

dict

Returns:

Response Syntax

{
    'datasetSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            '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'
                        },
                    ]
                }
            }
        },
    ],
    '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.

        • 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.

    • nextToken (string) –

      The token for the next set of results, or null if there are no additional results.

Exceptions