Skip to content

EC2  >  Operations  >  allocate_hosts

allocate_hosts

Operation

allocate_hosts async

allocate_hosts(request: AllocateHostsInput | AllocateHostsInputDict, /, *, plugins: list[Plugin] | None = None) -> AllocateHostsOutput
allocate_hosts(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AllocateHostsInputDict]) -> AllocateHostsOutput

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
AllocateHostsOutput

An instance of AllocateHostsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

AllocateHostsInput dataclass

Bases: _SerdeShape

Dataclass for AllocateHostsInput structure.

Attributes
asset_ids class-attribute instance-attribute
asset_ids: list[str] | None = ...

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

  • If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

  • If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

auto_placement class-attribute instance-attribute
auto_placement: str | None = ...

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: off

availability_zone class-attribute instance-attribute
availability_zone: str | None = ...

The Availability Zone in which to allocate the Dedicated Host.

availability_zone_id class-attribute instance-attribute
availability_zone_id: str | None = ...

The ID of the Availability Zone.

client_token class-attribute instance-attribute
client_token: str | None = ...

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

cpu_options class-attribute instance-attribute
cpu_options: HostCpuOptionsRequest | None = ...

The CPU configuration options to apply to the Dedicated Host.

host_maintenance class-attribute instance-attribute
host_maintenance: str | None = ...

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

host_recovery class-attribute instance-attribute
host_recovery: str | None = ...

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

instance_family class-attribute instance-attribute
instance_family: str | None = ...

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

instance_type class-attribute instance-attribute
instance_type: str | None = ...

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

outpost_arn class-attribute instance-attribute
outpost_arn: str | None = ...

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

quantity class-attribute instance-attribute
quantity: int | None = ...

The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the Dedicated Host during creation.

Dictionaries

AllocateHostsInputDict

Bases: TypedDict

Dictionary form of AllocateHostsInput.

Attributes
asset_ids instance-attribute
asset_ids: Sequence[str] | None

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

  • If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

  • If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

auto_placement instance-attribute
auto_placement: str | None

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: off

availability_zone instance-attribute
availability_zone: str | None

The Availability Zone in which to allocate the Dedicated Host.

availability_zone_id instance-attribute
availability_zone_id: str | None

The ID of the Availability Zone.

client_token instance-attribute
client_token: str | None

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

cpu_options instance-attribute

The CPU configuration options to apply to the Dedicated Host.

host_maintenance instance-attribute
host_maintenance: str | None

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

host_recovery instance-attribute
host_recovery: str | None

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

instance_family instance-attribute
instance_family: str | None

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

instance_type instance-attribute
instance_type: str | None

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

outpost_arn instance-attribute
outpost_arn: str | None

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

quantity instance-attribute
quantity: int | None

The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to apply to the Dedicated Host during creation.

Output

AllocateHostsOutput dataclass

Bases: _SerdeShape

Contains the output of AllocateHosts.

Attributes

host_ids class-attribute instance-attribute
host_ids: list[str] | None = ...

The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.