Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Glue.CreateCrawler

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data CreateCrawler = CreateCrawler' {
- classifiers :: Maybe [Text]
- configuration :: Maybe Text
- crawlerSecurityConfiguration :: Maybe Text
- databaseName :: Maybe Text
- description :: Maybe Text
- lakeFormationConfiguration :: Maybe LakeFormationConfiguration
- lineageConfiguration :: Maybe LineageConfiguration
- recrawlPolicy :: Maybe RecrawlPolicy
- schedule :: Maybe Text
- schemaChangePolicy :: Maybe SchemaChangePolicy
- tablePrefix :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
- role' :: Text
- targets :: CrawlerTargets
}
newCreateCrawler :: Text -> Text -> CrawlerTargets -> CreateCrawler
createCrawler_classifiers :: Lens' CreateCrawler (Maybe [Text])
createCrawler_configuration :: Lens' CreateCrawler (Maybe Text)
createCrawler_crawlerSecurityConfiguration :: Lens' CreateCrawler (Maybe Text)
createCrawler_databaseName :: Lens' CreateCrawler (Maybe Text)
createCrawler_description :: Lens' CreateCrawler (Maybe Text)
createCrawler_lakeFormationConfiguration :: Lens' CreateCrawler (Maybe LakeFormationConfiguration)
createCrawler_lineageConfiguration :: Lens' CreateCrawler (Maybe LineageConfiguration)
createCrawler_recrawlPolicy :: Lens' CreateCrawler (Maybe RecrawlPolicy)
createCrawler_schedule :: Lens' CreateCrawler (Maybe Text)
createCrawler_schemaChangePolicy :: Lens' CreateCrawler (Maybe SchemaChangePolicy)
createCrawler_tablePrefix :: Lens' CreateCrawler (Maybe Text)
createCrawler_tags :: Lens' CreateCrawler (Maybe (HashMap Text Text))
createCrawler_name :: Lens' CreateCrawler Text
createCrawler_role :: Lens' CreateCrawler Text
createCrawler_targets :: Lens' CreateCrawler CrawlerTargets
data CreateCrawlerResponse = CreateCrawlerResponse' {
- httpStatus :: Int
}
newCreateCrawlerResponse :: Int -> CreateCrawlerResponse
createCrawlerResponse_httpStatus :: Lens' CreateCrawlerResponse Int

Creating a Request

data CreateCrawler Source #

See: newCreateCrawler smart constructor.

Constructors

CreateCrawler'

Fields

classifiers :: Maybe [Text]
A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
configuration :: Maybe Text
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.
crawlerSecurityConfiguration :: Maybe Text
The name of the SecurityConfiguration structure to be used by this crawler.
databaseName :: Maybe Text
The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
description :: Maybe Text
A description of the new crawler.
lakeFormationConfiguration :: Maybe LakeFormationConfiguration
Specifies Lake Formation configuration settings for the crawler.
lineageConfiguration :: Maybe LineageConfiguration
Specifies data lineage configuration settings for the crawler.
recrawlPolicy :: Maybe 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.
schedule :: Maybe Text
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 * * ? *).
schemaChangePolicy :: Maybe SchemaChangePolicy
The policy for the crawler's update and deletion behavior.
tablePrefix :: Maybe Text
The table prefix used for catalog tables that are created.
tags :: Maybe (HashMap Text Text)
The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
name :: Text
Name of the new crawler.
role' :: Text
The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
targets :: CrawlerTargets
A list of collection of targets to crawl.

Instances

Instances details

ToJSON CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods toJSON :: CreateCrawler -> Value # toEncoding :: CreateCrawler -> Encoding # toJSONList :: [CreateCrawler] -> Value # toEncodingList :: [CreateCrawler] -> Encoding #
ToHeaders CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods toHeaders :: CreateCrawler -> [Header] #
ToPath CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods toPath :: CreateCrawler -> ByteString #
ToQuery CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods toQuery :: CreateCrawler -> QueryString #
AWSRequest CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Associated Types type AWSResponse CreateCrawler # Methods request :: (Service -> Service) -> CreateCrawler -> Request CreateCrawler # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCrawler -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCrawler))) #
Generic CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Associated Types type Rep CreateCrawler :: Type -> Type # Methods from :: CreateCrawler -> Rep CreateCrawler x # to :: Rep CreateCrawler x -> CreateCrawler #
Read CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods readsPrec :: Int -> ReadS CreateCrawler # readList :: ReadS [CreateCrawler] # readPrec :: ReadPrec CreateCrawler # readListPrec :: ReadPrec [CreateCrawler] #
Show CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods showsPrec :: Int -> CreateCrawler -> ShowS # show :: CreateCrawler -> String # showList :: [CreateCrawler] -> ShowS #
NFData CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods rnf :: CreateCrawler -> () #
Eq CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods (==) :: CreateCrawler -> CreateCrawler -> Bool # (/=) :: CreateCrawler -> CreateCrawler -> Bool #
Hashable CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods hashWithSalt :: Int -> CreateCrawler -> Int # hash :: CreateCrawler -> Int #
type AWSResponse CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler type AWSResponse CreateCrawler = CreateCrawlerResponse
type Rep CreateCrawler Source #
Instance details Defined in Amazonka.Glue.CreateCrawler type Rep CreateCrawler = D1 ('MetaData "CreateCrawler" "Amazonka.Glue.CreateCrawler" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "CreateCrawler'" '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 "crawlerSecurityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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 "lineageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LineageConfiguration))))) :: (((S1 ('MetaSel ('Just "recrawlPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecrawlPolicy)) :: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "schemaChangePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaChangePolicy)) :: S1 ('MetaSel ('Just "tablePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CrawlerTargets))))))

newCreateCrawler Source #

Arguments

:: Text	`CreateCrawler`
-> Text	`CreateCrawler`
-> CrawlerTargets	`CreateCrawler`
-> CreateCrawler

Create a value of CreateCrawler 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:

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

CreateCrawler, createCrawler_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.

CreateCrawler, createCrawler_crawlerSecurityConfiguration - The name of the SecurityConfiguration structure to be used by this crawler.

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

CreateCrawler, createCrawler_description - A description of the new crawler.

CreateCrawler, createCrawler_lakeFormationConfiguration - Specifies Lake Formation configuration settings for the crawler.

CreateCrawler, createCrawler_lineageConfiguration - Specifies data lineage configuration settings for the crawler.

CreateCrawler, createCrawler_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.

CreateCrawler, createCrawler_schedule - 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 * * ? *).

CreateCrawler, createCrawler_schemaChangePolicy - The policy for the crawler's update and deletion behavior.

CreateCrawler, createCrawler_tablePrefix - The table prefix used for catalog tables that are created.

$sel:tags:CreateCrawler', createCrawler_tags - The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

CreateCrawler, createCrawler_name - Name of the new crawler.

CreateCrawler, createCrawler_role - The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

CreateCrawler, createCrawler_targets - A list of collection of targets to crawl.

Request Lenses

createCrawler_classifiers :: Lens' CreateCrawler (Maybe [Text]) Source #

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

createCrawler_configuration :: Lens' CreateCrawler (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.

createCrawler_crawlerSecurityConfiguration :: Lens' CreateCrawler (Maybe Text) Source #

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

createCrawler_databaseName :: Lens' CreateCrawler (Maybe Text) Source #

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

createCrawler_description :: Lens' CreateCrawler (Maybe Text) Source #

A description of the new crawler.

createCrawler_lakeFormationConfiguration :: Lens' CreateCrawler (Maybe LakeFormationConfiguration) Source #

Specifies Lake Formation configuration settings for the crawler.

createCrawler_lineageConfiguration :: Lens' CreateCrawler (Maybe LineageConfiguration) Source #

Specifies data lineage configuration settings for the crawler.

createCrawler_recrawlPolicy :: Lens' CreateCrawler (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.

createCrawler_schedule :: Lens' CreateCrawler (Maybe Text) Source #

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 * * ? *).

createCrawler_schemaChangePolicy :: Lens' CreateCrawler (Maybe SchemaChangePolicy) Source #

The policy for the crawler's update and deletion behavior.

createCrawler_tablePrefix :: Lens' CreateCrawler (Maybe Text) Source #

The table prefix used for catalog tables that are created.

createCrawler_tags :: Lens' CreateCrawler (Maybe (HashMap Text Text)) Source #

The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

createCrawler_name :: Lens' CreateCrawler Text Source #

Name of the new crawler.

createCrawler_role :: Lens' CreateCrawler Text Source #

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

createCrawler_targets :: Lens' CreateCrawler CrawlerTargets Source #

A list of collection of targets to crawl.

Destructuring the Response

data CreateCrawlerResponse Source #

See: newCreateCrawlerResponse smart constructor.

Constructors

CreateCrawlerResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateCrawlerResponse Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Associated Types type Rep CreateCrawlerResponse :: Type -> Type # Methods from :: CreateCrawlerResponse -> Rep CreateCrawlerResponse x # to :: Rep CreateCrawlerResponse x -> CreateCrawlerResponse #
Read CreateCrawlerResponse Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods readsPrec :: Int -> ReadS CreateCrawlerResponse # readList :: ReadS [CreateCrawlerResponse] # readPrec :: ReadPrec CreateCrawlerResponse # readListPrec :: ReadPrec [CreateCrawlerResponse] #
Show CreateCrawlerResponse Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods showsPrec :: Int -> CreateCrawlerResponse -> ShowS # show :: CreateCrawlerResponse -> String # showList :: [CreateCrawlerResponse] -> ShowS #
NFData CreateCrawlerResponse Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods rnf :: CreateCrawlerResponse -> () #
Eq CreateCrawlerResponse Source #
Instance details Defined in Amazonka.Glue.CreateCrawler Methods (==) :: CreateCrawlerResponse -> CreateCrawlerResponse -> Bool # (/=) :: CreateCrawlerResponse -> CreateCrawlerResponse -> Bool #
type Rep CreateCrawlerResponse Source #
Instance details Defined in Amazonka.Glue.CreateCrawler type Rep CreateCrawlerResponse = D1 ('MetaData "CreateCrawlerResponse" "Amazonka.Glue.CreateCrawler" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "CreateCrawlerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCrawlerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCrawlerResponse'`
-> CreateCrawlerResponse

Create a value of CreateCrawlerResponse 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:httpStatus:CreateCrawlerResponse', createCrawlerResponse_httpStatus - The response's http status code.

Response Lenses

createCrawlerResponse_httpStatus :: Lens' CreateCrawlerResponse Int Source #

The response's http status code.