EC2 / Paginator / DescribeInstanceTopology

DescribeInstanceTopology

class EC2.Paginator.DescribeInstanceTopology

paginator = client.get_paginator('describe_instance_topology')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_instance_topology().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    InstanceIds=[
        'string',
    ],
    GroupNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DryRun (boolean) – 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.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'InstanceId': 'string',
            'InstanceType': 'string',
            'GroupName': 'string',
            'NetworkNodes': [
                'string',
            ],
            'AvailabilityZone': 'string',
            'ZoneId': '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.