Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetApplication

Gets information about an existing Amazon Q Business application.

Request Syntax


GET /applications/applicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of the Amazon Q Business application.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "applicationId": "string",
   "attachmentsConfiguration": { 
      "attachmentsControlMode": "string"
   },
   "autoSubscriptionConfiguration": { 
      "autoSubscribe": "string",
      "defaultSubscriptionType": "string"
   },
   "clientIdsForOIDC": [ "string" ],
   "createdAt": number,
   "description": "string",
   "displayName": "string",
   "encryptionConfiguration": { 
      "kmsKeyId": "string"
   },
   "error": { 
      "errorCode": "string",
      "errorMessage": "string"
   },
   "iamIdentityProviderArn": "string",
   "identityCenterApplicationArn": "string",
   "identityType": "string",
   "personalizationConfiguration": { 
      "personalizationControlMode": "string"
   },
   "qAppsConfiguration": { 
      "qAppsControlMode": "string"
   },
   "roleArn": "string",
   "status": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

applicationArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

applicationId

The identifier of the Amazon Q Business application.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

attachmentsConfiguration

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

Type: AppliedAttachmentsConfiguration object

autoSubscriptionConfiguration

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

Type: AutoSubscriptionConfiguration object

clientIdsForOIDC

The OIDC client ID for a Amazon Q Business application.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

createdAt

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

Type: Timestamp

description

A description for the Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: \P{C}*

displayName

The name of the Amazon Q Business application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

encryptionConfiguration

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

Type: EncryptionConfiguration object

error

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

Type: ErrorDetail object

iamIdentityProviderArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+

identityCenterApplicationArn

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}

identityType

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

Type: String

Valid Values: AWS_IAM_IDP_SAML | AWS_IAM_IDP_OIDC | AWS_IAM_IDC

personalizationConfiguration

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

Type: PersonalizationConfiguration object

qAppsConfiguration

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

Type: QAppsConfiguration object

roleArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

status

The status of the Amazon Q Business application.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED | UPDATING

updatedAt

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400