Skip to content

WebCrawlerParameters

Source code in docs_src/capo_quicksight/types/web_crawler_parameters.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class WebCrawlerParameters(TypedDict, closed=True):
    web_crawler_auth_type: (
        "capo_quicksight.types.web_crawler_auth_type.WebCrawlerAuthType"
    )
    """<p>The authentication type for the web crawler. The type can be one of the following:</p> <ul> <li> <p> <code>NO_AUTH</code>: No authentication required.</p> </li> <li> <p> <code>BASIC_AUTH</code>: Basic authentication using username and password.</p> </li> <li> <p> <code>SAML</code>: SAML-based authentication.</p> </li> <li> <p> <code>FORM</code>: Form-based authentication.</p> </li> </ul>"""
    username_field_xpath: NotRequired["capo_quicksight.types.xpath_fields.XpathFields"]
    """<p>The XPath expression for locating the username field on the login page.</p>"""
    password_field_xpath: NotRequired["capo_quicksight.types.xpath_fields.XpathFields"]
    """<p>The XPath expression for locating the password field on the login page.</p>"""
    username_button_xpath: NotRequired["capo_quicksight.types.xpath_fields.XpathFields"]
    """<p>The XPath expression for locating the username submit button on the login page.</p>"""
    password_button_xpath: NotRequired["capo_quicksight.types.xpath_fields.XpathFields"]
    """<p>The XPath expression for locating the password submit button on the login page.</p>"""
    login_page_url: NotRequired["capo_quicksight.types.site_base_url.SiteBaseUrl"]
    """<p>The URL of the login page for the web crawler to authenticate.</p>"""
    web_proxy_host_name: NotRequired["capo_quicksight.types.host.Host"]
    """<p>The hostname of the web proxy server for the web crawler.</p>"""
    web_proxy_port_number: "capo_quicksight.types.optional_port.OptionalPort"
    """<p>The port number of the web proxy server for the web crawler.</p>"""

login_page_url instance-attribute 

login_page_url: NotRequired[SiteBaseUrl]

The URL of the login page for the web crawler to authenticate.

password_button_xpath instance-attribute 

password_button_xpath: NotRequired[XpathFields]

The XPath expression for locating the password submit button on the login page.

password_field_xpath instance-attribute 

password_field_xpath: NotRequired[XpathFields]

The XPath expression for locating the password field on the login page.

username_button_xpath instance-attribute 

username_button_xpath: NotRequired[XpathFields]

The XPath expression for locating the username submit button on the login page.

username_field_xpath instance-attribute 

username_field_xpath: NotRequired[XpathFields]

The XPath expression for locating the username field on the login page.

web_crawler_auth_type instance-attribute 

web_crawler_auth_type: WebCrawlerAuthType

The authentication type for the web crawler. The type can be one of the following:

  • NO_AUTH: No authentication required.

  • BASIC_AUTH: Basic authentication using username and password.

  • SAML: SAML-based authentication.

  • FORM: Form-based authentication.

web_proxy_host_name instance-attribute 

web_proxy_host_name: NotRequired[Host]

The hostname of the web proxy server for the web crawler.

web_proxy_port_number instance-attribute 

web_proxy_port_number: OptionalPort

The port number of the web proxy server for the web crawler.