updateRetriever method

Future<void> updateRetriever({
  1. required String applicationId,
  2. required String retrieverId,
  3. RetrieverConfiguration? configuration,
  4. String? displayName,
  5. String? roleArn,
})

Updates the retriever used for your Amazon Q Business application.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ServiceQuotaExceededException. May throw ThrottlingException. May throw ValidationException.

Parameter applicationId : The identifier of your Amazon Q Business application.

Parameter retrieverId : The identifier of your retriever.

Parameter displayName : The name of your retriever.

Parameter roleArn : The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

Implementation

Future<void> updateRetriever({
  required String applicationId,
  required String retrieverId,
  RetrieverConfiguration? configuration,
  String? displayName,
  String? roleArn,
}) async {
  final $payload = <String, dynamic>{
    if (configuration != null) 'configuration': configuration,
    if (displayName != null) 'displayName': displayName,
    if (roleArn != null) 'roleArn': roleArn,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/applications/${Uri.encodeComponent(applicationId)}/retrievers/${Uri.encodeComponent(retrieverId)}',
    exceptionFnMap: _exceptionFns,
  );
}