Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

ModifyInstancePlacement

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a Dedicated Host. When affinity is set to host 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.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance from host to dedicated, or from dedicated to host.

  • Move an instance to or from a placement group.

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, or placement group for an instance, the instance must be in the stopped state.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Affinity

The affinity setting for the instance.

Type: String

Valid Values: default | host

Required: No

GroupName

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster placement groups, the instance must have a tenancy of default or dedicated.

To remove an instance from a placement group, specify an empty string ("").

Type: String

Required: No

HostId

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

Type: String

Required: No

InstanceId

The ID of the instance that you are modifying.

Type: String

Required: Yes

Tenancy

The tenancy for the instance.

Type: String

Valid Values: dedicated | host

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example 1

This example modifies the affinity of instance i-0b33i09 so that it always has affinity with host h-00548908djdsgfs.

Sample Request

https://ec2.amazonaws.com/?Action=ModifyInstancePlacement &Affinity=host &HostId=h-00548908djdsgfs &InstanceId=i-0b33i09 &AUTHPARAMS

Sample Response

<ModifyInstancePlacementResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId> <return>true</item> </ModifyInstancePlacementResponse>

Example 2

This example places instance i-01234567812345678 in the placement group MyPlacementGroup.

Sample Request

https://ec2.amazonaws.com/?Action=ModifyInstancePlacement &InstanceId=i-01234567812345678 &GroupName=MyPlacementGroup &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: