CreateSignalCatalog - AWS IoT FleetWise

CreateSignalCatalog

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

Request Syntax

{ "description": "string", "name": "string", "nodes": [ { "actuator": { "allowedValues": [ "string" ], "assignedValue": "string", "dataType": "string", "description": "string", "fullyQualifiedName": "string", "max": number, "min": number, "unit": "string" }, "attribute": { "allowedValues": [ "string" ], "assignedValue": "string", "dataType": "string", "defaultValue": "string", "description": "string", "fullyQualifiedName": "string", "max": number, "min": number, "unit": "string" }, "branch": { "description": "string", "fullyQualifiedName": "string" }, "sensor": { "allowedValues": [ "string" ], "dataType": "string", "description": "string", "fullyQualifiedName": "string", "max": number, "min": number, "unit": "string" } } ], "tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

description

A brief description of the signal catalog.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

name

The name of the signal catalog to create.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Required: Yes

nodes

A list of information about nodes, which are a general abstraction of signals. For more information, see the Node API data type.

Type: Array of Node objects

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Required: No

tags

Metadata that can be used to manage the signal catalog.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

{ "arn": "string", "name": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The ARN of the created signal catalog.

Type: String

name

The name of the created signal catalog.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

ConflictException

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

HTTP Status Code: 500

InvalidNodeException

The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.

HTTP Status Code: 400

InvalidSignalsException

The request couldn't be completed because it contains signals that aren't valid.

HTTP Status Code: 400

LimitExceededException

A service quota was exceeded.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: