ImportSignalCatalog - AWS IoT FleetWise

ImportSignalCatalog

Creates a signal catalog using your existing VSS file from your local device.

Request Syntax

{ "description": "string", "name": "string", "vss": { "vssJson": "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 import.

Type: String

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

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

Required: Yes

vss

The file format of the Vehicle Signal Specification (VSS) configuration.

Note

Vehicle Signal Specification is a precise language used to describe and model signals in vehicle networks.

Type: VssFormats object

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 Amazon Resource Name (ARN) of the imported signal catalog.

Type: String

name

The name of the imported 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

Your 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

InvalidSignalsException

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

HTTP Status Code: 400

ResourceNotFoundException

The resource wasn't found.

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: