Skip to content

Enable Image Deprecation

ec2_enable_image_deprecation R Documentation

Enables deprecation of the specified AMI at the specified date and time

Description

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.

Usage

ec2_enable_image_deprecation(ImageId, DeprecateAt, DryRun)

Arguments

ImageId

[required] The ID of the AMI.

DeprecateAt

[required] 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.

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

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax

svc$enable_image_deprecation(
  ImageId = "string",
  DeprecateAt = as.POSIXct(
    "2015-01-01"
  ),
  DryRun = TRUE|FALSE
)