allocate_hosts¶
Operation¶
async
¶
allocate_hosts(input: AllocateHostsInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
AllocateHostsInput
|
An instance of |
required |
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 |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for AllocateHostsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
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.
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
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
The Availability Zone in which to allocate the Dedicated Host.
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
The ID of the Availability Zone.
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.
class-attribute
instance-attribute
¶
The CPU configuration options to apply to the Dedicated Host.
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.
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
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.
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.
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.
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the output of AllocateHosts.
Attributes¶
class-attribute
instance-attribute
¶
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
class-attribute
instance-attribute
¶
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.