describeComputeEnvironments method

Future<DescribeComputeEnvironmentsResponse> describeComputeEnvironments({ List<String>? computeEnvironments, int? maxResults, String? nextToken, })

Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

May throw ClientException. May throw ServerException.

Parameter computeEnvironments : A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

Parameter maxResults : The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Parameter nextToken : The nextToken value returned from a previous paginated DescribeComputeEnvironments 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. This value is null when there are no more results to return.

Implementation

Future<DescribeComputeEnvironmentsResponse> describeComputeEnvironments({
  List<String>? computeEnvironments,
  int? maxResults,
  String? nextToken,
}) async {
  final $payload = <String, dynamic>{
    if (computeEnvironments != null)
      'computeEnvironments': computeEnvironments,
    if (maxResults != null) 'maxResults': maxResults,
    if (nextToken != null) 'nextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v1/describecomputeenvironments',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeComputeEnvironmentsResponse.fromJson(response);
}