WAFV2 / Client / get_web_acl

get_web_acl#

WAFV2.Client.get_web_acl(**kwargs)#

Retrieves the specified WebACL.

Request Syntax

response = client.get_web_acl(
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    Id='string'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the web ACL. You cannot change the name of a web ACL 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, or an App Runner service.

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]

The unique identifier for the web ACL. 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

# This section is too large to render.
# Please see the AWS API Documentation linked below.

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

Exceptions