QBusiness / Client / update_application

update_application#

QBusiness.Client.update_application(**kwargs)#

Updates an existing Amazon Q Business application.

Note

Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.update_application(
    applicationId='string',
    identityCenterInstanceArn='string',
    displayName='string',
    description='string',
    roleArn='string',
    attachmentsConfiguration={
        'attachmentsControlMode': 'ENABLED'|'DISABLED'
    },
    qAppsConfiguration={
        'qAppsControlMode': 'ENABLED'|'DISABLED'
    },
    personalizationConfiguration={
        'personalizationControlMode': 'ENABLED'|'DISABLED'
    },
    autoSubscriptionConfiguration={
        'autoSubscribe': 'ENABLED'|'DISABLED',
        'defaultSubscriptionType': 'Q_LITE'|'Q_BUSINESS'
    }
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business application.

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

  • displayName (string) – A name for the Amazon Q Business application.

  • description (string) – A description for the Amazon Q Business application.

  • roleArn (string) – An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.

  • attachmentsConfiguration (dict) –

    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.

  • qAppsConfiguration (dict) –

    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.

  • personalizationConfiguration (dict) –

    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.

  • autoSubscriptionConfiguration (dict) –

    An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

    • autoSubscribe (string) – [REQUIRED]

      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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • QBusiness.Client.exceptions.ResourceNotFoundException

  • QBusiness.Client.exceptions.InternalServerException

  • QBusiness.Client.exceptions.ConflictException

  • QBusiness.Client.exceptions.ThrottlingException

  • QBusiness.Client.exceptions.ValidationException

  • QBusiness.Client.exceptions.AccessDeniedException