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 |
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.
CreateCrawler' | |
|
Instances
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.
CreateCrawlerResponse' | |
|
Instances
newCreateCrawlerResponse Source #
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.