QBusiness / Client / list_retrievers

list_retrievers#

QBusiness.Client.list_retrievers(**kwargs)#

Lists the retriever used by an Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

response = client.list_retrievers(
    applicationId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business application using the retriever.

  • nextToken (string) – If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

  • maxResults (integer) – The maximum number of retrievers returned.

Return type:

dict

Returns:

Response Syntax

{
    'retrievers': [
        {
            'applicationId': 'string',
            'retrieverId': 'string',
            'type': 'NATIVE_INDEX'|'KENDRA_INDEX',
            'status': 'CREATING'|'ACTIVE'|'FAILED',
            'displayName': 'string'
        },
    ],
    '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 Business application.

        • applicationId (string) –

          The identifier of the Amazon Q Business application using the retriever.

        • retrieverId (string) –

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

        • type (string) –

          The type of your retriever.

        • status (string) –

          The status of your retriever.

        • displayName (string) –

          The name of your retriever.

    • nextToken (string) –

      If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.

Exceptions