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

UpdateQApp

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

Request Syntax


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

{
   "appDefinition": { 
      "cards": [ 
         { ... }
      ],
      "initialPrompt": "string"
   },
   "appId": "string",
   "description": "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 new definition specifying the cards and flow for the Q App.

Type: AppDefinitionInput object

Required: No

appId

The unique identifier of the Q App to update.

Type: String

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

Required: Yes

description

The new description for the Q App.

Type: String

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

Required: No

title

The new title for the Q App.

Type: String

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

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

Required: No

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 updated Q App.

Type: String

appId

The unique identifier of the updated Q App.

Type: String

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

appVersion

The new version of the updated Q App.

Type: Integer

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

createdAt

The date and time the Q App was originally created.

Type: Timestamp

createdBy

The user who originally created the Q App.

Type: String

description

The new description of the updated Q App.

Type: String

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

initialPrompt

The initial prompt for the updated Q App.

Type: String

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

requiredCapabilities

The capabilities required for the updated Q App.

Type: Array of strings

Valid Values: FileUpload | CreatorMode | RetrievalMode | PluginMode

status

The status of the updated Q App.

Type: String

Valid Values: PUBLISHED | DRAFT | DELETED

title

The new title of the updated 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

ContentTooLargeException

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

resourceId: The unique identifier of the resource
resourceType: The type of the resource

HTTP Status Code: 413

InternalServerException

An internal service error occurred while processing the request.

retryAfterSeconds: The number of seconds to wait before retrying the operation

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

resourceId: The unique identifier of the resource
resourceType: The type of the resource

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.

quotaCode: The code of the quota that was exceeded
retryAfterSeconds: The number of seconds to wait before retrying the operation
serviceCode: The code for the service where the quota was exceeded

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