WAFV2 / Client / get_regex_pattern_set

get_regex_pattern_set#

WAFV2.Client.get_regex_pattern_set(**kwargs)#

Retrieves the specified RegexPatternSet.

Request Syntax

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

Parameters:

Name (string) –
[REQUIRED]

The name of the set. You cannot change the name after you create the set.
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, a 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]

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

{
    'RegexPatternSet': {
        'Name': 'string',
        'Id': 'string',
        'ARN': 'string',
        'Description': 'string',
        'RegularExpressionList': [
            {
                'RegexString': 'string'
            },
        ]
    },
    'LockToken': 'string'
}

Response Structure

(dict) –
- RegexPatternSet (dict) –
  - Name (string) –
    
    The name of the set. You cannot change the name after you create the set.
  - 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 set that helps with identification.
  - RegularExpressionList (list) –
    
    The regular expression patterns in the set.
    - (dict) –
      
      A single regular expression. This is used in a RegexPatternSet.
      - RegexString (string) –
        
        The string representing the regular expression.
- 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

WAFV2.Client.exceptions.WAFInternalErrorException
WAFV2.Client.exceptions.WAFInvalidParameterException
WAFV2.Client.exceptions.WAFNonexistentItemException
WAFV2.Client.exceptions.WAFInvalidOperationException