listFargateProfiles method

Future<ListFargateProfilesResponse> listFargateProfiles({ required String clusterName, int? maxResults, String? nextToken, })

Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.

May throw InvalidParameterException. May throw ResourceNotFoundException. May throw ClientException. May throw ServerException.

Parameter clusterName : The name of the Amazon EKS cluster that you would like to listFargate profiles in.

Parameter maxResults : The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

Parameter nextToken : The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Implementation

Future<ListFargateProfilesResponse> listFargateProfiles({
  required String clusterName,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(clusterName, 'clusterName');
  _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:
        '/clusters/${Uri.encodeComponent(clusterName)}/fargate-profiles',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListFargateProfilesResponse.fromJson(response);
}