QBusiness / Client / get_web_experience

get_web_experience

QBusiness.Client.get_web_experience(**kwargs)

Gets information about an existing Amazon Q Business 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 Business application linked to the web experience.

• webExperienceId (string) –

  [REQUIRED]

  The identifier of the Amazon Q Business web experience.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'webExperienceId': 'string',
    'webExperienceArn': 'string',
    'defaultEndpoint': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'title': 'string',
    'subtitle': 'string',
    'welcomeMessage': 'string',
    'samplePromptsControlMode': 'ENABLED'|'DISABLED',
    'origins': [
        'string',
    ],
    'roleArn': 'string',
    'identityProviderConfiguration': {
        'samlConfiguration': {
            'authenticationUrl': 'string'
        },
        'openIDConnectConfiguration': {
            'secretsArn': 'string',
            'secretsRole': 'string'
        }
    },
    'authenticationConfiguration': {
        'samlConfiguration': {
            'metadataXML': 'string',
            'roleArn': 'string',
            'userIdAttribute': 'string',
            'userGroupAttribute': 'string'
        }
    },
    'error': {
        'errorMessage': 'string',
        'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
    }
}

Response Structure

• (dict) –

  • applicationId (string) –

    The identifier of the Amazon Q Business application linked to the web experience.

  • webExperienceId (string) –

    The identifier of the Amazon Q Business web experience.

  • webExperienceArn (string) –

    The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

  • defaultEndpoint (string) –

    The endpoint of your Amazon Q Business web experience.

  • status (string) –

    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.

  • createdAt (datetime) –

    The Unix timestamp when the Amazon Q Business web experience was last created.

  • updatedAt (datetime) –

    The Unix timestamp when the Amazon Q Business web experience was last updated.

  • title (string) –

    The title for your Amazon Q Business web experience.

  • subtitle (string) –

    The subtitle for your Amazon Q Business web experience.

  • welcomeMessage (string) –

    The customized welcome message for end users of an Amazon Q Business web experience.

  • samplePromptsControlMode (string) –

    Determines whether sample prompts are enabled in the web experience for an end user.

  • origins (list) –

    Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p>

    • (string) –

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

  • identityProviderConfiguration (dict) –

    Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: samlConfiguration, openIDConnectConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • samlConfiguration (dict) –

      Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      • authenticationUrl (string) –

        The URL where Amazon Q Business end users will be redirected for authentication.

    • openIDConnectConfiguration (dict) –

      Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      • secretsArn (string) –

        The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.

      • secretsRole (string) –

        An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.

  • authenticationConfiguration (dict) –

    The authentication configuration information for your Amazon Q Business 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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 Business needs to deploy a Amazon Q Business 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 Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

      • userIdAttribute (string) –

        The user attribute name in your IdP that maps to the user email.

      • userGroupAttribute (string) –

        The group attribute name in your IdP that maps to user groups.

  • error (dict) –

    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

    • errorMessage (string) –

      The message explaining the data source sync error.

    • errorCode (string) –

      The code associated with the data source sync error.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException