listRetrievers method

Future<ListRetrieversResponse> listRetrievers({
  1. required String applicationId,
  2. int? maxResults,
  3. String? nextToken,
})

Lists the retriever used by an Amazon Q Business application.

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

Parameter applicationId : The identifier of the Amazon Q Business application using the retriever.

Parameter maxResults : The maximum number of retrievers returned.

Parameter nextToken : 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.

Implementation

Future<ListRetrieversResponse> listRetrievers({
  required String applicationId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/applications/${Uri.encodeComponent(applicationId)}/retrievers',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListRetrieversResponse.fromJson(response);
}