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

ListApplications

List all OpenSearch Applications under your account.

Request Syntax


GET /2021-01-01/opensearch/list-applications?maxResults=maxResults&nextToken=nextToken&statuses=statuses HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

An optional parameter that specifies the maximum number of results to return for a given request.

Valid Range: Maximum value of 100.

nextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

statuses

OpenSearch Application Status can be used as filters for the listing request. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

Valid Values: CREATING | UPDATING | DELETING | ACTIVE | FAILED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationSummaries": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "endpoint": "string",
         "id": "string",
         "lastUpdatedAt": number,
         "name": "string",
         "status": "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.

ApplicationSummaries

Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.

Type: Array of ApplicationSummary objects

nextToken

Type: String

Errors

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

AccessDeniedException

An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400