Amplify / Client / delete_backend_environment

delete_backend_environment#

Amplify.Client.delete_backend_environment(**kwargs)#

Deletes a backend environment for an Amplify app.

Request Syntax

response = client.delete_backend_environment(
    appId='string',
    environmentName='string'
)

Parameters:

appId (string) –
[REQUIRED]

The unique ID of an Amplify app.
environmentName (string) –
[REQUIRED]

The name of a backend environment of an Amplify app.

Return type:

dict

Returns:

Response Syntax

{
    'backendEnvironment': {
        'backendEnvironmentArn': 'string',
        'environmentName': 'string',
        'stackName': 'string',
        'deploymentArtifacts': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –

The result structure of the delete backend environment result.
- backendEnvironment (dict) –
  
  Describes the backend environment for an Amplify app.
  - backendEnvironmentArn (string) –
    
    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
  - environmentName (string) –
    
    The name for a backend environment that is part of an Amplify app.
  - stackName (string) –
    
    The AWS CloudFormation stack name of a backend environment.
  - deploymentArtifacts (string) –
    
    The name of deployment artifacts.
  - createTime (datetime) –
    
    The creation date and time for a backend environment that is part of an Amplify app.
  - updateTime (datetime) –
    
    The last updated date and time for a backend environment that is part of an Amplify app.

Exceptions

Amplify.Client.exceptions.BadRequestException
Amplify.Client.exceptions.UnauthorizedException
Amplify.Client.exceptions.NotFoundException
Amplify.Client.exceptions.InternalFailureException
Amplify.Client.exceptions.DependentServiceFailureException