IoTFleetWise / Client / create_state_template

create_state_template

IoTFleetWise.Client.create_state_template(**kwargs)

Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.

Warning

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_state_template(
    name='string',
    description='string',
    signalCatalogArn='string',
    stateTemplateProperties=[
        'string',
    ],
    dataExtraDimensions=[
        'string',
    ],
    metadataExtraDimensions=[
        'string',
    ],
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the state template.

• description (string) – A brief description of the state template.

• signalCatalogArn (string) –

  [REQUIRED]

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

• stateTemplateProperties (list) –

  [REQUIRED]

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

  • (string) –

• dataExtraDimensions (list) –

  A list of vehicle attributes to associate with the payload published on the state template’s MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.

  • (string) –

• metadataExtraDimensions (list) –

  A list of vehicle attributes to associate with user properties of the messages published on the state template’s MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

  Default: An empty array

  • (string) –

• tags (list) –

  Metadata that can be used to manage the state template.

  • (dict) –

    A set of key/value pairs that are used to manage the resource.

    • Key (string) – [REQUIRED]

      The tag’s key.

    • Value (string) – [REQUIRED]

      The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'id': 'string'
}

Response Structure

• (dict) –

  • name (string) –

    The name of the state template.

  • arn (string) –

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

  • id (string) –

    The unique ID of the state template.

Exceptions

• IoTFleetWise.Client.exceptions.ResourceNotFoundException

• IoTFleetWise.Client.exceptions.InternalServerException

• IoTFleetWise.Client.exceptions.ConflictException

• IoTFleetWise.Client.exceptions.LimitExceededException

• IoTFleetWise.Client.exceptions.ThrottlingException

• IoTFleetWise.Client.exceptions.ValidationException

• IoTFleetWise.Client.exceptions.InvalidSignalsException

• IoTFleetWise.Client.exceptions.AccessDeniedException