:doc:`AppConfig <../../appconfig>` / Client / delete_environment

******************
delete_environment
******************



.. py:method:: AppConfig.Client.delete_environment(**kwargs)

  

  Deletes an environment.

   

  To prevent users from unintentionally deleting actively-used environments, enable `deletion protection <https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteEnvironment>`_  


  **Request Syntax**
  ::

    response = client.delete_environment(
        EnvironmentId='string',
        ApplicationId='string',
        DeletionProtectionCheck='ACCOUNT_DEFAULT'|'APPLY'|'BYPASS'
    )
    
  :type EnvironmentId: string
  :param EnvironmentId: **[REQUIRED]** 

    The ID of the environment that you want to delete.

    

  
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

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

    

  
  :type DeletionProtectionCheck: string
  :param DeletionProtectionCheck: 

    A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either `GetLatestConfiguration <https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html>`__ 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**
  
  *   :py:class:`AppConfig.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`AppConfig.Client.exceptions.ConflictException`

  
  *   :py:class:`AppConfig.Client.exceptions.InternalServerException`

  
  *   :py:class:`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': {
            '...': '...',
        },
    }

  