Amazonka.Kendra.Types.WebCrawlerConfiguration

Documentation

data WebCrawlerConfiguration

Provides the configuration information required for Amazon Kendra Web Crawler.

See: newWebCrawlerConfiguration smart constructor.

Constructors

WebCrawlerConfiguration'

Fields

• authenticationConfiguration :: Maybe AuthenticationConfiguration

  Configuration information required to connect to websites using authentication.

  You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

  You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

• crawlDepth :: Maybe Natural

  Specifies the number of levels in a website that you want to crawl.

  The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

  The default crawl depth is set to 2.

• maxContentSizePerPageInMegaBytes :: Maybe Double

  The maximum size (in MB) of a webpage or attachment to crawl.

  Files larger than this size (in MB) are skipped/not crawled.

  The default maximum size of a webpage or attachment is set to 50 MB.

• maxLinksPerPage :: Maybe Natural

  The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

  As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

  The default maximum links per page is 100.

• maxUrlsPerMinuteCrawlRate :: Maybe Natural

  The maximum number of URLs crawled per website host per minute.

  A minimum of one URL is required.

  The default maximum number of URLs crawled per website host per minute is 300.

• proxyConfiguration :: Maybe ProxyConfiguration

  Configuration information required to connect to your internal websites via a web proxy.

  You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

  Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

• urlExclusionPatterns :: Maybe [Text]

  A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

• urlInclusionPatterns :: Maybe [Text]

  A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

• urls :: Urls

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

  You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

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

Instances

FromJSON WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

parseJSON :: Value -> Parser WebCrawlerConfiguration

parseJSONList :: Value -> Parser [WebCrawlerConfiguration]

ToJSON WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

toJSON :: WebCrawlerConfiguration -> Value

toEncoding :: WebCrawlerConfiguration -> Encoding

toJSONList :: [WebCrawlerConfiguration] -> Value

toEncodingList :: [WebCrawlerConfiguration] -> Encoding

Generic WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Associated Types

type Rep WebCrawlerConfiguration :: Type -> Type

Methods

from :: WebCrawlerConfiguration -> Rep WebCrawlerConfiguration x

to :: Rep WebCrawlerConfiguration x -> WebCrawlerConfiguration

Read WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

readsPrec :: Int -> ReadS WebCrawlerConfiguration

readList :: ReadS [WebCrawlerConfiguration]

readPrec :: ReadPrec WebCrawlerConfiguration

readListPrec :: ReadPrec [WebCrawlerConfiguration]

Show WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

showsPrec :: Int -> WebCrawlerConfiguration -> ShowS

show :: WebCrawlerConfiguration -> String

showList :: [WebCrawlerConfiguration] -> ShowS

NFData WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

rnf :: WebCrawlerConfiguration -> ()

Eq WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

(==) :: WebCrawlerConfiguration -> WebCrawlerConfiguration -> Bool

(/=) :: WebCrawlerConfiguration -> WebCrawlerConfiguration -> Bool

Hashable WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

hashWithSalt :: Int -> WebCrawlerConfiguration -> Int

hash :: WebCrawlerConfiguration -> Int

type Rep WebCrawlerConfiguration

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

type Rep WebCrawlerConfiguration = D1 ('MetaData "WebCrawlerConfiguration" "Amazonka.Kendra.Types.WebCrawlerConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "WebCrawlerConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationConfiguration)) :*: S1 ('MetaSel ('Just "crawlDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "maxContentSizePerPageInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "maxLinksPerPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "maxUrlsPerMinuteCrawlRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration))) :*: (S1 ('MetaSel ('Just "urlExclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "urlInclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "urls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Urls))))))

newWebCrawlerConfiguration

Arguments

:: Urls

$sel:urls:WebCrawlerConfiguration'

-> WebCrawlerConfiguration

Create a value of WebCrawlerConfiguration 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:authenticationConfiguration:WebCrawlerConfiguration', webCrawlerConfiguration_authenticationConfiguration - Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

$sel:crawlDepth:WebCrawlerConfiguration', webCrawlerConfiguration_crawlDepth - Specifies the number of levels in a website that you want to crawl.

The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

The default crawl depth is set to 2.

$sel:maxContentSizePerPageInMegaBytes:WebCrawlerConfiguration', webCrawlerConfiguration_maxContentSizePerPageInMegaBytes - The maximum size (in MB) of a webpage or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a webpage or attachment is set to 50 MB.

$sel:maxLinksPerPage:WebCrawlerConfiguration', webCrawlerConfiguration_maxLinksPerPage - The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

The default maximum links per page is 100.

$sel:maxUrlsPerMinuteCrawlRate:WebCrawlerConfiguration', webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate - The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

$sel:proxyConfiguration:WebCrawlerConfiguration', webCrawlerConfiguration_proxyConfiguration - Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

$sel:urlExclusionPatterns:WebCrawlerConfiguration', webCrawlerConfiguration_urlExclusionPatterns - A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

$sel:urlInclusionPatterns:WebCrawlerConfiguration', webCrawlerConfiguration_urlInclusionPatterns - A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

$sel:urls:WebCrawlerConfiguration', webCrawlerConfiguration_urls - Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

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

webCrawlerConfiguration_authenticationConfiguration :: Lens' WebCrawlerConfiguration (Maybe AuthenticationConfiguration)

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

webCrawlerConfiguration_crawlDepth :: Lens' WebCrawlerConfiguration (Maybe Natural)

Specifies the number of levels in a website that you want to crawl.

The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

The default crawl depth is set to 2.

webCrawlerConfiguration_maxContentSizePerPageInMegaBytes :: Lens' WebCrawlerConfiguration (Maybe Double)

The maximum size (in MB) of a webpage or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a webpage or attachment is set to 50 MB.

webCrawlerConfiguration_maxLinksPerPage :: Lens' WebCrawlerConfiguration (Maybe Natural)

The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

The default maximum links per page is 100.

webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate :: Lens' WebCrawlerConfiguration (Maybe Natural)

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

webCrawlerConfiguration_proxyConfiguration :: Lens' WebCrawlerConfiguration (Maybe ProxyConfiguration)

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

webCrawlerConfiguration_urlExclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text])

A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

webCrawlerConfiguration_urlInclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text])

A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

webCrawlerConfiguration_urls :: Lens' WebCrawlerConfiguration Urls

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

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

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