Glue / Client / get_custom_entity_type

get_custom_entity_type#

Glue.Client.get_custom_entity_type(**kwargs)#

Retrieves the details of a custom pattern by specifying its name.

See also: AWS API Documentation

Request Syntax

response = client.get_custom_entity_type(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

The name of the custom pattern that you want to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'RegexString': 'string',
    'ContextWords': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the custom pattern that you retrieved.

    • 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 specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

      • (string) –

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.AccessDeniedException

  • Glue.Client.exceptions.InternalServiceException

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.OperationTimeoutException