QBusiness

2024/10/15 - QBusiness - 3 updated api methods

Changes  Amazon Q Business now supports embedding the Amazon Q Business web experience on third-party websites.

CreateWebExperience (updated) Link ¶
Changes (request) 
{'origins': ['string']}

Creates an Amazon Q Business web experience.

See also: AWS API Documentation

Request Syntax

client.create_web_experience(
    applicationId='string',
    title='string',
    subtitle='string',
    welcomeMessage='string',
    samplePromptsControlMode='ENABLED'|'DISABLED',
    origins=[
        'string',
    ],
    roleArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    clientToken='string',
    identityProviderConfiguration={
        'samlConfiguration': {
            'authenticationUrl': 'string'
        },
        'openIDConnectConfiguration': {
            'secretsArn': 'string',
            'secretsRole': 'string'
        }
    }
)
type applicationId:

string

param applicationId:

[REQUIRED]

The identifier of the Amazon Q Business web experience.

type title:

string

param title:

The title for your Amazon Q Business web experience.

type subtitle:

string

param subtitle:

A subtitle to personalize your Amazon Q Business web experience.

type welcomeMessage:

string

param welcomeMessage:

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

type samplePromptsControlMode:

string

param samplePromptsControlMode:

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

type origins:

list

param origins:

Sets 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> <note> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </note>

  • (string) --

type roleArn:

string

param roleArn:

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

type tags:

list

param tags:

A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

  • (dict) --

    A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key (string) -- [REQUIRED]

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value (string) -- [REQUIRED]

      The value associated with the tag. The value may be an empty string but it can't be null.

type clientToken:

string

param clientToken:

A token you provide to identify a request to create an Amazon Q Business web experience.

This field is autopopulated if not provided.

type identityProviderConfiguration:

dict

param identityProviderConfiguration:

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

  • 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) -- [REQUIRED]

      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) -- [REQUIRED]

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

    • secretsRole (string) -- [REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'webExperienceId': 'string',
    'webExperienceArn': 'string'
}

Response Structure

  • (dict) --

    • webExperienceId (string) --

      The identifier of the Amazon Q Business web experience.

    • webExperienceArn (string) --

      The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

GetWebExperience (updated) Link ¶
Changes (response) 
{'origins': ['string']}

Gets information about an existing Amazon Q Business web experience.

See also: AWS API Documentation

Request Syntax

client.get_web_experience(
    applicationId='string',
    webExperienceId='string'
)
type applicationId:

string

param applicationId:

[REQUIRED]

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

type webExperienceId:

string

param webExperienceId:

[REQUIRED]

The identifier of the Amazon Q Business web experience.

rtype:

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.

      • 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.

      • 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.

UpdateWebExperience (updated) Link ¶
Changes (request) 
{'origins': ['string']}

Updates an Amazon Q Business web experience.

See also: AWS API Documentation

Request Syntax

client.update_web_experience(
    applicationId='string',
    webExperienceId='string',
    roleArn='string',
    authenticationConfiguration={
        'samlConfiguration': {
            'metadataXML': 'string',
            'roleArn': 'string',
            'userIdAttribute': 'string',
            'userGroupAttribute': 'string'
        }
    },
    title='string',
    subtitle='string',
    welcomeMessage='string',
    samplePromptsControlMode='ENABLED'|'DISABLED',
    identityProviderConfiguration={
        'samlConfiguration': {
            'authenticationUrl': 'string'
        },
        'openIDConnectConfiguration': {
            'secretsArn': 'string',
            'secretsRole': 'string'
        }
    },
    origins=[
        'string',
    ]
)
type applicationId:

string

param applicationId:

[REQUIRED]

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

type webExperienceId:

string

param webExperienceId:

[REQUIRED]

The identifier of the Amazon Q Business web experience.

type roleArn:

string

param roleArn:

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

type authenticationConfiguration:

dict

param authenticationConfiguration:

The authentication configuration of the Amazon Q Business web experience.

  • 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) -- [REQUIRED]

      The metadata XML that your IdP generated.

    • roleArn (string) -- [REQUIRED]

      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) -- [REQUIRED]

      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.

type title:

string

param title:

The title of the Amazon Q Business web experience.

type subtitle:

string

param subtitle:

The subtitle of the Amazon Q Business web experience.

type welcomeMessage:

string

param welcomeMessage:

A customized welcome message for an end user in an Amazon Q Business web experience.

type samplePromptsControlMode:

string

param samplePromptsControlMode:

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

type identityProviderConfiguration:

dict

param identityProviderConfiguration:

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

  • 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) -- [REQUIRED]

      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) -- [REQUIRED]

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

    • secretsRole (string) -- [REQUIRED]

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

type origins:

list

param origins:

Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --