describe_instance_topology¶
Operation¶
describe_instance_topology
async
¶
describe_instance_topology(request: DescribeInstanceTopologyInput | DescribeInstanceTopologyInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeInstanceTopologyOutput
describe_instance_topology(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceTopologyInputDict]) -> DescribeInstanceTopologyOutput
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Instance topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide.
Note
The Amazon EC2 API follows an eventual consistency model due to the
distributed nature of the system supporting it. As a result, when you
call the DescribeInstanceTopology API command immediately after
launching instances, the response might return a null value for
capacityBlockId because the data might not have fully propagated
across all subsystems. For more information, see Eventual consistency
in the Amazon EC2
API
in the Amazon EC2 Developer Guide.
For more information, see Amazon EC2 topology in the Amazon EC2 User Guide.
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 |
|---|---|
DescribeInstanceTopologyOutput
|
An instance of |
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¶
DescribeInstanceTopologyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceTopologyInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the operation,
without actually making the request, and provides an error response. If
you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters
class-attribute
instance-attribute
¶
The filters.
-
availability-zone- The name of the Availability Zone (for example,us-west-2a) or Local Zone (for example,us-west-2-lax-1b) that the instance is in. -
instance-type- The instance type (for example,p4d.24xlarge) or instance family (for example,p4d*). You can use the*wildcard to match zero or more characters, or the?wildcard to match zero or one character. -
zone-id- The ID of the Availability Zone (for example,usw2-az2) or Local Zone (for example,usw2-lax1-az1) that the instance is in.
group_names
class-attribute
instance-attribute
¶
The name of the placement group that each instance is in.
Constraints: Maximum 100 explicitly specified placement group names.
instance_ids
class-attribute
instance-attribute
¶
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You can't specify this parameter and the instance IDs parameter in the same request.
Default: 20
Dictionaries¶
DescribeInstanceTopologyInputDict
¶
Bases: TypedDict
Dictionary form of DescribeInstanceTopologyInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the operation,
without actually making the request, and provides an error response. If
you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
-
availability-zone- The name of the Availability Zone (for example,us-west-2a) or Local Zone (for example,us-west-2-lax-1b) that the instance is in. -
instance-type- The instance type (for example,p4d.24xlarge) or instance family (for example,p4d*). You can use the*wildcard to match zero or more characters, or the?wildcard to match zero or one character. -
zone-id- The ID of the Availability Zone (for example,usw2-az2) or Local Zone (for example,usw2-lax1-az1) that the instance is in.
group_names
instance-attribute
¶
The name of the placement group that each instance is in.
Constraints: Maximum 100 explicitly specified placement group names.
instance_ids
instance-attribute
¶
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You can't specify this parameter and the instance IDs parameter in the same request.
Default: 20
Output¶
DescribeInstanceTopologyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceTopologyOutput structure.
Attributes¶
instances
class-attribute
instance-attribute
¶
instances: list[InstanceTopology] | None = ...
Information about the topology of each instance.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
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.