VPCLattice / Client / list_target_groups

list_target_groups

VPCLattice.Client.list_target_groups(**kwargs)

Lists your target groups. You can narrow your search by using the filters below in your request.

See also: AWS API Documentation

Request Syntax

response = client.list_target_groups(
    maxResults=123,
    nextToken='string',
    targetGroupType='IP'|'LAMBDA'|'INSTANCE'|'ALB',
    vpcIdentifier='string'
)

Parameters:

• maxResults (integer) – The maximum number of results to return.

• nextToken (string) – A pagination token for the next page of results.

• targetGroupType (string) – The target group type.

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

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

    If there are additional results, a pagination token for the next page of results.

Exceptions

• VPCLattice.Client.exceptions.ValidationException

• VPCLattice.Client.exceptions.AccessDeniedException

• VPCLattice.Client.exceptions.ThrottlingException

• VPCLattice.Client.exceptions.InternalServerException