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

GetQApp

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

Request Syntax


GET /apps.get?appId=appId HTTP/1.1
instance-id: instanceId

URI Request Parameters

The request uses the following URI parameters.

appId

The unique identifier of the Q App to retrieve.

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

Required: Yes

instanceId

The unique identifier of the Amazon Q Business application environment instance.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appArn": "string",
   "appDefinition": { 
      "appDefinitionVersion": "string",
      "canEdit": boolean,
      "cards": [ 
         { ... }
      ]
   },
   "appId": "string",
   "appVersion": number,
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "initialPrompt": "string",
   "requiredCapabilities": [ "string" ],
   "status": "string",
   "title": "string",
   "updatedAt": "string",
   "updatedBy": "string"
}

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.

appArn

The Amazon Resource Name (ARN) of the Q App.

Type: String

appDefinition

The full definition of the Q App, specifying the cards and flow.

Type: AppDefinition object

appId

The unique identifier of the Q App.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

appVersion

The version of the Q App.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

createdAt

The date and time the Q App was created.

Type: Timestamp

createdBy

The user who created the Q App.

Type: String

description

The description of the Q App.

Type: String

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

initialPrompt

The initial prompt displayed when the Q App is started.

Type: String

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

requiredCapabilities

The capabilities required to run the Q App, such as file upload or third-party integrations.

Type: Array of strings

Valid Values: FileUpload | CreatorMode | RetrievalMode | PluginMode

status

The status of the Q App.

Type: String

Valid Values: PUBLISHED | DRAFT | DELETED

title

The title of the Q App.

Type: String

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

Pattern: [^{}\\"<>]+

updatedAt

The date and time the Q App was last updated.

Type: Timestamp

updatedBy

The user who last updated the Q App.

Type: String

Errors

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

AccessDeniedException

The client is not authorized to perform the requested operation.

HTTP Status Code: 403

InternalServerException

An internal service error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

ThrottlingException

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

HTTP Status Code: 429

UnauthorizedException

The client is not authenticated or authorized to perform the requested operation.

HTTP Status Code: 401

ValidationException

The input failed to satisfy the constraints specified by the service.

HTTP Status Code: 400