listIndices method

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

Lists the Amazon Q Business indices you have created.

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 connected to the index.

Parameter maxResults : The maximum number of indices to return.

Parameter nextToken : If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.

Implementation

Future<ListIndicesResponse> listIndices({
  required String applicationId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  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)}/indices',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListIndicesResponse.fromJson(response);
}