AmplifyBackend / Client / delete_backend

delete_backend#

AmplifyBackend.Client.delete_backend(**kwargs)#

Removes an existing environment from your Amplify project.

Request Syntax

response = client.delete_backend(
    AppId='string',
    BackendEnvironmentName='string'
)

Parameters:

AppId (string) –
[REQUIRED]

The app ID.
BackendEnvironmentName (string) –
[REQUIRED]

The name of the backend environment.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'BackendEnvironmentName': 'string',
    'Error': 'string',
    'JobId': 'string',
    'Operation': 'string',
    'Status': 'string'
}

Response Structure

(dict) –

200 response
- AppId (string) –
  
  The app ID.
- BackendEnvironmentName (string) –
  
  The name of the backend environment.
- Error (string) –
  
  If the request fails, this error is returned.
- JobId (string) –
  
  The ID for the job.
- Operation (string) –
  
  The name of the operation.
- Status (string) –
  
  The current status of the request.

Exceptions

AmplifyBackend.Client.exceptions.NotFoundException
AmplifyBackend.Client.exceptions.GatewayTimeoutException
AmplifyBackend.Client.exceptions.TooManyRequestsException
AmplifyBackend.Client.exceptions.BadRequestException