:doc:`WAFV2 <../../wafv2>` / Client / get_regex_pattern_set

*********************
get_regex_pattern_set
*********************



.. py:method:: WAFV2.Client.get_regex_pattern_set(**kwargs)

  

  Retrieves the specified  RegexPatternSet.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetRegexPatternSet>`_  


  **Request Syntax**
  ::

    response = client.get_regex_pattern_set(
        Name='string',
        Scope='CLOUDFRONT'|'REGIONAL',
        Id='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of the set. You cannot change the name after you create the set.

    

  
  :type Scope: string
  :param Scope: **[REQUIRED]** 

    Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use ``CLOUDFRONT``.

     

    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.
    

    

  
  :type Id: string
  :param Id: **[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.

    

  
  
  :rtype: 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 and also in the configuration for the Amazon Web Services Managed Rules rule group ``AWSManagedRulesAntiDDoSRuleSet``.

            
            

            - **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**
  
  *   :py:class:`WAFV2.Client.exceptions.WAFInternalErrorException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFInvalidParameterException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFNonexistentItemException`

  
  *   :py:class:`WAFV2.Client.exceptions.WAFInvalidOperationException`

  