enable_image_deregistration_protection `async` ¶

enable_image_deregistration_protection(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    image_id: Optional[ImageId] = None,
    with_cooldown: Optional[Boolean] = None,
    dry_run: Optional[Boolean] = None,
) -> EnableImageDeregistrationProtectionResult

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:

image_id (Optional[ImageId], default: None ) –

The ID of the AMI.
with_cooldown (Optional[Boolean], default: None ) –

If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def enable_image_deregistration_protection(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    image_id: Optional["capo_ec2.types.image_id.ImageId"] = None,
    with_cooldown: Optional["capo_ec2.types.boolean.Boolean"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.enable_image_deregistration_protection_result.EnableImageDeregistrationProtectionResult":
    """<p>Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.</p> <p>To allow the AMI to be deregistered, you must first disable deregistration protection.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html">Protect an Amazon EC2 AMI from deregistration</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        image_id: <p>The ID of the AMI.</p>
        with_cooldown: <p>If <code>true</code>, enforces deregistration protection for 24 hours after deregistration protection is disabled.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.enable_image_deregistration_protection_request.EnableImageDeregistrationProtectionRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.enable_image_deregistration_protection_result.EnableImageDeregistrationProtectionResult"
    ]:
        import capo_ec2._operations.amazon_ec2.enable_image_deregistration_protection

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.enable_image_deregistration_protection.async_enable_image_deregistration_protection(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableImageDeregistrationProtection")
    )
    input_: capo_ec2.types.enable_image_deregistration_protection_request.EnableImageDeregistrationProtectionRequest = {}
    if image_id is not None:
        input_["image_id"] = image_id
    if with_cooldown is not None:
        input_["with_cooldown"] = with_cooldown
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

enable_image_deregistration_protection async ¶

enable_image_deregistration_protection `async` ¶