Skip to content

ProxyConfiguration

Source code in docs_src/capo_kendra/types/proxy_configuration.py 
15
16
17
18
19
20
21
class ProxyConfiguration(TypedDict, closed=True):
    host: "capo_kendra.types.host.Host"
    """<p>The name of the website host you want to connect to via a web proxy server.</p> <p>For example, the host name of https://a.example.com/page1.html is "a.example.com".</p>"""
    port: "capo_kendra.types.port.Port"
    """<p>The port number of the website host you want to connect to via a web proxy server. </p> <p>For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.</p>"""
    credentials: NotRequired["capo_kendra.types.secret_arn.SecretArn"]
    """<p>The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a secret to store your credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a> </p> <p>The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.</p>"""

credentials instance-attribute 

credentials: NotRequired[SecretArn]

The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a secret to store your credentials in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

host instance-attribute 

host: Host

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

port instance-attribute 

port: Port

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.