ListSignalCatalogNodes - AWS IoT FleetWise

ListSignalCatalogNodes

Lists of information about the signals (nodes) specified in a signal catalog.

Note

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Request Syntax

{ "maxResults": number, "name": "string", "nextToken": "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.

maxResults

The maximum number of items to return, between 1 and 100, inclusive.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

name

The name of the signal catalog to list information about.

Type: String

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

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

Required: Yes

nextToken

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Type: String

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

Required: No

Response Syntax

{ "nextToken": "string", "nodes": [ { "actuator": { "allowedValues": [ "string" ], "assignedValue": "string", "dataType": "string", "description": "string", "fullyQualifiedName": "string", "max": number, "min": number, "name": "string", "unit": "string" }, "attribute": { "allowedValues": [ "string" ], "assignedValue": "string", "dataType": "string", "defaultValue": "string", "description": "string", "fullyQualifiedName": "string", "max": number, "min": number, "name": "string", "unit": "string" }, "branch": { "description": "string", "fullyQualifiedName": "string", "name": "string" }, "sensor": { "allowedValues": [ "string" ], "dataType": "string", "description": "string", "fullyQualifiedName": "string", "max": number, "min": number, "name": "string", "unit": "string" }, "type": "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.

nextToken

The token to retrieve the next set of results, or null if there are no more results.

Type: String

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

nodes

A list of information about nodes.

Type: Array of Node objects

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

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

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 400

ServiceQuotaExceededException

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: