custom_entity_types

Creates, updates, deletes, gets or lists a custom_entity_types resource.

Overview

Name	custom_entity_types
Type	Resource
Id	aws.glue.custom_entity_types

Fields

The following fields are returned by SELECT queries:

batch_get_custom_entity_types

Name	Datatype	Description
custom_entity_types	array	A list of CustomEntityType objects representing the custom patterns that have been created.
custom_entity_types_not_found	array	A list of the names of custom patterns that were not found.

get_custom_entity_type

Name	Datatype	Description
context_words	array	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.
name	string	The name of the custom pattern that you retrieved. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
regex_string	string	A regular expression string that is used for detecting sensitive data in a custom pattern. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_custom_entity_types	select	region		Retrieves the details for the custom patterns specified by a list of names.
get_custom_entity_type	select	region		Retrieves the details of a custom pattern by specifying its name.
create_custom_entity_type	insert	region, RegexString		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.
delete_custom_entity_type	delete	region		Deletes a custom pattern by specifying its name.
list_custom_entity_types	exec	region		Lists all the custom patterns that have been created.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_custom_entity_types

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

SELECT
custom_entity_types,
custom_entity_types_not_found
FROM aws.glue.custom_entity_types
WHERE region = '{{ region }}' -- required
;

get_custom_entity_type

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

SELECT
context_words,
name,
regex_string
FROM aws.glue.custom_entity_types
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_custom_entity_type

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.

INSERT INTO aws.glue.custom_entity_types (
Name,
RegexString,
ContextWords,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ RegexString }}' /* required */,
'{{ ContextWords }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: custom_entity_types
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_entity_types resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      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.
  - name: RegexString
    value: "{{ RegexString }}"
    description: |
      A regular expression string that is used for detecting sensitive data in a custom pattern.
  - name: ContextWords
    value:
      - "{{ ContextWords }}"
    description: |
      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.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A list of tags applied to the custom entity type.

DELETE examples

delete_custom_entity_type

Deletes a custom pattern by specifying its name.

DELETE FROM aws.glue.custom_entity_types
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_custom_entity_types

Lists all the custom patterns that have been created.

EXEC aws.glue.custom_entity_types.list_custom_entity_types 
@region='{{ region }}' --required 
@@json=
'{
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}, 
"Tags": "{{ Tags }}"
}'
;