Struct rusoto_kendra::WebCrawlerConfiguration

pub struct WebCrawlerConfiguration {
    pub authentication_configuration: Option<AuthenticationConfiguration>,
    pub crawl_depth: Option<i64>,
    pub max_content_size_per_page_in_mega_bytes: Option<f32>,
    pub max_links_per_page: Option<i64>,
    pub max_urls_per_minute_crawl_rate: Option<i64>,
    pub proxy_configuration: Option<ProxyConfiguration>,
    pub url_exclusion_patterns: Option<Vec<String>>,
    pub url_inclusion_patterns: Option<Vec<String>>,
    pub urls: Urls,
}

Provides the configuration information required for Amazon Kendra web crawler.

Fields

authentication_configuration: Option<AuthenticationConfiguration>

Provides configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password.

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. You use a secret in AWS Secrets Manager to store your authentication credentials.

crawl_depth: Option<i64>

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.

max_content_size_per_page_in_mega_bytes: Option<f32>

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.

max_links_per_page: Option<i64>

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.

max_urls_per_minute_crawl_rate: Option<i64>

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.

proxy_configuration: Option<ProxyConfiguration>

Provides 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 AWS Secrets Manager.

url_exclusion_patterns: Option<Vec<String>>

The regular expression pattern to exclude certain URLs to crawl.

If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.

url_inclusion_patterns: Option<Vec<String>>

The regular expression pattern to include certain URLs to crawl.

If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.

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.

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 the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

Trait Implementations

impl Clone for WebCrawlerConfiguration

fn clone(&self) -> WebCrawlerConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebCrawlerConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebCrawlerConfiguration

fn default() -> WebCrawlerConfiguration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebCrawlerConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<WebCrawlerConfiguration> for WebCrawlerConfiguration

fn eq(&self, other: &WebCrawlerConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WebCrawlerConfiguration) -> bool

This method tests for !=.

impl Serialize for WebCrawlerConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebCrawlerConfiguration