AWS Glue

{'Tags': {'string': 'string'}}

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.

See also: AWS API Documentation

Request Syntax

client.create_custom_entity_type(
    Name='string',
    RegexString='string',
    ContextWords=[
        'string',
    ],
    Tags={
        'string': 'string'
    }
)

type Name

string

param Name

[REQUIRED]

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.

type RegexString

string

param RegexString

[REQUIRED]

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

type ContextWords

list

param ContextWords

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) --

type Tags

dict

param Tags

A list of tags applied to the custom entity type.

• (string) --

  • (string) --

rtype

dict

returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

• (dict) --

  • Name (string) --

    The name of the custom pattern you created.

{'Tags': {'string': 'string'}}

Lists all the custom patterns that have been created.

See also: AWS API Documentation

Request Syntax

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.