IoTSiteWise / Client / describe_dataset

describe_dataset

IoTSiteWise.Client.describe_dataset(**kwargs)

Retrieves information about a dataset.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset(
    datasetId='string',
    workspaceName='string',
    datasetVersion='string'
)

Parameters:

• datasetId (string) –

  [REQUIRED]

  The ID of the dataset.

• workspaceName (string) – The name of the workspace that contains the dataset.

• datasetVersion (string) – The version of the dataset.

Return type:

dict

Returns:

Response Syntax

{
    'datasetId': 'string',
    'datasetArn': 'string',
    'datasetName': 'string',
    'datasetDescription': 'string',
    'datasetType': 'SESSION'|'CURATED'|'EXTERNAL',
    'datasetConfig': {
        'session': {
            'sessionStartTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'sessionEndTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            }
        }
    },
    'workspaceName': 'string',
    'metadata': {
        'string': 'string'
    },
    'datasetSource': {
        'sourceType': 'KENDRA'|'SITEWISE',
        'sourceFormat': 'KNOWLEDGE_BASE'|'TIMESERIES',
        'sourceDetail': {
            'kendra': {
                'knowledgeBaseArn': 'string',
                'roleArn': 'string'
            }
        }
    },
    'datasetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    },
    'datasetCreationDate': datetime(2015, 1, 1),
    'datasetLastUpdateDate': datetime(2015, 1, 1),
    'datasetVersion': 'string',
    'enrichmentStatus': {
        'video': {
            'status': 'FULLY_ENRICHED'|'PARTIALLY_ENRICHED'|'NOT_ENRICHED',
            'lastEnrichedAt': datetime(2015, 1, 1)
        }
    }
}

Response Structure

• (dict) –

  • datasetId (string) –

    The ID of the dataset.

  • datasetArn (string) –

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

  • datasetName (string) –

    The name of the dataset.

  • datasetDescription (string) –

    A description about the dataset, and its functionality.

  • datasetType (string) –

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

  • datasetConfig (dict) –

    The configuration for the dataset.

    • session (dict) –

      The session configuration for a session-type dataset.

      • sessionStartTimestamp (dict) –

        The nanosecond-precision start time of the session.

        • timeInSeconds (integer) –

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

        • offsetInNanos (integer) –

          The nanosecond offset from timeInSeconds.

      • sessionEndTimestamp (dict) –

        The nanosecond-precision end time of the session.

        • timeInSeconds (integer) –

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

        • offsetInNanos (integer) –

          The nanosecond offset from timeInSeconds.

  • workspaceName (string) –

    The name of the workspace that contains the dataset.

  • metadata (dict) –

    The metadata for the dataset.

    • (string) –

      • (string) –

  • datasetSource (dict) –

    The data source for the dataset.

    • sourceType (string) –

      The type of data source for the dataset.

    • sourceFormat (string) –

      The format of the dataset source associated with the dataset.

    • sourceDetail (dict) –

      The details of the dataset source associated with the dataset.

      • kendra (dict) –

        Contains details about the Kendra dataset source.

        • knowledgeBaseArn (string) –

          The knowledgeBaseArn details for the Kendra dataset source.

        • roleArn (string) –

          The roleARN details for the Kendra dataset source.

  • datasetStatus (dict) –

    The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. 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.

  • datasetCreationDate (datetime) –

    The dataset creation date, in Unix epoch time.

  • datasetLastUpdateDate (datetime) –

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

  • datasetVersion (string) –

    The version of the dataset.

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

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException