amazonka-glue-2.0: Amazon Glue SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glue.Types.Crawler

Description

 
Synopsis

Documentation

data Crawler Source #

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 Glue Data Catalog.

See: newCrawler smart constructor.

Constructors

Crawler' 

Fields

Instances

Instances details
FromJSON Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

Generic Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

Associated Types

type Rep Crawler :: Type -> Type #

Methods

from :: Crawler -> Rep Crawler x #

to :: Rep Crawler x -> Crawler #

Read Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

Show Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

NFData Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

Methods

rnf :: Crawler -> () #

Eq Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

Methods

(==) :: Crawler -> Crawler -> Bool #

(/=) :: Crawler -> Crawler -> Bool #

Hashable Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

Methods

hashWithSalt :: Int -> Crawler -> Int #

hash :: Crawler -> Int #

type Rep Crawler Source # 
Instance details

Defined in Amazonka.Glue.Types.Crawler

type Rep Crawler = D1 ('MetaData "Crawler" "Amazonka.Glue.Types.Crawler" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "Crawler'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "classifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "crawlElapsedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "crawlerSecurityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lakeFormationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LakeFormationConfiguration)) :*: (S1 ('MetaSel ('Just "lastCrawl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LastCrawlInfo)) :*: S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "lineageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LineageConfiguration)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recrawlPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecrawlPolicy)) :*: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule))))) :*: ((S1 ('MetaSel ('Just "schemaChangePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaChangePolicy)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CrawlerState))) :*: (S1 ('MetaSel ('Just "tablePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CrawlerTargets)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))))

newCrawler :: Crawler Source #

Create a value of Crawler with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:classifiers:Crawler', crawler_classifiers - A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

$sel:configuration:Crawler', crawler_configuration - Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.

$sel:crawlElapsedTime:Crawler', crawler_crawlElapsedTime - If the crawler is running, contains the total time elapsed since the last crawl began.

$sel:crawlerSecurityConfiguration:Crawler', crawler_crawlerSecurityConfiguration - The name of the SecurityConfiguration structure to be used by this crawler.

$sel:creationTime:Crawler', crawler_creationTime - The time that the crawler was created.

$sel:databaseName:Crawler', crawler_databaseName - The name of the database in which the crawler's output is stored.

$sel:description:Crawler', crawler_description - A description of the crawler.

$sel:lakeFormationConfiguration:Crawler', crawler_lakeFormationConfiguration - Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.

$sel:lastCrawl:Crawler', crawler_lastCrawl - The status of the last crawl, and potentially error information if an error occurred.

$sel:lastUpdated:Crawler', crawler_lastUpdated - The time that the crawler was last updated.

$sel:lineageConfiguration:Crawler', crawler_lineageConfiguration - A configuration that specifies whether data lineage is enabled for the crawler.

$sel:name:Crawler', crawler_name - The name of the crawler.

$sel:recrawlPolicy:Crawler', crawler_recrawlPolicy - A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

$sel:role':Crawler', crawler_role - The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

$sel:schedule:Crawler', crawler_schedule - For scheduled crawlers, the schedule when the crawler runs.

$sel:schemaChangePolicy:Crawler', crawler_schemaChangePolicy - The policy that specifies update and delete behaviors for the crawler.

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

$sel:tablePrefix:Crawler', crawler_tablePrefix - The prefix added to the names of tables that are created.

$sel:targets:Crawler', crawler_targets - A collection of targets to crawl.

$sel:version:Crawler', crawler_version - The version of the crawler.

crawler_classifiers :: Lens' Crawler (Maybe [Text]) Source #

A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

crawler_configuration :: Lens' Crawler (Maybe Text) Source #

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.

crawler_crawlElapsedTime :: Lens' Crawler (Maybe Integer) Source #

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

crawler_crawlerSecurityConfiguration :: Lens' Crawler (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used by this crawler.

crawler_creationTime :: Lens' Crawler (Maybe UTCTime) Source #

The time that the crawler was created.

crawler_databaseName :: Lens' Crawler (Maybe Text) Source #

The name of the database in which the crawler's output is stored.

crawler_description :: Lens' Crawler (Maybe Text) Source #

A description of the crawler.

crawler_lakeFormationConfiguration :: Lens' Crawler (Maybe LakeFormationConfiguration) Source #

Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.

crawler_lastCrawl :: Lens' Crawler (Maybe LastCrawlInfo) Source #

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

crawler_lastUpdated :: Lens' Crawler (Maybe UTCTime) Source #

The time that the crawler was last updated.

crawler_lineageConfiguration :: Lens' Crawler (Maybe LineageConfiguration) Source #

A configuration that specifies whether data lineage is enabled for the crawler.

crawler_name :: Lens' Crawler (Maybe Text) Source #

The name of the crawler.

crawler_recrawlPolicy :: Lens' Crawler (Maybe RecrawlPolicy) Source #

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

crawler_role :: Lens' Crawler (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

crawler_schedule :: Lens' Crawler (Maybe Schedule) Source #

For scheduled crawlers, the schedule when the crawler runs.

crawler_schemaChangePolicy :: Lens' Crawler (Maybe SchemaChangePolicy) Source #

The policy that specifies update and delete behaviors for the crawler.

crawler_state :: Lens' Crawler (Maybe CrawlerState) Source #

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

crawler_tablePrefix :: Lens' Crawler (Maybe Text) Source #

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

crawler_targets :: Lens' Crawler (Maybe CrawlerTargets) Source #

A collection of targets to crawl.

crawler_version :: Lens' Crawler (Maybe Integer) Source #

The version of the crawler.