Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListApplicationInstanceNodeInstances

Returns a list of application node instances.

Request Syntax


GET /application-instances/ApplicationInstanceId/node-instances?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationInstanceId

The node instances' application instance ID.

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

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

MaxResults

The maximum number of node instances 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: ^.+$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "NodeInstances": [ 
      { 
         "CurrentStatus": "string",
         "NodeId": "string",
         "NodeInstanceId": "string",
         "NodeName": "string",
         "PackageName": "string",
         "PackagePatchVersion": "string",
         "PackageVersion": "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

A pagination token that's included if more results are available.

Type: String

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

Pattern: ^.+$

NodeInstances

A list of node instances.

Type: Array of NodeInstance objects

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

InternalServerException

An internal error occurred.

HTTP Status Code: 500