ListInstances

class ServiceDiscovery.Paginator.ListInstances

paginator = client.get_paginator('list_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ServiceDiscovery.Client.list_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ServiceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• ServiceId (string) --

  [REQUIRED]

  The ID of the service that you want to list instances for.

• 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': [
        {
            'Id': 'string',
            'Attributes': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) --

  • Instances (list) --

    Summary information about the instances that are associated with the specified service.

    • (dict) --

      A complex type that contains information about the instances that you registered by using a specified service.

      • Id (string) --

        The ID for an instance that you created by using a specified service.

      • Attributes (dict) --

        A string map that contains the following information:

        • The attributes that are associated with the instance.
        • For each attribute, the applicable value.

        Supported attribute keys include the following:

        AWS_ALIAS_DNS_NAME

        For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.

        AWS_EC2_INSTANCE_ID (HTTP namespaces only)

        The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

        AWS_INIT_HEALTH_STATUS

        If the service configuration includes HealthCheckCustomConfig , you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY . If you don't specify a value for AWS_INIT_HEALTH_STATUS , the initial status is HEALTHY .

        AWS_INSTANCE_CNAME

        For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example, example.com ).

        AWS_INSTANCE_IPV4

        For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example, 192.0.2.44 ).

        AWS_INSTANCE_IPV6

        For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 ).

        AWS_INSTANCE_PORT

        For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig , the port on the endpoint that Route 53 sends requests to.

        • (string) --
          • (string) --