Skip to content

EC2  >  Operations  >  enable_image_deprecation

enable_image_deprecation

Operation

enable_image_deprecation async

enable_image_deprecation(request: EnableImageDeprecationInput | EnableImageDeprecationInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableImageDeprecationOutput
enable_image_deprecation(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableImageDeprecationInputDict]) -> EnableImageDeprecationOutput

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.

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
EnableImageDeprecationOutput

An instance of EnableImageDeprecationOutput.

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

EnableImageDeprecationInput dataclass

Bases: _SerdeShape

Dataclass for EnableImageDeprecationInput structure.

Attributes
deprecate_at class-attribute instance-attribute
deprecate_at: datetime | None = ...

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 DeprecateAt is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.

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.

image_id class-attribute instance-attribute
image_id: str | None = ...

The ID of the AMI.

Dictionaries

EnableImageDeprecationInputDict

Bases: TypedDict

Dictionary form of EnableImageDeprecationInput.

Attributes
deprecate_at instance-attribute
deprecate_at: Required[datetime]

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 DeprecateAt is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.

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.

image_id instance-attribute
image_id: Required[str]

The ID of the AMI.

Output

EnableImageDeprecationOutput dataclass

Bases: _SerdeShape

Dataclass for EnableImageDeprecationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

return_ class-attribute instance-attribute
return_: bool | None = ...

Returns true if the request succeeds; otherwise, it returns an error.