Skip to content

GetStateTemplateResponse

Source code in docs_src/capo_iotfleetwise/types/get_state_template_response.py
class GetStateTemplateResponse(TypedDict, closed=True):
    name: NotRequired["capo_iotfleetwise.types.resource_name.resourceName"]
    """<p>The name of the state template.</p>"""
    arn: NotRequired["capo_iotfleetwise.types.arn.arn"]
    """<p>The Amazon Resource Name (ARN) of the state template.</p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>A brief description of the state template.</p>"""
    signal_catalog_arn: NotRequired["capo_iotfleetwise.types.arn.arn"]
    """<p>The ARN of the signal catalog associated with the state template.</p>"""
    state_template_properties: NotRequired[
        "capo_iotfleetwise.types.state_template_properties.StateTemplateProperties"
    ]
    """<p>A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.</p>"""
    data_extra_dimensions: NotRequired[
        "capo_iotfleetwise.types.state_template_data_extra_dimension_node_path_list.StateTemplateDataExtraDimensionNodePathList"
    ]
    """<p>A list of vehicle attributes associated with the payload published on the state template's MQTT topic. </p> <p>Default: An empty array</p>"""
    metadata_extra_dimensions: NotRequired[
        "capo_iotfleetwise.types.state_template_metadata_extra_dimension_node_path_list.StateTemplateMetadataExtraDimensionNodePathList"
    ]
    """<p>A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.</p> <p>Default: An empty array</p>"""
    creation_time: NotRequired["capo_iotfleetwise.types.timestamp.timestamp"]
    """<p>The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).</p>"""
    last_modification_time: NotRequired["capo_iotfleetwise.types.timestamp.timestamp"]
    """<p>The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).</p>"""
    id: NotRequired["capo_iotfleetwise.types.resource_unique_id.ResourceUniqueId"]
    """<p>The unique ID of the state template.</p>"""

arn instance-attribute

arn: NotRequired[arn]

The Amazon Resource Name (ARN) of the state template.

creation_time instance-attribute

creation_time: NotRequired[timestamp]

The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).

data_extra_dimensions instance-attribute

data_extra_dimensions: NotRequired[StateTemplateDataExtraDimensionNodePathList]

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

Default: An empty array

description instance-attribute

description: NotRequired[description]

A brief description of the state template.

id instance-attribute

id: NotRequired[ResourceUniqueId]

The unique ID of the state template.

last_modification_time instance-attribute

last_modification_time: NotRequired[timestamp]

The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

metadata_extra_dimensions instance-attribute

metadata_extra_dimensions: NotRequired[StateTemplateMetadataExtraDimensionNodePathList]

A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.

Default: An empty array

name instance-attribute

name: NotRequired[resourceName]

The name of the state template.

signal_catalog_arn instance-attribute

signal_catalog_arn: NotRequired[arn]

The ARN of the signal catalog associated with the state template.

state_template_properties instance-attribute

state_template_properties: NotRequired[StateTemplateProperties]

A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.