OpenSearchService / Client / list_applications

list_applications

OpenSearchService.Client.list_applications(**kwargs)

Lists all OpenSearch applications under your account.

See also: AWS API Documentation

Request Syntax

response = client.list_applications(
    nextToken='string',
    statuses=[
        'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    ],
    maxResults=123
)
Parameters:

  • nextToken (string) – 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 (list) –

    Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

    • (string) –

  • maxResults (integer) – An optional parameter that specifies the maximum number of results to return for a given request.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'endpoint': 'string',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • ApplicationSummaries (list) –

      Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time.

      • (dict) –

        Basic details of an OpenSearch application.

        • id (string) –

          The unique identifier of an OpenSearch application.

        • arn (string) –

          The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

        • name (string) –

          The name of an OpenSearch application.

        • endpoint (string) –

          The endpoint URL of an OpenSearch application.

        • status (string) –

          The current status of an OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

        • createdAt (datetime) –

          The timestamp when an OpenSearch application was created.

        • lastUpdatedAt (datetime) –

          The timestamp of the last update to an OpenSearch application.

    • nextToken (string) –

      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.

Exceptions