get_ip_set

WAF.Client.get_ip_set(**kwargs)

Note

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the IPSet that is specified by IPSetId .

See also: AWS API Documentation

Request Syntax

response = client.get_ip_set(
    IPSetId='string'
)
Parameters
IPSetId (string) --

[REQUIRED]

The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

Return type
dict
Returns
Response Syntax
{
    'IPSet': {
        'IPSetId': 'string',
        'Name': 'string',
        'IPSetDescriptors': [
            {
                'Type': 'IPV4'|'IPV6',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • IPSet (dict) --

      Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

      • IPSet: Contains IPSetDescriptors , IPSetId , and Name
      • IPSetDescriptors : Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value
      • IPSetId (string) --

        The IPSetId for an IPSet . You use IPSetId to get information about an IPSet (see GetIPSet ), update an IPSet (see UpdateIPSet ), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule ), and delete an IPSet from AWS WAF (see DeleteIPSet ).

        IPSetId is returned by CreateIPSet and by ListIPSets.
      • Name (string) --

        A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

      • IPSetDescriptors (list) --

        The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

        • (dict) --

          Note

          This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

          For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

          Specifies the IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR format) that web requests originate from.

          • Type (string) --

            Specify IPV4 or IPV6 .

          • Value (string) --

            Specify an IPv4 address by using CIDR notation. For example:

            • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32 .
            • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .

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

            Specify an IPv6 address by using CIDR notation. For example:

            • To configure AWS WAF to allow, block, or count 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 .
            • To configure AWS WAF to allow, block, or count 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 .

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException
  • WAF.Client.exceptions.WAFInvalidAccountException
  • WAF.Client.exceptions.WAFNonexistentItemException

Examples

The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.

response = client.get_ip_set(
    IPSetId='example1ds3t-46da-4fdb-b8d5-abc321j569j5',
)

print(response)

Expected Output:

{
    'IPSet': {
        'IPSetDescriptors': [
            {
                'Type': 'IPV4',
                'Value': '192.0.2.44/32',
            },
        ],
        'IPSetId': 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        'Name': 'MyIPSetFriendlyName',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}