WAFV2 / Client / get_ip_set

get_ip_set#

WAFV2.Client.get_ip_set(**kwargs)#

Retrieves the specified IPSet.

See also: AWS API Documentation

Request Syntax

response = client.get_ip_set(
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    Id='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the IP set. You cannot change the name of an IPSet after you create it.

  • Scope (string) –

    [REQUIRED]

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

  • Id (string) –

    [REQUIRED]

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Return type:

dict

Returns:

Response Syntax

{
    'IPSet': {
        'Name': 'string',
        'Id': 'string',
        'ARN': 'string',
        'Description': 'string',
        'IPAddressVersion': 'IPV4'|'IPV6',
        'Addresses': [
            'string',
        ]
    },
    'LockToken': 'string'
}

Response Structure

  • (dict) –

    • IPSet (dict) –

      • Name (string) –

        The name of the IP set. You cannot change the name of an IPSet after you create it.

      • Id (string) –

        A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • ARN (string) –

        The Amazon Resource Name (ARN) of the entity.

      • Description (string) –

        A description of the IP set that helps with identification.

      • IPAddressVersion (string) –

        The version of the IP addresses, either IPV4 or IPV6.

      • Addresses (list) –

        Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

        Example address strings:

        • For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

        • For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

        • For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

        • For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

        Example JSON Addresses specifications:

        • Empty array: "Addresses": []

        • Array with one address: "Addresses": ["192.0.2.44/32"]

        • Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

        • INVALID specification: "Addresses": [""] INVALID

        • (string) –

    • LockToken (string) –

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Exceptions