IoTSiteWise / Client / delete_time_series

delete_time_series#

IoTSiteWise.Client.delete_time_series(**kwargs)#

Deletes a time series (data stream). If you delete a time series that’s associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

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.delete_time_series(
    alias='string',
    assetId='string',
    propertyId='string',
    clientToken='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.

  • propertyId (string) – The ID of the asset property.

  • clientToken (string) –

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Returns:

None

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException

  • IoTSiteWise.Client.exceptions.ConflictingOperationException