WebCrawlerParameters
The parameters for a web crawler data source.
Contents
Note
In the following list, the required parameters are described first.
- 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.
Type: String
Valid Values:
NO_AUTH | BASIC_AUTH | FORM | SAML
Required: Yes
-
- LoginPageUrl
-
The URL of the login page for the web crawler to authenticate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- PasswordButtonXpath
-
The XPath expression for locating the password submit button on the login page.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- PasswordFieldXpath
-
The XPath expression for locating the password field on the login page.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- UsernameButtonXpath
-
The XPath expression for locating the username submit button on the login page.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- UsernameFieldXpath
-
The XPath expression for locating the username field on the login page.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- WebProxyHostName
-
The hostname of the web proxy server for the web crawler.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- WebProxyPortNumber
-
The port number of the web proxy server for the web crawler.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65535.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: