Skip to content

DescribeTimeSeriesRequest

Source code in docs_src/capo_iotsitewise/types/describe_time_series_request.py 
13
14
15
16
17
18
19
20
21
class DescribeTimeSeriesRequest(TypedDict, closed=True):
    alias: NotRequired["capo_iotsitewise.types.property_alias.PropertyAlias"]
    """<p>The alias that identifies the time series.</p>"""
    asset_id: NotRequired["capo_iotsitewise.types.custom_id.CustomID"]
    """<p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    property_id: NotRequired["capo_iotsitewise.types.custom_id.CustomID"]
    """<p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    workspace_name: NotRequired["capo_iotsitewise.types.workspace_name.WorkspaceName"]
    """<p>The name of the workspace.</p>"""

alias instance-attribute 

alias: NotRequired[PropertyAlias]

The alias that identifies the time series.

asset_id instance-attribute 

asset_id: NotRequired[CustomID]

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.

property_id instance-attribute 

property_id: NotRequired[CustomID]

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.

workspace_name instance-attribute 

workspace_name: NotRequired[WorkspaceName]

The name of the workspace.