:doc:`VPCLattice <../../vpc-lattice>` / Client / get_target_group

****************
get_target_group
****************



.. py:method:: VPCLattice.Client.get_target_group(**kwargs)

  

  Retrieves information about the specified target group.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetTargetGroup>`_  


  **Request Syntax**
  ::

    response = client.get_target_group(
        targetGroupIdentifier='string'
    )
    
  :type targetGroupIdentifier: string
  :param targetGroupIdentifier: **[REQUIRED]** 

    The ID or ARN of the target group.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The ID of the target group.

        
      

      - **arn** *(string) --* 

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

        
      

      - **name** *(string) --* 

        The name of the target group.

        
      

      - **type** *(string) --* 

        The target group type.

        
      

      - **config** *(dict) --* 

        The target group configuration.

        
        

        - **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``.

          
        

        - **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``.

          
        

        - **vpcIdentifier** *(string) --* 

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

          
        

        - **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.

            
          

          - **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``.

            
          

          - **port** *(integer) --* 

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

            
          

          - **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.

            
          

          - **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.

            
          

          - **unhealthyThresholdCount** *(integer) --* 

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

            
          

          - **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.

              
        
      
        

        - **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``.

          
    
      

      - **createdAt** *(datetime) --* 

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

        
      

      - **lastUpdatedAt** *(datetime) --* 

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

        
      

      - **status** *(string) --* 

        The status.

        
      

      - **serviceArns** *(list) --* 

        The Amazon Resource Names (ARNs) of the service.

        
        

        - *(string) --* 
    
      

      - **failureMessage** *(string) --* 

        The failure message.

        
      

      - **failureCode** *(string) --* 

        The failure code.

        
  
  **Exceptions**
  
  *   :py:class:`VPCLattice.Client.exceptions.ValidationException`

  
  *   :py:class:`VPCLattice.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`VPCLattice.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`VPCLattice.Client.exceptions.ThrottlingException`

  
  *   :py:class:`VPCLattice.Client.exceptions.InternalServerException`

  