Table Of Contents


User Guide

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

[ aws . glue ]



Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in either the s3Targets or the jdbcTargets field.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--name <value>
--role <value>
--database-name <value>
[--description <value>]
--targets <value>
[--schedule <value>]
[--classifiers <value>]
[--table-prefix <value>]
[--schema-change-policy <value>]
[--configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--name (string)

Name of the new crawler.

--role (string)

The IAM role (or ARN of an IAM role) used by the new crawler to access customer resources.

--database-name (string)

The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/* .

--description (string)

A description of the new crawler.

--targets (structure)

A list of collection of targets to crawl.

JSON Syntax:

  "S3Targets": [
      "Path": "string",
      "Exclusions": ["string", ...]
  "JdbcTargets": [
      "ConnectionName": "string",
      "Path": "string",
      "Exclusions": ["string", ...]

--schedule (string)

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) .

--classifiers (list)

A list of custom classifiers that the user has registered. By default, all AWS classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.


"string" "string" ...

--table-prefix (string)

The table prefix used for catalog tables that are created.

--schema-change-policy (structure)

Policy for the crawler's update and deletion behavior.

Shorthand Syntax:


JSON Syntax:

  "UpdateBehavior": "LOG"|"UPDATE_IN_DATABASE",

--configuration (string)

Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.

You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:

Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'

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

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