GET

/#Action=ModifyInstancePlacement

http://ec2.{region}.amazonaws.com/#Action=ModifyInstancePlacement

Modifies the placement attributes for a specified instance. You can do the following: <ul> <li> Modify the affinity between an instance and a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html">Dedicated Host</a>. When affinity is set to <code>host</code> and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists. </li> <li> Change the Dedicated Host with which an instance is associated. </li> <li> Change the instance tenancy of an instance. </li> <li> Move an instance to or from a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">placement group</a>. </li> </ul> At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request. To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the <code>stopped</code> state.

Access Token Required: API Key

Query Params

Affinitystring

The affinity setting for the instance.

Allowed:

GroupNamestring

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of <code>default</code>. For cluster and partition placement groups, the instance must have a tenancy of <code>default</code> or <code>dedicated</code>. To remove an instance from a placement group, specify an empty string ("").

HostIdstring

The ID of the Dedicated Host with which to associate the instance.

InstanceIdstringrequired

The ID of the instance that you are modifying.

Tenancystring

The tenancy for the instance. <note> For T3 instances, you can't change the tenancy from <code>dedicated</code> to <code>host</code>, or from <code>host</code> to <code>dedicated</code>. Attempting to make one of these unsupported tenancy changes results in the <code>InvalidTenancy</code> error code. </note>

Allowed:

PartitionNumberinteger

The number of the partition in which to place the instance. Valid only if the placement group strategy is set to <code>partition</code>.

HostResourceGroupArnstring

The ARN of the host resource group in which to place the instance.

GroupIdstring

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=ModifyInstancePlacement' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}