| Column Name | Column Data Type |
|---|
application_id Required Input Column
The identifier of the Amazon Q Business application linked to the web experience. | VARCHAR |
web_experience_id Required Input Column
The identifier of the Amazon Q Business web experience. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
authentication_configuration
The authentication configuration information for your Amazon Q Business web experience. | STRUCT(
"saml_configuration" STRUCT(
"metadata_xml" VARCHAR,
"role_arn" VARCHAR,
"user_id_attribute" VARCHAR,
"user_group_attribute" VARCHAR
)
) |
Show child fields- authentication_configuration.saml_configuration
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience. Show child fields- authentication_configuration.saml_configuration.metadata_xml
The metadata XML that your IdP generated. - authentication_configuration.saml_configuration.role_arn
The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business. - authentication_configuration.saml_configuration.user_group_attribute
The group attribute name in your IdP that maps to user groups. - authentication_configuration.saml_configuration.user_id_attribute
The user attribute name in your IdP that maps to the user email.
|
created_at
The Unix timestamp when the Amazon Q Business web experience was last created. | TIMESTAMP_S |
default_endpoint
The endpoint of your Amazon Q Business web experience. | VARCHAR |
error
When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail. | STRUCT(
"error_message" VARCHAR,
"error_code" VARCHAR
) |
Show child fields- error.error_code
The code associated with the data source sync error. - error.error_message
The message explaining the data source sync error.
|
identity_provider_configuration
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. | STRUCT(
"saml_configuration" STRUCT(
"authentication_url" VARCHAR
),
"open_id_connect_configuration" STRUCT(
"secrets_arn" VARCHAR,
"secrets_role" VARCHAR
)
) |
Show child fields- identity_provider_configuration.open_id_connect_configuration
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. Show child fields- identity_provider_configuration.open_id_connect_configuration.secrets_arn
The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret. - identity_provider_configuration.open_id_connect_configuration.secrets_role
An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
- identity_provider_configuration.saml_configuration
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. Show child fields- identity_provider_configuration.saml_configuration.authentication_url
The URL where Amazon Q Business end users will be redirected for authentication.
|
role_arn
The Amazon Resource Name (ARN) of the service role attached to your web experience. | VARCHAR |
sample_prompts_control_mode
Determines whether sample prompts are enabled in the web experience for an end user. | VARCHAR |
status
The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail. | VARCHAR |
subtitle
The subtitle for your Amazon Q Business web experience. | VARCHAR |
title
The title for your Amazon Q Business web experience. | VARCHAR |
updated_at
The Unix timestamp when the Amazon Q Business web experience was last updated. | TIMESTAMP_S |
web_experience_arn
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources. | VARCHAR |
welcome_message
The customized welcome message for end users of an Amazon Q Business web experience. | VARCHAR |