Skip to content

Bedrock Agent  >  Structures  >  WebCrawlerConfiguration

WebCrawlerConfiguration

Structure Class

WebCrawlerConfiguration dataclass

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

Attributes

crawler_limits class-attribute instance-attribute
crawler_limits: WebCrawlerLimits | None = None

The configuration of crawl limits for the web URLs.

exclusion_filters class-attribute instance-attribute
exclusion_filters: list[str] | None = field(repr=False, default=None)

A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn't crawled.

inclusion_filters class-attribute instance-attribute
inclusion_filters: list[str] | None = field(repr=False, default=None)

A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn't crawled.

scope class-attribute instance-attribute
scope: WebScopeType | None = None

The scope of what is crawled for your URLs.

You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".

user_agent class-attribute instance-attribute
user_agent: str | None = field(repr=False, default=None)

Returns the user agent suffix for your web crawler.

user_agent_header class-attribute instance-attribute
user_agent_header: str | None = field(repr=False, default=None)

A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the bedrockbot, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to bedrockbot_UUID. You can optionally append a custom suffix to bedrockbot_UUID to allowlist a specific user agent permitted to access your source URLs.