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 |
Updates a crawler. If a crawler is running, you must stop it using
StopCrawler
before updating it.
Synopsis
- data UpdateCrawler = UpdateCrawler' {
- classifiers :: Maybe [Text]
- configuration :: Maybe Text
- crawlerSecurityConfiguration :: Maybe Text
- databaseName :: Maybe Text
- description :: Maybe Text
- lakeFormationConfiguration :: Maybe LakeFormationConfiguration
- lineageConfiguration :: Maybe LineageConfiguration
- recrawlPolicy :: Maybe RecrawlPolicy
- role' :: Maybe Text
- schedule :: Maybe Text
- schemaChangePolicy :: Maybe SchemaChangePolicy
- tablePrefix :: Maybe Text
- targets :: Maybe CrawlerTargets
- name :: Text
- newUpdateCrawler :: Text -> UpdateCrawler
- updateCrawler_classifiers :: Lens' UpdateCrawler (Maybe [Text])
- updateCrawler_configuration :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_crawlerSecurityConfiguration :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_databaseName :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_description :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_lakeFormationConfiguration :: Lens' UpdateCrawler (Maybe LakeFormationConfiguration)
- updateCrawler_lineageConfiguration :: Lens' UpdateCrawler (Maybe LineageConfiguration)
- updateCrawler_recrawlPolicy :: Lens' UpdateCrawler (Maybe RecrawlPolicy)
- updateCrawler_role :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_schedule :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_schemaChangePolicy :: Lens' UpdateCrawler (Maybe SchemaChangePolicy)
- updateCrawler_tablePrefix :: Lens' UpdateCrawler (Maybe Text)
- updateCrawler_targets :: Lens' UpdateCrawler (Maybe CrawlerTargets)
- 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.
UpdateCrawler' | |
|
Instances
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:
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.
UpdateCrawler
, updateCrawler_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.
UpdateCrawler
, updateCrawler_crawlerSecurityConfiguration
- The name of the SecurityConfiguration
structure to be used by this
crawler.
UpdateCrawler
, updateCrawler_databaseName
- The Glue database where results are stored, such as:
arn:aws:daylight:us-east-1::database/sometable/*
.
UpdateCrawler
, updateCrawler_description
- A description of the new crawler.
UpdateCrawler
, updateCrawler_lakeFormationConfiguration
- Specifies Lake Formation configuration settings for the crawler.
UpdateCrawler
, updateCrawler_lineageConfiguration
- Specifies data lineage configuration settings for the crawler.
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.
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.
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 * * ? *)
.
UpdateCrawler
, updateCrawler_schemaChangePolicy
- The policy for the crawler's update and deletion behavior.
UpdateCrawler
, updateCrawler_tablePrefix
- The table prefix used for catalog tables that are created.
UpdateCrawler
, updateCrawler_targets
- A list of targets to crawl.
UpdateCrawler
, updateCrawler_name
- Name of the new crawler.
Request Lenses
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_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 Setting crawler configuration options.
updateCrawler_crawlerSecurityConfiguration :: Lens' UpdateCrawler (Maybe Text) Source #
The name of the SecurityConfiguration
structure to be used by this
crawler.
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_description :: Lens' UpdateCrawler (Maybe Text) Source #
A description of the new crawler.
updateCrawler_lakeFormationConfiguration :: Lens' UpdateCrawler (Maybe LakeFormationConfiguration) Source #
Specifies Lake Formation configuration settings for the crawler.
updateCrawler_lineageConfiguration :: Lens' UpdateCrawler (Maybe LineageConfiguration) Source #
Specifies data lineage configuration settings for the crawler.
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_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_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_schemaChangePolicy :: Lens' UpdateCrawler (Maybe SchemaChangePolicy) Source #
The policy for the crawler's update and deletion behavior.
updateCrawler_tablePrefix :: Lens' UpdateCrawler (Maybe Text) Source #
The table prefix used for catalog tables that are created.
updateCrawler_targets :: Lens' UpdateCrawler (Maybe CrawlerTargets) Source #
A list of targets to crawl.
updateCrawler_name :: Lens' UpdateCrawler Text Source #
Name of the new crawler.
Destructuring the Response
data UpdateCrawlerResponse Source #
See: newUpdateCrawlerResponse
smart constructor.
UpdateCrawlerResponse' | |
|
Instances
newUpdateCrawlerResponse Source #
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.