listBots method

Future<ListBotsResponse> listBots({ required String instanceId, required LexVersion lexVersion, int? maxResults, String? nextToken, })

This API is in preview release for Connect Customer and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

May throw InternalServiceException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter instanceId : The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameter lexVersion : The version of Amazon Lex or Amazon Lex V2.

Parameter maxResults : The maximum number of results to return per page.

Parameter nextToken : The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Implementation

Future<ListBotsResponse> listBots({
  required String instanceId,
  required LexVersion lexVersion,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    25,
  );
  final $query = <String, List<String>>{
    'lexVersion': [lexVersion.value],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/instance/${Uri.encodeComponent(instanceId)}/bots',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListBotsResponse.fromJson(response);
}