OpenSearchService / Paginator / ListApplications

ListApplications¶

class OpenSearchService.Paginator.ListApplications¶

paginator = client.get_paginator('list_applications')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from OpenSearchService.Client.list_applications().

Request Syntax

response_iterator = paginator.paginate(
    statuses=[
        'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

statuses (list) –
Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
- (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –
  
  A token to resume pagination.