Amazon Elastic Compute Cloud

{'GroupName': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.modify_instance_placement(
    Affinity='default'|'host',
    GroupName='string',
    HostId='string',
    InstanceId='string',
    Tenancy='dedicated'|'host'
)

type Affinity:

string

param Affinity:

The affinity setting for the instance.

type GroupName:

string

param 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 HostId:

string

param HostId:

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

type InstanceId:

string

param InstanceId:

[REQUIRED]

The ID of the instance that you are modifying.

type Tenancy:

string

param Tenancy:

The tenancy for the instance.

rtype:

dict

returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

• (dict) --

  Contains the output of ModifyInstancePlacement.

  • Return (boolean) --

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