DisableImage
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 AWS 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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
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.Type: Boolean
Required: No
- ImageId
-
The ID of the AMI.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- return
-
Returns
trueif the request succeeds; otherwise, it returns an error.Type: Boolean
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example disables the specified AMI.
Sample Request
https://ec2.amazonaws.com/?Action=DisableImage
&ImageId=ami-0123456789EXAMPLE
&AUTHPARAMSSample Response
<DisableImageResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>11aabb229-4eac-35bd-99ed-be587EXAMPLE</requestId>
<return>true</return>
</DisableImageResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
