delete_environment

delete_environment(**kwargs)

Deletes an environment. Deleting an environment does not delete a configuration from a host.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment(
    ApplicationId='string',
    EnvironmentId='string'
)
Parameters
  • ApplicationId (string) --

    [REQUIRED]

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

  • EnvironmentId (string) --

    [REQUIRED]

    The ID of the environment that you want to delete.

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': {
        '...': '...',
    },
}