QBusiness / Client / create_retriever

create_retriever#

QBusiness.Client.create_retriever(**kwargs)#

Adds a retriever to your Amazon Q application.

See also: AWS API Documentation

Request Syntax

response = client.create_retriever(
    applicationId='string',
    clientToken='string',
    configuration={
        'kendraIndexConfiguration': {
            'indexId': 'string'
        },
        'nativeIndexConfiguration': {
            'indexId': 'string'
        }
    },
    displayName='string',
    roleArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    type='NATIVE_INDEX'|'KENDRA_INDEX'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of your Amazon Q application.

  • clientToken (string) –

    A token that you provide to identify the request to create your Amazon Q application retriever.

    This field is autopopulated if not provided.

  • configuration (dict) –

    [REQUIRED]

    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 can be set: kendraIndexConfiguration, nativeIndexConfiguration.

    • kendraIndexConfiguration (dict) –

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

      • indexId (string) – [REQUIRED]

        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) – [REQUIRED]

        The identifier for the Amazon Q index.

  • displayName (string) –

    [REQUIRED]

    The name of your retriever.

  • roleArn (string) – The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.

  • tags (list) –

    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • (dict) –

      A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      • key (string) – [REQUIRED]

        The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.

      • value (string) – [REQUIRED]

        The value associated with the tag. The value may be an empty string but it can’t be null.

  • type (string) –

    [REQUIRED]

    The type of retriever you are using.

Return type:

dict

Returns:

Response Syntax

{
    'retrieverArn': 'string',
    'retrieverId': 'string'
}

Response Structure

  • (dict) –

    • retrieverArn (string) –

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

    • retrieverId (string) –

      The identifier of the retriever you are using.

Exceptions

  • QBusiness.Client.exceptions.ResourceNotFoundException

  • QBusiness.Client.exceptions.InternalServerException

  • QBusiness.Client.exceptions.ConflictException

  • QBusiness.Client.exceptions.ThrottlingException

  • QBusiness.Client.exceptions.ValidationException

  • QBusiness.Client.exceptions.AccessDeniedException

  • QBusiness.Client.exceptions.ServiceQuotaExceededException