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

ListApplicationInstances

Returns a list of application instances.

Request Syntax


GET /application-instances?deviceId=DeviceId&maxResults=MaxResults&nextToken=NextToken&statusFilter=StatusFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeviceId

The application instances' device ID.

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

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

MaxResults

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

StatusFilter

Only include instances with a specific status.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationInstances": [ 
      { 
         "ApplicationInstanceId": "string",
         "Arn": "string",
         "CreatedTime": number,
         "DefaultRuntimeContextDevice": "string",
         "DefaultRuntimeContextDeviceName": "string",
         "Description": "string",
         "HealthStatus": "string",
         "Name": "string",
         "RuntimeContextStates": [ 
            { 
               "DesiredState": "string",
               "DeviceReportedStatus": "string",
               "DeviceReportedTime": number,
               "RuntimeContextName": "string"
            }
         ],
         "Status": "string",
         "StatusDescription": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "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.

ApplicationInstances

A list of application instances.

Type: Array of ApplicationInstance objects

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: ^.+$

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