EC2 / Client / disable_image
disable_image#
- EC2.Client.disable_image(**kwargs)#
Sets the AMI state to
disabled
and removes all launch permissions from the AMI. A disabled AMI can’t be used for instance launches.A disabled AMI can’t be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI.
A disabled AMI does not appear in DescribeImages API calls by default.
Only the AMI owner can disable an AMI.
You can re-enable a disabled AMI using EnableImage.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
response = client.disable_image( ImageId='string', DryRun=True|False )
- Parameters:
ImageId (string) –
[REQUIRED]
The ID of the AMI.
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 isUnauthorizedOperation
.
- Return type:
dict
- Returns:
Response Syntax
{ 'Return': True|False }
Response Structure
(dict) –
Return (boolean) –
Returns
true
if the request succeeds; otherwise, it returns an error.