AppConfig / Client / delete_environment

delete_environment#

AppConfig.Client.delete_environment(**kwargs)#

Deletes an environment.

To prevent users from unintentionally deleting actively-used environments, enable deletion protection.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment(
    EnvironmentId='string',
    ApplicationId='string',
    DeletionProtectionCheck='ACCOUNT_DEFAULT'|'APPLY'|'BYPASS'
)
Parameters:

  • EnvironmentId (string) –

    [REQUIRED]

    The ID of the environment that you want to delete.

  • ApplicationId (string) –

    [REQUIRED]

    The application ID that includes the environment that you want to delete.

  • DeletionProtectionCheck (string) –

    A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.

    This parameter supports the following values:

    • BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.

    • APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.

    • ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.

Returns:

None

Exceptions

  • AppConfig.Client.exceptions.ResourceNotFoundException

  • AppConfig.Client.exceptions.ConflictException

  • AppConfig.Client.exceptions.InternalServerException

  • AppConfig.Client.exceptions.BadRequestException

Examples

The following delete-environment example deletes the specified application environment.

response = client.delete_environment(
    ApplicationId='339ohji',
    EnvironmentId='54j1r29',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}