UpdateSignalCatalog
Updates a signal catalog.
Request Syntax
{
"description": "string",
"name": "string",
"nodesToAdd": [
{ ... }
],
"nodesToRemove": [ "string" ],
"nodesToUpdate": [
{ ... }
]
}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 to update.
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 update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+Required: Yes
- nodesToAdd
-
A list of information about nodes to add to the signal catalog.
Type: Array of Node objects
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Required: No
- nodesToRemove
-
A list of
fullyQualifiedNameof nodes to remove from the signal catalog.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Length Constraints: Minimum length of 1. Maximum length of 150.
Pattern:
[a-zA-Z0-9_.]+Required: No
- nodesToUpdate
-
A list of information about nodes to update in the signal catalog.
Type: Array of Node objects
Array Members: Minimum number of 0 items. Maximum number of 500 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.
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.
- resource
-
The resource on which there are conflicting operations.
- resourceType
-
The type of resource on which there are conflicting operations..
HTTP Status Code: 400
- InternalServerException
-
The request couldn't be completed because the server temporarily failed.
- retryAfterSeconds
-
The number of seconds to wait before retrying the command.
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.
- invalidNodes
-
The specified node type isn't valid.
- reason
-
The reason the node validation failed.
HTTP Status Code: 400
- InvalidSignalsException
-
The request couldn't be completed because it contains signals that aren't valid.
- invalidSignals
-
The signals which caused the exception.
HTTP Status Code: 400
- LimitExceededException
-
A service quota was exceeded.
- resourceId
-
The identifier of the resource that was exceeded.
- resourceType
-
The type of resource that was exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource wasn't found.
- resourceId
-
The identifier of the resource that wasn't found.
- resourceType
-
The type of resource that wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request couldn't be completed due to throttling.
- quotaCode
-
The quota identifier of the applied throttling rules for this request.
- retryAfterSeconds
-
The number of seconds to wait before retrying the command.
- serviceCode
-
The code for the service that couldn't be completed due to throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
- fieldList
-
The list of fields that fail to satisfy the constraints specified by an AWS service.
- reason
-
The reason the input failed 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:
