Glue / Client / get_classifier

get_classifier#

Glue.Client.get_classifier(**kwargs)#

Retrieve a classifier by name.

See also: AWS API Documentation

Request Syntax

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

Name (string) –

[REQUIRED]

Name of the classifier to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Classifier': {
        'GrokClassifier': {
            'Name': 'string',
            'Classification': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'GrokPattern': 'string',
            'CustomPatterns': 'string'
        },
        'XMLClassifier': {
            'Name': 'string',
            'Classification': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'RowTag': 'string'
        },
        'JsonClassifier': {
            'Name': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'JsonPath': 'string'
        },
        'CsvClassifier': {
            'Name': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Version': 123,
            'Delimiter': 'string',
            'QuoteSymbol': 'string',
            'ContainsHeader': 'UNKNOWN'|'PRESENT'|'ABSENT',
            'Header': [
                'string',
            ],
            'DisableValueTrimming': True|False,
            'AllowSingleColumn': True|False,
            'CustomDatatypeConfigured': True|False,
            'CustomDatatypes': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) –

    • Classifier (dict) –

      The requested classifier.

      • GrokClassifier (dict) –

        A classifier that uses grok.

        • Name (string) –

          The name of the classifier.

        • Classification (string) –

          An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

        • CreationTime (datetime) –

          The time that this classifier was registered.

        • LastUpdated (datetime) –

          The time that this classifier was last updated.

        • Version (integer) –

          The version of this classifier.

        • GrokPattern (string) –

          The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.

        • CustomPatterns (string) –

          Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.

      • XMLClassifier (dict) –

        A classifier for XML content.

        • Name (string) –

          The name of the classifier.

        • Classification (string) –

          An identifier of the data format that the classifier matches.

        • CreationTime (datetime) –

          The time that this classifier was registered.

        • LastUpdated (datetime) –

          The time that this classifier was last updated.

        • Version (integer) –

          The version of this classifier.

        • RowTag (string) –

          The XML tag designating the element that contains each record in an XML document being parsed. This can’t identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

      • JsonClassifier (dict) –

        A classifier for JSON content.

        • Name (string) –

          The name of the classifier.

        • CreationTime (datetime) –

          The time that this classifier was registered.

        • LastUpdated (datetime) –

          The time that this classifier was last updated.

        • Version (integer) –

          The version of this classifier.

        • JsonPath (string) –

          A JsonPath string defining the JSON data for the classifier to classify. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

      • CsvClassifier (dict) –

        A classifier for comma-separated values (CSV).

        • Name (string) –

          The name of the classifier.

        • CreationTime (datetime) –

          The time that this classifier was registered.

        • LastUpdated (datetime) –

          The time that this classifier was last updated.

        • Version (integer) –

          The version of this classifier.

        • Delimiter (string) –

          A custom symbol to denote what separates each column entry in the row.

        • QuoteSymbol (string) –

          A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

        • ContainsHeader (string) –

          Indicates whether the CSV file contains a header.

        • Header (list) –

          A list of strings representing column names.

          • (string) –

        • DisableValueTrimming (boolean) –

          Specifies not to trim values before identifying the type of column values. The default value is true.

        • AllowSingleColumn (boolean) –

          Enables the processing of files that contain only one column.

        • CustomDatatypeConfigured (boolean) –

          Enables the custom datatype to be configured.

        • CustomDatatypes (list) –

          A list of custom datatypes including “BINARY”, “BOOLEAN”, “DATE”, “DECIMAL”, “DOUBLE”, “FLOAT”, “INT”, “LONG”, “SHORT”, “STRING”, “TIMESTAMP”.

          • (string) –

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.OperationTimeoutException