Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glue.UpdateCrawler

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.

Synopsis

data UpdateCrawler = UpdateCrawler' {
- schemaChangePolicy :: Maybe SchemaChangePolicy
- schedule :: Maybe Text
- recrawlPolicy :: Maybe RecrawlPolicy
- classifiers :: Maybe [Text]
- role' :: Maybe Text
- targets :: Maybe CrawlerTargets
- databaseName :: Maybe Text
- crawlerSecurityConfiguration :: Maybe Text
- lineageConfiguration :: Maybe LineageConfiguration
- configuration :: Maybe Text
- tablePrefix :: Maybe Text
- description :: Maybe Text
- name :: Text
}
newUpdateCrawler :: Text -> UpdateCrawler
updateCrawler_schemaChangePolicy :: Lens' UpdateCrawler (Maybe SchemaChangePolicy)
updateCrawler_schedule :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_recrawlPolicy :: Lens' UpdateCrawler (Maybe RecrawlPolicy)
updateCrawler_classifiers :: Lens' UpdateCrawler (Maybe [Text])
updateCrawler_role :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_targets :: Lens' UpdateCrawler (Maybe CrawlerTargets)
updateCrawler_databaseName :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_crawlerSecurityConfiguration :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_lineageConfiguration :: Lens' UpdateCrawler (Maybe LineageConfiguration)
updateCrawler_configuration :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_tablePrefix :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_description :: Lens' UpdateCrawler (Maybe Text)
updateCrawler_name :: Lens' UpdateCrawler Text
data UpdateCrawlerResponse = UpdateCrawlerResponse' {
- httpStatus :: Int
}
newUpdateCrawlerResponse :: Int -> UpdateCrawlerResponse
updateCrawlerResponse_httpStatus :: Lens' UpdateCrawlerResponse Int

Creating a Request

data UpdateCrawler Source #

See: newUpdateCrawler smart constructor.

Constructors

UpdateCrawler'

Fields

schemaChangePolicy :: Maybe SchemaChangePolicy
The policy for the crawler's update and deletion behavior.
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 * * ? *).
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.
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.
role' :: Maybe Text
The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
targets :: Maybe CrawlerTargets
A list of targets to crawl.
databaseName :: Maybe Text
The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.
crawlerSecurityConfiguration :: Maybe Text
The name of the SecurityConfiguration structure to be used by this crawler.
lineageConfiguration :: Maybe LineageConfiguration
Specifies data lineage configuration settings for the crawler.
configuration :: Maybe Text
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
tablePrefix :: Maybe Text
The table prefix used for catalog tables that are created.
description :: Maybe Text
A description of the new crawler.
name :: Text
Name of the new crawler.

Instances

Instances details

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

newUpdateCrawler Source #

Arguments

:: Text	`$sel:name:UpdateCrawler'`
-> UpdateCrawler

Create a value of UpdateCrawler 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:schemaChangePolicy:UpdateCrawler', updateCrawler_schemaChangePolicy - The policy for the crawler's update and deletion behavior.

$sel:schedule:UpdateCrawler', updateCrawler_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 * * ? *).

$sel:recrawlPolicy:UpdateCrawler', updateCrawler_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:classifiers:UpdateCrawler', updateCrawler_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.

$sel:role':UpdateCrawler', updateCrawler_role - The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.

$sel:targets:UpdateCrawler', updateCrawler_targets - A list of targets to crawl.

$sel:databaseName:UpdateCrawler', updateCrawler_databaseName - The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.

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

$sel:lineageConfiguration:UpdateCrawler', updateCrawler_lineageConfiguration - Specifies data lineage configuration settings for the crawler.

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

$sel:tablePrefix:UpdateCrawler', updateCrawler_tablePrefix - The table prefix used for catalog tables that are created.

$sel:description:UpdateCrawler', updateCrawler_description - A description of the new crawler.

$sel:name:UpdateCrawler', updateCrawler_name - Name of the new crawler.

Request Lenses

updateCrawler_schemaChangePolicy :: Lens' UpdateCrawler (Maybe SchemaChangePolicy) Source #

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

updateCrawler_schedule :: Lens' UpdateCrawler (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 * * ? *).

updateCrawler_recrawlPolicy :: Lens' UpdateCrawler (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.

updateCrawler_classifiers :: Lens' UpdateCrawler (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.

updateCrawler_role :: Lens' UpdateCrawler (Maybe Text) Source #

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

updateCrawler_targets :: Lens' UpdateCrawler (Maybe CrawlerTargets) Source #

A list of targets to crawl.

updateCrawler_databaseName :: Lens' UpdateCrawler (Maybe Text) Source #

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

updateCrawler_crawlerSecurityConfiguration :: Lens' UpdateCrawler (Maybe Text) Source #

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

updateCrawler_lineageConfiguration :: Lens' UpdateCrawler (Maybe LineageConfiguration) Source #

Specifies data lineage configuration settings for the crawler.

updateCrawler_configuration :: Lens' UpdateCrawler (Maybe Text) Source #

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

updateCrawler_tablePrefix :: Lens' UpdateCrawler (Maybe Text) Source #

The table prefix used for catalog tables that are created.

updateCrawler_description :: Lens' UpdateCrawler (Maybe Text) Source #

A description of the new crawler.

updateCrawler_name :: Lens' UpdateCrawler Text Source #

Name of the new crawler.

Destructuring the Response

data UpdateCrawlerResponse Source #

See: newUpdateCrawlerResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateCrawlerResponse Source #

Arguments

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

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

Response Lenses

updateCrawlerResponse_httpStatus :: Lens' UpdateCrawlerResponse Int Source #

The response's http status code.