listBackendEnvironments method

Future<ListBackendEnvironmentsResult> listBackendEnvironments({ required String appId, String? environmentName, int? maxResults, String? nextToken, })

Lists the backend environments for an Amplify app.

May throw BadRequestException. May throw UnauthorizedException. May throw InternalFailureException.

Parameter appId : The unique ID for an Amplify app.

Parameter environmentName : The name of the backend environment

Parameter maxResults : The maximum number of records to list in a single response.

Parameter nextToken : A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

Implementation

Future<ListBackendEnvironmentsResult> listBackendEnvironments({
  required String appId,
  String? environmentName,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(appId, 'appId');
  _s.validateStringLength(
    'appId',
    appId,
    1,
    20,
    isRequired: true,
  );
  _s.validateStringLength(
    'environmentName',
    environmentName,
    1,
    255,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    0,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    2000,
  );
  final $query = <String, List<String>>{
    if (environmentName != null) 'environmentName': [environmentName],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/apps/${Uri.encodeComponent(appId)}/backendenvironments',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListBackendEnvironmentsResult.fromJson(response);
}