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

CreateQApp

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.

Request Syntax


POST /apps.create HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "appDefinition": { 
      "cards": [ 
         { ... }
      ],
      "initialPrompt": "string"
   },
   "description": "string",
   "tags": { 
      "string" : "string" 
   },
   "title": "string"
}

URI Request Parameters

The request uses the following URI parameters.

instanceId

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

appDefinition

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

Type: AppDefinitionInput object

Required: Yes

description

The description of the new Q App.

Type: String

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

Required: No

tags

Optional tags to associate with the new Q App.

Type: String to string map

Required: No

title

The title of the new Q App.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "appArn": "string",
   "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 new Q App.

Type: String

appId

The unique identifier of the new Q App.

Type: String

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

appVersion

The version of the new 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 new 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 new Q App, such as "Created".

Type: String

Valid Values: PUBLISHED | DRAFT | DELETED

title

The title of the new Q App.

Type: String

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

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

ConflictException

The requested operation could not be completed due to a conflict with the current state of the resource.

HTTP Status Code: 409

ContentTooLargeException

The requested operation could not be completed because the content exceeds the maximum allowed size.

HTTP Status Code: 413

InternalServerException

An internal service error occurred while processing the request.

HTTP Status Code: 500

ServiceQuotaExceededException

The requested operation could not be completed because it would exceed the service's quota or limit.

HTTP Status Code: 402

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