Shield / Paginator / ListProtections

ListProtections

class Shield.Paginator.ListProtections

paginator = client.get_paginator('list_protections')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Shield.Client.list_protections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InclusionFilters={
        'ResourceArns': [
            'string',
        ],
        'ProtectionNames': [
            'string',
        ],
        'ResourceTypes': [
            'CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InclusionFilters (dict) –

  Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

  • ResourceArns (list) –

    The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.

    • (string) –

  • ProtectionNames (list) –

    The name of the protection that you want to retrieve.

    • (string) –

  • ResourceTypes (list) –

    The type of protected resource whose protections you want to retrieve.

    • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • Protections (list) –

    The array of enabled Protection objects.

    • (dict) –

      An object that represents a resource that is under DDoS protection.

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