ServiceNowConfiguration ¶

class ServiceNowConfiguration(TypedDict, closed=True):
    host_url: "capo_kendra.types.service_now_host_url.ServiceNowHostUrl"
    """<p>The ServiceNow instance that the data source connects to. The host endpoint should look like the following: <i>{instance}.service-now.com.</i> </p>"""
    secret_arn: "capo_kendra.types.secret_arn.SecretArn"
    """<p>The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a ServiceNow data source</a>.</p>"""
    service_now_build_version: (
        "capo_kendra.types.service_now_build_version_type.ServiceNowBuildVersionType"
    )
    """<p>The identifier of the release that the ServiceNow host is running. If the host is not running the <code>LONDON</code> release, use <code>OTHERS</code>.</p>"""
    knowledge_article_configuration: NotRequired[
        "capo_kendra.types.service_now_knowledge_article_configuration.ServiceNowKnowledgeArticleConfiguration"
    ]
    """<p>Configuration information for crawling knowledge articles in the ServiceNow site.</p>"""
    service_catalog_configuration: NotRequired[
        "capo_kendra.types.service_now_service_catalog_configuration.ServiceNowServiceCatalogConfiguration"
    ]
    """<p>Configuration information for crawling service catalogs in the ServiceNow site.</p>"""
    authentication_type: NotRequired[
        "capo_kendra.types.service_now_authentication_type.ServiceNowAuthenticationType"
    ]
    """<p>The type of authentication used to connect to the ServiceNow instance. If you choose <code>HTTP_BASIC</code>, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the <code>SecretArn</code> field. If you choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.</p> <p>When you use <code>OAUTH2</code> authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html">Using a ServiceNow data source</a>.</p>"""