VPCLattice / Paginator / ListTargetGroups

ListTargetGroups

class VPCLattice.Paginator.ListTargetGroups

paginator = client.get_paginator('list_target_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from VPCLattice.Client.list_target_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    targetGroupType='IP'|'LAMBDA'|'INSTANCE'|'ALB',
    vpcIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• targetGroupType (string) – The target group type.

• vpcIdentifier (string) – The ID or Amazon Resource Name (ARN) of the service.

• 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

{
    'items': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'ipAddressType': 'IPV4'|'IPV6',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'port': 123,
            'protocol': 'HTTP'|'HTTPS',
            'serviceArns': [
                'string',
            ],
            'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
            'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB',
            'vpcIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    Information about the target groups.

    • (dict) –

      Summary information about a target group.

      • arn (string) –

        The ARN (Amazon Resource Name) of the target group.

      • createdAt (datetime) –

        The date and time that the target group was created, specified in ISO-8601 format.

      • id (string) –

        The ID of the target group.

      • ipAddressType (string) –

        The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

      • lastUpdatedAt (datetime) –

        The date and time that the target group was last updated, specified in ISO-8601 format.

      • name (string) –

        The name of the target group.

      • port (integer) –

        The port of the target group.

      • protocol (string) –

        The protocol of the target group.

      • serviceArns (list) –

        The list of Amazon Resource Names (ARNs) of the service.

        • (string) –

      • status (string) –

        The status.

      • type (string) –

        The target group type.

      • vpcIdentifier (string) –

        The ID of the VPC of the target group.

  • NextToken (string) –

    A token to resume pagination.