AWS API Changes

2025/04/29 - QBusiness - 1 new3 updated api methods

Changes Add support for anonymous user access for Q Business applications

CreateAnonymousWebExperienceUrl (new)

Link ¶

Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.

See also: AWS API Documentation

Request Syntax

client.create_anonymous_web_experience_url(
    applicationId='string',
    webExperienceId='string',
    sessionDurationInMinutes=123
)

type applicationId:

string

param applicationId:

[REQUIRED]

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

type webExperienceId:

string

param webExperienceId:

[REQUIRED]

The identifier of the web experience.

type sessionDurationInMinutes:

integer

param sessionDurationInMinutes:

The duration of the session associated with the unique URL for the web experience.

rtype:

dict

returns:

Response Syntax

{
    'anonymousUrl': 'string'
}

Response Structure

(dict) --
- anonymousUrl (string) --
  
  The unique URL for accessing the web experience.
  
  Warning
  
  This URL can only be used once and must be used within 5 minutes after it's generated.

CreateApplication (updated)

Link ¶
Changes (request)

{'identityType': {'ANONYMOUS'}}

Creates an Amazon Q Business application.

Note

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

See also: AWS API Documentation

Request Syntax

client.create_application(
    displayName='string',
    roleArn='string',
    identityType='AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS',
    iamIdentityProviderArn='string',
    identityCenterInstanceArn='string',
    clientIdsForOIDC=[
        'string',
    ],
    description='string',
    encryptionConfiguration={
        'kmsKeyId': 'string'
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    clientToken='string',
    attachmentsConfiguration={
        'attachmentsControlMode': 'ENABLED'|'DISABLED'
    },
    qAppsConfiguration={
        'qAppsControlMode': 'ENABLED'|'DISABLED'
    },
    personalizationConfiguration={
        'personalizationControlMode': 'ENABLED'|'DISABLED'
    },
    quickSightConfiguration={
        'clientNamespace': 'string'
    }
)

type displayName:

string

param displayName:

[REQUIRED]

A name for the Amazon Q Business application.

type roleArn:

string

param roleArn:

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.

type identityType:

string

param identityType:

The authentication type being used by a Amazon Q Business application.

type iamIdentityProviderArn:

string

param iamIdentityProviderArn:

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

type identityCenterInstanceArn:

string

param identityCenterInstanceArn:

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

type clientIdsForOIDC:

list

param clientIdsForOIDC:

The OIDC client ID for a Amazon Q Business application.

(string) --

type description:

string

param description:

A description for the Amazon Q Business application.

type encryptionConfiguration:

dict

param encryptionConfiguration:

The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

kmsKeyId (string) --

The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.

type tags:

list

param tags:

A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. 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 that you provide to identify the request to create your Amazon Q Business application.

This field is autopopulated if not provided.

type attachmentsConfiguration:

dict

param attachmentsConfiguration:

An option to allow end users to upload files directly during chat.

attachmentsControlMode (string) -- [REQUIRED]

Status information about whether file upload functionality is activated or deactivated for your end user.

type qAppsConfiguration:

dict

param qAppsConfiguration:

An option to allow end users to create and use Amazon Q Apps in the web experience.

qAppsControlMode (string) -- [REQUIRED]

Status information about whether end users can create and use Amazon Q Apps in the web experience.

type personalizationConfiguration:

dict

param personalizationConfiguration:

Configuration information about chat response personalization. For more information, see Personalizing chat responses

personalizationControlMode (string) -- [REQUIRED]

An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.

type quickSightConfiguration:

dict

param quickSightConfiguration:

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

clientNamespace (string) -- [REQUIRED]

The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.

rtype:

dict

returns:

Response Syntax

{
    'applicationId': 'string',
    'applicationArn': 'string'
}

Response Structure

(dict) --
- applicationId (string) --
  
  The identifier of the Amazon Q Business application.
- applicationArn (string) --
  
  The Amazon Resource Name (ARN) of the Amazon Q Business application.

GetApplication (updated)

Link ¶
Changes (response)

{'identityType': {'ANONYMOUS'}}

Gets information about an existing Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

client.get_application(
    applicationId='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The identifier of the Amazon Q Business application.

rtype:

dict

returns:

Response Syntax

{
    'displayName': 'string',
    'applicationId': 'string',
    'applicationArn': 'string',
    'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS',
    'iamIdentityProviderArn': 'string',
    'identityCenterApplicationArn': 'string',
    'roleArn': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
    'description': 'string',
    'encryptionConfiguration': {
        'kmsKeyId': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'error': {
        'errorMessage': 'string',
        'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
    },
    'attachmentsConfiguration': {
        'attachmentsControlMode': 'ENABLED'|'DISABLED'
    },
    'qAppsConfiguration': {
        'qAppsControlMode': 'ENABLED'|'DISABLED'
    },
    'personalizationConfiguration': {
        'personalizationControlMode': 'ENABLED'|'DISABLED'
    },
    'autoSubscriptionConfiguration': {
        'autoSubscribe': 'ENABLED'|'DISABLED',
        'defaultSubscriptionType': 'Q_LITE'|'Q_BUSINESS'
    },
    'clientIdsForOIDC': [
        'string',
    ],
    'quickSightConfiguration': {
        'clientNamespace': 'string'
    }
}

Response Structure

(dict) --
- displayName (string) --
  
  The name of the Amazon Q Business application.
- applicationId (string) --
  
  The identifier of the Amazon Q Business application.
- applicationArn (string) --
  
  The Amazon Resource Name (ARN) of the Amazon Q Business application.
- identityType (string) --
  
  The authentication type being used by a Amazon Q Business application.
- iamIdentityProviderArn (string) --
  
  The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
- identityCenterApplicationArn (string) --
  
  The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
- roleArn (string) --
  
  The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
- status (string) --
  
  The status of the Amazon Q Business application.
- description (string) --
  
  A description for the Amazon Q Business application.
- encryptionConfiguration (dict) --
  
  The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
  - kmsKeyId (string) --
    
    The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
- createdAt (datetime) --
  
  The Unix timestamp when the Amazon Q Business application was last updated.
- updatedAt (datetime) --
  
  The Unix timestamp when the Amazon Q Business application was last updated.
- error (dict) --
  
  If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
  - errorMessage (string) --
    
    The message explaining the Amazon Q Business request error.
  - errorCode (string) --
    
    The code associated with the Amazon Q Business request error.
- attachmentsConfiguration (dict) --
  
  Settings for whether end users can upload files directly during chat.
  - attachmentsControlMode (string) --
    
    Information about whether file upload during chat functionality is activated for your application.
- qAppsConfiguration (dict) --
  
  Settings for whether end users can create and use Amazon Q Apps in the web experience.
  - qAppsControlMode (string) --
    
    Status information about whether end users can create and use Amazon Q Apps in the web experience.
- personalizationConfiguration (dict) --
  
  Configuration information about chat response personalization. For more information, see Personalizing chat responses.
  - personalizationControlMode (string) --
    
    An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
- autoSubscriptionConfiguration (dict) --
  
  Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
  - autoSubscribe (string) --
    
    Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
  - defaultSubscriptionType (string) --
    
    Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
- clientIdsForOIDC (list) --
  
  The OIDC client ID for a Amazon Q Business application.
  - (string) --
- quickSightConfiguration (dict) --
  
  The Amazon QuickSight authentication configuration for the Amazon Q Business application.
  - clientNamespace (string) --
    
    The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.

ListApplications (updated)

Link ¶
Changes (response)

{'applications': {'identityType': {'ANONYMOUS'}}}

Lists Amazon Q Business applications.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

type maxResults:

integer

param maxResults:

The maximum number of Amazon Q Business applications to return.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'applications': [
        {
            'displayName': 'string',
            'applicationId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
            'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS',
            'quickSightConfiguration': {
                'clientNamespace': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
- applications (list) --
  
  An array of summary information on the configuration of one or more Amazon Q Business applications.
  - (dict) --
    
    Summary information for an Amazon Q Business application.
    - displayName (string) --
      
      The name of the Amazon Q Business application.
    - applicationId (string) --
      
      The identifier for the Amazon Q Business application.
    - createdAt (datetime) --
      
      The Unix timestamp when the Amazon Q Business application was created.
    - updatedAt (datetime) --
      
      The Unix timestamp when the Amazon Q Business application was last updated.
    - status (string) --
      
      The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.
    - identityType (string) --
      
      The authentication type being used by a Amazon Q Business application.
    - quickSightConfiguration (dict) --
      
      The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
      - clientNamespace (string) --
        
        The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.