QBusiness / Client / get_retriever

get_retriever

QBusiness.Client.get_retriever(**kwargs)

Gets information about an existing retriever used by an Amazon Q application.

See also: AWS API Documentation

Request Syntax

response = client.get_retriever(
    applicationId='string',
    retrieverId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of the Amazon Q application using the retriever.

• retrieverId (string) –

  [REQUIRED]

  The identifier of the retriever.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'configuration': {
        'kendraIndexConfiguration': {
            'indexId': 'string'
        },
        'nativeIndexConfiguration': {
            'indexId': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'displayName': 'string',
    'retrieverArn': 'string',
    'retrieverId': 'string',
    'roleArn': 'string',
    'status': 'CREATING'|'ACTIVE'|'FAILED',
    'type': 'NATIVE_INDEX'|'KENDRA_INDEX',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • applicationId (string) –

    The identifier of the Amazon Q application using the retriever.

  • configuration (dict) –

    Provides information on how the retriever used for your Amazon Q application is configured.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: kendraIndexConfiguration, nativeIndexConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • kendraIndexConfiguration (dict) –

      Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

      • indexId (string) –

        The identifier of the Amazon Kendra index.

    • nativeIndexConfiguration (dict) –

      Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

      • indexId (string) –

        The identifier for the Amazon Q index.

  • createdAt (datetime) –

    The Unix timestamp when the retriever was created.

  • displayName (string) –

    The name of the retriever.

  • retrieverArn (string) –

    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

  • retrieverId (string) –

    The identifier of the retriever.

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

  • status (string) –

    The status of the retriever.

  • type (string) –

    The type of the retriever.

  • updatedAt (datetime) –

    The Unix timestamp when the retriever was last updated.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException