getBackend method

Future<GetBackendResponse> getBackend({
  1. required String appId,
  2. String? backendEnvironmentName,
})

Provides project-level details for your Amplify UI project.

May throw BadRequestException. May throw GatewayTimeoutException. May throw NotFoundException. May throw TooManyRequestsException.

Parameter appId : The app ID.

Parameter backendEnvironmentName : The name of the backend environment.

Implementation

Future<GetBackendResponse> getBackend({
  required String appId,
  String? backendEnvironmentName,
}) async {
  final $payload = <String, dynamic>{
    if (backendEnvironmentName != null)
      'backendEnvironmentName': backendEnvironmentName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/backend/${Uri.encodeComponent(appId)}/details',
    exceptionFnMap: _exceptionFns,
  );
  return GetBackendResponse.fromJson(response);
}