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.Kendra.Types.SeedUrlConfiguration

Description

Synopsis

data SeedUrlConfiguration = SeedUrlConfiguration' {
- webCrawlerMode :: Maybe WebCrawlerMode
- seedUrls :: [Text]
}
newSeedUrlConfiguration :: SeedUrlConfiguration
seedUrlConfiguration_webCrawlerMode :: Lens' SeedUrlConfiguration (Maybe WebCrawlerMode)
seedUrlConfiguration_seedUrls :: Lens' SeedUrlConfiguration [Text]

Documentation

data SeedUrlConfiguration Source #

Provides the configuration information for the seed or starting point URLs to crawl.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newSeedUrlConfiguration smart constructor.

Constructors

SeedUrlConfiguration'

Fields

webCrawlerMode :: Maybe WebCrawlerMode
You can choose one of the following modes:
- HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
- SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
- EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.
The default mode is set to HOST_ONLY.
seedUrls :: [Text]
The list of seed or starting point URLs of the websites you want to crawl.
The list can include a maximum of 100 seed URLs.

Instances

Instances details

FromJSON SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods parseJSON :: Value -> Parser SeedUrlConfiguration # parseJSONList :: Value -> Parser [SeedUrlConfiguration] #
ToJSON SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods toJSON :: SeedUrlConfiguration -> Value # toEncoding :: SeedUrlConfiguration -> Encoding # toJSONList :: [SeedUrlConfiguration] -> Value # toEncodingList :: [SeedUrlConfiguration] -> Encoding #
Generic SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Associated Types type Rep SeedUrlConfiguration :: Type -> Type # Methods from :: SeedUrlConfiguration -> Rep SeedUrlConfiguration x # to :: Rep SeedUrlConfiguration x -> SeedUrlConfiguration #
Read SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods readsPrec :: Int -> ReadS SeedUrlConfiguration # readList :: ReadS [SeedUrlConfiguration] # readPrec :: ReadPrec SeedUrlConfiguration # readListPrec :: ReadPrec [SeedUrlConfiguration] #
Show SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods showsPrec :: Int -> SeedUrlConfiguration -> ShowS # show :: SeedUrlConfiguration -> String # showList :: [SeedUrlConfiguration] -> ShowS #
NFData SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods rnf :: SeedUrlConfiguration -> () #
Eq SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods (==) :: SeedUrlConfiguration -> SeedUrlConfiguration -> Bool # (/=) :: SeedUrlConfiguration -> SeedUrlConfiguration -> Bool #
Hashable SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods hashWithSalt :: Int -> SeedUrlConfiguration -> Int # hash :: SeedUrlConfiguration -> Int #
type Rep SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration type Rep SeedUrlConfiguration = D1 ('MetaData "SeedUrlConfiguration" "Amazonka.Kendra.Types.SeedUrlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SeedUrlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webCrawlerMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebCrawlerMode)) :*: S1 ('MetaSel ('Just "seedUrls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newSeedUrlConfiguration :: SeedUrlConfiguration Source #

Create a value of SeedUrlConfiguration 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:webCrawlerMode:SeedUrlConfiguration', seedUrlConfiguration_webCrawlerMode - You can choose one of the following modes:

HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

The default mode is set to HOST_ONLY.

$sel:seedUrls:SeedUrlConfiguration', seedUrlConfiguration_seedUrls - The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

seedUrlConfiguration_webCrawlerMode :: Lens' SeedUrlConfiguration (Maybe WebCrawlerMode) Source #

You can choose one of the following modes:

HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

The default mode is set to HOST_ONLY.

seedUrlConfiguration_seedUrls :: Lens' SeedUrlConfiguration [Text] Source #

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.