get_dataset_content

IoTAnalytics.Client.get_dataset_content(**kwargs)

Retrieves the contents of a dataset as presigned URIs.

See also: AWS API Documentation

Request Syntax

response = client.get_dataset_content(
    datasetName='string',
    versionId='string'
)

Parameters

• datasetName (string) --

  [REQUIRED]

  The name of the dataset whose contents are retrieved.

• versionId (string) -- The version of the dataset whose contents are retrieved. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed dataset. If not specified, "$LATEST_SUCCEEDED" is the default.

Return type

dict

Returns

Response Syntax

{
    'entries': [
        {
            'entryName': 'string',
            'dataURI': 'string'
        },
    ],
    'timestamp': datetime(2015, 1, 1),
    'status': {
        'state': 'CREATING'|'SUCCEEDED'|'FAILED',
        'reason': 'string'
    }
}

Response Structure

• (dict) --

  • entries (list) --

    A list of DatasetEntry objects.

    • (dict) --

      The reference to a dataset entry.

      • entryName (string) --

        The name of the dataset item.

      • dataURI (string) --

        The presigned URI of the dataset item.

  • timestamp (datetime) --

    The time when the request was made.

  • status (dict) --

    The status of the dataset content.

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

Exceptions

• IoTAnalytics.Client.exceptions.InvalidRequestException
• IoTAnalytics.Client.exceptions.ResourceNotFoundException
• IoTAnalytics.Client.exceptions.InternalFailureException
• IoTAnalytics.Client.exceptions.ServiceUnavailableException
• IoTAnalytics.Client.exceptions.ThrottlingException