Skip to content

OAuth2ClientCredentialConfigurationDict

Dictionary Type

OAuth2ClientCredentialConfigurationDict

Bases: TypedDict

Dictionary form of OAuth2ClientCredentialConfiguration.

Attributes

authorization_url instance-attribute
authorization_url: str | None

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: Required[str]

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: Required[str]

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: str | None

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