AWS API Changes

2024/06/24 - QBusiness - 3 updated api methods

Changes Allow enable/disable Q Apps when creating/updating a Q application; Return the Q Apps enablement information when getting a Q application.

CreateApplication (updated)

Link ¶
Changes (request)

{'qAppsConfiguration': {'qAppsControlMode': 'ENABLED | DISABLED'}}

Creates an Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

client.create_application(
    displayName='string',
    roleArn='string',
    identityCenterInstanceArn='string',
    description='string',
    encryptionConfiguration={
        'kmsKeyId': 'string'
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    clientToken='string',
    attachmentsConfiguration={
        'attachmentsControlMode': 'ENABLED'|'DISABLED'
    },
    qAppsConfiguration={
        'qAppsControlMode': 'ENABLED'|'DISABLED'
    }
)

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.

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

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)

{'qAppsConfiguration': {'qAppsControlMode': 'ENABLED | DISABLED'}}

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',
    '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'
    }
}

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.
- 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 data source sync error.
  - errorCode (string) --
    
    The code associated with the data source sync 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.

UpdateApplication (updated)

Link ¶
Changes (request)

{'qAppsConfiguration': {'qAppsControlMode': 'ENABLED | DISABLED'}}

Updates an existing Amazon Q Business application.