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.

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.

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.

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

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: 20

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.

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.

Value¶

A list with the following syntax:

list(
  Instances = list(
    list(
      InstanceId = "string",
      InstanceType = "string",
      GroupName = "string",
      NetworkNodes = list(
        "string"
      ),
      AvailabilityZone = "string",
      ZoneId = "string",
      CapacityBlockId = "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"
      )
    )
  )
)