IoTSiteWise / Client / describe_time_series

describe_time_series

IoTSiteWise.Client.describe_time_series(**kwargs)

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

  • If the time series isn’t associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

    • The alias of the time series.

    • The assetId and propertyId that identifies the asset property.

See also: AWS API Documentation

Request Syntax

response = client.describe_time_series(
    alias='string',
    assetId='string',
    propertyId='string'
)
Parameters:

  • alias (string) – The alias that identifies the time series.

  • assetId (string) – The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • propertyId (string) – The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'assetId': 'string',
    'propertyId': 'string',
    'alias': 'string',
    'timeSeriesId': 'string',
    'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
    'dataTypeSpec': 'string',
    'timeSeriesCreationDate': datetime(2015, 1, 1),
    'timeSeriesLastUpdateDate': datetime(2015, 1, 1),
    'timeSeriesArn': 'string'
}

Response Structure

  • (dict) –

    • assetId (string) –

      The ID of the asset in which the asset property was created.

    • propertyId (string) –

      The ID of the asset property, in UUID format.

    • alias (string) –

      The alias that identifies the time series.

    • timeSeriesId (string) –

      The ID of the time series.

    • dataType (string) –

      The data type of the time series.

      If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

    • dataTypeSpec (string) –

      The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

      The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

    • timeSeriesCreationDate (datetime) –

      The date that the time series was created, in Unix epoch time.

    • timeSeriesLastUpdateDate (datetime) –

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

    • timeSeriesArn (string) –

      The ARN of the time series, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

Exceptions