:doc:`Glue <../../glue>` / Client / list_custom_entity_types

************************
list_custom_entity_types
************************



.. py:method:: Glue.Client.list_custom_entity_types(**kwargs)

  

  Lists all the custom patterns that have been created.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListCustomEntityTypes>`_  


  **Request Syntax**
  ::

    response = client.list_custom_entity_types(
        NextToken='string',
        MaxResults=123,
        Tags={
            'string': 'string'
        }
    )
    
  :type NextToken: string
  :param NextToken: 

    A paginated token to offset the results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return.

    

  
  :type Tags: dict
  :param Tags: 

    A list of key-value pair tags.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'CustomEntityTypes': [
              {
                  'Name': 'string',
                  'RegexString': 'string',
                  'ContextWords': [
                      'string',
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CustomEntityTypes** *(list) --* 

        A list of ``CustomEntityType`` objects representing custom patterns.

        
        

        - *(dict) --* 

          An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.

          
          

          - **Name** *(string) --* 

            A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.

            
          

          - **RegexString** *(string) --* 

            A regular expression string that is used for detecting sensitive data in a custom pattern.

            
          

          - **ContextWords** *(list) --* 

            A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

             

            If no context words are passed only a regular expression is checked.

            
            

            - *(string) --* 
        
      
    
      

      - **NextToken** *(string) --* 

        A pagination token, if more results are available.

        
  
  **Exceptions**
  
  *   :py:class:`Glue.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Glue.Client.exceptions.OperationTimeoutException`

  
  *   :py:class:`Glue.Client.exceptions.InternalServiceException`

  