Glue / Client / batch_get_custom_entity_types

batch_get_custom_entity_types#

Glue.Client.batch_get_custom_entity_types(**kwargs)#

Retrieves the details for the custom patterns specified by a list of names.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_custom_entity_types(
    Names=[
        'string',
    ]
)
Parameters:

Names (list) –

[REQUIRED]

A list of names of the custom patterns that you want to retrieve.

  • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • CustomEntityTypes (list) –

      A list of CustomEntityType objects representing the custom patterns that have been created.

      • (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) –

    • CustomEntityTypesNotFound (list) –

      A list of the names of custom patterns that were not found.

      • (string) –

Exceptions

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.InternalServiceException

  • Glue.Client.exceptions.OperationTimeoutException