Describe Instance Topology
ec2_describe_instance_topology | R Documentation |
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone¶
Description¶
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.
Limitations
-
Supported zones
-
Availability Zone
-
Local Zone
-
-
Supported instance types
-
hpc6a.48xlarge
|hpc6id.32xlarge
|hpc7a.12xlarge
|hpc7a.24xlarge
|hpc7a.48xlarge
|hpc7a.96xlarge
|hpc7g.4xlarge
|hpc7g.8xlarge
|hpc7g.16xlarge
-
p3dn.24xlarge
|p4d.24xlarge
|p4de.24xlarge
|p5.48xlarge
|p5e.48xlarge
|p5en.48xlarge
-
trn1.2xlarge
|trn1.32xlarge
|trn1n.32xlarge
|trn2.48xlarge
|trn2u.48xlarge
-
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
Usage¶
ec2_describe_instance_topology(DryRun, NextToken, MaxResults,
InstanceIds, GroupNames, Filters)
Arguments¶
DryRun |
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
|
NextToken |
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. |
MaxResults |
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: |
InstanceIds |
The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. |
GroupNames |
The name of the placement group that each instance is in. Constraints: Maximum 100 explicitly specified placement group names. |
Filters |
The filters.
|
Value¶
A list with the following syntax:
list(
Instances = list(
list(
InstanceId = "string",
InstanceType = "string",
GroupName = "string",
NetworkNodes = list(
"string"
),
AvailabilityZone = "string",
ZoneId = "string"
)
),
NextToken = "string"
)
Request syntax¶
svc$describe_instance_topology(
DryRun = TRUE|FALSE,
NextToken = "string",
MaxResults = 123,
InstanceIds = list(
"string"
),
GroupNames = list(
"string"
),
Filters = list(
list(
Name = "string",
Values = list(
"string"
)
)
)
)