GetApplicationCommand

Suggest an Edit

Gets information about an existing Amazon Q Business application.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, GetApplicationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetApplicationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetApplicationRequest
  applicationId: "STRING_VALUE", // required
};
const command = new GetApplicationCommand(input);
const response = await client.send(command);
// { // GetApplicationResponse
//   displayName: "STRING_VALUE",
//   applicationId: "STRING_VALUE",
//   applicationArn: "STRING_VALUE",
//   identityType: "AWS_IAM_IDP_SAML" || "AWS_IAM_IDP_OIDC" || "AWS_IAM_IDC" || "AWS_QUICKSIGHT_IDP",
//   iamIdentityProviderArn: "STRING_VALUE",
//   identityCenterApplicationArn: "STRING_VALUE",
//   roleArn: "STRING_VALUE",
//   status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
//   description: "STRING_VALUE",
//   encryptionConfiguration: { // EncryptionConfiguration
//     kmsKeyId: "STRING_VALUE",
//   },
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   error: { // ErrorDetail
//     errorMessage: "STRING_VALUE",
//     errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
//   },
//   attachmentsConfiguration: { // AppliedAttachmentsConfiguration
//     attachmentsControlMode: "ENABLED" || "DISABLED",
//   },
//   qAppsConfiguration: { // QAppsConfiguration
//     qAppsControlMode: "ENABLED" || "DISABLED", // required
//   },
//   personalizationConfiguration: { // PersonalizationConfiguration
//     personalizationControlMode: "ENABLED" || "DISABLED", // required
//   },
//   autoSubscriptionConfiguration: { // AutoSubscriptionConfiguration
//     autoSubscribe: "ENABLED" || "DISABLED", // required
//     defaultSubscriptionType: "Q_LITE" || "Q_BUSINESS",
//   },
//   clientIdsForOIDC: [ // ClientIdsForOIDC
//     "STRING_VALUE",
//   ],
//   quickSightConfiguration: { // QuickSightConfiguration
//     clientNamespace: "STRING_VALUE", // required
//   },
// };

GetApplicationCommand Input

See GetApplicationCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the Amazon Q Business application.

GetApplicationCommand Output

See GetApplicationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applicationArn
string | undefined

The Amazon Resource Name (ARN) of the Amazon Q Business application.

applicationId
string | undefined

The identifier of the Amazon Q Business application.

attachmentsConfiguration
AppliedAttachmentsConfiguration | undefined

Settings for whether end users can upload files directly during chat.

autoSubscriptionConfiguration
AutoSubscriptionConfiguration | undefined

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

clientIdsForOIDC
string[] | undefined

The OIDC client ID for a Amazon Q Business application.

createdAt
Date | undefined

The Unix timestamp when the Amazon Q Business application was last updated.

description
string | undefined

A description for the Amazon Q Business application.

displayName
string | undefined

The name of the Amazon Q Business application.

encryptionConfiguration
EncryptionConfiguration | undefined

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

error
ErrorDetail | undefined

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

iamIdentityProviderArn
string | undefined

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

identityCenterApplicationArn
string | undefined

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

identityType
IdentityType | undefined

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

personalizationConfiguration
PersonalizationConfiguration | undefined

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

qAppsConfiguration
QAppsConfiguration | undefined

Settings for whether end users can create and use Amazon Q Apps in the web experience.

quickSightConfiguration
QuickSightConfiguration | undefined

The Amazon QuickSight authentication configuration for the Amazon Q Business application.

roleArn
string | undefined

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

status
ApplicationStatus | undefined

The status of the Amazon Q Business application.

updatedAt
Date | undefined

The Unix timestamp when the Amazon Q Business application was last updated.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.