Class: Aws::Kendra::Types::WebCrawlerConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::WebCrawlerConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information required for Amazon Kendra Web Crawler.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authentication_configuration ⇒ Types::AuthenticationConfiguration

  Configuration information required to connect to websites using authentication.

• #crawl_depth ⇒ Integer

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

• #max_content_size_per_page_in_mega_bytes ⇒ Float

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

• #max_links_per_page ⇒ Integer

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

• #max_urls_per_minute_crawl_rate ⇒ Integer

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

• #proxy_configuration ⇒ Types::ProxyConfiguration

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

• #url_exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain URLs to crawl.

• #url_inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain URLs to crawl.

• #urls ⇒ Types::Urls

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

Instance Attribute Details

#authentication_configuration ⇒ Types::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.

Returns:

• (Types::AuthenticationConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_depth ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#max_content_size_per_page_in_mega_bytes ⇒ Float

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.

Returns:

• (Float)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#max_links_per_page ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#max_urls_per_minute_crawl_rate ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#proxy_configuration ⇒ Types::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.

Returns:

• (Types::ProxyConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#url_exclusion_patterns ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#url_inclusion_patterns ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#urls ⇒ Types::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.

Returns:

• (Types::Urls)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9711

class WebCrawlerConfiguration < Struct.new(
  :urls,
  :crawl_depth,
  :max_links_per_page,
  :max_content_size_per_page_in_mega_bytes,
  :max_urls_per_minute_crawl_rate,
  :url_inclusion_patterns,
  :url_exclusion_patterns,
  :proxy_configuration,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end