aws_qbusiness_web_experience

account_id

Type: STRING

application_id

Type: STRING
Provider name: applicationId
Description: The identifier of the Amazon Q Business application linked to the web experience.

authentication_configuration

Type: STRUCT
Provider name: authenticationConfiguration
Description: The authentication configuration information for your Amazon Q Business web experience.

• saml_configuration
  Type: STRUCT
  Provider name: samlConfiguration
  
  • metadata_xml
    Type: STRING
    Provider name: metadataXML
    Description: The metadata XML that your IdP generated.
    
  • role_arn
    Type: STRING
    Provider name: roleArn
    Description: 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.
    
  • user_group_attribute
    Type: STRING
    Provider name: userGroupAttribute
    Description: The group attribute name in your IdP that maps to user groups.
    
  • user_id_attribute
    Type: STRING
    Provider name: userIdAttribute
    Description: The user attribute name in your IdP that maps to the user email.
    

browser_extension_configuration

Type: STRUCT
Provider name: browserExtensionConfiguration
Description: The browser extension configuration for an Amazon Q Business web experience.

• enabled_browser_extensions
  Type: UNORDERED_LIST_STRING
  Provider name: enabledBrowserExtensions
  Description: Specify the browser extensions allowed for your Amazon Q web experience.
  • CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
  • FIREFOX — Enables the extension for Mozilla Firefox.
  • CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The Unix timestamp when the Amazon Q Business web experience was last created.

customization_configuration

Type: STRUCT
Provider name: customizationConfiguration
Description: Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.

• custom_css_url
  Type: STRING
  Provider name: customCSSUrl
  Description: Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
  
• favicon_url
  Type: STRING
  Provider name: faviconUrl
  Description: Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
  
• font_url
  Type: STRING
  Provider name: fontUrl
  Description: Provides the URL where the custom font file is hosted for an Amazon Q web experience.
  
• logo_url
  Type: STRING
  Provider name: logoUrl
  Description: Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
  

default_endpoint

Type: STRING
Provider name: defaultEndpoint
Description: The endpoint of your Amazon Q Business web experience.

error

Type: STRUCT
Provider name: error
Description: When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

• error_code
  Type: STRING
  Provider name: errorCode
  Description: The code associated with the Amazon Q Business request error.
  
• error_message
  Type: STRING
  Provider name: errorMessage
  Description: The message explaining the Amazon Q Business request error.
  

identity_provider_configuration

Type: STRUCT
Provider name: identityProviderConfiguration
Description: Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

• open_id_connect_configuration
  Type: STRUCT
  Provider name: openIDConnectConfiguration
  
  • secrets_arn
    Type: STRING
    Provider name: secretsArn
    Description: The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
    
  • secrets_role
    Type: STRING
    Provider name: secretsRole
    Description: An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
    
• saml_configuration
  Type: STRUCT
  Provider name: samlConfiguration
  
  • authentication_url
    Type: STRING
    Provider name: authenticationUrl
    Description: The URL where Amazon Q Business end users will be redirected for authentication.
    

origins

Type: UNORDERED_LIST_STRING
Provider name: origins
Description: Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

role_arn

Type: STRING
Provider name: roleArn
Description: The Amazon Resource Name (ARN) of the service role attached to your web experience.

sample_prompts_control_mode

Type: STRING
Provider name: samplePromptsControlMode
Description: Determines whether sample prompts are enabled in the web experience for an end user.

status

Type: STRING
Provider name: status
Description: 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.

subtitle

Type: STRING
Provider name: subtitle
Description: The subtitle for your Amazon Q Business web experience.

tags

Type: UNORDERED_LIST_STRING

title

Type: STRING
Provider name: title
Description: The title for your Amazon Q Business web experience.

updated_at

Type: TIMESTAMP
Provider name: updatedAt
Description: The Unix timestamp when the Amazon Q Business web experience was last updated.

web_experience_arn

Type: STRING
Provider name: webExperienceArn
Description: The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

web_experience_id

Type: STRING
Provider name: webExperienceId
Description: The identifier of the Amazon Q Business web experience.

welcome_message

Type: STRING
Provider name: welcomeMessage
Description: The customized welcome message for end users of an Amazon Q Business web experience.