Skip to content

DescribeTimeSeriesResponse

Source code in docs_src/capo_iotsitewise/types/describe_time_series_response.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class DescribeTimeSeriesResponse(TypedDict, closed=True):
    asset_id: NotRequired["capo_iotsitewise.types.id.ID"]
    """<p>The ID of the asset in which the asset property was created.</p>"""
    property_id: NotRequired["capo_iotsitewise.types.id.ID"]
    """<p>The ID of the asset property, in UUID format.</p>"""
    alias: NotRequired["capo_iotsitewise.types.property_alias.PropertyAlias"]
    """<p>The alias that identifies the time series.</p>"""
    time_series_id: "capo_iotsitewise.types.time_series_id.TimeSeriesId"
    """<p>The ID of the time series.</p>"""
    data_type: "capo_iotsitewise.types.property_data_type.PropertyDataType"
    """<p>The data type of the time series.</p> <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>"""
    data_type_spec: NotRequired["capo_iotsitewise.types.name.Name"]
    """<p>The data type of the structure for this time series. This parameter is required for time series that have the <code>STRUCT</code> data type.</p> <p>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 <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>"""
    time_series_creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date that the time series was created, in Unix epoch time.</p>"""
    time_series_last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date that the time series was last updated, in Unix epoch time.</p>"""
    time_series_arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}</code> </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[ID]

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

data_type instance-attribute 

data_type: PropertyDataType

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.

data_type_spec instance-attribute 

data_type_spec: NotRequired[Name]

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.

property_id instance-attribute 

property_id: NotRequired[ID]

The ID of the asset property, in UUID format.

time_series_arn instance-attribute 

time_series_arn: ARN

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

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

time_series_creation_date instance-attribute 

time_series_creation_date: Timestamp

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

time_series_id instance-attribute 

time_series_id: TimeSeriesId

The ID of the time series.

time_series_last_update_date instance-attribute 

time_series_last_update_date: Timestamp

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

workspace_name instance-attribute 

workspace_name: NotRequired[WorkspaceName]

The name of the workspace.