DescribeNode
Important
End of support notice: On May 31, 2026, AWS will end support for AWS Panorama. After May 31, 2026, you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see AWS Panorama end of support.
Returns information about a node.
Request Syntax
GET /nodes/NodeId?OwnerAccount=OwnerAccount HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- NodeId
-
The node's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\-\_\.]+Required: Yes
- OwnerAccount
-
The account ID of the node's owner.
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern:
[0-9a-z\_]+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AssetName": "string",
"Category": "string",
"CreatedTime": number,
"Description": "string",
"LastUpdatedTime": number,
"Name": "string",
"NodeId": "string",
"NodeInterface": {
"Inputs": [
{
"DefaultValue": "string",
"Description": "string",
"MaxConnections": number,
"Name": "string",
"Type": "string"
}
],
"Outputs": [
{
"Description": "string",
"Name": "string",
"Type": "string"
}
]
},
"OwnerAccount": "string",
"PackageArn": "string",
"PackageId": "string",
"PackageName": "string",
"PackageVersion": "string",
"PatchVersion": "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.
- AssetName
-
The node's asset name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\-\_]+ - Category
-
The node's category.
Type: String
Valid Values:
BUSINESS_LOGIC | ML_MODEL | MEDIA_SOURCE | MEDIA_SINK - CreatedTime
-
When the node was created.
Type: Timestamp
- Description
-
The node's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
.* - LastUpdatedTime
-
When the node was updated.
Type: Timestamp
- Name
-
The node's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9\-\_]+ - NodeId
-
The node's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\-\_\.]+ - NodeInterface
-
The node's interface.
Type: NodeInterface object
- OwnerAccount
-
The account ID of the node's owner.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern:
[0-9a-z\_]+ - PackageArn
-
The node's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- PackageId
-
The node's package ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9\-\_\/]+ - PackageName
-
The node's package name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9\-\_]+ - PackageVersion
-
The node's package version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
([0-9]+)\.([0-9]+) - PatchVersion
-
The node's patch version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403
- ConflictException
-
The target resource is in use.
- ErrorArguments
-
A list of attributes that led to the exception and their values.
- ErrorId
-
A unique ID for the error.
- ResourceId
-
The resource's ID.
- ResourceType
-
The resource's type.
HTTP Status Code: 409
- InternalServerException
-
An internal error occurred.
- RetryAfterSeconds
-
The number of seconds a client should wait before retrying the call.
HTTP Status Code: 500
- ResourceNotFoundException
-
The target resource was not found.
- ResourceId
-
The resource's ID.
- ResourceType
-
The resource's type.
HTTP Status Code: 404
- ValidationException
-
The request contains an invalid parameter value.
- ErrorArguments
-
A list of attributes that led to the exception and their values.
- ErrorId
-
A unique ID for the error.
- Fields
-
A list of request parameters that failed validation.
- Reason
-
The reason that validation failed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
