EC2 / Client / modify_instance_placement

modify_instance_placement#

EC2.Client.modify_instance_placement(**kwargs)#

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.

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

See also: AWS API Documentation

Request Syntax

response = client.modify_instance_placement(
    Affinity='default'|'host',
    GroupName='string',
    HostId='string',
    InstanceId='string',
    Tenancy='dedicated'|'host',
    PartitionNumber=123,
    HostResourceGroupArn='string',
    GroupId='string'
)
Parameters:

  • Affinity (string) – The affinity setting for the instance.

  • GroupName (string) –

    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 and partition placement groups, the instance must have a tenancy of default or dedicated.

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

  • HostId (string) – The ID of the Dedicated Host with which to associate the instance.

  • InstanceId (string) –

    [REQUIRED]

    The ID of the instance that you are modifying.

  • Tenancy (string) –

    The tenancy for the instance.

    Note

    For T3 instances, you can’t change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.

  • PartitionNumber (integer) – The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.

  • HostResourceGroupArn (string) – The ARN of the host resource group in which to place the instance.

  • GroupId (string) – The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) –

    • Return (boolean) –

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