GetSignalCatalog
Retrieves information about a signal catalog.
Request Syntax
{
"name": "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.
- name
-
The name of the signal catalog to retrieve information about.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+Required: Yes
Response Syntax
{
"arn": "string",
"creationTime": number,
"description": "string",
"lastModificationTime": number,
"name": "string",
"nodeCounts": {
"totalActuators": number,
"totalAttributes": number,
"totalBranches": number,
"totalNodes": number,
"totalProperties": number,
"totalSensors": number,
"totalStructs": number
}
}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 signal catalog.
Type: String
- creationTime
-
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Type: Timestamp
- description
-
A brief description of the signal catalog.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+ - lastModificationTime
-
The last time the signal catalog was modified.
Type: Timestamp
- name
-
The name of the signal catalog.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+ - nodeCounts
-
The total number of network nodes specified in a signal catalog.
Type: NodeCounts object
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
- 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:
