Skip to content

DeregisterImageRequest

Source code in docs_src/capo_ec2/types/deregister_image_request.py
class DeregisterImageRequest(TypedDict, closed=True):
    image_id: NotRequired["capo_ec2.types.image_id.ImageId"]
    """<p>The ID of the AMI.</p>"""
    delete_associated_snapshots: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Specifies whether to delete the snapshots associated with the AMI during deregistration.</p> <note> <p>If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting.</p> </note> <p>Default: The snapshots are not deleted.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<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>"""

delete_associated_snapshots instance-attribute

delete_associated_snapshots: NotRequired[Boolean]

Specifies whether to delete the snapshots associated with the AMI during deregistration.

If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting.

Default: The snapshots are not deleted.

dry_run instance-attribute

dry_run: NotRequired[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.

image_id instance-attribute

image_id: NotRequired[ImageId]

The ID of the AMI.