Skip to content

Replaces or removes the instance type specification for an AMI

Description

Replaces or removes the instance type specification for an AMI. The instance type specification defines which instance types are compatible with the AMI.

When you launch an instance using run_instances, Amazon EC2 validates the requested instance type against the AMI's instance type specification. If the instance type is not compatible, the request fails with an InvalidParameterCombination error.

You can specify supported instance types, unsupported instance types, or both. The evaluation logic is as follows:

  • No specification set – all instance types are allowed.
  • Only UnsupportedInstanceTypes set – All instance types are allowed except those that match the unsupported list.
  • SupportedInstanceTypes set – The instance type must match the supported list and must not match the unsupported list.

Instance type entries support wildcard patterns using * (for example, t3.* matches all t3 sizes).

To remove an existing instance type specification, omit the InstanceTypeSpecification parameter or set it to null.

To set the instance type specification, you must be the AMI owner. You cannot set an instance type specification on an AMI that is listed in Amazon Web Services Marketplace, and you cannot list an AMI in Amazon Web Services Marketplace if it has an instance type specification set.

Usage

ec2_replace_image_instance_type_specification(ImageId,
  InstanceTypeSpecification, DryRun)

Arguments

  • ImageId

[required] The ID of the AMI.

  • InstanceTypeSpecification

The instance type specification to set on the AMI. Omit this parameter to remove the existing instance type specification.

  • 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(
  ReturnValue = TRUE|FALSE
)

Request syntax

svc$replace_image_instance_type_specification(
  ImageId = "string",
  InstanceTypeSpecification = list(
    SupportedInstanceTypes = list(
      "string"
    ),
    UnsupportedInstanceTypes = list(
      "string"
    )
  ),
  DryRun = TRUE|FALSE
)