QBusiness / Client / get_application

get_application

QBusiness.Client.get_application(**kwargs)

Gets information about an existing Amazon Q Business application.

See also: AWS API Documentation

Request Syntax

response = client.get_application(
    applicationId='string'
)

Parameters:

applicationId (string) –

[REQUIRED]

The identifier of the Amazon Q Business application.

Return type:

dict

Returns:

Response Syntax

{
    'displayName': 'string',
    'applicationId': 'string',
    'applicationArn': 'string',
    'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC',
    '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',
    ]
}

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

  • 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) –

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException