# QApps The following actions are supported by QApps: + [AssociateLibraryItemReview](API_qapps_AssociateLibraryItemReview.md) + [AssociateQAppWithUser](API_qapps_AssociateQAppWithUser.md) + [BatchCreateCategory](API_qapps_BatchCreateCategory.md) + [BatchDeleteCategory](API_qapps_BatchDeleteCategory.md) + [BatchUpdateCategory](API_qapps_BatchUpdateCategory.md) + [CreateLibraryItem](API_qapps_CreateLibraryItem.md) + [CreatePresignedUrl](API_qapps_CreatePresignedUrl.md) + [CreateQApp](API_qapps_CreateQApp.md) + [DeleteLibraryItem](API_qapps_DeleteLibraryItem.md) + [DeleteQApp](API_qapps_DeleteQApp.md) + [DescribeQAppPermissions](API_qapps_DescribeQAppPermissions.md) + [DisassociateLibraryItemReview](API_qapps_DisassociateLibraryItemReview.md) + [DisassociateQAppFromUser](API_qapps_DisassociateQAppFromUser.md) + [ExportQAppSessionData](API_qapps_ExportQAppSessionData.md) + [GetLibraryItem](API_qapps_GetLibraryItem.md) + [GetQApp](API_qapps_GetQApp.md) + [GetQAppSession](API_qapps_GetQAppSession.md) + [GetQAppSessionMetadata](API_qapps_GetQAppSessionMetadata.md) + [ImportDocument](API_qapps_ImportDocument.md) + [ListCategories](API_qapps_ListCategories.md) + [ListLibraryItems](API_qapps_ListLibraryItems.md) + [ListQApps](API_qapps_ListQApps.md) + [ListQAppSessionData](API_qapps_ListQAppSessionData.md) + [ListTagsForResource](API_qapps_ListTagsForResource.md) + [PredictQApp](API_qapps_PredictQApp.md) + [StartQAppSession](API_qapps_StartQAppSession.md) + [StopQAppSession](API_qapps_StopQAppSession.md) + [TagResource](API_qapps_TagResource.md) + [UntagResource](API_qapps_UntagResource.md) + [UpdateLibraryItem](API_qapps_UpdateLibraryItem.md) + [UpdateLibraryItemMetadata](API_qapps_UpdateLibraryItemMetadata.md) + [UpdateQApp](API_qapps_UpdateQApp.md) + [UpdateQAppPermissions](API_qapps_UpdateQAppPermissions.md) + [UpdateQAppSession](API_qapps_UpdateQAppSession.md) + [UpdateQAppSessionMetadata](API_qapps_UpdateQAppSessionMetadata.md) # AssociateLibraryItemReview Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item. ## Request Syntax ``` POST /catalog.associateItemRating HTTP/1.1 instance-id: instanceId Content-type: application/json { "libraryItemId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_AssociateLibraryItemReview_RequestSyntax) ** The unique identifier for the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [libraryItemId](#API_qapps_AssociateLibraryItemReview_RequestSyntax) ** The unique identifier of the library item to associate the review with. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/AssociateLibraryItemReview) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/AssociateLibraryItemReview) # AssociateQAppWithUser This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a *favorite* for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps. ## Request Syntax ``` POST /apps.install HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_AssociateQAppWithUser_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_AssociateQAppWithUser_RequestSyntax) ** The ID of the Amazon Q App to associate with the user. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/AssociateQAppWithUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/AssociateQAppWithUser) # BatchCreateCategory Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html). ## Request Syntax ``` POST /catalog.createCategories HTTP/1.1 instance-id: instanceId Content-type: application/json { "categories": [ { "color": "string", "id": "string", "title": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_BatchCreateCategory_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [categories](#API_qapps_BatchCreateCategory_RequestSyntax) ** The list of category objects to be created Type: Array of [BatchCreateCategoryInputCategory](API_qapps_BatchCreateCategoryInputCategory.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/BatchCreateCategory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/BatchCreateCategory) # BatchDeleteCategory Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html). ## Request Syntax ``` POST /catalog.deleteCategories HTTP/1.1 instance-id: instanceId Content-type: application/json { "categories": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_BatchDeleteCategory_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [categories](#API_qapps_BatchDeleteCategory_RequestSyntax) ** The list of IDs of the categories to be deleted. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/BatchDeleteCategory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/BatchDeleteCategory) # BatchUpdateCategory Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html). ## Request Syntax ``` POST /catalog.updateCategories HTTP/1.1 instance-id: instanceId Content-type: application/json { "categories": [ { "color": "string", "id": "string", "title": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_BatchUpdateCategory_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [categories](#API_qapps_BatchUpdateCategory_RequestSyntax) ** The list of categories to be updated with their new values. Type: Array of [CategoryInput](API_qapps_CategoryInput.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/BatchUpdateCategory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/BatchUpdateCategory) # CreateLibraryItem Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users. ## Request Syntax ``` POST /catalog.createItem HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string", "appVersion": number, "categories": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_CreateLibraryItem_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_CreateLibraryItem_RequestSyntax) ** The unique identifier of the Amazon Q App to publish to the library. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [appVersion](#API_qapps_CreateLibraryItem_RequestSyntax) ** The version of the Amazon Q App to publish to the library. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: Yes ** [categories](#API_qapps_CreateLibraryItem_RequestSyntax) ** The categories to associate with the library item for easier discovery. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "createdBy": "string", "isVerified": boolean, "libraryItemId": "string", "ratingCount": number, "status": "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. ** [createdAt](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The date and time the library item was created. Type: Timestamp ** [createdBy](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The user who created the library item. Type: String ** [isVerified](#API_qapps_CreateLibraryItem_ResponseSyntax) ** Indicates whether the library item has been verified. Type: Boolean ** [libraryItemId](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The unique identifier of the new library item. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [ratingCount](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The number of ratings the library item has received from users. Type: Integer ** [status](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The status of the new library item, such as "Published". Type: String ** [updatedAt](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The date and time the library item was last updated. Type: Timestamp ** [updatedBy](#API_qapps_CreateLibraryItem_ResponseSyntax) ** The user who last updated the library item. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/CreateLibraryItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/CreateLibraryItem) # CreatePresignedUrl Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a `FileUploadCard` in a Q App definition or to provide a file for a single Q App run. The `scope` parameter determines how the file will be used, either at the app definition level or the app session level. **Note** The IAM permissions are derived from the `qapps:ImportDocument` action. For more information on the IAM policy for Amazon Q Apps, see [IAM permissions for using Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-q-apps-iam-permissions.html). ## Request Syntax ``` POST /apps.createPresignedUrl HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string", "cardId": "string", "fileContentsSha256": "string", "fileName": "string", "scope": "string", "sessionId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_CreatePresignedUrl_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_CreatePresignedUrl_RequestSyntax) ** The unique identifier of the Q App the file is associated with. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [cardId](#API_qapps_CreatePresignedUrl_RequestSyntax) ** The unique identifier of the card the file is associated with. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [fileContentsSha256](#API_qapps_CreatePresignedUrl_RequestSyntax) ** The Base64-encoded SHA-256 digest of the contents of the file to be uploaded. Type: String Pattern: `[A-Za-z0-9+/]{43}=$|^[A-Za-z0-9+/]{42}==$|^[A-Za-z0-9+/]{44}` Required: Yes ** [fileName](#API_qapps_CreatePresignedUrl_RequestSyntax) ** The name of the file to be uploaded. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: Yes ** [scope](#API_qapps_CreatePresignedUrl_RequestSyntax) ** Whether the file is associated with a Q App definition or a specific Q App session. Type: String Valid Values: `APPLICATION | SESSION` Required: Yes ** [sessionId](#API_qapps_CreatePresignedUrl_RequestSyntax) ** The unique identifier of the Q App session the file is associated with, if applicable. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "fileId": "string", "presignedUrl": "string", "presignedUrlExpiration": "string", "presignedUrlFields": { "string" : "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. ** [fileId](#API_qapps_CreatePresignedUrl_ResponseSyntax) ** The unique identifier assigned to the file to be uploaded. Type: String ** [presignedUrl](#API_qapps_CreatePresignedUrl_ResponseSyntax) ** The URL for a presigned S3 POST operation used to upload a file. Type: String ** [presignedUrlExpiration](#API_qapps_CreatePresignedUrl_ResponseSyntax) ** The date and time that the presigned URL will expire in ISO 8601 format. Type: Timestamp ** [presignedUrlFields](#API_qapps_CreatePresignedUrl_ResponseSyntax) ** The form fields to include in the presigned S3 POST operation used to upload a file. Type: String to string map ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** retryAfterSeconds ** The number of seconds to wait before retrying the operation HTTP Status Code: 500 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/CreatePresignedUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/CreatePresignedUrl) # 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](#API_qapps_CreateQApp_RequestSyntax) ** 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](#API_qapps_CreateQApp_RequestSyntax) ** The definition of the new Q App, specifying the cards and flow. Type: [AppDefinitionInput](API_qapps_AppDefinitionInput.md) object Required: Yes ** [description](#API_qapps_CreateQApp_RequestSyntax) ** The description of the new Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No ** [tags](#API_qapps_CreateQApp_RequestSyntax) ** Optional tags to associate with the new Q App. Type: String to string map Required: No ** [title](#API_qapps_CreateQApp_RequestSyntax) ** The title of the new Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `[^{}\\"<>]+` 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](#API_qapps_CreateQApp_ResponseSyntax) ** The Amazon Resource Name (ARN) of the new Q App. Type: String ** [appId](#API_qapps_CreateQApp_ResponseSyntax) ** The unique identifier of the new Q App. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [appVersion](#API_qapps_CreateQApp_ResponseSyntax) ** The version of the new Q App. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [createdAt](#API_qapps_CreateQApp_ResponseSyntax) ** The date and time the Q App was created. Type: Timestamp ** [createdBy](#API_qapps_CreateQApp_ResponseSyntax) ** The user who created the Q App. Type: String ** [description](#API_qapps_CreateQApp_ResponseSyntax) ** The description of the new Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [initialPrompt](#API_qapps_CreateQApp_ResponseSyntax) ** The initial prompt displayed when the Q App is started. Type: String Length Constraints: Minimum length of 0. Maximum length of 10000. ** [requiredCapabilities](#API_qapps_CreateQApp_ResponseSyntax) ** 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](#API_qapps_CreateQApp_ResponseSyntax) ** The status of the new Q App, such as "Created". Type: String Valid Values: `PUBLISHED | DRAFT | DELETED` ** [title](#API_qapps_CreateQApp_ResponseSyntax) ** The title of the new Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `[^{}\\"<>]+` ** [updatedAt](#API_qapps_CreateQApp_ResponseSyntax) ** The date and time the Q App was last updated. Type: Timestamp ** [updatedBy](#API_qapps_CreateQApp_ResponseSyntax) ** The user who last updated the Q App. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/CreateQApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/CreateQApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/CreateQApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/CreateQApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/CreateQApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/CreateQApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/CreateQApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/CreateQApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/CreateQApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/CreateQApp) # DeleteLibraryItem Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users. ## Request Syntax ``` POST /catalog.deleteItem HTTP/1.1 instance-id: instanceId Content-type: application/json { "libraryItemId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_DeleteLibraryItem_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [libraryItemId](#API_qapps_DeleteLibraryItem_RequestSyntax) ** The unique identifier of the library item to delete. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/DeleteLibraryItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/DeleteLibraryItem) # DeleteQApp Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library. ## Request Syntax ``` POST /apps.delete HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_DeleteQApp_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_DeleteQApp_RequestSyntax) ** The unique identifier of the Q App to delete. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/DeleteQApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/DeleteQApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/DeleteQApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/DeleteQApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/DeleteQApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/DeleteQApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/DeleteQApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/DeleteQApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/DeleteQApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/DeleteQApp) # DescribeQAppPermissions Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance. ## Request Syntax ``` GET /apps.describeQAppPermissions?appId=appId HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [appId](#API_qapps_DescribeQAppPermissions_RequestSyntax) ** The unique identifier of the Amazon Q App for which to retrieve permissions. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [instanceId](#API_qapps_DescribeQAppPermissions_RequestSyntax) ** 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 { "appId": "string", "permissions": [ { "action": "string", "principal": { "email": "string", "userId": "string", "userType": "string" } } ], "resourceArn": "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. ** [appId](#API_qapps_DescribeQAppPermissions_ResponseSyntax) ** The unique identifier of the Amazon Q App for which permissions are returned. Type: String ** [permissions](#API_qapps_DescribeQAppPermissions_ResponseSyntax) ** The list of permissions granted for the Amazon Q App. Type: Array of [PermissionOutput](API_qapps_PermissionOutput.md) objects ** [resourceArn](#API_qapps_DescribeQAppPermissions_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/DescribeQAppPermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/DescribeQAppPermissions) # DisassociateLibraryItemReview Removes a rating or review previously submitted by the user for a library item. ## Request Syntax ``` POST /catalog.disassociateItemRating HTTP/1.1 instance-id: instanceId Content-type: application/json { "libraryItemId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_DisassociateLibraryItemReview_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [libraryItemId](#API_qapps_DisassociateLibraryItemReview_RequestSyntax) ** The unique identifier of the library item to remove the review from. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/DisassociateLibraryItemReview) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/DisassociateLibraryItemReview) # DisassociateQAppFromUser Disassociates a Q App from a user removing the user's access to run the Q App. ## Request Syntax ``` POST /apps.uninstall HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_DisassociateQAppFromUser_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_DisassociateQAppFromUser_RequestSyntax) ** The unique identifier of the Q App to disassociate from the user. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/DisassociateQAppFromUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/DisassociateQAppFromUser) # ExportQAppSessionData Exports the collected data of a Q App data collection session. ## Request Syntax ``` POST /runtime.exportQAppSessionData HTTP/1.1 instance-id: instanceId Content-type: application/json { "sessionId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_ExportQAppSessionData_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [sessionId](#API_qapps_ExportQAppSessionData_RequestSyntax) ** The unique identifier of the Q App data collection session. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "csvFileLink": "string", "expiresAt": "string", "sessionArn": "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. ** [csvFileLink](#API_qapps_ExportQAppSessionData_ResponseSyntax) ** The link where the exported Q App session data can be downloaded from. Type: String ** [expiresAt](#API_qapps_ExportQAppSessionData_ResponseSyntax) ** The date and time when the link for the exported Q App session data expires. Type: Timestamp ** [sessionArn](#API_qapps_ExportQAppSessionData_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Q App data collection session. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ExportQAppSessionData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ExportQAppSessionData) # GetLibraryItem Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics. ## Request Syntax ``` GET /catalog.getItem?appId=appId&libraryItemId=libraryItemId HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [appId](#API_qapps_GetLibraryItem_RequestSyntax) ** The unique identifier of the Amazon Q App associated with the library item. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [instanceId](#API_qapps_GetLibraryItem_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ** [libraryItemId](#API_qapps_GetLibraryItem_RequestSyntax) ** The unique identifier of the library item to retrieve. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appId": "string", "appVersion": number, "categories": [ { "appCount": number, "color": "string", "id": "string", "title": "string" } ], "createdAt": "string", "createdBy": "string", "isRatedByUser": boolean, "isVerified": boolean, "libraryItemId": "string", "ratingCount": number, "status": "string", "updatedAt": "string", "updatedBy": "string", "userCount": 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. ** [appId](#API_qapps_GetLibraryItem_ResponseSyntax) ** The unique identifier of the Q App associated with the library item. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [appVersion](#API_qapps_GetLibraryItem_ResponseSyntax) ** The version of the Q App associated with the library item. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [categories](#API_qapps_GetLibraryItem_ResponseSyntax) ** The categories associated with the library item for discovery. Type: Array of [Category](API_qapps_Category.md) objects Array Members: Minimum number of 0 items. Maximum number of 3 items. ** [createdAt](#API_qapps_GetLibraryItem_ResponseSyntax) ** The date and time the library item was created. Type: Timestamp ** [createdBy](#API_qapps_GetLibraryItem_ResponseSyntax) ** The user who created the library item. Type: String ** [isRatedByUser](#API_qapps_GetLibraryItem_ResponseSyntax) ** Whether the current user has rated the library item. Type: Boolean ** [isVerified](#API_qapps_GetLibraryItem_ResponseSyntax) ** Indicates whether the library item has been verified. Type: Boolean ** [libraryItemId](#API_qapps_GetLibraryItem_ResponseSyntax) ** The unique identifier of the library item. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [ratingCount](#API_qapps_GetLibraryItem_ResponseSyntax) ** The number of ratings the library item has received from users. Type: Integer ** [status](#API_qapps_GetLibraryItem_ResponseSyntax) ** The status of the library item, such as "Published". Type: String ** [updatedAt](#API_qapps_GetLibraryItem_ResponseSyntax) ** The date and time the library item was last updated. Type: Timestamp ** [updatedBy](#API_qapps_GetLibraryItem_ResponseSyntax) ** The user who last updated the library item. Type: String ** [userCount](#API_qapps_GetLibraryItem_ResponseSyntax) ** The number of users who have associated the Q App with their account. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/GetLibraryItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/GetLibraryItem) # GetQApp Retrieves the full details of an Q App, including its definition specifying the cards and flow. ## Request Syntax ``` GET /apps.get?appId=appId&appVersion=appVersion HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [appId](#API_qapps_GetQApp_RequestSyntax) ** 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 ** [appVersion](#API_qapps_GetQApp_RequestSyntax) ** The version of the Q App. Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [instanceId](#API_qapps_GetQApp_RequestSyntax) ** 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](#API_qapps_GetQApp_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Q App. Type: String ** [appDefinition](#API_qapps_GetQApp_ResponseSyntax) ** The full definition of the Q App, specifying the cards and flow. Type: [AppDefinition](API_qapps_AppDefinition.md) object ** [appId](#API_qapps_GetQApp_ResponseSyntax) ** 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](#API_qapps_GetQApp_ResponseSyntax) ** The version of the Q App. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [createdAt](#API_qapps_GetQApp_ResponseSyntax) ** The date and time the Q App was created. Type: Timestamp ** [createdBy](#API_qapps_GetQApp_ResponseSyntax) ** The user who created the Q App. Type: String ** [description](#API_qapps_GetQApp_ResponseSyntax) ** The description of the Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [initialPrompt](#API_qapps_GetQApp_ResponseSyntax) ** The initial prompt displayed when the Q App is started. Type: String Length Constraints: Minimum length of 0. Maximum length of 10000. ** [requiredCapabilities](#API_qapps_GetQApp_ResponseSyntax) ** 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](#API_qapps_GetQApp_ResponseSyntax) ** The status of the Q App. Type: String Valid Values: `PUBLISHED | DRAFT | DELETED` ** [title](#API_qapps_GetQApp_ResponseSyntax) ** The title of the Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `[^{}\\"<>]+` ** [updatedAt](#API_qapps_GetQApp_ResponseSyntax) ** The date and time the Q App was last updated. Type: Timestamp ** [updatedBy](#API_qapps_GetQApp_ResponseSyntax) ** The user who last updated the Q App. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/GetQApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/GetQApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/GetQApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/GetQApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/GetQApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/GetQApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/GetQApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/GetQApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/GetQApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/GetQApp) # GetQAppSession Retrieves the current state and results for an active session of an Amazon Q App. ## Request Syntax ``` GET /runtime.getQAppSession?sessionId=sessionId HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_GetQAppSession_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ** [sessionId](#API_qapps_GetQAppSession_RequestSyntax) ** The unique identifier of the Q App session to retrieve. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appVersion": number, "cardStatus": { "string" : { "currentState": "string", "currentValue": "string", "submissions": [ { "submissionId": "string", "timestamp": "string", "value": JSON value } ] } }, "latestPublishedAppVersion": number, "sessionArn": "string", "sessionId": "string", "sessionName": "string", "status": "string", "userIsHost": boolean } ``` ## 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. ** [appVersion](#API_qapps_GetQAppSession_ResponseSyntax) ** The version of the Q App used for the session. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [cardStatus](#API_qapps_GetQAppSession_ResponseSyntax) ** The current status for each card in the Q App session. Type: String to [CardStatus](API_qapps_CardStatus.md) object map Key Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [latestPublishedAppVersion](#API_qapps_GetQAppSession_ResponseSyntax) ** The latest published version of the Q App used for the session. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [sessionArn](#API_qapps_GetQAppSession_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Q App session. Type: String ** [sessionId](#API_qapps_GetQAppSession_ResponseSyntax) ** The unique identifier of the Q App session. Type: String ** [sessionName](#API_qapps_GetQAppSession_ResponseSyntax) ** The name of the Q App session. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. ** [status](#API_qapps_GetQAppSession_ResponseSyntax) ** The current status of the Q App session. Type: String Valid Values: `IN_PROGRESS | WAITING | COMPLETED | ERROR` ** [userIsHost](#API_qapps_GetQAppSession_ResponseSyntax) ** Indicates whether the current user is the owner of the Q App data collection session. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/GetQAppSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/GetQAppSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/GetQAppSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/GetQAppSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/GetQAppSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/GetQAppSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/GetQAppSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/GetQAppSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/GetQAppSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/GetQAppSession) # GetQAppSessionMetadata Retrieves the current configuration of a Q App session. ## Request Syntax ``` GET /runtime.getQAppSessionMetadata?sessionId=sessionId HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_GetQAppSessionMetadata_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ** [sessionId](#API_qapps_GetQAppSessionMetadata_RequestSyntax) ** The unique identifier of the Q App session. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "sessionArn": "string", "sessionId": "string", "sessionName": "string", "sessionOwner": boolean, "sharingConfiguration": { "acceptResponses": boolean, "enabled": boolean, "revealCards": boolean } } ``` ## 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. ** [sessionArn](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Q App session. Type: String ** [sessionId](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) ** The unique identifier of the Q App session. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [sessionName](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) ** The name of the Q App session. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. ** [sessionOwner](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) ** Indicates whether the current user is the owner of the Q App session. Type: Boolean ** [sharingConfiguration](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) ** The sharing configuration of the Q App data collection session. Type: [SessionSharingConfiguration](API_qapps_SessionSharingConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/GetQAppSessionMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/GetQAppSessionMetadata) # ImportDocument Uploads a file that can then be used either as a default in a `FileUploadCard` from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level. ## Request Syntax ``` POST /apps.importDocument HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string", "cardId": "string", "fileContentsBase64": "string", "fileName": "string", "scope": "string", "sessionId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_ImportDocument_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_ImportDocument_RequestSyntax) ** The unique identifier of the Q App the file is associated with. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [cardId](#API_qapps_ImportDocument_RequestSyntax) ** The unique identifier of the card the file is associated with. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [fileContentsBase64](#API_qapps_ImportDocument_RequestSyntax) ** The base64-encoded contents of the file to upload. Type: String Required: Yes ** [fileName](#API_qapps_ImportDocument_RequestSyntax) ** The name of the file being uploaded. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: Yes ** [scope](#API_qapps_ImportDocument_RequestSyntax) ** Whether the file is associated with a Q App definition or a specific Q App session. Type: String Valid Values: `APPLICATION | SESSION` Required: Yes ** [sessionId](#API_qapps_ImportDocument_RequestSyntax) ** The unique identifier of the Q App session the file is associated with, if applicable. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "fileId": "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. ** [fileId](#API_qapps_ImportDocument_ResponseSyntax) ** The unique identifier assigned to the uploaded file. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ImportDocument) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ImportDocument) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ImportDocument) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ImportDocument) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ImportDocument) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ImportDocument) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ImportDocument) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ImportDocument) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ImportDocument) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ImportDocument) # ListCategories Lists the categories of a Amazon Q Business application environment instance. For more information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html). ## Request Syntax ``` GET /catalog.listCategories HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_ListCategories_RequestSyntax) ** 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 { "categories": [ { "appCount": number, "color": "string", "id": "string", "title": "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. ** [categories](#API_qapps_ListCategories_ResponseSyntax) ** The categories of a Amazon Q Business application environment instance. Type: Array of [Category](API_qapps_Category.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ListCategories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ListCategories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ListCategories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ListCategories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ListCategories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ListCategories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ListCategories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ListCategories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ListCategories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ListCategories) # ListLibraryItems Lists the library items for Amazon Q Apps that are published and available for users in your AWS account. ## Request Syntax ``` GET /catalog.list?categoryId=categoryId&limit=limit&nextToken=nextToken HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [categoryId](#API_qapps_ListLibraryItems_RequestSyntax) ** Optional category to filter the library items by. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [instanceId](#API_qapps_ListLibraryItems_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ** [limit](#API_qapps_ListLibraryItems_RequestSyntax) ** The maximum number of library items to return in the response. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_qapps_ListLibraryItems_RequestSyntax) ** The token to request the next page of results. Length Constraints: Minimum length of 0. Maximum length of 300. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "libraryItems": [ { "appId": "string", "appVersion": number, "categories": [ { "appCount": number, "color": "string", "id": "string", "title": "string" } ], "createdAt": "string", "createdBy": "string", "isRatedByUser": boolean, "isVerified": boolean, "libraryItemId": "string", "ratingCount": number, "status": "string", "updatedAt": "string", "updatedBy": "string", "userCount": number } ], "nextToken": "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. ** [libraryItems](#API_qapps_ListLibraryItems_ResponseSyntax) ** The list of library items meeting the request criteria. Type: Array of [LibraryItemMember](API_qapps_LibraryItemMember.md) objects ** [nextToken](#API_qapps_ListLibraryItems_ResponseSyntax) ** The token to use to request the next page of results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ListLibraryItems) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ListLibraryItems) # ListQApps Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation.. ## Request Syntax ``` GET /apps.list?limit=limit&nextToken=nextToken HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_ListQApps_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ** [limit](#API_qapps_ListQApps_RequestSyntax) ** The maximum number of Q Apps to return in the response. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_qapps_ListQApps_RequestSyntax) ** The token to request the next page of results. Length Constraints: Minimum length of 0. Maximum length of 300. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "apps": [ { "appArn": "string", "appId": "string", "canEdit": boolean, "createdAt": "string", "description": "string", "isVerified": boolean, "status": "string", "title": "string" } ], "nextToken": "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. ** [apps](#API_qapps_ListQApps_ResponseSyntax) ** The list of Amazon Q Apps meeting the request criteria. Type: Array of [UserAppItem](API_qapps_UserAppItem.md) objects ** [nextToken](#API_qapps_ListQApps_ResponseSyntax) ** The token to use to request the next page of results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** retryAfterSeconds ** The number of seconds to wait before retrying the operation HTTP Status Code: 500 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ListQApps) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ListQApps) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ListQApps) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ListQApps) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ListQApps) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ListQApps) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ListQApps) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ListQApps) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ListQApps) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ListQApps) # ListQAppSessionData Lists the collected data of a Q App data collection session. ## Request Syntax ``` GET /runtime.listQAppSessionData?sessionId=sessionId HTTP/1.1 instance-id: instanceId ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_ListQAppSessionData_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ** [sessionId](#API_qapps_ListQAppSessionData_RequestSyntax) ** The unique identifier of the Q App data collection session. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "sessionArn": "string", "sessionData": [ { "cardId": "string", "submissionId": "string", "timestamp": "string", "user": { "userId": "string" }, "value": JSON value } ], "sessionId": "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. ** [nextToken](#API_qapps_ListQAppSessionData_ResponseSyntax) ** The pagination token that indicates the next set of results to retrieve. Type: String ** [sessionArn](#API_qapps_ListQAppSessionData_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Q App data collection session. Type: String ** [sessionData](#API_qapps_ListQAppSessionData_ResponseSyntax) ** The collected responses of a Q App session. Type: Array of [QAppSessionData](API_qapps_QAppSessionData.md) objects ** [sessionId](#API_qapps_ListQAppSessionData_ResponseSyntax) ** The unique identifier of the Q App data collection session. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ListQAppSessionData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ListQAppSessionData) # ListTagsForResource Lists the tags associated with an Amazon Q Apps resource. ## Request Syntax ``` GET /tags/resourceARN HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceARN](#API_qapps_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource whose tags should be listed. Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "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. ** [tags](#API_qapps_ListTagsForResource_ResponseSyntax) ** The list of tags that are assigned to the resource. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ValidationException ** The input failed to satisfy the constraints specified by the service. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/ListTagsForResource) # PredictQApp Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call `CreateQApp`. This API doesn't create Amazon Q Apps directly. ## Request Syntax ``` POST /apps.predictQApp HTTP/1.1 instance-id: instanceId Content-type: application/json { "options": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_PredictQApp_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [options](#API_qapps_PredictQApp_RequestSyntax) ** The input to generate the Q App definition from, either a conversation or problem statement. Type: [PredictQAppInputOptions](API_qapps_PredictQAppInputOptions.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "app": { "appDefinition": { "cards": [ { ... } ], "initialPrompt": "string" }, "description": "string", "title": "string" }, "problemStatement": "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. ** [app](#API_qapps_PredictQApp_ResponseSyntax) ** The generated Q App definition. Type: [PredictAppDefinition](API_qapps_PredictAppDefinition.md) object ** [problemStatement](#API_qapps_PredictQApp_ResponseSyntax) ** The problem statement extracted from the input conversation, if provided. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** retryAfterSeconds ** The number of seconds to wait before retrying the operation HTTP Status Code: 500 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/PredictQApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/PredictQApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/PredictQApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/PredictQApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/PredictQApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/PredictQApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/PredictQApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/PredictQApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/PredictQApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/PredictQApp) # StartQAppSession Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. **Note** Each Q App session will be condensed into a single conversation in the web experience. ## Request Syntax ``` POST /runtime.startQAppSession HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string", "appVersion": number, "initialValues": [ { "cardId": "string", "submissionMutation": { "mutationType": "string", "submissionId": "string" }, "value": "string" } ], "sessionId": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_StartQAppSession_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_StartQAppSession_RequestSyntax) ** The unique identifier of the Q App to start a session for. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [appVersion](#API_qapps_StartQAppSession_RequestSyntax) ** The version of the Q App to use for the session. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: Yes ** [initialValues](#API_qapps_StartQAppSession_RequestSyntax) ** Optional initial input values to provide for the Q App session. Type: Array of [CardValue](API_qapps_CardValue.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No ** [sessionId](#API_qapps_StartQAppSession_RequestSyntax) ** The unique identifier of the a Q App session. Type: String Required: No ** [tags](#API_qapps_StartQAppSession_RequestSyntax) ** Optional tags to associate with the new Q App session. Type: String to string map Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "sessionArn": "string", "sessionId": "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. ** [sessionArn](#API_qapps_StartQAppSession_ResponseSyntax) ** The Amazon Resource Name (ARN) of the new Q App session. Type: String ** [sessionId](#API_qapps_StartQAppSession_ResponseSyntax) ** The unique identifier of the new or retrieved Q App session. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/StartQAppSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/StartQAppSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/StartQAppSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/StartQAppSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/StartQAppSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/StartQAppSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/StartQAppSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/StartQAppSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/StartQAppSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/StartQAppSession) # StopQAppSession Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation. ## Request Syntax ``` POST /runtime.deleteMiniAppRun HTTP/1.1 instance-id: instanceId Content-type: application/json { "sessionId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_StopQAppSession_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [sessionId](#API_qapps_StopQAppSession_RequestSyntax) ** The unique identifier of the Q App session to stop. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/StopQAppSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/StopQAppSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/StopQAppSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/StopQAppSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/StopQAppSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/StopQAppSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/StopQAppSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/StopQAppSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/StopQAppSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/StopQAppSession) # TagResource Associates tags with an Amazon Q Apps resource. ## Request Syntax ``` POST /tags/resourceARN HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceARN](#API_qapps_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to tag. Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_qapps_TagResource_RequestSyntax) ** The tags to associate with the resource. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ** ValidationException ** The input failed to satisfy the constraints specified by the service. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/TagResource) # UntagResource Disassociates tags from an Amazon Q Apps resource. ## Request Syntax ``` DELETE /tags/resourceARN?tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceARN](#API_qapps_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to disassociate the tag from. Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes ** [tagKeys](#API_qapps_UntagResource_RequestSyntax) ** The keys of the tags to disassociate from the resource. Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ValidationException ** The input failed to satisfy the constraints specified by the service. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UntagResource) # UpdateLibraryItem Updates the library item for an Amazon Q App. ## Request Syntax ``` POST /catalog.updateItem HTTP/1.1 instance-id: instanceId Content-type: application/json { "categories": [ "string" ], "libraryItemId": "string", "status": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_UpdateLibraryItem_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [categories](#API_qapps_UpdateLibraryItem_RequestSyntax) ** The new categories to associate with the library item. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: No ** [libraryItemId](#API_qapps_UpdateLibraryItem_RequestSyntax) ** The unique identifier of the library item to update. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [status](#API_qapps_UpdateLibraryItem_RequestSyntax) ** The new status to set for the library item, such as "Published" or "Hidden". Type: String Valid Values: `PUBLISHED | DISABLED` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appId": "string", "appVersion": number, "categories": [ { "appCount": number, "color": "string", "id": "string", "title": "string" } ], "createdAt": "string", "createdBy": "string", "isRatedByUser": boolean, "isVerified": boolean, "libraryItemId": "string", "ratingCount": number, "status": "string", "updatedAt": "string", "updatedBy": "string", "userCount": 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. ** [appId](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The unique identifier of the Q App associated with the library item. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [appVersion](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The version of the Q App associated with the library item. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [categories](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The categories associated with the updated library item. Type: Array of [Category](API_qapps_Category.md) objects Array Members: Minimum number of 0 items. Maximum number of 3 items. ** [createdAt](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The date and time the library item was originally created. Type: Timestamp ** [createdBy](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The user who originally created the library item. Type: String ** [isRatedByUser](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** Whether the current user has rated the library item. Type: Boolean ** [isVerified](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** Indicates whether the library item has been verified. Type: Boolean ** [libraryItemId](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The unique identifier of the updated library item. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [ratingCount](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The number of ratings the library item has received. Type: Integer ** [status](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The new status of the updated library item. Type: String ** [updatedAt](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The date and time the library item was last updated. Type: Timestamp ** [updatedBy](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The user who last updated the library item. Type: String ** [userCount](#API_qapps_UpdateLibraryItem_ResponseSyntax) ** The number of users who have the associated Q App. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UpdateLibraryItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UpdateLibraryItem) # UpdateLibraryItemMetadata Updates the verification status of a library item for an Amazon Q App. ## Request Syntax ``` POST /catalog.updateItemMetadata HTTP/1.1 instance-id: instanceId Content-type: application/json { "isVerified": boolean, "libraryItemId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_UpdateLibraryItemMetadata_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [isVerified](#API_qapps_UpdateLibraryItemMetadata_RequestSyntax) ** The verification status of the library item Type: Boolean Required: No ** [libraryItemId](#API_qapps_UpdateLibraryItemMetadata_RequestSyntax) ** The unique identifier of the updated library item. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource HTTP Status Code: 409 ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UpdateLibraryItemMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UpdateLibraryItemMetadata) # 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](#API_qapps_UpdateQApp_RequestSyntax) ** 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](#API_qapps_UpdateQApp_RequestSyntax) ** The new definition specifying the cards and flow for the Q App. Type: [AppDefinitionInput](API_qapps_AppDefinitionInput.md) object Required: No ** [appId](#API_qapps_UpdateQApp_RequestSyntax) ** 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](#API_qapps_UpdateQApp_RequestSyntax) ** The new description for the Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No ** [title](#API_qapps_UpdateQApp_RequestSyntax) ** 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](#API_qapps_UpdateQApp_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated Q App. Type: String ** [appId](#API_qapps_UpdateQApp_ResponseSyntax) ** 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](#API_qapps_UpdateQApp_ResponseSyntax) ** The new version of the updated Q App. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [createdAt](#API_qapps_UpdateQApp_ResponseSyntax) ** The date and time the Q App was originally created. Type: Timestamp ** [createdBy](#API_qapps_UpdateQApp_ResponseSyntax) ** The user who originally created the Q App. Type: String ** [description](#API_qapps_UpdateQApp_ResponseSyntax) ** The new description of the updated Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [initialPrompt](#API_qapps_UpdateQApp_ResponseSyntax) ** The initial prompt for the updated Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 10000. ** [requiredCapabilities](#API_qapps_UpdateQApp_ResponseSyntax) ** The capabilities required for the updated Q App. Type: Array of strings Valid Values: `FileUpload | CreatorMode | RetrievalMode | PluginMode` ** [status](#API_qapps_UpdateQApp_ResponseSyntax) ** The status of the updated Q App. Type: String Valid Values: `PUBLISHED | DRAFT | DELETED` ** [title](#API_qapps_UpdateQApp_ResponseSyntax) ** The new title of the updated Q App. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `[^{}\\"<>]+` ** [updatedAt](#API_qapps_UpdateQApp_ResponseSyntax) ** The date and time the Q App was last updated. Type: Timestamp ** [updatedBy](#API_qapps_UpdateQApp_ResponseSyntax) ** The user who last updated the Q App. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UpdateQApp) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UpdateQApp) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UpdateQApp) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UpdateQApp) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UpdateQApp) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UpdateQApp) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UpdateQApp) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UpdateQApp) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UpdateQApp) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UpdateQApp) # UpdateQAppPermissions Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance. ## Request Syntax ``` POST /apps.updateQAppPermissions HTTP/1.1 instance-id: instanceId Content-type: application/json { "appId": "string", "grantPermissions": [ { "action": "string", "principal": "string" } ], "revokePermissions": [ { "action": "string", "principal": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_UpdateQAppPermissions_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appId](#API_qapps_UpdateQAppPermissions_RequestSyntax) ** The unique identifier of the Amazon Q App for which permissions are being updated. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [grantPermissions](#API_qapps_UpdateQAppPermissions_RequestSyntax) ** The list of permissions to grant for the Amazon Q App. Type: Array of [PermissionInput](API_qapps_PermissionInput.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No ** [revokePermissions](#API_qapps_UpdateQAppPermissions_RequestSyntax) ** The list of permissions to revoke for the Amazon Q App. Type: Array of [PermissionInput](API_qapps_PermissionInput.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appId": "string", "permissions": [ { "action": "string", "principal": { "email": "string", "userId": "string", "userType": "string" } } ], "resourceArn": "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. ** [appId](#API_qapps_UpdateQAppPermissions_ResponseSyntax) ** The unique identifier of the Amazon Q App for which permissions were updated. Type: String ** [permissions](#API_qapps_UpdateQAppPermissions_ResponseSyntax) ** The updated list of permissions for the Amazon Q App. Type: Array of [PermissionOutput](API_qapps_PermissionOutput.md) objects ** [resourceArn](#API_qapps_UpdateQAppPermissions_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UpdateQAppPermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UpdateQAppPermissions) # UpdateQAppSession Updates the session for a given Q App `sessionId`. This is only valid when at least one card of the session is in the `WAITING` state. Data for each `WAITING` card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the `WAITING` status will be ignored. ## Request Syntax ``` POST /runtime.updateQAppSession HTTP/1.1 instance-id: instanceId Content-type: application/json { "sessionId": "string", "values": [ { "cardId": "string", "submissionMutation": { "mutationType": "string", "submissionId": "string" }, "value": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_UpdateQAppSession_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [sessionId](#API_qapps_UpdateQAppSession_RequestSyntax) ** The unique identifier of the Q App session to provide input for. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [values](#API_qapps_UpdateQAppSession_RequestSyntax) ** The input values to provide for the current state of the Q App session. Type: Array of [CardValue](API_qapps_CardValue.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "sessionArn": "string", "sessionId": "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. ** [sessionArn](#API_qapps_UpdateQAppSession_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated Q App session. Type: String ** [sessionId](#API_qapps_UpdateQAppSession_ResponseSyntax) ** The unique identifier of the updated Q App session. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UpdateQAppSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UpdateQAppSession) # UpdateQAppSessionMetadata Updates the configuration metadata of a session for a given Q App `sessionId`. ## Request Syntax ``` POST /runtime.updateQAppSessionMetadata HTTP/1.1 instance-id: instanceId Content-type: application/json { "sessionId": "string", "sessionName": "string", "sharingConfiguration": { "acceptResponses": boolean, "enabled": boolean, "revealCards": boolean } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [instanceId](#API_qapps_UpdateQAppSessionMetadata_RequestSyntax) ** The unique identifier of the Amazon Q Business application environment instance. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [sessionId](#API_qapps_UpdateQAppSessionMetadata_RequestSyntax) ** The unique identifier of the Q App session to update configuration for. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` Required: Yes ** [sessionName](#API_qapps_UpdateQAppSessionMetadata_RequestSyntax) ** The new name for the Q App session. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: No ** [sharingConfiguration](#API_qapps_UpdateQAppSessionMetadata_RequestSyntax) ** The new sharing configuration for the Q App data collection session. Type: [SessionSharingConfiguration](API_qapps_SessionSharingConfiguration.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "sessionArn": "string", "sessionId": "string", "sessionName": "string", "sharingConfiguration": { "acceptResponses": boolean, "enabled": boolean, "revealCards": boolean } } ``` ## 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. ** [sessionArn](#API_qapps_UpdateQAppSessionMetadata_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated Q App session. Type: String ** [sessionId](#API_qapps_UpdateQAppSessionMetadata_ResponseSyntax) ** The unique identifier of the updated Q App session. Type: String Pattern: `[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}` ** [sessionName](#API_qapps_UpdateQAppSessionMetadata_ResponseSyntax) ** The new name of the updated Q App session. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. ** [sharingConfiguration](#API_qapps_UpdateQAppSessionMetadata_ResponseSyntax) ** The new sharing configuration of the updated Q App data collection session. Type: [SessionSharingConfiguration](API_qapps_SessionSharingConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** 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 ** ServiceQuotaExceededException ** The requested operation could not be completed because it would exceed the service's quota or limit. ** quotaCode ** The code of the quota that was exceeded ** resourceId ** The unique identifier of the resource ** resourceType ** The type of the resource ** serviceCode ** The code for the service where the quota was exceeded 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. ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qapps-2023-11-27/UpdateQAppSessionMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qapps-2023-11-27/UpdateQAppSessionMetadata)