retrievers

Creates, updates, deletes, gets or lists a retrievers resource.

Overview

Name	retrievers
Type	Resource
Id	aws.qbusiness.retrievers

Fields

The following fields are returned by SELECT queries:

get_retriever

Name	Datatype	Description
application_id	string	The identifier of the Amazon Q Business application using the retriever. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
configuration	object	Provides information on how the retriever used for your Amazon Q Business application is configured.
created_at	string (date-time)	The Unix timestamp when the retriever was created.
display_name	string	The name of the retriever. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
retriever_arn	string	The Amazon Resource Name (ARN) of the IAM role associated with the retriever. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
retriever_id	string	The identifier of the retriever. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
role_arn	string	The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
status	string	The status of the retriever. (CREATING, ACTIVE, FAILED)
type_	string	The type of the retriever. (NATIVE_INDEX, KENDRA_INDEX)
updated_at	string (date-time)	The Unix timestamp when the retriever was last updated.

list_retrievers

Name	Datatype	Description
application_id	string	The identifier of the Amazon Q Business application using the retriever. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
display_name	string	The name of your retriever. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
retriever_id	string	The identifier of the retriever used by your Amazon Q Business application. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
status	string	The status of your retriever. (CREATING, ACTIVE, FAILED)
type_	string	The type of your retriever. (NATIVE_INDEX, KENDRA_INDEX)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_retriever	select	application_id, retriever_id, region		Gets information about an existing retriever used by an Amazon Q Business application.
list_retrievers	select	application_id, region	nextToken, maxResults	Lists the retriever used by an Amazon Q Business application.
create_retriever	insert	application_id, region, type, displayName, configuration		Adds a retriever to your Amazon Q Business application.
update_retriever	update	application_id, retriever_id, region		Updates the retriever used for your Amazon Q Business application.
delete_retriever	delete	application_id, retriever_id, region		Deletes the retriever used by an Amazon Q Business application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The identifier of the Amazon Q Business application using the retriever.
region	string	AWS region (default: us-east-1)
retriever_id	string	The identifier of the retriever being deleted.
maxResults	integer	The maximum number of retrievers returned.
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.

SELECT examples

get_retriever

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

SELECT
application_id,
configuration,
created_at,
display_name,
retriever_arn,
retriever_id,
role_arn,
status,
type_,
updated_at
FROM aws.qbusiness.retrievers
WHERE application_id = '{{ application_id }}' -- required
AND retriever_id = '{{ retriever_id }}' -- required
AND region = '{{ region }}' -- required
;

list_retrievers

Lists the retriever used by an Amazon Q Business application.

SELECT
application_id,
display_name,
retriever_id,
status,
type_
FROM aws.qbusiness.retrievers
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_retriever

Adds a retriever to your Amazon Q Business application.

INSERT INTO aws.qbusiness.retrievers (
type,
displayName,
configuration,
roleArn,
clientToken,
tags,
application_id,
region
)
SELECT 
'{{ type }}' /* required */,
'{{ displayName }}' /* required */,
'{{ configuration }}' /* required */,
'{{ roleArn }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
retriever_arn,
retriever_id
;

Manifest

# Description fields are for documentation purposes
- name: retrievers
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the retrievers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the retrievers resource.
  - name: type
    value: "{{ type }}"
    valid_values: ['NATIVE_INDEX', 'KENDRA_INDEX']
  - name: displayName
    value: "{{ displayName }}"
  - name: configuration
    description: |
      Provides information on how the retriever used for your Amazon Q Business application is configured.
    value:
      nativeIndexConfiguration:
        indexId: "{{ indexId }}"
        version: {{ version }}
        boostingOverride: "{{ boostingOverride }}"
      kendraIndexConfiguration:
        indexId: "{{ indexId }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_retriever

Updates the retriever used for your Amazon Q Business application.

UPDATE aws.qbusiness.retrievers
SET 
configuration = '{{ configuration }}',
displayName = '{{ displayName }}',
roleArn = '{{ roleArn }}'
WHERE 
application_id = '{{ application_id }}' --required
AND retriever_id = '{{ retriever_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_retriever

Deletes the retriever used by an Amazon Q Business application.

DELETE FROM aws.qbusiness.retrievers
WHERE application_id = '{{ application_id }}' --required
AND retriever_id = '{{ retriever_id }}' --required
AND region = '{{ region }}' --required
;