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

ListApplications

Lists the applications associated with a specific AWS account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.

Request Syntax


GET /applications?environmentId=environmentId&maxResults=maxResults&names=names&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

environmentId

The unique identifier of the runtime environment where the applications are deployed.

Pattern: \S{1,80}

maxResults

The maximum number of applications to return.

Valid Range: Minimum value of 1. Maximum value of 2000.

names

The names of the applications.

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: [A-Za-z0-9][A-Za-z0-9_\-]{1,59}

nextToken

A pagination token to control the number of applications displayed in the list.

Pattern: \S{1,2000}

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applications": [ 
      { 
         "applicationArn": "string",
         "applicationId": "string",
         "applicationVersion": number,
         "creationTime": number,
         "deploymentStatus": "string",
         "description": "string",
         "engineType": "string",
         "environmentId": "string",
         "lastStartTime": number,
         "name": "string",
         "roleArn": "string",
         "status": "string",
         "versionStatus": "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.

applications

Returns a list of summary details for all the applications in a runtime environment.

Type: Array of ApplicationSummary objects

nextToken

A pagination token that's returned when the response doesn't contain all applications.

Type: String

Pattern: \S{1,2000}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The account or role doesn't have the right permissions to make the request.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ThrottlingException

The number of requests made exceeds the limit.

quotaCode: The identifier of the throttled request.
retryAfterSeconds: The number of seconds to wait before retrying the request.
serviceCode: The identifier of the service that the throttled request was made to.

HTTP Status Code: 429

ValidationException

One or more parameters provided in the request is not valid.

fieldList: The list of fields that failed service validation.
reason: The reason why it failed service validation.

HTTP Status Code: 400