ListNodes
Returns a list of nodes.
Request Syntax
GET /nodes?category=Category&maxResults=MaxResults&nextToken=NextToken&ownerAccount=OwnerAccount&packageName=PackageName&packageVersion=PackageVersion&patchVersion=PatchVersion HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Category
-
Search for nodes by category.
Valid Values:
BUSINESS_LOGIC | ML_MODEL | MEDIA_SOURCE | MEDIA_SINK - MaxResults
-
The maximum number of nodes to return in one page of results.
Valid Range: Minimum value of 0. Maximum value of 25.
- NextToken
-
Specify the pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^.+$ - OwnerAccount
-
Search for nodes by the account ID of the nodes' owner.
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern:
^[0-9a-z\_]+$ - PackageName
-
Search for nodes by name.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-\_]+$ - PackageVersion
-
Search for nodes by version.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^([0-9]+)\.([0-9]+)$ - PatchVersion
-
Search for nodes by patch version.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-z0-9]+$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Nodes": [
{
"Category": "string",
"CreatedTime": number,
"Description": "string",
"Name": "string",
"NodeId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The target resource is in use.
HTTP Status Code: 409
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
