Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate 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.
- DeprecateAt
-
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for
DeprecateAtis 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.Type: Timestamp
Required: Yes
- 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 deprecates the specified AMI at the specified date and time. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
Sample Request
https://ec2.amazonaws.com/?Action=EnableImageDeprecation
&ImageId=ami-0123456789EXAMPLE
&DeprecateAt="2022-06-15T13:17:00.000Z"
&AUTHPARAMSSample Response
<EnableImageDeprecationResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<return>true</return>
</EnableImageDeprecationResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
