QBusiness / Client / update_retriever
update_retriever#
- QBusiness.Client.update_retriever(**kwargs)#
Updates the retriever used for your Amazon Q application.
See also: AWS API Documentation
Request Syntax
response = client.update_retriever( applicationId='string', configuration={ 'kendraIndexConfiguration': { 'indexId': 'string' }, 'nativeIndexConfiguration': { 'indexId': 'string' } }, displayName='string', retrieverId='string', roleArn='string' )
- Parameters:
applicationId (string) –
[REQUIRED]
The identifier of your Amazon Q application.
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 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) – The name of your retriever.
retrieverId (string) –
[REQUIRED]
The identifier of your retriever.
roleArn (string) – The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
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