listEndpoints method

Future<ListEndpointsResponse> listEndpoints({ EndpointFilter? filter, int? maxResults, String? nextToken, })

Gets a list of all existing endpoints that you've created.

May throw InvalidRequestException. May throw TooManyRequestsException. May throw InternalServerException.

Parameter filter : Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

Parameter maxResults : The maximum number of results to return in each page. The default is 100.

Parameter nextToken : Identifies the next page of results to return.

Implementation

Future<ListEndpointsResponse> listEndpoints({
  EndpointFilter? filter,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    500,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Comprehend_20171127.ListEndpoints'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filter != null) 'Filter': filter,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return ListEndpointsResponse.fromJson(jsonResponse.body);
}