WAFRegional / Client / get_web_acl_for_resource

get_web_acl_for_resource#

WAFRegional.Client.get_web_acl_for_resource(**kwargs)#

Note

This is AWS WAF Classic Regional 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 web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.

Request Syntax

response = client.get_web_acl_for_resource(
    ResourceArn='string'
)

Parameters:

ResourceArn (string) –

[REQUIRED]

The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.

The ARN should be in one of the following formats:

For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

Return type:

dict

Returns:

Response Syntax

{
    'WebACLSummary': {
        'WebACLId': 'string',
        'Name': 'string'
    }
}

Response Structure

(dict) –
- WebACLSummary (dict) –
  
  Information about the web ACL that you specified in the GetWebACLForResource request. If there is no associated resource, a null WebACLSummary is returned.
  - 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

WAFRegional.Client.exceptions.WAFInternalErrorException
WAFRegional.Client.exceptions.WAFInvalidAccountException
WAFRegional.Client.exceptions.WAFNonexistentItemException
WAFRegional.Client.exceptions.WAFInvalidParameterException
WAFRegional.Client.exceptions.WAFUnavailableEntityException