QBusiness / Paginator / ListIndices

ListIndices

class QBusiness.Paginator.ListIndices

paginator = client.get_paginator('list_indices')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QBusiness.Client.list_indices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of the Amazon Q application connected to the index.

• 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

{
    'indices': [
        {
            'createdAt': datetime(2015, 1, 1),
            'displayName': 'string',
            'indexId': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • indices (list) –

    An array of information on the items in one or more indexes.

    • (dict) –

      Summary information for your Amazon Q index.

      • createdAt (datetime) –

        The Unix timestamp when the index was created.

      • displayName (string) –

        The name of the index.

      • indexId (string) –

        The identifier for the index.

      • status (string) –

        The current status of the index. When the status is ACTIVE, the index is ready.

      • updatedAt (datetime) –

        The Unix timestamp when the index was last updated.

  • NextToken (string) –

    A token to resume pagination.