EC2 / Client / describe_instance_topology

describe_instance_topology

EC2.Client.describe_instance_topology(**kwargs)

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

  • trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge

For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance_topology(
    DryRun=True|False,
    NextToken='string',
    MaxResults=123,
    InstanceIds=[
        'string',
    ],
    GroupNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• DryRun (boolean) – Checks whether you have the required permissions for the action, 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 (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• MaxResults (integer) –

  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 (list) –

  The instance IDs.

  Default: Describes all your instances.

  Constraints: Maximum 100 explicitly specified instance IDs.

  • (string) –

• GroupNames (list) –

  The name of the placement group that each instance is in.

  Constraints: Maximum 100 explicitly specified placement group names.

  • (string) –

• Filters (list) –

  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.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'InstanceId': 'string',
            'InstanceType': 'string',
            'GroupName': 'string',
            'NetworkNodes': [
                'string',
            ],
            'AvailabilityZone': 'string',
            'ZoneId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Instances (list) –

    Information about the topology of each instance.

    • (dict) –

      Information about the instance topology.

      • InstanceId (string) –

        The instance ID.

      • InstanceType (string) –

        The instance type.

      • GroupName (string) –

        The name of the placement group that the instance is in.

      • NetworkNodes (list) –

        The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.

        • (string) –

      • AvailabilityZone (string) –

        The name of the Availability Zone or Local Zone that the instance is in.

      • ZoneId (string) –

        The ID of the Availability Zone or Local Zone that the instance is in.

  • NextToken (string) –

    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.