deleteBackendAPI method

Future<DeleteBackendAPIResponse> deleteBackendAPI({
  1. required String appId,
  2. required String backendEnvironmentName,
  3. required String resourceName,
  4. BackendAPIResourceConfig? resourceConfig,
})

Deletes an existing backend API resource.

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.

Parameter resourceName : The name of this resource.

Parameter resourceConfig : Defines the resource configuration for the data model in your Amplify project.

Implementation

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