QBusiness / Paginator / ListRetrievers

ListRetrievers

class QBusiness.Paginator.ListRetrievers

paginator = client.get_paginator('list_retrievers')

paginate(**kwargs)

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

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 using the retriever.

• 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

{
    'retrievers': [
        {
            'applicationId': 'string',
            'displayName': 'string',
            'retrieverId': 'string',
            'status': 'CREATING'|'ACTIVE'|'FAILED',
            'type': 'NATIVE_INDEX'|'KENDRA_INDEX'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • retrievers (list) –

    An array of summary information for one or more retrievers.

    • (dict) –

      Summary information for the retriever used for your Amazon Q application.

      • applicationId (string) –

        The identifier of the Amazon Q application using the retriever.

      • displayName (string) –

        The name of your retriever.

      • retrieverId (string) –

        The identifier of the retriever used by your Amazon Q application.

      • status (string) –

        The status of your retriever.

      • type (string) –

        The type of your retriever.

  • NextToken (string) –

    A token to resume pagination.