VPCLattice / Client / get_target_group

get_target_group

VPCLattice.Client.get_target_group(**kwargs)

Retrieves information about the specified target group.

See also: AWS API Documentation

Request Syntax

response = client.get_target_group(
    targetGroupIdentifier='string'
)

Parameters:

targetGroupIdentifier (string) –

[REQUIRED]

The ID or ARN of the target group.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'config': {
        'healthCheck': {
            'enabled': True|False,
            'healthCheckIntervalSeconds': 123,
            'healthCheckTimeoutSeconds': 123,
            'healthyThresholdCount': 123,
            'matcher': {
                'httpCode': 'string'
            },
            'path': 'string',
            'port': 123,
            'protocol': 'HTTP'|'HTTPS'|'TCP',
            'protocolVersion': 'HTTP1'|'HTTP2',
            'unhealthyThresholdCount': 123
        },
        'ipAddressType': 'IPV4'|'IPV6',
        'lambdaEventStructureVersion': 'V1'|'V2',
        'port': 123,
        'protocol': 'HTTP'|'HTTPS'|'TCP',
        'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC',
        'vpcIdentifier': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'failureCode': 'string',
    'failureMessage': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'serviceArns': [
        'string',
    ],
    'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
    'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB'
}

Response Structure

• (dict) –

  • arn (string) –

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

  • config (dict) –

    The target group configuration.

    • healthCheck (dict) –

      The health check configuration. Not supported if the target group type is LAMBDA or ALB.

      • enabled (boolean) –

        Indicates whether health checking is enabled.

      • healthCheckIntervalSeconds (integer) –

        The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

      • healthCheckTimeoutSeconds (integer) –

        The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

      • healthyThresholdCount (integer) –

        The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

      • matcher (dict) –

        The codes to use when checking for a successful response from a target.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: httpCode. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • httpCode (string) –

          The HTTP code to use when checking for a successful response from a target.

      • path (string) –

        The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

      • port (integer) –

        The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

      • protocol (string) –

        The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

      • protocolVersion (string) –

        The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

      • unhealthyThresholdCount (integer) –

        The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

    • ipAddressType (string) –

      The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

    • lambdaEventStructureVersion (string) –

      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

    • port (integer) –

      The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

    • protocol (string) –

      The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

    • protocolVersion (string) –

      The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

    • vpcIdentifier (string) –

      The ID of the VPC. Not supported if the target group type is LAMBDA.

  • createdAt (datetime) –

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

  • failureCode (string) –

    The failure code.

  • failureMessage (string) –

    The failure message.

  • id (string) –

    The ID of the target group.

  • lastUpdatedAt (datetime) –

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

  • name (string) –

    The name of the target group.

  • serviceArns (list) –

    The Amazon Resource Names (ARNs) of the service.

    • (string) –

  • status (string) –

    The status.

  • type (string) –

    The target group type.

Exceptions

• VPCLattice.Client.exceptions.ValidationException

• VPCLattice.Client.exceptions.AccessDeniedException

• VPCLattice.Client.exceptions.ThrottlingException

• VPCLattice.Client.exceptions.ResourceNotFoundException

• VPCLattice.Client.exceptions.InternalServerException