:doc:`Shield <../../shield>` / Client / associate_health_check

**********************
associate_health_check
**********************



.. py:method:: Shield.Client.associate_health_check(**kwargs)

  

  Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

   

  You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see `Shield Advanced Health-Based Detection <https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option>`__ in the *WAF Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AssociateHealthCheck>`_  


  **Request Syntax**
  ::

    response = client.associate_health_check(
        ProtectionId='string',
        HealthCheckArn='string'
    )
    
  :type ProtectionId: string
  :param ProtectionId: **[REQUIRED]** 

    The unique identifier (ID) for the  Protection object to add the health check association to.

    

  
  :type HealthCheckArn: string
  :param HealthCheckArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the health check to associate with the protection.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Shield.Client.exceptions.InternalErrorException`

  
  *   :py:class:`Shield.Client.exceptions.LimitsExceededException`

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

  
  *   :py:class:`Shield.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Shield.Client.exceptions.OptimisticLockException`

  
  *   :py:class:`Shield.Client.exceptions.InvalidResourceException`

  