You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::Crawler

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#classifiersArray<String>

A list of custom classifiers associated with the crawler.

Returns:

  • (Array<String>)

    A list of custom classifiers associated with the crawler.

#configurationString

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:

Returns:

  • (String)

    Crawler configuration information.

#crawl_elapsed_timeInteger

If the crawler is running, contains the total time elapsed since the last crawl began.

Returns:

  • (Integer)

    If the crawler is running, contains the total time elapsed since the last crawl began.

#creation_timeTime

The time when the crawler was created.

Returns:

  • (Time)

    The time when the crawler was created.

#database_nameString

The database where metadata is written by this crawler.

Returns:

  • (String)

    The database where metadata is written by this crawler.

#descriptionString

A description of the crawler.

Returns:

  • (String)

    A description of the crawler.

#last_crawlTypes::LastCrawlInfo

The status of the last crawl, and potentially error information if an error occurred.

Returns:

  • (Types::LastCrawlInfo)

    The status of the last crawl, and potentially error information if an error occurred.

#last_updatedTime

The time the crawler was last updated.

Returns:

  • (Time)

    The time the crawler was last updated.

#nameString

The crawler name.

Returns:

  • (String)

    The crawler name.

#roleString

The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

Returns:

  • (String)

    The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

#scheduleTypes::Schedule

For scheduled crawlers, the schedule when the crawler runs.

Returns:

  • (Types::Schedule)

    For scheduled crawlers, the schedule when the crawler runs.

#schema_change_policyTypes::SchemaChangePolicy

Sets the behavior when the crawler finds a changed or deleted object.

Returns:

#stateString

Indicates whether the crawler is running, or whether a run is pending.

Possible values:

  • READY
  • RUNNING
  • STOPPING

Returns:

  • (String)

    Indicates whether the crawler is running, or whether a run is pending.

#table_prefixString

The prefix added to the names of tables that are created.

Returns:

  • (String)

    The prefix added to the names of tables that are created.

#targetsTypes::CrawlerTargets

A collection of targets to crawl.

Returns:

#versionInteger

The version of the crawler.

Returns:

  • (Integer)

    The version of the crawler.