Skip to content

EC2  >  Operations  >  enable_image_deregistration_protection

enable_image_deregistration_protection

Operation

enable_image_deregistration_protection async

enable_image_deregistration_protection(request: EnableImageDeregistrationProtectionInput | EnableImageDeregistrationProtectionInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableImageDeregistrationProtectionOutput
enable_image_deregistration_protection(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableImageDeregistrationProtectionInputDict]) -> EnableImageDeregistrationProtectionOutput

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.

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
EnableImageDeregistrationProtectionOutput

An instance of EnableImageDeregistrationProtectionOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

EnableImageDeregistrationProtectionInput dataclass

Bases: _SerdeShape

Dataclass for EnableImageDeregistrationProtectionInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

image_id class-attribute instance-attribute
image_id: str | None = ...

The ID of the AMI.

with_cooldown class-attribute instance-attribute
with_cooldown: bool | None = ...

If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.

Dictionaries

EnableImageDeregistrationProtectionInputDict

Bases: TypedDict

Dictionary form of EnableImageDeregistrationProtectionInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

image_id instance-attribute
image_id: Required[str]

The ID of the AMI.

with_cooldown instance-attribute
with_cooldown: bool | None

If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.

Output

EnableImageDeregistrationProtectionOutput dataclass

Bases: _SerdeShape

Dataclass for EnableImageDeregistrationProtectionOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_ class-attribute instance-attribute
return_: str | None = ...

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