Skip to content

OAuth2ClientCredentialConfiguration

Source code in docs_src/capo_qbusiness/types/o_auth2_client_credential_configuration.py 
15
16
17
18
19
20
21
22
23
class OAuth2ClientCredentialConfiguration(TypedDict, closed=True):
    secret_arn: "capo_qbusiness.types.secret_arn.SecretArn"
    """<p>The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.</p>"""
    role_arn: "capo_qbusiness.types.role_arn.RoleArn"
    """<p>The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.</p>"""
    authorization_url: NotRequired["capo_qbusiness.types.url.Url"]
    """<p>The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.</p>"""
    token_url: NotRequired["capo_qbusiness.types.url.Url"]
    """<p>The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.</p>"""

authorization_url instance-attribute 

authorization_url: NotRequired[Url]

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

role_arn instance-attribute 

role_arn: RoleArn

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

secret_arn instance-attribute 

secret_arn: SecretArn

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

token_url instance-attribute 

token_url: NotRequired[Url]

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.