model_manifests

Creates, updates, deletes, gets or lists a model_manifests resource.

Overview

Name	model_manifests
Type	Resource
Id	aws.iotfleetwise.model_manifests

Fields

The following fields are returned by SELECT queries:

get_model_manifest

Name	Datatype	Description
name	string	The name of the vehicle model. (pattern: <code>[a-zA-Z\d-_:]+</code>)
arn	string	The Amazon Resource Name (ARN) of the vehicle model.
creation_time	string (date-time)	The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
description	string	A brief description of the vehicle model. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_modification_time	string (date-time)	The last time the vehicle model was modified.
signal_catalog_arn	string	The ARN of the signal catalog associated with the vehicle model.
status	string	The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. You can edit the vehicle model if the status is marked DRAFT. (ACTIVE, DRAFT, INVALID, VALIDATING)

list_model_manifests

Name	Datatype	Description
name	string	The name of the vehicle model.
arn	string	The Amazon Resource Name (ARN) of the vehicle model.
creation_time	string (date-time)	The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
description	string	A brief description of the vehicle model. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_modification_time	string (date-time)	The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
signal_catalog_arn	string	The ARN of the signal catalog associated with the vehicle model.
status	string	The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model. (ACTIVE, DRAFT, INVALID, VALIDATING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_model_manifest	select	region		Retrieves information about a vehicle model (model manifest).
list_model_manifests	select	region		Retrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
create_model_manifest	insert	region, name, nodes, signalCatalogArn		Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.
update_model_manifest	update	region, name		Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
delete_model_manifest	delete	region		Deletes a vehicle model (model manifest).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_model_manifest

Retrieves information about a vehicle model (model manifest).

SELECT
name,
arn,
creation_time,
description,
last_modification_time,
signal_catalog_arn,
status
FROM aws.iotfleetwise.model_manifests
WHERE region = '{{ region }}' -- required
;

list_model_manifests

Retrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

SELECT
name,
arn,
creation_time,
description,
last_modification_time,
signal_catalog_arn,
status
FROM aws.iotfleetwise.model_manifests
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_model_manifest

Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.

INSERT INTO aws.iotfleetwise.model_manifests (
name,
description,
nodes,
signalCatalogArn,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ nodes }}' /* required */,
'{{ signalCatalogArn }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
name,
arn
;

Manifest

# Description fields are for documentation purposes
- name: model_manifests
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the model_manifests resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the vehicle model to create.
  - name: description
    value: "{{ description }}"
    description: |
      A brief description of the vehicle model.
  - name: nodes
    value:
      - "{{ nodes }}"
    description: |
      A list of nodes, which are a general abstraction of signals.
  - name: signalCatalogArn
    value: "{{ signalCatalogArn }}"
    description: |
      The Amazon Resource Name (ARN) of a signal catalog.
  - name: tags
    description: |
      Metadata that can be used to manage the vehicle model.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_model_manifest

Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.

UPDATE aws.iotfleetwise.model_manifests
SET 
name = '{{ name }}',
description = '{{ description }}',
nodesToAdd = '{{ nodesToAdd }}',
nodesToRemove = '{{ nodesToRemove }}',
status = '{{ status }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
arn;

DELETE examples

delete_model_manifest

Deletes a vehicle model (model manifest).

DELETE FROM aws.iotfleetwise.model_manifests
WHERE region = '{{ region }}' --required
;