WAF / Client / list_web_acls

list_web_acls#

WAF.Client.list_web_acls(**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 an array of WebACLSummary objects in the response.

See also: AWS API Documentation

Request Syntax

response = client.list_web_acls(
    NextMarker='string',
    Limit=123
)
Parameters:

  • NextMarker (string) – If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

  • Limit (integer) – Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

Return type:

dict

Returns:

Response Syntax

{
    'NextMarker': 'string',
    'WebACLs': [
        {
            'WebACLId': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextMarker (string) –

      If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    • WebACLs (list) –

      An array of WebACLSummary objects.

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

        Contains the identifier and the name or description of the WebACL.

        • WebACLId (string) –

          A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

          WebACLId is returned by CreateWebACL and by ListWebACLs.

        • Name (string) –

          A friendly name or description of the WebACL. You can’t change the name of a WebACL after you create it.

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException

  • WAF.Client.exceptions.WAFInvalidAccountException

Examples

The following example returns an array of up to 100 web ACLs.

response = client.list_web_acls(
    Limit=100,
)

print(response)

Expected Output:

{
    'WebACLs': [
        {
            'Name': 'WebACLexample',
            'WebACLId': 'webacl-1472061481310',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}