Amazon Elastic Compute Cloud

2023/11/13 - Amazon Elastic Compute Cloud - 1 new 1 updated api methods

Changes  Adds the new EC2 DescribeInstanceTopology API, which you can use to retrieve the network topology of your running instances on select platform types to determine their relative proximity to each other.

DescribeInstanceTopology (new) Link ¶

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

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

boolean

param DryRun

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 .

type NextToken

string

param NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type MaxResults

integer

param 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

type InstanceIds

list

param InstanceIds

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

  • (string) --

type GroupNames

list

param GroupNames

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

Constraints: Maximum 100 explicitly specified placement group names.

  • (string) --

type Filters

list

param 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.

  • (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) --

rtype

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 droplet 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.

GetCoipPoolUsage (updated) Link ¶
Changes (response) 
{'NextToken': 'string'}

Describes the allocations from the specified customer-owned address pool.

See also: AWS API Documentation

Request Syntax

client.get_coip_pool_usage(
    PoolId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type PoolId

string

param PoolId

[REQUIRED]

The ID of the address pool.

type Filters

list

param Filters

One or more filters.

  • coip-address-usage.allocation-id - The allocation ID of the address.

  • coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.

  • coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.

  • coip-address-usage.co-ip - The customer-owned IP address.

  • (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) --

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'CoipPoolId': 'string',
    'CoipAddressUsages': [
        {
            'AllocationId': 'string',
            'AwsAccountId': 'string',
            'AwsService': 'string',
            'CoIp': 'string'
        },
    ],
    'LocalGatewayRouteTableId': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CoipPoolId (string) --

      The ID of the customer-owned address pool.

    • CoipAddressUsages (list) --

      Information about the address usage.

      • (dict) --

        Describes address usage for a customer-owned address pool.

        • AllocationId (string) --

          The allocation ID of the address.

        • AwsAccountId (string) --

          The Amazon Web Services account ID.

        • AwsService (string) --

          The Amazon Web Services service.

        • CoIp (string) --

          The customer-owned IP address.

    • LocalGatewayRouteTableId (string) --

      The ID of the local gateway route table.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.