Shield / Client / associate_health_check

associate_health_check#

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 in the WAF Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.associate_health_check(
    ProtectionId='string',
    HealthCheckArn='string'
)
Parameters:

  • ProtectionId (string) –

    [REQUIRED]

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

  • HealthCheckArn (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Shield.Client.exceptions.InternalErrorException

  • Shield.Client.exceptions.LimitsExceededException

  • Shield.Client.exceptions.ResourceNotFoundException

  • Shield.Client.exceptions.InvalidParameterException

  • Shield.Client.exceptions.OptimisticLockException

  • Shield.Client.exceptions.InvalidResourceException