Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . glue ]

get-classifiers

Description

Lists all classifier objects in the Data Catalog.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-classifiers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Classifiers

Synopsis

  get-classifiers
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Classifiers -> (list)

The requested list of classifier objects.

(structure)

Classifiers are written in Python and triggered during a crawl task. You can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier checks whether a given file is in a format it can handle, and if it is, the classifier creates a schema in the form of a StructType object that matches that data format.

A classifier can be a grok classifier, an XML classifier, or a JSON classifier, asspecified in one of the fields in the Classifier object.

GrokClassifier -> (structure)

A GrokClassifier object.

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

The time this classifier was registered.

LastUpdated -> (timestamp)

The time this classifier was last updated.

Version -> (long)

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 Classifers .

CustomPatterns -> (string)

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

XMLClassifier -> (structure)

An XMLClassifier object.

Name -> (string)

The name of the classifier.

Classification -> (string)

An identifier of the data format that the classifier matches.

CreationTime -> (timestamp)

The time this classifier was registered.

LastUpdated -> (timestamp)

The time this classifier was last updated.

Version -> (long)

The version of this classifier.

RowTag -> (string)

The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot 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 -> (structure)

A JsonClassifier object.

Name -> (string)

The name of the classifier.

CreationTime -> (timestamp)

The time this classifier was registered.

LastUpdated -> (timestamp)

The time this classifier was last updated.

Version -> (long)

The version of this classifier.

JsonPath -> (string)

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

NextToken -> (string)

A continuation token.