listEnvironments method

Future<Environments> listEnvironments({ required String applicationId, int? maxResults, String? nextToken, })

List the environments for an application.

May throw ResourceNotFoundException. May throw InternalServerException. May throw BadRequestException.

Parameter applicationId : The application ID.

Parameter maxResults : The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameter nextToken : A token to start the list. Use this token to get the next set of results.

Implementation

Future<Environments> listEnvironments({
  required String applicationId,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(applicationId, 'applicationId');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    2048,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'max_results': [maxResults.toString()],
    if (nextToken != null) 'next_token': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/applications/${Uri.encodeComponent(applicationId)}/environments',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return Environments.fromJson(response);
}