deregister_image¶
Operation¶
deregister_image
async
¶
deregister_image(request: DeregisterImageInput | DeregisterImageInputDict, /, *, plugins: list[Plugin] | None = None) -> DeregisterImageOutput
deregister_image(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeregisterImageInputDict]) -> DeregisterImageOutput
Deregisters the specified AMI. A deregistered AMI can't be used to launch new instances.
If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin in the Amazon EBS User Guide.
When deregistering an EBS-backed AMI, you can optionally delete its associated snapshots at the same time. However, if a snapshot is associated with multiple AMIs, it won't be deleted even if specified for deletion, although the AMI will still be deregistered.
Deregistering an AMI does not delete the following:
-
Instances already launched from the AMI. You'll continue to incur usage costs for the instances until you terminate them.
-
For EBS-backed AMIs: Snapshots that are associated with multiple AMIs. You'll continue to incur snapshot storage costs.
-
For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll continue to incur S3 storage costs.
For more information, see Deregister an Amazon EC2 AMI 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 |
|---|---|
DeregisterImageOutput
|
An instance of |
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¶
DeregisterImageInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DeregisterImage.
Attributes¶
delete_associated_snapshots
class-attribute
instance-attribute
¶
delete_associated_snapshots: bool | None = ...
Specifies whether to delete the snapshots associated with the AMI during deregistration.
Note
If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting.
Default: The snapshots are not deleted.
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.
Dictionaries¶
DeregisterImageInputDict
¶
Bases: TypedDict
Dictionary form of DeregisterImageInput.
Attributes¶
delete_associated_snapshots
instance-attribute
¶
delete_associated_snapshots: bool | None
Specifies whether to delete the snapshots associated with the AMI during deregistration.
Note
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: 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.
Output¶
DeregisterImageOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeregisterImageOutput structure.
Attributes¶
delete_snapshot_results
class-attribute
instance-attribute
¶
delete_snapshot_results: list[DeleteSnapshotReturnCode] | None = ...
The deletion result for each snapshot associated with the AMI, including the snapshot ID and its success or error code.
response_metadata
class-attribute
instance-attribute
¶
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.