classifiers

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

Overview

Name	classifiers
Type	Resource
Id	aws.glue.classifiers

Fields

The following fields are returned by SELECT queries:

get_classifier

Name	Datatype	Description
csv_classifier	object	A classifier for comma-separated values (CSV).
grok_classifier	object	A classifier that uses grok.
json_classifier	object	A classifier for JSON content.
xml_classifier	object	A classifier for XML content.

get_classifiers

Name	Datatype	Description
csv_classifier	object	A classifier for comma-separated values (CSV).
grok_classifier	object	A classifier that uses grok.
json_classifier	object	A classifier for JSON content.
xml_classifier	object	A classifier for XML content.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_classifier	select	region		Retrieve a classifier by name.
get_classifiers	select	region		Lists all classifier objects in the Data Catalog.
create_classifier	insert	region		Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.
update_classifier	update	region		Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).
delete_classifier	delete	region		Removes a classifier from the Data Catalog.

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

get_classifier

Retrieve a classifier by name.

SELECT
csv_classifier,
grok_classifier,
json_classifier,
xml_classifier
FROM aws.glue.classifiers
WHERE region = '{{ region }}' -- required
;

get_classifiers

Lists all classifier objects in the Data Catalog.

SELECT
csv_classifier,
grok_classifier,
json_classifier,
xml_classifier
FROM aws.glue.classifiers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_classifier

Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.

INSERT INTO aws.glue.classifiers (
GrokClassifier,
XMLClassifier,
JsonClassifier,
CsvClassifier,
region
)
SELECT 
'{{ GrokClassifier }}',
'{{ XMLClassifier }}',
'{{ JsonClassifier }}',
'{{ CsvClassifier }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: classifiers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the classifiers resource.
  - name: GrokClassifier
    description: |
      A GrokClassifier object specifying the classifier to create.
    value:
      Classification: "{{ Classification }}"
      Name: "{{ Name }}"
      GrokPattern: "{{ GrokPattern }}"
      CustomPatterns: "{{ CustomPatterns }}"
  - name: XMLClassifier
    description: |
      An XMLClassifier object specifying the classifier to create.
    value:
      Classification: "{{ Classification }}"
      Name: "{{ Name }}"
      RowTag: "{{ RowTag }}"
  - name: JsonClassifier
    description: |
      A JsonClassifier object specifying the classifier to create.
    value:
      Name: "{{ Name }}"
      JsonPath: "{{ JsonPath }}"
  - name: CsvClassifier
    description: |
      A CsvClassifier object specifying the classifier to create.
    value:
      Name: "{{ Name }}"
      Delimiter: "{{ Delimiter }}"
      QuoteSymbol: "{{ QuoteSymbol }}"
      ContainsHeader: "{{ ContainsHeader }}"
      Header:
        - "{{ Header }}"
      DisableValueTrimming: {{ DisableValueTrimming }}
      AllowSingleColumn: {{ AllowSingleColumn }}
      CustomDatatypeConfigured: {{ CustomDatatypeConfigured }}
      CustomDatatypes:
        - "{{ CustomDatatypes }}"
      Serde: "{{ Serde }}"

UPDATE examples

update_classifier

Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).

UPDATE aws.glue.classifiers
SET 
GrokClassifier = '{{ GrokClassifier }}',
XMLClassifier = '{{ XMLClassifier }}',
JsonClassifier = '{{ JsonClassifier }}',
CsvClassifier = '{{ CsvClassifier }}'
WHERE 
region = '{{ region }}' --required;

DELETE examples

delete_classifier

Removes a classifier from the Data Catalog.

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