QBusiness / Client / get_web_experience
get_web_experience#
- QBusiness.Client.get_web_experience(**kwargs)#
Gets information about an existing Amazon Q web experience.
See also: AWS API Documentation
Request Syntax
response = client.get_web_experience( applicationId='string', webExperienceId='string' )
- Parameters:
applicationId (string) –
[REQUIRED]
The identifier of the Amazon Q application linked to the web experience.
webExperienceId (string) –
[REQUIRED]
The identifier of the Amazon Q web experience.
- Return type:
dict
- Returns:
Response Syntax
{ 'applicationId': 'string', 'authenticationConfiguration': { 'samlConfiguration': { 'metadataXML': 'string', 'roleArn': 'string', 'userGroupAttribute': 'string', 'userIdAttribute': 'string' } }, 'createdAt': datetime(2015, 1, 1), 'defaultEndpoint': 'string', 'error': { 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound', 'errorMessage': 'string' }, 'samplePromptsControlMode': 'ENABLED'|'DISABLED', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG', 'subtitle': 'string', 'title': 'string', 'updatedAt': datetime(2015, 1, 1), 'webExperienceArn': 'string', 'webExperienceId': 'string', 'welcomeMessage': 'string' }
Response Structure
(dict) –
applicationId (string) –
The identifier of the Amazon Q application linked to the web experience.
authenticationConfiguration (dict) –
The authentication configuration information for your Amazon Q web experience.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
samlConfiguration
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
samlConfiguration (dict) –
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.
metadataXML (string) –
The metadata XML that your IdP generated.
roleArn (string) –
The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q web experience, containing the relevant Amazon Q permissions for conversing with Amazon Q.
userGroupAttribute (string) –
The group attribute name in your IdP that maps to user groups.
userIdAttribute (string) –
The user attribute name in your IdP that maps to the user email.
createdAt (datetime) –
The Unix timestamp when the retriever was created.
defaultEndpoint (string) –
The endpoint of your Amazon Q web experience.
error (dict) –
When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.errorCode (string) –
The code associated with the data source sync error.
errorMessage (string) –
The message explaining the data source sync error.
samplePromptsControlMode (string) –
Determines whether sample prompts are enabled in the web experience for an end user.
status (string) –
The current status of the Amazon Q web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.subtitle (string) –
The subtitle for your Amazon Q web experience.
title (string) –
The title for your Amazon Q web experience.
updatedAt (datetime) –
The Unix timestamp when the data source connector was last updated.
webExperienceArn (string) –
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
webExperienceId (string) –
The identifier of the Amazon Q web experience.
welcomeMessage (string) –
The customized welcome message for end users of an Amazon Q web experience.
Exceptions
QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException