[ aws . glue ]

get-classifiers

Description

Lists all classifier objects in the Data Catalog.

See also: AWS API Documentation

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 | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json

• text

• table

• yaml

• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on

• off

• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Classifiers -> (list)

The requested list of classifier objects.

(structure)

Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.

You can use the standard classifiers that Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.

GrokClassifier -> (structure)

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

The time that this classifier was registered.

LastUpdated -> (timestamp)

The time that 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 Classifiers .

CustomPatterns -> (string)

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

XMLClassifier -> (structure)

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

The time that this classifier was registered.

LastUpdated -> (timestamp)

The time that 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. 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 -> (structure)

A classifier for JSON content.

Name -> (string)

The name of the classifier.

CreationTime -> (timestamp)

The time that this classifier was registered.

LastUpdated -> (timestamp)

The time that 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. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers .

CsvClassifier -> (structure)

A classifier for comma-separated values (CSV).

Name -> (string)

The name of the classifier.

CreationTime -> (timestamp)

The time that this classifier was registered.

LastUpdated -> (timestamp)

The time that this classifier was last updated.

Version -> (long)

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)

NextToken -> (string)

A continuation token.