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

ListApplications

Lists applications based on a set of parameters.

Request Syntax


GET /applications?maxResults=maxResults&nextToken=nextToken&states=states HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of applications that can be listed.

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

nextToken

The token for the next set of application results.

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

Pattern: [A-Za-z0-9_=-]+

states

An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applications": [ 
      { 
         "architecture": "string",
         "arn": "string",
         "createdAt": number,
         "id": "string",
         "name": "string",
         "releaseLabel": "string",
         "state": "string",
         "stateDetails": "string",
         "type": "string",
         "updatedAt": number
      }
   ],
   "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

The output lists the specified applications.

Type: Array of ApplicationSummary objects

nextToken

The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.

Type: String

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

Pattern: [A-Za-z0-9_=-]+

Errors

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

InternalServerException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

ValidationException

The input fails to satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400