EC2 / Client / enable_image_deregistration_protection

enable_image_deregistration_protection#

EC2.Client.enable_image_deregistration_protection(**kwargs)#

Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can’t be deregistered.

To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.

For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.enable_image_deregistration_protection(
    ImageId='string',
    WithCooldown=True|False,
    DryRun=True|False
)
Parameters:
  • ImageId (string) –

    [REQUIRED]

    The ID of the AMI.

  • WithCooldown (boolean) – If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'Return': 'string'
}

Response Structure

  • (dict) –

    • Return (string) –

      Returns true if the request succeeds; otherwise, it returns an error.