# Backend appId Api backendEnvironmentName Remove The data model from your Amplify project. ## URI `/prod/backend/appId/api/backendEnvironmentName/remove` ## HTTP methods ### POST **Operation ID:** `DeleteBackendAPI` Deletes an existing backend API resource. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | appId | String | True | The app ID. | | backendEnvironmentName | String | True | The name of the backend environment. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | BackendAPIRespObj | 200 response | | 400 | BadRequestException | 400 response | | 404 | NotFoundException | 404 response | | 429 | LimitExceededException | 429 response | | 504 | InternalServiceException | 504 response | ### OPTIONS Enables CORS by returning the correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | appId | String | True | The app ID. | | backendEnvironmentName | String | True | The name of the backend environment. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | 200 response | ## Schemas ### Request bodies #### POST schema POST ``` { "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } } ], "conflictResolution": { "resolutionStrategy": enum } }, "resourceName": "string" } ``` ### Response bodies #### BackendAPIRespObj schema BackendAPIRespObj ``` { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } ``` #### BadRequestException schema BadRequestException ``` { "message": "string" } ``` #### NotFoundException schema NotFoundException ``` { "message": "string", "resourceType": "string" } ``` #### LimitExceededException schema LimitExceededException ``` { "message": "string", "limitType": "string" } ``` #### InternalServiceException schema InternalServiceException ``` { "message": "string" } ``` ## Properties ### BackendAPIAppSyncAuthSettings The authentication settings for accessing provisioned data models in your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | cognitoUserPoolId | string | False | The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. | | description | string | False | The API key description for `API_KEY`, if it was used as an authentication mechanism to access your data models. | | expirationTime | number | False | The API key expiration time for `API_KEY`, if it was used as an authentication mechanism to access your data models. | | openIDAuthTTL | string | False | The expiry time for the `OpenID` authentication mechanism. | | openIDClientId | string | False | The `clientID` for `openID`, if `openID` was used as an authentication setting to access your data models. | | openIDIatTTL | string | False | The expiry time for the `OpenID` authentication mechanism. | | openIDIssueURL | string | False | The `openID` issuer URL, if `openID` was used as an authentication setting to access your data models. | | openIDProviderName | string | False | The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. | ### BackendAPIAuthType Describes the auth types for your configured data models. | Property | Type | Required | Description | | --- |--- |--- |--- | | mode | stringValues: `API_KEY \| AWS_IAM \| AMAZON_COGNITO_USER_POOLS \| OPENID_CONNECT` | False | Describes the authentication mode. | | settings | [BackendAPIAppSyncAuthSettings](#backend-appid-api-backendenvironmentname-remove-model-backendapiappsyncauthsettings) | False | Describes settings for the authentication mode. | ### BackendAPIConflictResolution Describes the conflict resolution configuration for your data model configured in your Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | resolutionStrategy | stringValues: `OPTIMISTIC_CONCURRENCY \| LAMBDA \| AUTOMERGE \| NONE` | False | The strategy for conflict resolution. | ### BackendAPIReqObj The request object for this operation. | Property | Type | Required | Description | | --- |--- |--- |--- | | resourceConfig | [BackendAPIResourceConfig](#backend-appid-api-backendenvironmentname-remove-model-backendapiresourceconfig) | False | Defines the resource configuration for the data model in your Amplify project. | | resourceName | string | True | The name of this resource. | ### BackendAPIResourceConfig The resource config for the data model, configured as a part of the Amplify project. | Property | Type | Required | Description | | --- |--- |--- |--- | | additionalAuthTypes | Array of type [BackendAPIAuthType](#backend-appid-api-backendenvironmentname-remove-model-backendapiauthtype) | False | Additional authentication methods used to interact with your data models. | | apiName | string | False | The API name used to interact with the data model, configured as a part of your Amplify project. | | conflictResolution | [BackendAPIConflictResolution](#backend-appid-api-backendenvironmentname-remove-model-backendapiconflictresolution) | False | The conflict resolution strategy for your data stored in the data models. | | defaultAuthType | [BackendAPIAuthType](#backend-appid-api-backendenvironmentname-remove-model-backendapiauthtype) | False | The default authentication type for interacting with the configured data models in your Amplify project. | | service | string | False | The service used to provision and interact with the data model. | | transformSchema | string | False | The definition of the data model in the annotated transform of the GraphQL schema. | ### BackendAPIRespObj The response object sent when a backend is created. | Property | Type | Required | Description | | --- |--- |--- |--- | | appId | string | True | The app ID. | | backendEnvironmentName | string | True | The name of the backend environment. | | error | string | False | If the request fails, this error is returned. | | jobId | string | False | The ID for the job. | | operation | string | False | The name of the operation. | | status | string | False | The current status of the request. | ### BadRequestException An error returned if a request is not formed properly. | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | An error message to inform that the request failed. | ### InternalServiceException An error returned if there's a temporary issue with the service. | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | An error message to inform that the request failed. | ### LimitExceededException An error that is returned when a limit of a specific type has been exceeded. | Property | Type | Required | Description | | --- |--- |--- |--- | | limitType | string | False | The type of limit that was exceeded. | | message | string | False | An error message to inform that the request has failed. | ### NotFoundException An error returned when a specific resource type is not found. | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | An error message to inform that the request has failed. | | resourceType | string | False | The type of resource that is not found. | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### DeleteBackendAPI + [AWS Command Line Interface V2](/goto/cli2/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for Go v2](/goto/SdkForGoV2/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for Java V2](/goto/SdkForJavaV2/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for Kotlin](/goto/SdkForKotlin/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for Python](/goto/boto3/amplifybackend-2020-08-11/DeleteBackendAPI) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/amplifybackend-2020-08-11/DeleteBackendAPI)