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.Urls

Description

Synopsis

Documentation

data Urls Source #

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

/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: newUrls smart constructor.

Constructors

Urls'

Fields

seedUrlConfiguration :: Maybe SeedUrlConfiguration
Configuration of the seed or starting point URLs of the websites you want to crawl.
You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.
You can list up to 100 seed URLs.
siteMapsConfiguration :: Maybe SiteMapsConfiguration
Configuration of the sitemap URLs of the websites you want to crawl.
Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

Instances

Instances details

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

newUrls :: Urls Source #

Create a value of Urls 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:seedUrlConfiguration:Urls', urls_seedUrlConfiguration - Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

You can list up to 100 seed URLs.

$sel:siteMapsConfiguration:Urls', urls_siteMapsConfiguration - Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

urls_seedUrlConfiguration :: Lens' Urls (Maybe SeedUrlConfiguration) Source #

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

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

You can list up to 100 seed URLs.

urls_siteMapsConfiguration :: Lens' Urls (Maybe SiteMapsConfiguration) Source #

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.