Shield / Client / describe_protection

describe_protection#

Shield.Client.describe_protection(**kwargs)#

Lists the details of a Protection object.

See also: AWS API Documentation

Request Syntax

response = client.describe_protection(
    ProtectionId='string',
    ResourceArn='string'
)
Parameters:

  • ProtectionId (string) – The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

  • ResourceArn (string) – The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

Return type:

dict

Returns:

Response Syntax

{
    'Protection': {
        'Id': 'string',
        'Name': 'string',
        'ResourceArn': 'string',
        'HealthCheckIds': [
            'string',
        ],
        'ProtectionArn': 'string',
        'ApplicationLayerAutomaticResponseConfiguration': {
            'Status': 'ENABLED'|'DISABLED',
            'Action': {
                'Block': {},
                'Count': {}
            }
        }
    }
}

Response Structure

  • (dict) –

    • Protection (dict) –

      The Protection that you requested.

      • Id (string) –

        The unique identifier (ID) of the protection.

      • Name (string) –

        The name of the protection. For example, My CloudFront distributions.

      • ResourceArn (string) –

        The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.

      • HealthCheckIds (list) –

        The unique identifier (ID) for the Route 53 health check that’s associated with the protection.

        • (string) –

      • ProtectionArn (string) –

        The ARN (Amazon Resource Name) of the protection.

      • ApplicationLayerAutomaticResponseConfiguration (dict) –

        The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.

        • Status (string) –

          Indicates whether automatic application layer DDoS mitigation is enabled for the protection.

        • Action (dict) –

          Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

          • Block (dict) –

            Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.

            You must specify exactly one action, either Block or Count.

          • Count (dict) –

            Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.

            You must specify exactly one action, either Block or Count.

Exceptions

  • Shield.Client.exceptions.InternalErrorException

  • Shield.Client.exceptions.InvalidParameterException

  • Shield.Client.exceptions.ResourceNotFoundException