AWS API Changes

2024/08/28 - Amazon AppConfig - 2 new2 updated api methods

Changes This release adds support for deletion protection, which is a safety guardrail to prevent the unintentional deletion of a recently used AWS AppConfig Configuration Profile or Environment. This also includes a change to increase the maximum length of the Name parameter in UpdateConfigurationProfile.

UpdateAccountSettings (new)

Link ¶

Updates the value of the DeletionProtection parameter.

See also: AWS API Documentation

Request Syntax

client.update_account_settings(
    DeletionProtection={
        'Enabled': True|False,
        'ProtectionPeriodInMinutes': 123
    }
)

type DeletionProtection:

dict

param DeletionProtection:

A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.

Enabled (boolean) --

A parameter that indicates if deletion protection is enabled or not.
ProtectionPeriodInMinutes (integer) --

The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .

rtype:

dict

returns:

Response Syntax

{
    'DeletionProtection': {
        'Enabled': True|False,
        'ProtectionPeriodInMinutes': 123
    }
}

Response Structure

(dict) --
- DeletionProtection (dict) --
  
  A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.
  - Enabled (boolean) --
    
    A parameter that indicates if deletion protection is enabled or not.
  - ProtectionPeriodInMinutes (integer) --
    
    The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .

GetAccountSettings (new)

Link ¶

Returns information about the status of the DeletionProtection parameter.

See also: AWS API Documentation

Request Syntax

client.get_account_settings()

rtype:

dict

returns:

Response Syntax

{
    'DeletionProtection': {
        'Enabled': True|False,
        'ProtectionPeriodInMinutes': 123
    }
}

Response Structure

(dict) --
- DeletionProtection (dict) --
  
  A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.
  - Enabled (boolean) --
    
    A parameter that indicates if deletion protection is enabled or not.
  - ProtectionPeriodInMinutes (integer) --
    
    The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .

DeleteConfigurationProfile (updated)

Link ¶
Changes (request)

{'DeletionProtectionCheck': 'ACCOUNT_DEFAULT | APPLY | BYPASS'}

Deletes a configuration profile.

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

See also: AWS API Documentation

Request Syntax

client.delete_configuration_profile(
    ApplicationId='string',
    ConfigurationProfileId='string',
    DeletionProtectionCheck='ACCOUNT_DEFAULT'|'APPLY'|'BYPASS'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The application ID that includes the configuration profile you want to delete.

type ConfigurationProfileId:

string

param ConfigurationProfileId:

[REQUIRED]

The ID of the configuration profile you want to delete.

type DeletionProtectionCheck:

string

param DeletionProtectionCheck:

A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile 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

DeleteEnvironment (updated)

Link ¶
Changes (request)

{'DeletionProtectionCheck': 'ACCOUNT_DEFAULT | APPLY | BYPASS'}

Deletes an environment.

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

See also: AWS API Documentation

Request Syntax

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. 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