EC2 / Client / enable_image_deprecation

enable_image_deprecation#

EC2.Client.enable_image_deprecation(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.enable_image_deprecation(
    ImageId='string',
    DeprecateAt=datetime(2015, 1, 1),
    DryRun=True|False
)
Parameters:

  • ImageId (string) –

    [REQUIRED]

    The ID of the AMI.

  • DeprecateAt (datetime) –

    [REQUIRED]

    The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DD*T*HH:MM:*SS*Z. 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 DeprecateAt is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.

  • 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 is UnauthorizedOperation.

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.