---
title: "GET /applications/{applicationId}"
method: GET
path: "/applications/{applicationId}"
---

# GET /applications/{applicationId}

`GET /applications/{applicationId}`

Gets information about an existing Amazon Q Business application.

## Path parameters

- `applicationId` string, required

## Response `200`

Success

- GetApplicationResponse
  - `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` 'AWS_IAM_IDP_SAML' | 'AWS_IAM_IDP_OIDC' | 'AWS_IAM_IDC' | 'AWS_QUICKSIGHT_IDP' | 'ANONYMOUS' — 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` 'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'UPDATING' — The status of the Amazon Q Business application.
  - `description` string — A description for the Amazon Q Business application.
  - `encryptionConfiguration` object — 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, password — The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
  - `createdAt` string, date-time — The Unix timestamp when the Amazon Q Business application was last updated.
  - `updatedAt` string, date-time — The Unix timestamp when the Amazon Q Business application was last updated.
  - `error` object — If the <code>Status</code> field is set to <code>ERROR</code>, the <code>ErrorMessage</code> 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` 'InternalError' | 'InvalidRequest' | 'ResourceInactive' | 'ResourceNotFound' — The code associated with the Amazon Q Business request error.
  - `attachmentsConfiguration` object — Settings for whether end users can upload files directly during chat.
    - `attachmentsControlMode` 'ENABLED' | 'DISABLED' — Information about whether file upload during chat functionality is activated for your application.
  - `qAppsConfiguration` object — Settings for whether end users can create and use Amazon Q Apps in the web experience.
    - `qAppsControlMode` 'ENABLED' | 'DISABLED', required — Status information about whether end users can create and use Amazon Q Apps in the web experience.
  - `personalizationConfiguration` object — Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.
    - `personalizationControlMode` 'ENABLED' | 'DISABLED', 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` object — Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
    - `autoSubscribe` 'ENABLED' | 'DISABLED', required — Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
    - `defaultSubscriptionType` 'Q_LITE' | 'Q_BUSINESS' — Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for <code>autoSubscribe</code> is set to <code>ENABLED</code> you must select a value for this field.
  - `clientIdsForOIDC` ClientIdForOIDC[] — The OIDC client ID for a Amazon Q Business application.
  - `quickSightConfiguration` object — The Amazon Quick Suite authentication configuration for the Amazon Q Business application.
    - `clientNamespace` string, required — The Amazon Quick Suite namespace that is used as the identity provider. For more information about Quick Suite namespaces, see <a href="https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html">Namespace operations</a>.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/versions/82966d6c4053/schema)