signal_catalogs

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

Overview

Name	signal_catalogs
Type	Resource
Id	aws.iotfleetwise.signal_catalogs

Fields

The following fields are returned by SELECT queries:

get_signal_catalog

Name	Datatype	Description
name	string	The name of the signal catalog. (pattern: <code>[a-zA-Z\d-_:]+</code>)
arn	string	The Amazon Resource Name (ARN) of the signal catalog.
creation_time	string (date-time)	The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
description	string	A brief description of the signal catalog. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_modification_time	string (date-time)	The last time the signal catalog was modified.
node_counts	object	The total number of network nodes specified in a signal catalog.

list_signal_catalogs

Name	Datatype	Description
name	string	The name of the signal catalog.
arn	string	The Amazon Resource Name (ARN) of the signal catalog.
creation_time	string (date-time)	The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
last_modification_time	string (date-time)	The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_signal_catalog	select	region		Retrieves information about a signal catalog.
list_signal_catalogs	select	region		Lists all the created signal catalogs in an Amazon Web Services account. You can use to list information about each signal (node) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
create_signal_catalog	insert	region, name		Creates a collection of standardized signals that can be reused to create vehicle models.
update_signal_catalog	update	region, name		Updates a signal catalog.
delete_signal_catalog	delete	region		Deletes a signal catalog.

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_signal_catalog

Retrieves information about a signal catalog.

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

list_signal_catalogs

Lists all the created signal catalogs in an Amazon Web Services account. You can use to list information about each signal (node) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

SELECT
name,
arn,
creation_time,
last_modification_time
FROM aws.iotfleetwise.signal_catalogs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_signal_catalog

Creates a collection of standardized signals that can be reused to create vehicle models.

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

Manifest

# Description fields are for documentation purposes
- name: signal_catalogs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the signal_catalogs resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the signal catalog to create.
  - name: description
    value: "{{ description }}"
    description: |
      A brief description of the signal catalog.
  - name: nodes
    description: |
      A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
    value:
      - branch:
          fullyQualifiedName: "{{ fullyQualifiedName }}"
          description: "{{ description }}"
          deprecationMessage: "{{ deprecationMessage }}"
          comment: "{{ comment }}"
        sensor:
          fullyQualifiedName: "{{ fullyQualifiedName }}"
          dataType: "{{ dataType }}"
          description: "{{ description }}"
          unit: "{{ unit }}"
          allowedValues:
            - "{{ allowedValues }}"
          min: {{ min }}
          max: {{ max }}
          deprecationMessage: "{{ deprecationMessage }}"
          comment: "{{ comment }}"
          structFullyQualifiedName: "{{ structFullyQualifiedName }}"
        actuator:
          fullyQualifiedName: "{{ fullyQualifiedName }}"
          dataType: "{{ dataType }}"
          description: "{{ description }}"
          unit: "{{ unit }}"
          allowedValues:
            - "{{ allowedValues }}"
          min: {{ min }}
          max: {{ max }}
          assignedValue: "{{ assignedValue }}"
          deprecationMessage: "{{ deprecationMessage }}"
          comment: "{{ comment }}"
          structFullyQualifiedName: "{{ structFullyQualifiedName }}"
        attribute:
          fullyQualifiedName: "{{ fullyQualifiedName }}"
          dataType: "{{ dataType }}"
          description: "{{ description }}"
          unit: "{{ unit }}"
          allowedValues:
            - "{{ allowedValues }}"
          min: {{ min }}
          max: {{ max }}
          assignedValue: "{{ assignedValue }}"
          defaultValue: "{{ defaultValue }}"
          deprecationMessage: "{{ deprecationMessage }}"
          comment: "{{ comment }}"
        struct:
          fullyQualifiedName: "{{ fullyQualifiedName }}"
          description: "{{ description }}"
          deprecationMessage: "{{ deprecationMessage }}"
          comment: "{{ comment }}"
        property:
          fullyQualifiedName: "{{ fullyQualifiedName }}"
          dataType: "{{ dataType }}"
          dataEncoding: "{{ dataEncoding }}"
          description: "{{ description }}"
          deprecationMessage: "{{ deprecationMessage }}"
          comment: "{{ comment }}"
          structFullyQualifiedName: "{{ structFullyQualifiedName }}"
  - name: tags
    description: |
      Metadata that can be used to manage the signal catalog.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_signal_catalog

Updates a signal catalog.

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

DELETE examples

delete_signal_catalog

Deletes a signal catalog.

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