Disable Image

ec2_disable_image

R Documentation

Sets the AMI state to disabled and removes all launch permissions from the AMI¶

Description¶

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 Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI.

A disabled AMI does not appear in describe_images API calls by default.

Only the AMI owner can disable an AMI.

You can re-enable a disabled AMI using enable_image.

For more information, see Disable an AMI in the Amazon EC2 User Guide.

Usage¶

ec2_disable_image(ImageId, DryRun)

Arguments¶

ImageId: [required] The ID of the AMI.
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$disable_image(
  ImageId = "string",
  DryRun = TRUE|FALSE
)