# Actions
<a name="API_Operations"></a>

The following actions are supported by QBusiness:
+  [AssociatePermission](API_AssociatePermission.md) 
+  [BatchDeleteDocument](API_BatchDeleteDocument.md) 
+  [BatchPutDocument](API_BatchPutDocument.md) 
+  [CancelSubscription](API_CancelSubscription.md) 
+  [Chat](API_Chat.md) 
+  [ChatSync](API_ChatSync.md) 
+  [CheckDocumentAccess](API_CheckDocumentAccess.md) 
+  [CreateAnonymousWebExperienceUrl](API_CreateAnonymousWebExperienceUrl.md) 
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateChatResponseConfiguration](API_CreateChatResponseConfiguration.md) 
+  [CreateDataAccessor](API_CreateDataAccessor.md) 
+  [CreateDataSource](API_CreateDataSource.md) 
+  [CreateIndex](API_CreateIndex.md) 
+  [CreatePlugin](API_CreatePlugin.md) 
+  [CreateRetriever](API_CreateRetriever.md) 
+  [CreateSubscription](API_CreateSubscription.md) 
+  [CreateUser](API_CreateUser.md) 
+  [CreateWebExperience](API_CreateWebExperience.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteAttachment](API_DeleteAttachment.md) 
+  [DeleteChatControlsConfiguration](API_DeleteChatControlsConfiguration.md) 
+  [DeleteChatResponseConfiguration](API_DeleteChatResponseConfiguration.md) 
+  [DeleteConversation](API_DeleteConversation.md) 
+  [DeleteDataAccessor](API_DeleteDataAccessor.md) 
+  [DeleteDataSource](API_DeleteDataSource.md) 
+  [DeleteGroup](API_DeleteGroup.md) 
+  [DeleteIndex](API_DeleteIndex.md) 
+  [DeletePlugin](API_DeletePlugin.md) 
+  [DeleteRetriever](API_DeleteRetriever.md) 
+  [DeleteUser](API_DeleteUser.md) 
+  [DeleteWebExperience](API_DeleteWebExperience.md) 
+  [DisassociatePermission](API_DisassociatePermission.md) 
+  [GetApplication](API_GetApplication.md) 
+  [GetChatControlsConfiguration](API_GetChatControlsConfiguration.md) 
+  [GetChatResponseConfiguration](API_GetChatResponseConfiguration.md) 
+  [GetDataAccessor](API_GetDataAccessor.md) 
+  [GetDataSource](API_GetDataSource.md) 
+  [GetDocumentContent](API_GetDocumentContent.md) 
+  [GetGroup](API_GetGroup.md) 
+  [GetIndex](API_GetIndex.md) 
+  [GetMedia](API_GetMedia.md) 
+  [GetPlugin](API_GetPlugin.md) 
+  [GetPolicy](API_GetPolicy.md) 
+  [GetRetriever](API_GetRetriever.md) 
+  [GetUser](API_GetUser.md) 
+  [GetWebExperience](API_GetWebExperience.md) 
+  [ListApplications](API_ListApplications.md) 
+  [ListAttachments](API_ListAttachments.md) 
+  [ListChatResponseConfigurations](API_ListChatResponseConfigurations.md) 
+  [ListConversations](API_ListConversations.md) 
+  [ListDataAccessors](API_ListDataAccessors.md) 
+  [ListDataSources](API_ListDataSources.md) 
+  [ListDataSourceSyncJobs](API_ListDataSourceSyncJobs.md) 
+  [ListDocuments](API_ListDocuments.md) 
+  [ListGroups](API_ListGroups.md) 
+  [ListIndices](API_ListIndices.md) 
+  [ListMessages](API_ListMessages.md) 
+  [ListPluginActions](API_ListPluginActions.md) 
+  [ListPlugins](API_ListPlugins.md) 
+  [ListPluginTypeActions](API_ListPluginTypeActions.md) 
+  [ListPluginTypeMetadata](API_ListPluginTypeMetadata.md) 
+  [ListRetrievers](API_ListRetrievers.md) 
+  [ListSubscriptions](API_ListSubscriptions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListWebExperiences](API_ListWebExperiences.md) 
+  [PutFeedback](API_PutFeedback.md) 
+  [PutGroup](API_PutGroup.md) 
+  [SearchRelevantContent](API_SearchRelevantContent.md) 
+  [StartDataSourceSyncJob](API_StartDataSourceSyncJob.md) 
+  [StopDataSourceSyncJob](API_StopDataSourceSyncJob.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateApplication](API_UpdateApplication.md) 
+  [UpdateChatControlsConfiguration](API_UpdateChatControlsConfiguration.md) 
+  [UpdateChatResponseConfiguration](API_UpdateChatResponseConfiguration.md) 
+  [UpdateDataAccessor](API_UpdateDataAccessor.md) 
+  [UpdateDataSource](API_UpdateDataSource.md) 
+  [UpdateIndex](API_UpdateIndex.md) 
+  [UpdatePlugin](API_UpdatePlugin.md) 
+  [UpdateRetriever](API_UpdateRetriever.md) 
+  [UpdateSubscription](API_UpdateSubscription.md) 
+  [UpdateUser](API_UpdateUser.md) 
+  [UpdateWebExperience](API_UpdateWebExperience.md) 

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) 

# QBusiness
<a name="API_Operations_QBusiness"></a>

The following actions are supported by QBusiness:
+  [AssociatePermission](API_AssociatePermission.md) 
+  [BatchDeleteDocument](API_BatchDeleteDocument.md) 
+  [BatchPutDocument](API_BatchPutDocument.md) 
+  [CancelSubscription](API_CancelSubscription.md) 
+  [Chat](API_Chat.md) 
+  [ChatSync](API_ChatSync.md) 
+  [CheckDocumentAccess](API_CheckDocumentAccess.md) 
+  [CreateAnonymousWebExperienceUrl](API_CreateAnonymousWebExperienceUrl.md) 
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateChatResponseConfiguration](API_CreateChatResponseConfiguration.md) 
+  [CreateDataAccessor](API_CreateDataAccessor.md) 
+  [CreateDataSource](API_CreateDataSource.md) 
+  [CreateIndex](API_CreateIndex.md) 
+  [CreatePlugin](API_CreatePlugin.md) 
+  [CreateRetriever](API_CreateRetriever.md) 
+  [CreateSubscription](API_CreateSubscription.md) 
+  [CreateUser](API_CreateUser.md) 
+  [CreateWebExperience](API_CreateWebExperience.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteAttachment](API_DeleteAttachment.md) 
+  [DeleteChatControlsConfiguration](API_DeleteChatControlsConfiguration.md) 
+  [DeleteChatResponseConfiguration](API_DeleteChatResponseConfiguration.md) 
+  [DeleteConversation](API_DeleteConversation.md) 
+  [DeleteDataAccessor](API_DeleteDataAccessor.md) 
+  [DeleteDataSource](API_DeleteDataSource.md) 
+  [DeleteGroup](API_DeleteGroup.md) 
+  [DeleteIndex](API_DeleteIndex.md) 
+  [DeletePlugin](API_DeletePlugin.md) 
+  [DeleteRetriever](API_DeleteRetriever.md) 
+  [DeleteUser](API_DeleteUser.md) 
+  [DeleteWebExperience](API_DeleteWebExperience.md) 
+  [DisassociatePermission](API_DisassociatePermission.md) 
+  [GetApplication](API_GetApplication.md) 
+  [GetChatControlsConfiguration](API_GetChatControlsConfiguration.md) 
+  [GetChatResponseConfiguration](API_GetChatResponseConfiguration.md) 
+  [GetDataAccessor](API_GetDataAccessor.md) 
+  [GetDataSource](API_GetDataSource.md) 
+  [GetDocumentContent](API_GetDocumentContent.md) 
+  [GetGroup](API_GetGroup.md) 
+  [GetIndex](API_GetIndex.md) 
+  [GetMedia](API_GetMedia.md) 
+  [GetPlugin](API_GetPlugin.md) 
+  [GetPolicy](API_GetPolicy.md) 
+  [GetRetriever](API_GetRetriever.md) 
+  [GetUser](API_GetUser.md) 
+  [GetWebExperience](API_GetWebExperience.md) 
+  [ListApplications](API_ListApplications.md) 
+  [ListAttachments](API_ListAttachments.md) 
+  [ListChatResponseConfigurations](API_ListChatResponseConfigurations.md) 
+  [ListConversations](API_ListConversations.md) 
+  [ListDataAccessors](API_ListDataAccessors.md) 
+  [ListDataSources](API_ListDataSources.md) 
+  [ListDataSourceSyncJobs](API_ListDataSourceSyncJobs.md) 
+  [ListDocuments](API_ListDocuments.md) 
+  [ListGroups](API_ListGroups.md) 
+  [ListIndices](API_ListIndices.md) 
+  [ListMessages](API_ListMessages.md) 
+  [ListPluginActions](API_ListPluginActions.md) 
+  [ListPlugins](API_ListPlugins.md) 
+  [ListPluginTypeActions](API_ListPluginTypeActions.md) 
+  [ListPluginTypeMetadata](API_ListPluginTypeMetadata.md) 
+  [ListRetrievers](API_ListRetrievers.md) 
+  [ListSubscriptions](API_ListSubscriptions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListWebExperiences](API_ListWebExperiences.md) 
+  [PutFeedback](API_PutFeedback.md) 
+  [PutGroup](API_PutGroup.md) 
+  [SearchRelevantContent](API_SearchRelevantContent.md) 
+  [StartDataSourceSyncJob](API_StartDataSourceSyncJob.md) 
+  [StopDataSourceSyncJob](API_StopDataSourceSyncJob.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateApplication](API_UpdateApplication.md) 
+  [UpdateChatControlsConfiguration](API_UpdateChatControlsConfiguration.md) 
+  [UpdateChatResponseConfiguration](API_UpdateChatResponseConfiguration.md) 
+  [UpdateDataAccessor](API_UpdateDataAccessor.md) 
+  [UpdateDataSource](API_UpdateDataSource.md) 
+  [UpdateIndex](API_UpdateIndex.md) 
+  [UpdatePlugin](API_UpdatePlugin.md) 
+  [UpdateRetriever](API_UpdateRetriever.md) 
+  [UpdateSubscription](API_UpdateSubscription.md) 
+  [UpdateUser](API_UpdateUser.md) 
+  [UpdateWebExperience](API_UpdateWebExperience.md) 

# AssociatePermission
<a name="API_AssociatePermission"></a>

Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.

## Request Syntax
<a name="API_AssociatePermission_RequestSyntax"></a>

```
POST /applications/applicationId/policy HTTP/1.1
Content-type: application/json

{
   "actions": [ "string" ],
   "conditions": [ 
      { 
         "conditionKey": "string",
         "conditionOperator": "string",
         "conditionValues": [ "string" ]
      }
   ],
   "principal": "string",
   "statementId": "string"
}
```

## URI Request Parameters
<a name="API_AssociatePermission_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_AssociatePermission_RequestSyntax) **   <a name="qbusiness-AssociatePermission-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_AssociatePermission_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actions](#API_AssociatePermission_RequestSyntax) **   <a name="qbusiness-AssociatePermission-request-actions"></a>
The list of Amazon Q Business actions that the ISV is allowed to perform.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Pattern: `qbusiness:[a-zA-Z]+`   
Required: Yes

 ** [conditions](#API_AssociatePermission_RequestSyntax) **   <a name="qbusiness-AssociatePermission-request-conditions"></a>
The conditions that restrict when the permission is effective. These conditions can be used to limit the permission based on specific attributes of the request.  
Type: Array of [PermissionCondition](API_PermissionCondition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [principal](#API_AssociatePermission_RequestSyntax) **   <a name="qbusiness-AssociatePermission-request-principal"></a>
The Amazon Resource Name of the IAM role for the ISV that is being granted permission.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1284.  
Pattern: `arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+`   
Required: Yes

 ** [statementId](#API_AssociatePermission_RequestSyntax) **   <a name="qbusiness-AssociatePermission-request-statementId"></a>
A unique identifier for the policy statement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## Response Syntax
<a name="API_AssociatePermission_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "statement": "string"
}
```

## Response Elements
<a name="API_AssociatePermission_ResponseElements"></a>

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

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

 ** [statement](#API_AssociatePermission_ResponseSyntax) **   <a name="qbusiness-AssociatePermission-response-statement"></a>
The JSON representation of the added permission statement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_AssociatePermission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_AssociatePermission_SeeAlso"></a>

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/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/AssociatePermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/AssociatePermission) 

# BatchDeleteDocument
<a name="API_BatchDeleteDocument"></a>

Asynchronously deletes one or more documents added using the `BatchPutDocument` API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

## Request Syntax
<a name="API_BatchDeleteDocument_RequestSyntax"></a>

```
POST /applications/applicationId/indices/indexId/documents/delete HTTP/1.1
Content-type: application/json

{
   "dataSourceSyncId": "string",
   "documents": [ 
      { 
         "documentId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchDeleteDocument_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_BatchDeleteDocument_RequestSyntax) **   <a name="qbusiness-BatchDeleteDocument-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_BatchDeleteDocument_RequestSyntax) **   <a name="qbusiness-BatchDeleteDocument-request-uri-indexId"></a>
The identifier of the Amazon Q Business index that contains the documents to delete.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_BatchDeleteDocument_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dataSourceSyncId](#API_BatchDeleteDocument_RequestSyntax) **   <a name="qbusiness-BatchDeleteDocument-request-dataSourceSyncId"></a>
The identifier of the data source sync during which the documents were deleted.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: No

 ** [documents](#API_BatchDeleteDocument_RequestSyntax) **   <a name="qbusiness-BatchDeleteDocument-request-documents"></a>
Documents deleted from the Amazon Q Business index.  
Type: Array of [DeleteDocument](API_DeleteDocument.md) objects  
Required: Yes

## Response Syntax
<a name="API_BatchDeleteDocument_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedDocuments": [ 
      { 
         "dataSourceId": "string",
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDeleteDocument_ResponseElements"></a>

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

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

 ** [failedDocuments](#API_BatchDeleteDocument_ResponseSyntax) **   <a name="qbusiness-BatchDeleteDocument-response-failedDocuments"></a>
A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.   
Type: Array of [FailedDocument](API_FailedDocument.md) objects

## Errors
<a name="API_BatchDeleteDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_BatchDeleteDocument_SeeAlso"></a>

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/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/BatchDeleteDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/BatchDeleteDocument) 

# BatchPutDocument
<a name="API_BatchPutDocument"></a>

Adds one or more documents to an Amazon Q Business index.

You use this API to:
+ ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.
+ add custom attributes to documents in an Amazon Q Business index.
+ attach an access control list to the documents added to an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

## Request Syntax
<a name="API_BatchPutDocument_RequestSyntax"></a>

```
POST /applications/applicationId/indices/indexId/documents HTTP/1.1
Content-type: application/json

{
   "dataSourceSyncId": "string",
   "documents": [ 
      { 
         "accessConfiguration": { 
            "accessControls": [ 
               { 
                  "memberRelation": "string",
                  "principals": [ 
                     { ... }
                  ]
               }
            ],
            "memberRelation": "string"
         },
         "attributes": [ 
            { 
               "name": "string",
               "value": { ... }
            }
         ],
         "content": { ... },
         "contentType": "string",
         "documentEnrichmentConfiguration": { 
            "inlineConfigurations": [ 
               { 
                  "condition": { 
                     "key": "string",
                     "operator": "string",
                     "value": { ... }
                  },
                  "documentContentOperator": "string",
                  "target": { 
                     "attributeValueOperator": "string",
                     "key": "string",
                     "value": { ... }
                  }
               }
            ],
            "postExtractionHookConfiguration": { 
               "invocationCondition": { 
                  "key": "string",
                  "operator": "string",
                  "value": { ... }
               },
               "lambdaArn": "string",
               "roleArn": "string",
               "s3BucketName": "string"
            },
            "preExtractionHookConfiguration": { 
               "invocationCondition": { 
                  "key": "string",
                  "operator": "string",
                  "value": { ... }
               },
               "lambdaArn": "string",
               "roleArn": "string",
               "s3BucketName": "string"
            }
         },
         "id": "string",
         "mediaExtractionConfiguration": { 
            "audioExtractionConfiguration": { 
               "audioExtractionStatus": "string"
            },
            "imageExtractionConfiguration": { 
               "imageExtractionStatus": "string"
            },
            "videoExtractionConfiguration": { 
               "videoExtractionStatus": "string"
            }
         },
         "title": "string"
      }
   ],
   "roleArn": "string"
}
```

## URI Request Parameters
<a name="API_BatchPutDocument_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_BatchPutDocument_RequestSyntax) **   <a name="qbusiness-BatchPutDocument-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_BatchPutDocument_RequestSyntax) **   <a name="qbusiness-BatchPutDocument-request-uri-indexId"></a>
The identifier of the Amazon Q Business index to add the documents to.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_BatchPutDocument_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dataSourceSyncId](#API_BatchPutDocument_RequestSyntax) **   <a name="qbusiness-BatchPutDocument-request-dataSourceSyncId"></a>
The identifier of the data source sync during which the documents were added.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: No

 ** [documents](#API_BatchPutDocument_RequestSyntax) **   <a name="qbusiness-BatchPutDocument-request-documents"></a>
One or more documents to add to the index.  
Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.
Type: Array of [Document](API_Document.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** [roleArn](#API_BatchPutDocument_RequestSyntax) **   <a name="qbusiness-BatchPutDocument-request-roleArn"></a>
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

## Response Syntax
<a name="API_BatchPutDocument_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedDocuments": [ 
      { 
         "dataSourceId": "string",
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchPutDocument_ResponseElements"></a>

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

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

 ** [failedDocuments](#API_BatchPutDocument_ResponseSyntax) **   <a name="qbusiness-BatchPutDocument-response-failedDocuments"></a>
 A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.   
Type: Array of [FailedDocument](API_FailedDocument.md) objects

## Errors
<a name="API_BatchPutDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_BatchPutDocument_SeeAlso"></a>

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/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/BatchPutDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/BatchPutDocument) 

# CancelSubscription
<a name="API_CancelSubscription"></a>

Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month. 

## Request Syntax
<a name="API_CancelSubscription_RequestSyntax"></a>

```
DELETE /applications/applicationId/subscriptions/subscriptionId HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CancelSubscription_RequestSyntax) **   <a name="qbusiness-CancelSubscription-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application for which the subscription is being cancelled.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [subscriptionId](#API_CancelSubscription_RequestSyntax) **   <a name="qbusiness-CancelSubscription-request-uri-subscriptionId"></a>
The identifier of the Amazon Q Business subscription being cancelled.  
Length Constraints: Minimum length of 0. Maximum length of 1224.  
Required: Yes

## Request Body
<a name="API_CancelSubscription_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "currentSubscription": { 
      "type": "string"
   },
   "nextSubscription": { 
      "type": "string"
   },
   "subscriptionArn": "string"
}
```

## Response Elements
<a name="API_CancelSubscription_ResponseElements"></a>

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

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

 ** [currentSubscription](#API_CancelSubscription_ResponseSyntax) **   <a name="qbusiness-CancelSubscription-response-currentSubscription"></a>
The type of your current Amazon Q Business subscription.  
Type: [SubscriptionDetails](API_SubscriptionDetails.md) object

 ** [nextSubscription](#API_CancelSubscription_ResponseSyntax) **   <a name="qbusiness-CancelSubscription-response-nextSubscription"></a>
The type of the Amazon Q Business subscription for the next month.  
Type: [SubscriptionDetails](API_SubscriptionDetails.md) object

 ** [subscriptionArn](#API_CancelSubscription_ResponseSyntax) **   <a name="qbusiness-CancelSubscription-response-subscriptionArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors
<a name="API_CancelSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CancelSubscription_SeeAlso"></a>

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/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CancelSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CancelSubscription) 

# Chat
<a name="API_Chat"></a>

Starts or continues a streaming Amazon Q Business conversation.

## Request Syntax
<a name="API_Chat_RequestSyntax"></a>

```
POST /applications/applicationId/conversations?clientToken=clientToken&conversationId=conversationId&parentMessageId=parentMessageId&userGroups=userGroups&userId=userId HTTP/1.1
Content-type: application/json

{
   "actionExecutionEvent": { 
      "payload": { 
         "string" : { 
            "value": JSON value
         }
      },
      "payloadFieldNameSeparator": "string",
      "pluginId": "string"
   },
   "attachmentEvent": { 
      "attachment": { 
         "copyFrom": { ... },
         "data": blob,
         "name": "string"
      }
   },
   "authChallengeResponseEvent": { 
      "responseMap": { 
         "string" : "string" 
      }
   },
   "configurationEvent": { 
      "attributeFilter": { 
         "andAllFilters": [ 
            "AttributeFilter"
         ],
         "containsAll": { 
            "name": "string",
            "value": { ... }
         },
         "containsAny": { 
            "name": "string",
            "value": { ... }
         },
         "equalsTo": { 
            "name": "string",
            "value": { ... }
         },
         "greaterThan": { 
            "name": "string",
            "value": { ... }
         },
         "greaterThanOrEquals": { 
            "name": "string",
            "value": { ... }
         },
         "lessThan": { 
            "name": "string",
            "value": { ... }
         },
         "lessThanOrEquals": { 
            "name": "string",
            "value": { ... }
         },
         "notFilter": "AttributeFilter",
         "orAllFilters": [ 
            "AttributeFilter"
         ]
      },
      "chatMode": "string",
      "chatModeConfiguration": { ... }
   },
   "endOfInputEvent": { 
   },
   "textEvent": { 
      "userMessage": "string"
   }
}
```

## URI Request Parameters
<a name="API_Chat_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [clientToken](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-uri-clientToken"></a>
A token that you provide to identify the chat input.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [conversationId](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-uri-conversationId"></a>
The identifier of the Amazon Q Business conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [parentMessageId](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-uri-parentMessageId"></a>
The identifier used to associate a user message with a AI generated response.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [userGroups](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-uri-userGroups"></a>
The group names that a user associated with the chat input belongs to.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [userId](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-uri-userId"></a>
The identifier of the user attached to the chat input.   
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_Chat_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionExecutionEvent](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-actionExecutionEvent"></a>
A request from an end user to perform an Amazon Q Business plugin action.  
Type: [ActionExecutionEvent](API_ActionExecutionEvent.md) object  
Required: No

 ** [attachmentEvent](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-attachmentEvent"></a>
A request by an end user to upload a file during chat.  
Type: [AttachmentInputEvent](API_AttachmentInputEvent.md) object  
Required: No

 ** [authChallengeResponseEvent](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-authChallengeResponseEvent"></a>
An authentication verification event response by a third party authentication server to Amazon Q Business.  
Type: [AuthChallengeResponseEvent](API_AuthChallengeResponseEvent.md) object  
Required: No

 ** [configurationEvent](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-configurationEvent"></a>
A configuration event activated by an end user request to select a specific chat mode.  
Type: [ConfigurationEvent](API_ConfigurationEvent.md) object  
Required: No

 ** [endOfInputEvent](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-endOfInputEvent"></a>
The end of the streaming input for the `Chat` API.  
Type: [EndOfInputEvent](API_EndOfInputEvent.md) object  
Required: No

 ** [textEvent](#API_Chat_RequestSyntax) **   <a name="qbusiness-Chat-request-textEvent"></a>
Information about the payload of the `ChatInputStream` event containing the end user message input.  
Type: [TextInputEvent](API_TextInputEvent.md) object  
Required: No

## Response Syntax
<a name="API_Chat_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionReviewEvent": { 
      "conversationId": "string",
      "payload": { 
         "string" : { 
            "allowedFormat": "string",
            "allowedValues": [ 
               { 
                  "displayValue": JSON value,
                  "value": JSON value
               }
            ],
            "arrayItemJsonSchema": JSON value,
            "displayDescription": "string",
            "displayName": "string",
            "displayOrder": number,
            "required": boolean,
            "type": "string",
            "value": JSON value
         }
      },
      "payloadFieldNameSeparator": "string",
      "pluginId": "string",
      "pluginType": "string",
      "systemMessageId": "string",
      "userMessageId": "string"
   },
   "authChallengeRequestEvent": { 
      "authorizationUrl": "string"
   },
   "failedAttachmentEvent": { 
      "attachment": { 
         "attachmentId": "string",
         "conversationId": "string",
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "name": "string",
         "status": "string"
      },
      "conversationId": "string",
      "systemMessageId": "string",
      "userMessageId": "string"
   },
   "metadataEvent": { 
      "conversationId": "string",
      "finalTextMessage": "string",
      "sourceAttributions": [ 
         { 
            "citationNumber": number,
            "datasourceId": "string",
            "documentId": "string",
            "indexId": "string",
            "snippet": "string",
            "textMessageSegments": [ 
               { 
                  "beginOffset": number,
                  "endOffset": number,
                  "mediaId": "string",
                  "mediaMimeType": "string",
                  "snippetExcerpt": { 
                     "text": "string"
                  },
                  "sourceDetails": { ... }
               }
            ],
            "title": "string",
            "updatedAt": number,
            "url": "string"
         }
      ],
      "systemMessageId": "string",
      "userMessageId": "string"
   },
   "textEvent": { 
      "conversationId": "string",
      "systemMessage": "string",
      "systemMessageId": "string",
      "systemMessageType": "string",
      "userMessageId": "string"
   }
}
```

## Response Elements
<a name="API_Chat_ResponseElements"></a>

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

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

 ** [actionReviewEvent](#API_Chat_ResponseSyntax) **   <a name="qbusiness-Chat-response-actionReviewEvent"></a>
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.  
Type: [ActionReviewEvent](API_ActionReviewEvent.md) object

 ** [authChallengeRequestEvent](#API_Chat_ResponseSyntax) **   <a name="qbusiness-Chat-response-authChallengeRequestEvent"></a>
An authentication verification event activated by an end user request to use a custom plugin.  
Type: [AuthChallengeRequestEvent](API_AuthChallengeRequestEvent.md) object

 ** [failedAttachmentEvent](#API_Chat_ResponseSyntax) **   <a name="qbusiness-Chat-response-failedAttachmentEvent"></a>
A failed file upload event during a web experience chat.  
Type: [FailedAttachmentEvent](API_FailedAttachmentEvent.md) object

 ** [metadataEvent](#API_Chat_ResponseSyntax) **   <a name="qbusiness-Chat-response-metadataEvent"></a>
A metadata event for a AI-generated text output message in a Amazon Q Business conversation.   
Type: [MetadataEvent](API_MetadataEvent.md) object

 ** [textEvent](#API_Chat_ResponseSyntax) **   <a name="qbusiness-Chat-response-textEvent"></a>
Information about the payload of the `ChatOutputStream` event containing the AI-generated message output.  
Type: [TextOutputEvent](API_TextOutputEvent.md) object

## Errors
<a name="API_Chat_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** ExternalResourceException **   
An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.   
HTTP Status Code: 424

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_Chat_SeeAlso"></a>

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/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/Chat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/Chat) 

# ChatSync
<a name="API_ChatSync"></a>

Starts or continues a non-streaming Amazon Q Business conversation.

## Request Syntax
<a name="API_ChatSync_RequestSyntax"></a>

```
POST /applications/applicationId/conversations?sync&userGroups=userGroups&userId=userId HTTP/1.1
Content-type: application/json

{
   "actionExecution": { 
      "payload": { 
         "string" : { 
            "value": JSON value
         }
      },
      "payloadFieldNameSeparator": "string",
      "pluginId": "string"
   },
   "attachments": [ 
      { 
         "copyFrom": { ... },
         "data": blob,
         "name": "string"
      }
   ],
   "attributeFilter": { 
      "andAllFilters": [ 
         "AttributeFilter"
      ],
      "containsAll": { 
         "name": "string",
         "value": { ... }
      },
      "containsAny": { 
         "name": "string",
         "value": { ... }
      },
      "equalsTo": { 
         "name": "string",
         "value": { ... }
      },
      "greaterThan": { 
         "name": "string",
         "value": { ... }
      },
      "greaterThanOrEquals": { 
         "name": "string",
         "value": { ... }
      },
      "lessThan": { 
         "name": "string",
         "value": { ... }
      },
      "lessThanOrEquals": { 
         "name": "string",
         "value": { ... }
      },
      "notFilter": "AttributeFilter",
      "orAllFilters": [ 
         "AttributeFilter"
      ]
   },
   "authChallengeResponse": { 
      "responseMap": { 
         "string" : "string" 
      }
   },
   "chatMode": "string",
   "chatModeConfiguration": { ... },
   "clientToken": "string",
   "conversationId": "string",
   "parentMessageId": "string",
   "userMessage": "string"
}
```

## URI Request Parameters
<a name="API_ChatSync_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userGroups](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-uri-userGroups"></a>
The group names that a user associated with the chat input belongs to.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [userId](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-uri-userId"></a>
The identifier of the user attached to the chat input.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_ChatSync_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionExecution](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-actionExecution"></a>
A request from an end user to perform an Amazon Q Business plugin action.  
Type: [ActionExecution](API_ActionExecution.md) object  
Required: No

 ** [attachments](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-attachments"></a>
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.  
Type: Array of [AttachmentInput](API_AttachmentInput.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [attributeFilter](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-attributeFilter"></a>
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.  
Type: [AttributeFilter](API_AttributeFilter.md) object  
Required: No

 ** [authChallengeResponse](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-authChallengeResponse"></a>
An authentication verification event response by a third party authentication server to Amazon Q Business.  
Type: [AuthChallengeResponse](API_AuthChallengeResponse.md) object  
Required: No

 ** [chatMode](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-chatMode"></a>
The `chatMode` parameter determines the chat modes available to Amazon Q Business users:  
+  `RETRIEVAL_MODE` - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "*No Answer Found*" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge
+  `CREATOR_MODE` - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.
+  `PLUGIN_MODE` - By selecting this mode, users can choose to use plugins in chat to get their responses.
If none of the modes are selected, Amazon Q will only respond using the information from the attached files.
For more information, see [Admin controls and guardrails](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html), [Plugins](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html), and [Response sources](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope).  
Type: String  
Valid Values: `RETRIEVAL_MODE | CREATOR_MODE | PLUGIN_MODE`   
Required: No

 ** [chatModeConfiguration](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-chatModeConfiguration"></a>
The chat mode configuration for an Amazon Q Business application.  
Type: [ChatModeConfiguration](API_ChatModeConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [clientToken](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-clientToken"></a>
A token that you provide to identify a chat request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [conversationId](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-conversationId"></a>
The identifier of the Amazon Q Business conversation.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: No

 ** [parentMessageId](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-parentMessageId"></a>
The identifier of the previous system message in a conversation.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: No

 ** [userMessage](#API_ChatSync_RequestSyntax) **   <a name="qbusiness-ChatSync-request-userMessage"></a>
A end user message in a conversation.  
Type: String  
Required: No

## Response Syntax
<a name="API_ChatSync_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionReview": { 
      "payload": { 
         "string" : { 
            "allowedFormat": "string",
            "allowedValues": [ 
               { 
                  "displayValue": JSON value,
                  "value": JSON value
               }
            ],
            "arrayItemJsonSchema": JSON value,
            "displayDescription": "string",
            "displayName": "string",
            "displayOrder": number,
            "required": boolean,
            "type": "string",
            "value": JSON value
         }
      },
      "payloadFieldNameSeparator": "string",
      "pluginId": "string",
      "pluginType": "string"
   },
   "authChallengeRequest": { 
      "authorizationUrl": "string"
   },
   "conversationId": "string",
   "failedAttachments": [ 
      { 
         "attachmentId": "string",
         "conversationId": "string",
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "name": "string",
         "status": "string"
      }
   ],
   "sourceAttributions": [ 
      { 
         "citationNumber": number,
         "datasourceId": "string",
         "documentId": "string",
         "indexId": "string",
         "snippet": "string",
         "textMessageSegments": [ 
            { 
               "beginOffset": number,
               "endOffset": number,
               "mediaId": "string",
               "mediaMimeType": "string",
               "snippetExcerpt": { 
                  "text": "string"
               },
               "sourceDetails": { ... }
            }
         ],
         "title": "string",
         "updatedAt": number,
         "url": "string"
      }
   ],
   "systemMessage": "string",
   "systemMessageId": "string",
   "userMessageId": "string"
}
```

## Response Elements
<a name="API_ChatSync_ResponseElements"></a>

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

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

 ** [actionReview](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-actionReview"></a>
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.  
Type: [ActionReview](API_ActionReview.md) object

 ** [authChallengeRequest](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-authChallengeRequest"></a>
An authentication verification event activated by an end user request to use a custom plugin.  
Type: [AuthChallengeRequest](API_AuthChallengeRequest.md) object

 ** [conversationId](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-conversationId"></a>
The identifier of the Amazon Q Business conversation.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [failedAttachments](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-failedAttachments"></a>
A list of files which failed to upload during chat.  
Type: Array of [AttachmentOutput](API_AttachmentOutput.md) objects

 ** [sourceAttributions](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-sourceAttributions"></a>
The source documents used to generate the conversation response.  
Type: Array of [SourceAttribution](API_SourceAttribution.md) objects

 ** [systemMessage](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-systemMessage"></a>
An AI-generated message in a conversation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [systemMessageId](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-systemMessageId"></a>
The identifier of an Amazon Q Business AI generated message within the conversation.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [userMessageId](#API_ChatSync_ResponseSyntax) **   <a name="qbusiness-ChatSync-response-userMessageId"></a>
The identifier of an Amazon Q Business end user text input message within the conversation.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_ChatSync_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** ExternalResourceException **   
An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.   
HTTP Status Code: 424

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ChatSync_SeeAlso"></a>

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/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ChatSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ChatSync) 

# CheckDocumentAccess
<a name="API_CheckDocumentAccess"></a>

Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.

## Request Syntax
<a name="API_CheckDocumentAccess_RequestSyntax"></a>

```
GET /applications/applicationId/index/indexId/users/userId/documents/documentId/check-document-access?dataSourceId=dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_CheckDocumentAccess_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CheckDocumentAccess_RequestSyntax) **   <a name="qbusiness-CheckDocumentAccess-request-uri-applicationId"></a>
The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_CheckDocumentAccess_RequestSyntax) **   <a name="qbusiness-CheckDocumentAccess-request-uri-dataSourceId"></a>
The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [documentId](#API_CheckDocumentAccess_RequestSyntax) **   <a name="qbusiness-CheckDocumentAccess-request-uri-documentId"></a>
The unique identifier of the document. Specifies which document's access permissions are being checked.  
Length Constraints: Minimum length of 1. Maximum length of 1825.  
Pattern: `\P{C}*`   
Required: Yes

 ** [indexId](#API_CheckDocumentAccess_RequestSyntax) **   <a name="qbusiness-CheckDocumentAccess-request-uri-indexId"></a>
The unique identifier of the index. Used to locate the correct index within the application where the document is stored.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_CheckDocumentAccess_RequestSyntax) **   <a name="qbusiness-CheckDocumentAccess-request-uri-userId"></a>
The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Request Body
<a name="API_CheckDocumentAccess_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CheckDocumentAccess_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "documentAcl": { 
      "allowlist": { 
         "conditions": [ 
            { 
               "groups": [ 
                  { 
                     "name": "string",
                     "type": "string"
                  }
               ],
               "memberRelation": "string",
               "users": [ 
                  { 
                     "id": "string",
                     "type": "string"
                  }
               ]
            }
         ],
         "memberRelation": "string"
      },
      "denyList": { 
         "conditions": [ 
            { 
               "groups": [ 
                  { 
                     "name": "string",
                     "type": "string"
                  }
               ],
               "memberRelation": "string",
               "users": [ 
                  { 
                     "id": "string",
                     "type": "string"
                  }
               ]
            }
         ],
         "memberRelation": "string"
      }
   },
   "hasAccess": boolean,
   "userAliases": [ 
      { 
         "id": "string",
         "type": "string"
      }
   ],
   "userGroups": [ 
      { 
         "name": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CheckDocumentAccess_ResponseElements"></a>

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

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

 ** [documentAcl](#API_CheckDocumentAccess_ResponseSyntax) **   <a name="qbusiness-CheckDocumentAccess-response-documentAcl"></a>
The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.  
Type: [DocumentAcl](API_DocumentAcl.md) object

 ** [hasAccess](#API_CheckDocumentAccess_ResponseSyntax) **   <a name="qbusiness-CheckDocumentAccess-response-hasAccess"></a>
A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.  
Type: Boolean

 ** [userAliases](#API_CheckDocumentAccess_ResponseSyntax) **   <a name="qbusiness-CheckDocumentAccess-response-userAliases"></a>
An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.  
Type: Array of [AssociatedUser](API_AssociatedUser.md) objects

 ** [userGroups](#API_CheckDocumentAccess_ResponseSyntax) **   <a name="qbusiness-CheckDocumentAccess-response-userGroups"></a>
An array of groups the user is part of for the specified data source. Each group has a name and type.  
Type: Array of [AssociatedGroup](API_AssociatedGroup.md) objects

## Errors
<a name="API_CheckDocumentAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CheckDocumentAccess_SeeAlso"></a>

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/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CheckDocumentAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CheckDocumentAccess) 

# CreateAnonymousWebExperienceUrl
<a name="API_CreateAnonymousWebExperienceUrl"></a>

Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.

## Request Syntax
<a name="API_CreateAnonymousWebExperienceUrl_RequestSyntax"></a>

```
POST /applications/applicationId/experiences/webExperienceId/anonymous-url HTTP/1.1
Content-type: application/json

{
   "sessionDurationInMinutes": number
}
```

## URI Request Parameters
<a name="API_CreateAnonymousWebExperienceUrl_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateAnonymousWebExperienceUrl_RequestSyntax) **   <a name="qbusiness-CreateAnonymousWebExperienceUrl-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application environment attached to the web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [webExperienceId](#API_CreateAnonymousWebExperienceUrl_RequestSyntax) **   <a name="qbusiness-CreateAnonymousWebExperienceUrl-request-uri-webExperienceId"></a>
The identifier of the web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

## Request Body
<a name="API_CreateAnonymousWebExperienceUrl_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionDurationInMinutes](#API_CreateAnonymousWebExperienceUrl_RequestSyntax) **   <a name="qbusiness-CreateAnonymousWebExperienceUrl-request-sessionDurationInMinutes"></a>
The duration of the session associated with the unique URL for the web experience.  
Type: Integer  
Valid Range: Minimum value of 15. Maximum value of 60.  
Required: No

## Response Syntax
<a name="API_CreateAnonymousWebExperienceUrl_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "anonymousUrl": "string"
}
```

## Response Elements
<a name="API_CreateAnonymousWebExperienceUrl_ResponseElements"></a>

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

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

 ** [anonymousUrl](#API_CreateAnonymousWebExperienceUrl_ResponseSyntax) **   <a name="qbusiness-CreateAnonymousWebExperienceUrl-response-anonymousUrl"></a>
The unique URL for accessing the web experience.  
This URL can only be used once and must be used within 5 minutes after it's generated.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(https?|ftp|file)://([^\s]*)` 

## Errors
<a name="API_CreateAnonymousWebExperienceUrl_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateAnonymousWebExperienceUrl_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl) 

# CreateApplication
<a name="API_CreateApplication"></a>

Creates an Amazon Q Business application.

**Note**  
There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers). You must use the Amazon Q Business console to assign subscription tiers to users.   
An Amazon Q Apps service linked role will be created if it's absent in the AWS account when `QAppsConfiguration` is enabled in the request. For more information, see [ Using service-linked roles for Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html).  
When you create an application, Amazon Q Business may securely transmit data for processing from your selected AWS region, but within your geography. For more information, see [Cross region inference in Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html).

## Request Syntax
<a name="API_CreateApplication_RequestSyntax"></a>

```
POST /applications HTTP/1.1
Content-type: application/json

{
   "attachmentsConfiguration": { 
      "attachmentsControlMode": "string"
   },
   "clientIdsForOIDC": [ "string" ],
   "clientToken": "string",
   "description": "string",
   "displayName": "string",
   "encryptionConfiguration": { 
      "kmsKeyId": "string"
   },
   "iamIdentityProviderArn": "string",
   "identityCenterInstanceArn": "string",
   "identityType": "string",
   "personalizationConfiguration": { 
      "personalizationControlMode": "string"
   },
   "qAppsConfiguration": { 
      "qAppsControlMode": "string"
   },
   "quickSightConfiguration": { 
      "clientNamespace": "string"
   },
   "roleArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateApplication_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attachmentsConfiguration](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-attachmentsConfiguration"></a>
An option to allow end users to upload files directly during chat.  
Type: [AttachmentsConfiguration](API_AttachmentsConfiguration.md) object  
Required: No

 ** [clientIdsForOIDC](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-clientIdsForOIDC"></a>
The OIDC client ID for a Amazon Q Business application.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.:/()*?=-]*`   
Required: No

 ** [clientToken](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-clientToken"></a>
A token that you provide to identify the request to create your Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [description](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-description"></a>
A description for the Amazon Q Business application.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*`   
Required: No

 ** [displayName](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-displayName"></a>
A name for the Amazon Q Business application.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [encryptionConfiguration](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-encryptionConfiguration"></a>
The identifier of the AWS KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [iamIdentityProviderArn](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-iamIdentityProviderArn"></a>
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+`   
Required: No

 ** [identityCenterInstanceArn](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-identityCenterInstanceArn"></a>
 The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** [identityType](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-identityType"></a>
The authentication type being used by a Amazon Q Business application.  
Type: String  
Valid Values: `AWS_IAM_IDP_SAML | AWS_IAM_IDP_OIDC | AWS_IAM_IDC | AWS_QUICKSIGHT_IDP | ANONYMOUS`   
Required: No

 ** [personalizationConfiguration](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-personalizationConfiguration"></a>
Configuration information about chat response personalization. For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html)   
Type: [PersonalizationConfiguration](API_PersonalizationConfiguration.md) object  
Required: No

 ** [qAppsConfiguration](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-qAppsConfiguration"></a>
An option to allow end users to create and use Amazon Q Apps in the web experience.  
Type: [QAppsConfiguration](API_QAppsConfiguration.md) object  
Required: No

 ** [quickSightConfiguration](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-quickSightConfiguration"></a>
The Amazon Quick configuration for an Amazon Q Business application that uses Quick for authentication. This configuration is required if your application uses Quick as the identity provider. For more information, see [Creating an Amazon Quick integrated application](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html).  
Type: [QuickSightConfiguration](API_QuickSightConfiguration.md) object  
Required: No

 ** [roleArn](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-roleArn"></a>
 The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a [service linked role (SLR)](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions) and use it as the application's role.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [tags](#API_CreateApplication_RequestSyntax) **   <a name="qbusiness-CreateApplication-request-tags"></a>
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "applicationId": "string"
}
```

## Response Elements
<a name="API_CreateApplication_ResponseElements"></a>

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

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

 ** [applicationArn](#API_CreateApplication_ResponseSyntax) **   <a name="qbusiness-CreateApplication-response-applicationArn"></a>
 The Amazon Resource Name (ARN) of the Amazon Q Business application.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [applicationId](#API_CreateApplication_ResponseSyntax) **   <a name="qbusiness-CreateApplication-response-applicationId"></a>
The identifier of the Amazon Q Business application.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_CreateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateApplication_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateApplication) 

# CreateChatResponseConfiguration
<a name="API_CreateChatResponseConfiguration"></a>

Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.

## Request Syntax
<a name="API_CreateChatResponseConfiguration_RequestSyntax"></a>

```
POST /applications/applicationId/chatresponseconfigurations HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "displayName": "string",
   "responseConfigurations": { 
      "string" : { 
         "instructionCollection": { 
            "customInstructions": "string",
            "examples": "string",
            "identity": "string",
            "outputStyle": "string",
            "perspective": "string",
            "responseLength": "string",
            "targetAudience": "string",
            "tone": "string"
         }
      }
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateChatResponseConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateChatResponseConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [displayName](#API_CreateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-request-displayName"></a>
A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [responseConfigurations](#API_CreateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-request-responseConfigurations"></a>
A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.  
Type: String to [ResponseConfiguration](API_ResponseConfiguration.md) object map  
Map Entries: Maximum number of 1 item.  
Valid Keys: `ALL`   
Required: Yes

 ** [tags](#API_CreateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-request-tags"></a>
A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across AWS services.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateChatResponseConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "chatResponseConfigurationArn": "string",
   "chatResponseConfigurationId": "string"
}
```

## Response Elements
<a name="API_CreateChatResponseConfiguration_ResponseElements"></a>

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

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

 ** [chatResponseConfigurationArn](#API_CreateChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-response-chatResponseConfigurationArn"></a>
The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all AWS services.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [chatResponseConfigurationId](#API_CreateChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-CreateChatResponseConfiguration-response-chatResponseConfigurationId"></a>
The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_CreateChatResponseConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateChatResponseConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateChatResponseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateChatResponseConfiguration) 

# CreateDataAccessor
<a name="API_CreateDataAccessor"></a>

Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.

## Request Syntax
<a name="API_CreateDataAccessor_RequestSyntax"></a>

```
POST /applications/applicationId/dataaccessors HTTP/1.1
Content-type: application/json

{
   "actionConfigurations": [ 
      { 
         "action": "string",
         "filterConfiguration": { 
            "documentAttributeFilter": { 
               "andAllFilters": [ 
                  "AttributeFilter"
               ],
               "containsAll": { 
                  "name": "string",
                  "value": { ... }
               },
               "containsAny": { 
                  "name": "string",
                  "value": { ... }
               },
               "equalsTo": { 
                  "name": "string",
                  "value": { ... }
               },
               "greaterThan": { 
                  "name": "string",
                  "value": { ... }
               },
               "greaterThanOrEquals": { 
                  "name": "string",
                  "value": { ... }
               },
               "lessThan": { 
                  "name": "string",
                  "value": { ... }
               },
               "lessThanOrEquals": { 
                  "name": "string",
                  "value": { ... }
               },
               "notFilter": "AttributeFilter",
               "orAllFilters": [ 
                  "AttributeFilter"
               ]
            }
         }
      }
   ],
   "authenticationDetail": { 
      "authenticationConfiguration": { ... },
      "authenticationType": "string",
      "externalIds": [ "string" ]
   },
   "clientToken": "string",
   "displayName": "string",
   "principal": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateDataAccessor_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateDataAccessor_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionConfigurations](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-actionConfigurations"></a>
A list of action configurations specifying the allowed actions and any associated filters.  
Type: Array of [ActionConfiguration](API_ActionConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** [authenticationDetail](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-authenticationDetail"></a>
The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.  
Type: [DataAccessorAuthenticationDetail](API_DataAccessorAuthenticationDetail.md) object  
Required: No

 ** [clientToken](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-clientToken"></a>
A unique, case-sensitive identifier you provide to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [displayName](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-displayName"></a>
A friendly name for the data accessor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [principal](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-principal"></a>
The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1284.  
Pattern: `arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+`   
Required: Yes

 ** [tags](#API_CreateDataAccessor_RequestSyntax) **   <a name="qbusiness-CreateDataAccessor-request-tags"></a>
The tags to associate with the data accessor.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateDataAccessor_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataAccessorArn": "string",
   "dataAccessorId": "string",
   "idcApplicationArn": "string"
}
```

## Response Elements
<a name="API_CreateDataAccessor_ResponseElements"></a>

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

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

 ** [dataAccessorArn](#API_CreateDataAccessor_ResponseSyntax) **   <a name="qbusiness-CreateDataAccessor-response-dataAccessorArn"></a>
The Amazon Resource Name (ARN) of the created data accessor.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [dataAccessorId](#API_CreateDataAccessor_ResponseSyntax) **   <a name="qbusiness-CreateDataAccessor-response-dataAccessorId"></a>
The unique identifier of the created data accessor.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [idcApplicationArn](#API_CreateDataAccessor_ResponseSyntax) **   <a name="qbusiness-CreateDataAccessor-response-idcApplicationArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}` 

## Errors
<a name="API_CreateDataAccessor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateDataAccessor_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateDataAccessor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateDataAccessor) 

# CreateDataSource
<a name="API_CreateDataSource"></a>

Creates a data source connector for an Amazon Q Business application.

 `CreateDataSource` is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

## Request Syntax
<a name="API_CreateDataSource_RequestSyntax"></a>

```
POST /applications/applicationId/indices/indexId/datasources HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": JSON value,
   "description": "string",
   "displayName": "string",
   "documentEnrichmentConfiguration": { 
      "inlineConfigurations": [ 
         { 
            "condition": { 
               "key": "string",
               "operator": "string",
               "value": { ... }
            },
            "documentContentOperator": "string",
            "target": { 
               "attributeValueOperator": "string",
               "key": "string",
               "value": { ... }
            }
         }
      ],
      "postExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      },
      "preExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      }
   },
   "mediaExtractionConfiguration": { 
      "audioExtractionConfiguration": { 
         "audioExtractionStatus": "string"
      },
      "imageExtractionConfiguration": { 
         "imageExtractionStatus": "string"
      },
      "videoExtractionConfiguration": { 
         "videoExtractionStatus": "string"
      }
   },
   "roleArn": "string",
   "syncSchedule": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "vpcConfiguration": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ]
   }
}
```

## URI Request Parameters
<a name="API_CreateDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-uri-applicationId"></a>
 The identifier of the Amazon Q Business application the data source will be attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-uri-indexId"></a>
The identifier of the index that you want to use with the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-clientToken"></a>
A token you provide to identify a request to create a data source connector. Multiple calls to the `CreateDataSource` API with the same client token will create only one data source connector.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [configuration](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-configuration"></a>
Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.  
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:  
+  [Amazon S3 JSON schema](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-api.html) 
+  [Web Crawler JSON schema](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html) 
You can find configuration templates for your specific data source using the following steps:  

1. Navigate to the [Supported connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html) page in the Amazon Q Business User Guide, and select the data source of your choice.

1. Then, from your specific data source connector page, select **Using the API**. You will find the JSON schema for your data source, including parameter descriptions, in this section.
Type: JSON value  
Required: Yes

 ** [description](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-description"></a>
A description for the data source connector.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*`   
Required: No

 ** [displayName](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-displayName"></a>
A name for the data source connector.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [documentEnrichmentConfiguration](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-documentEnrichmentConfiguration"></a>
Provides the configuration information for altering document metadata and content during the document ingestion process.  
For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).  
Type: [DocumentEnrichmentConfiguration](API_DocumentEnrichmentConfiguration.md) object  
Required: No

 ** [mediaExtractionConfiguration](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-mediaExtractionConfiguration"></a>
The configuration for extracting information from media in documents during ingestion.  
Type: [MediaExtractionConfiguration](API_MediaExtractionConfiguration.md) object  
Required: No

 ** [roleArn](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-roleArn"></a>
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [syncSchedule](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-syncSchedule"></a>
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.  
Specify a `cron-` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the `Schedule` parameter when the `Type` parameter is set to `CUSTOM`. If you do, you receive a `ValidationException` exception.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 998.  
Pattern: `[\s\S]*`   
Required: No

 ** [tags](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-tags"></a>
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [vpcConfiguration](#API_CreateDataSource_RequestSyntax) **   <a name="qbusiness-CreateDataSource-request-vpcConfiguration"></a>
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see [Using Amazon VPC with Amazon Q Business connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html).  
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_CreateDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataSourceArn": "string",
   "dataSourceId": "string"
}
```

## Response Elements
<a name="API_CreateDataSource_ResponseElements"></a>

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

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

 ** [dataSourceArn](#API_CreateDataSource_ResponseSyntax) **   <a name="qbusiness-CreateDataSource-response-dataSourceArn"></a>
 The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [dataSourceId](#API_CreateDataSource_ResponseSyntax) **   <a name="qbusiness-CreateDataSource-response-dataSourceId"></a>
The identifier of the data source connector.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_CreateDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateDataSource_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateDataSource) 

# CreateIndex
<a name="API_CreateIndex"></a>

Creates an Amazon Q Business index.

To determine if index creation has completed, check the `Status` field returned from a call to `DescribeIndex`. The `Status` field is set to `ACTIVE` when the index is ready to use.

Once the index is active, you can index your documents using the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html) API or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) API.

## Request Syntax
<a name="API_CreateIndex_RequestSyntax"></a>

```
POST /applications/applicationId/indices HTTP/1.1
Content-type: application/json

{
   "capacityConfiguration": { 
      "units": number
   },
   "clientToken": "string",
   "description": "string",
   "displayName": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreateIndex_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application using the index.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateIndex_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [capacityConfiguration](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-capacityConfiguration"></a>
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.  
Type: [IndexCapacityConfiguration](API_IndexCapacityConfiguration.md) object  
Required: No

 ** [clientToken](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-clientToken"></a>
A token that you provide to identify the request to create an index. Multiple calls to the `CreateIndex` API with the same client token will create only one index.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [description](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-description"></a>
A description for the Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*`   
Required: No

 ** [displayName](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-displayName"></a>
A name for the Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [tags](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-tags"></a>
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [type](#API_CreateIndex_RequestSyntax) **   <a name="qbusiness-CreateIndex-request-type"></a>
The index type that's suitable for your needs. For more information on what's included in each type of index, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers).  
Type: String  
Valid Values: `ENTERPRISE | STARTER`   
Required: No

## Response Syntax
<a name="API_CreateIndex_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "indexArn": "string",
   "indexId": "string"
}
```

## Response Elements
<a name="API_CreateIndex_ResponseElements"></a>

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

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

 ** [indexArn](#API_CreateIndex_ResponseSyntax) **   <a name="qbusiness-CreateIndex-response-indexArn"></a>
 The Amazon Resource Name (ARN) of an Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [indexId](#API_CreateIndex_ResponseSyntax) **   <a name="qbusiness-CreateIndex-response-indexId"></a>
The identifier for the Amazon Q Business index.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_CreateIndex_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateIndex_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateIndex) 

# CreatePlugin
<a name="API_CreatePlugin"></a>

Creates an Amazon Q Business plugin.

## Request Syntax
<a name="API_CreatePlugin_RequestSyntax"></a>

```
POST /applications/applicationId/plugins HTTP/1.1
Content-type: application/json

{
   "authConfiguration": { ... },
   "clientToken": "string",
   "customPluginConfiguration": { 
      "apiSchema": { ... },
      "apiSchemaType": "string",
      "description": "string"
   },
   "displayName": "string",
   "serverUrl": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreatePlugin_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-uri-applicationId"></a>
The identifier of the application that will contain the plugin.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreatePlugin_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [authConfiguration](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-authConfiguration"></a>
Authentication configuration information for an Amazon Q Business plugin.  
Type: [PluginAuthConfiguration](API_PluginAuthConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [clientToken](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-clientToken"></a>
A token that you provide to identify the request to create your Amazon Q Business plugin.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [customPluginConfiguration](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-customPluginConfiguration"></a>
Contains configuration for a custom plugin.  
Type: [CustomPluginConfiguration](API_CustomPluginConfiguration.md) object  
Required: No

 ** [displayName](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-displayName"></a>
A the name for your plugin.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [serverUrl](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-serverUrl"></a>
The source URL used for plugin configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(https?|ftp|file)://([^\s]*)`   
Required: No

 ** [tags](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-tags"></a>
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [type](#API_CreatePlugin_RequestSyntax) **   <a name="qbusiness-CreatePlugin-request-type"></a>
The type of plugin you want to create.  
Type: String  
Valid Values: `SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM | QUICKSIGHT | SERVICENOW_NOW_PLATFORM | JIRA_CLOUD | SALESFORCE_CRM | ZENDESK_SUITE | ATLASSIAN_CONFLUENCE | GOOGLE_CALENDAR | MICROSOFT_TEAMS | MICROSOFT_EXCHANGE | PAGERDUTY_ADVANCE | SMARTSHEET | ASANA`   
Required: Yes

## Response Syntax
<a name="API_CreatePlugin_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "buildStatus": "string",
   "pluginArn": "string",
   "pluginId": "string"
}
```

## Response Elements
<a name="API_CreatePlugin_ResponseElements"></a>

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

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

 ** [buildStatus](#API_CreatePlugin_ResponseSyntax) **   <a name="qbusiness-CreatePlugin-response-buildStatus"></a>
The current status of a plugin. A plugin is modified asynchronously.  
Type: String  
Valid Values: `READY | CREATE_IN_PROGRESS | CREATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_FAILED | DELETE_IN_PROGRESS | DELETE_FAILED` 

 ** [pluginArn](#API_CreatePlugin_ResponseSyntax) **   <a name="qbusiness-CreatePlugin-response-pluginArn"></a>
The Amazon Resource Name (ARN) of a plugin.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [pluginId](#API_CreatePlugin_ResponseSyntax) **   <a name="qbusiness-CreatePlugin-response-pluginId"></a>
The identifier of the plugin created.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_CreatePlugin_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreatePlugin_SeeAlso"></a>

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/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreatePlugin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreatePlugin) 

# CreateRetriever
<a name="API_CreateRetriever"></a>

Adds a retriever to your Amazon Q Business application.

## Request Syntax
<a name="API_CreateRetriever_RequestSyntax"></a>

```
POST /applications/applicationId/retrievers HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "displayName": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreateRetriever_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-uri-applicationId"></a>
The identifier of your Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateRetriever_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-clientToken"></a>
A token that you provide to identify the request to create your Amazon Q Business application retriever.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [configuration](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-configuration"></a>
Provides information on how the retriever used for your Amazon Q Business application is configured.  
Type: [RetrieverConfiguration](API_RetrieverConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [displayName](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-displayName"></a>
The name of your retriever.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [roleArn](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-roleArn"></a>
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [tags](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-tags"></a>
A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [type](#API_CreateRetriever_RequestSyntax) **   <a name="qbusiness-CreateRetriever-request-type"></a>
The type of retriever you are using.  
Type: String  
Valid Values: `NATIVE_INDEX | KENDRA_INDEX`   
Required: Yes

## Response Syntax
<a name="API_CreateRetriever_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "retrieverArn": "string",
   "retrieverId": "string"
}
```

## Response Elements
<a name="API_CreateRetriever_ResponseElements"></a>

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

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

 ** [retrieverArn](#API_CreateRetriever_ResponseSyntax) **   <a name="qbusiness-CreateRetriever-response-retrieverArn"></a>
The Amazon Resource Name (ARN) of an IAM role associated with a retriever.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [retrieverId](#API_CreateRetriever_ResponseSyntax) **   <a name="qbusiness-CreateRetriever-response-retrieverId"></a>
The identifier of the retriever you are using.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_CreateRetriever_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateRetriever_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateRetriever) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateRetriever) 

# CreateSubscription
<a name="API_CreateSubscription"></a>

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: `Q_LITE` and `Q_BUSINESS`. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see [Amazon Q Business pricing](https://aws.amazon.com/q/business/pricing/).

**Note**  
For an example IAM role policy for assigning subscriptions, see [Set up required permissions](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/setting-up.html#permissions) in the Amazon Q Business User Guide.

## Request Syntax
<a name="API_CreateSubscription_RequestSyntax"></a>

```
POST /applications/applicationId/subscriptions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "principal": { ... },
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreateSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateSubscription_RequestSyntax) **   <a name="qbusiness-CreateSubscription-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application the subscription should be added to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateSubscription_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateSubscription_RequestSyntax) **   <a name="qbusiness-CreateSubscription-request-clientToken"></a>
A token that you provide to identify the request to create a subscription for your Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [principal](#API_CreateSubscription_RequestSyntax) **   <a name="qbusiness-CreateSubscription-request-principal"></a>
The IAM Identity Center `UserId` or `GroupId` of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.  
Type: [SubscriptionPrincipal](API_SubscriptionPrincipal.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [type](#API_CreateSubscription_RequestSyntax) **   <a name="qbusiness-CreateSubscription-request-type"></a>
The type of Amazon Q Business subscription you want to create.  
Type: String  
Valid Values: `Q_LITE | Q_BUSINESS`   
Required: Yes

## Response Syntax
<a name="API_CreateSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "currentSubscription": { 
      "type": "string"
   },
   "nextSubscription": { 
      "type": "string"
   },
   "subscriptionArn": "string",
   "subscriptionId": "string"
}
```

## Response Elements
<a name="API_CreateSubscription_ResponseElements"></a>

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

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

 ** [currentSubscription](#API_CreateSubscription_ResponseSyntax) **   <a name="qbusiness-CreateSubscription-response-currentSubscription"></a>
The type of your current Amazon Q Business subscription.  
Type: [SubscriptionDetails](API_SubscriptionDetails.md) object

 ** [nextSubscription](#API_CreateSubscription_ResponseSyntax) **   <a name="qbusiness-CreateSubscription-response-nextSubscription"></a>
The type of the Amazon Q Business subscription for the next month.  
Type: [SubscriptionDetails](API_SubscriptionDetails.md) object

 ** [subscriptionArn](#API_CreateSubscription_ResponseSyntax) **   <a name="qbusiness-CreateSubscription-response-subscriptionArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [subscriptionId](#API_CreateSubscription_ResponseSyntax) **   <a name="qbusiness-CreateSubscription-response-subscriptionId"></a>
The identifier of the Amazon Q Business subscription created.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1224.

## Errors
<a name="API_CreateSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateSubscription_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateSubscription) 

# CreateUser
<a name="API_CreateUser"></a>

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

## Request Syntax
<a name="API_CreateUser_RequestSyntax"></a>

```
POST /applications/applicationId/users HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "userAliases": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ],
   "userId": "string"
}
```

## URI Request Parameters
<a name="API_CreateUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateUser_RequestSyntax) **   <a name="qbusiness-CreateUser-request-uri-applicationId"></a>
The identifier of the application for which the user mapping will be created.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateUser_RequestSyntax) **   <a name="qbusiness-CreateUser-request-clientToken"></a>
A token that you provide to identify the request to create your Amazon Q Business user mapping.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [userAliases](#API_CreateUser_RequestSyntax) **   <a name="qbusiness-CreateUser-request-userAliases"></a>
The list of user aliases in the mapping.  
Type: Array of [UserAlias](API_UserAlias.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [userId](#API_CreateUser_RequestSyntax) **   <a name="qbusiness-CreateUser-request-userId"></a>
The user emails attached to a user mapping.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_CreateUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CreateUser_ResponseElements"></a>

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

## Errors
<a name="API_CreateUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateUser_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateUser) 

# CreateWebExperience
<a name="API_CreateWebExperience"></a>

Creates an Amazon Q Business web experience.

## Request Syntax
<a name="API_CreateWebExperience_RequestSyntax"></a>

```
POST /applications/applicationId/experiences HTTP/1.1
Content-type: application/json

{
   "browserExtensionConfiguration": { 
      "enabledBrowserExtensions": [ "string" ]
   },
   "clientToken": "string",
   "customizationConfiguration": { 
      "customCSSUrl": "string",
      "faviconUrl": "string",
      "fontUrl": "string",
      "logoUrl": "string"
   },
   "identityProviderConfiguration": { ... },
   "origins": [ "string" ],
   "roleArn": "string",
   "samplePromptsControlMode": "string",
   "subtitle": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "title": "string",
   "welcomeMessage": "string"
}
```

## URI Request Parameters
<a name="API_CreateWebExperience_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-uri-applicationId"></a>
The identifier of the Amazon Q Business web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_CreateWebExperience_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [browserExtensionConfiguration](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-browserExtensionConfiguration"></a>
The browser extension configuration for an Amazon Q Business web experience.  
 For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see [Configure external OIDC identity provider for your browser extensions.](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html). 
Type: [BrowserExtensionConfiguration](API_BrowserExtensionConfiguration.md) object  
Required: No

 ** [clientToken](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-clientToken"></a>
A token you provide to identify a request to create an Amazon Q Business web experience.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [customizationConfiguration](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-customizationConfiguration"></a>
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.   
Type: [CustomizationConfiguration](API_CustomizationConfiguration.md) object  
Required: No

 ** [identityProviderConfiguration](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-identityProviderConfiguration"></a>
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.  
Type: [IdentityProviderConfiguration](API_IdentityProviderConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [origins](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-origins"></a>
Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol (`http/https`), the domain name, and the port number (if specified).   
You must only submit a *base URL* and not a full path. For example, `https://docs.aws.amazon.com`.
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?`   
Required: No

 ** [roleArn](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-roleArn"></a>
The Amazon Resource Name (ARN) of the service role attached to your web experience.  
The `roleArn` parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [samplePromptsControlMode](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-samplePromptsControlMode"></a>
Determines whether sample prompts are enabled in the web experience for an end user.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [subtitle](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-subtitle"></a>
A subtitle to personalize your Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `[\s\S]*`   
Required: No

 ** [tags](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-tags"></a>
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [title](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-title"></a>
The title for your Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `[\s\S]*`   
Required: No

 ** [welcomeMessage](#API_CreateWebExperience_RequestSyntax) **   <a name="qbusiness-CreateWebExperience-request-welcomeMessage"></a>
The customized welcome message for end users of an Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 300.  
Required: No

## Response Syntax
<a name="API_CreateWebExperience_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "webExperienceArn": "string",
   "webExperienceId": "string"
}
```

## Response Elements
<a name="API_CreateWebExperience_ResponseElements"></a>

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

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

 ** [webExperienceArn](#API_CreateWebExperience_ResponseSyntax) **   <a name="qbusiness-CreateWebExperience-response-webExperienceArn"></a>
 The Amazon Resource Name (ARN) of an Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [webExperienceId](#API_CreateWebExperience_ResponseSyntax) **   <a name="qbusiness-CreateWebExperience-response-webExperienceId"></a>
The identifier of the Amazon Q Business web experience.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*` 

## Errors
<a name="API_CreateWebExperience_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_CreateWebExperience_SeeAlso"></a>

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/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/CreateWebExperience) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/CreateWebExperience) 

# DeleteApplication
<a name="API_DeleteApplication"></a>

Deletes an Amazon Q Business application.

## Request Syntax
<a name="API_DeleteApplication_RequestSyntax"></a>

```
DELETE /applications/applicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteApplication_RequestSyntax) **   <a name="qbusiness-DeleteApplication-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteApplication_ResponseElements"></a>

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

## Errors
<a name="API_DeleteApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteApplication_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteApplication) 

# DeleteAttachment
<a name="API_DeleteAttachment"></a>

Deletes an attachment associated with a specific Amazon Q Business conversation.

## Request Syntax
<a name="API_DeleteAttachment_RequestSyntax"></a>

```
DELETE /applications/applicationId/conversations/conversationId/attachments/attachmentId?userId=userId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAttachment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteAttachment_RequestSyntax) **   <a name="qbusiness-DeleteAttachment-request-uri-applicationId"></a>
The unique identifier for the Amazon Q Business application environment.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [attachmentId](#API_DeleteAttachment_RequestSyntax) **   <a name="qbusiness-DeleteAttachment-request-uri-attachmentId"></a>
The unique identifier for the attachment.  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`   
Required: Yes

 ** [conversationId](#API_DeleteAttachment_RequestSyntax) **   <a name="qbusiness-DeleteAttachment-request-uri-conversationId"></a>
The unique identifier of the conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_DeleteAttachment_RequestSyntax) **   <a name="qbusiness-DeleteAttachment-request-uri-userId"></a>
The unique identifier of the user involved in the conversation.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_DeleteAttachment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAttachment_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteAttachment_ResponseElements"></a>

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

## Errors
<a name="API_DeleteAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteAttachment_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteAttachment) 

# DeleteChatControlsConfiguration
<a name="API_DeleteChatControlsConfiguration"></a>

Deletes chat controls configured for an existing Amazon Q Business application.

## Request Syntax
<a name="API_DeleteChatControlsConfiguration_RequestSyntax"></a>

```
DELETE /applications/applicationId/chatcontrols HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteChatControlsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-DeleteChatControlsConfiguration-request-uri-applicationId"></a>
The identifier of the application the chat controls have been configured for.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteChatControlsConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteChatControlsConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteChatControlsConfiguration_ResponseElements"></a>

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

## Errors
<a name="API_DeleteChatControlsConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteChatControlsConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteChatControlsConfiguration) 

# DeleteChatResponseConfiguration
<a name="API_DeleteChatResponseConfiguration"></a>

Deletes a specified chat response configuration from an Amazon Q Business application.

## Request Syntax
<a name="API_DeleteChatResponseConfiguration_RequestSyntax"></a>

```
DELETE /applications/applicationId/chatresponseconfigurations/chatResponseConfigurationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteChatResponseConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-DeleteChatResponseConfiguration-request-uri-applicationId"></a>
The unique identifier of theAmazon Q Business application from which to delete the chat response configuration.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [chatResponseConfigurationId](#API_DeleteChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-DeleteChatResponseConfiguration-request-uri-chatResponseConfigurationId"></a>
The unique identifier of the chat response configuration to delete from the specified application.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteChatResponseConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteChatResponseConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteChatResponseConfiguration_ResponseElements"></a>

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

## Errors
<a name="API_DeleteChatResponseConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteChatResponseConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteChatResponseConfiguration) 

# DeleteConversation
<a name="API_DeleteConversation"></a>

Deletes an Amazon Q Business web experience conversation.

## Request Syntax
<a name="API_DeleteConversation_RequestSyntax"></a>

```
DELETE /applications/applicationId/conversations/conversationId?userId=userId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteConversation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteConversation_RequestSyntax) **   <a name="qbusiness-DeleteConversation-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application associated with the conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [conversationId](#API_DeleteConversation_RequestSyntax) **   <a name="qbusiness-DeleteConversation-request-uri-conversationId"></a>
The identifier of the Amazon Q Business web experience conversation being deleted.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_DeleteConversation_RequestSyntax) **   <a name="qbusiness-DeleteConversation-request-uri-userId"></a>
The identifier of the user who is deleting the conversation.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_DeleteConversation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteConversation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteConversation_ResponseElements"></a>

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

## Errors
<a name="API_DeleteConversation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteConversation_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteConversation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteConversation) 

# DeleteDataAccessor
<a name="API_DeleteDataAccessor"></a>

Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.

## Request Syntax
<a name="API_DeleteDataAccessor_RequestSyntax"></a>

```
DELETE /applications/applicationId/dataaccessors/dataAccessorId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataAccessor_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteDataAccessor_RequestSyntax) **   <a name="qbusiness-DeleteDataAccessor-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataAccessorId](#API_DeleteDataAccessor_RequestSyntax) **   <a name="qbusiness-DeleteDataAccessor-request-uri-dataAccessorId"></a>
The unique identifier of the data accessor to delete.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteDataAccessor_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataAccessor_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteDataAccessor_ResponseElements"></a>

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

## Errors
<a name="API_DeleteDataAccessor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteDataAccessor_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteDataAccessor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteDataAccessor) 

# DeleteDataSource
<a name="API_DeleteDataSource"></a>

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the `Status` field returned by a call to the `DescribeDataSource` API is set to `DELETING`. 

## Request Syntax
<a name="API_DeleteDataSource_RequestSyntax"></a>

```
DELETE /applications/applicationId/indices/indexId/datasources/dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteDataSource_RequestSyntax) **   <a name="qbusiness-DeleteDataSource-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application used with the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_DeleteDataSource_RequestSyntax) **   <a name="qbusiness-DeleteDataSource-request-uri-dataSourceId"></a>
The identifier of the data source connector that you want to delete.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_DeleteDataSource_RequestSyntax) **   <a name="qbusiness-DeleteDataSource-request-uri-indexId"></a>
The identifier of the index used with the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteDataSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteDataSource_ResponseElements"></a>

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

## Errors
<a name="API_DeleteDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteDataSource_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteDataSource) 

# DeleteGroup
<a name="API_DeleteGroup"></a>

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. 

If you want to delete, update, or replace users or sub groups of a group, you need to use the `PutGroup` operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling `PutGroup`.

## Request Syntax
<a name="API_DeleteGroup_RequestSyntax"></a>

```
DELETE /applications/applicationId/indices/indexId/groups/groupName?dataSourceId=dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteGroup_RequestSyntax) **   <a name="qbusiness-DeleteGroup-request-uri-applicationId"></a>
The identifier of the application in which the group mapping belongs.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_DeleteGroup_RequestSyntax) **   <a name="qbusiness-DeleteGroup-request-uri-dataSourceId"></a>
The identifier of the data source linked to the group  
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [groupName](#API_DeleteGroup_RequestSyntax) **   <a name="qbusiness-DeleteGroup-request-uri-groupName"></a>
The name of the group you want to delete.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*`   
Required: Yes

 ** [indexId](#API_DeleteGroup_RequestSyntax) **   <a name="qbusiness-DeleteGroup-request-uri-indexId"></a>
The identifier of the index you want to delete the group from.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteGroup_ResponseElements"></a>

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

## Errors
<a name="API_DeleteGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteGroup_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteGroup) 

# DeleteIndex
<a name="API_DeleteIndex"></a>

Deletes an Amazon Q Business index.

## Request Syntax
<a name="API_DeleteIndex_RequestSyntax"></a>

```
DELETE /applications/applicationId/indices/indexId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteIndex_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteIndex_RequestSyntax) **   <a name="qbusiness-DeleteIndex-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_DeleteIndex_RequestSyntax) **   <a name="qbusiness-DeleteIndex-request-uri-indexId"></a>
The identifier of the Amazon Q Business index.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteIndex_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteIndex_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteIndex_ResponseElements"></a>

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

## Errors
<a name="API_DeleteIndex_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteIndex_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteIndex) 

# DeletePlugin
<a name="API_DeletePlugin"></a>

Deletes an Amazon Q Business plugin.

## Request Syntax
<a name="API_DeletePlugin_RequestSyntax"></a>

```
DELETE /applications/applicationId/plugins/pluginId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePlugin_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeletePlugin_RequestSyntax) **   <a name="qbusiness-DeletePlugin-request-uri-applicationId"></a>
The identifier the application attached to the Amazon Q Business plugin.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [pluginId](#API_DeletePlugin_RequestSyntax) **   <a name="qbusiness-DeletePlugin-request-uri-pluginId"></a>
The identifier of the plugin being deleted.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_DeletePlugin_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePlugin_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeletePlugin_ResponseElements"></a>

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

## Errors
<a name="API_DeletePlugin_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeletePlugin_SeeAlso"></a>

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/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeletePlugin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeletePlugin) 

# DeleteRetriever
<a name="API_DeleteRetriever"></a>

Deletes the retriever used by an Amazon Q Business application.

## Request Syntax
<a name="API_DeleteRetriever_RequestSyntax"></a>

```
DELETE /applications/applicationId/retrievers/retrieverId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRetriever_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteRetriever_RequestSyntax) **   <a name="qbusiness-DeleteRetriever-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application using the retriever.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [retrieverId](#API_DeleteRetriever_RequestSyntax) **   <a name="qbusiness-DeleteRetriever-request-uri-retrieverId"></a>
The identifier of the retriever being deleted.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_DeleteRetriever_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRetriever_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteRetriever_ResponseElements"></a>

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

## Errors
<a name="API_DeleteRetriever_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteRetriever_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteRetriever) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteRetriever) 

# DeleteUser
<a name="API_DeleteUser"></a>

Deletes a user by email id.

## Request Syntax
<a name="API_DeleteUser_RequestSyntax"></a>

```
DELETE /applications/applicationId/users/userId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteUser_RequestSyntax) **   <a name="qbusiness-DeleteUser-request-uri-applicationId"></a>
The identifier of the application from which the user is being deleted.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_DeleteUser_RequestSyntax) **   <a name="qbusiness-DeleteUser-request-uri-userId"></a>
The user email being deleted.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Request Body
<a name="API_DeleteUser_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteUser_ResponseElements"></a>

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

## Errors
<a name="API_DeleteUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteUser_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteUser) 

# DeleteWebExperience
<a name="API_DeleteWebExperience"></a>

Deletes an Amazon Q Business web experience.

## Request Syntax
<a name="API_DeleteWebExperience_RequestSyntax"></a>

```
DELETE /applications/applicationId/experiences/webExperienceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteWebExperience_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DeleteWebExperience_RequestSyntax) **   <a name="qbusiness-DeleteWebExperience-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [webExperienceId](#API_DeleteWebExperience_RequestSyntax) **   <a name="qbusiness-DeleteWebExperience-request-uri-webExperienceId"></a>
The identifier of the Amazon Q Business web experience being deleted.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

## Request Body
<a name="API_DeleteWebExperience_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteWebExperience_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteWebExperience_ResponseElements"></a>

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

## Errors
<a name="API_DeleteWebExperience_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DeleteWebExperience_SeeAlso"></a>

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/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DeleteWebExperience) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DeleteWebExperience) 

# DisassociatePermission
<a name="API_DisassociatePermission"></a>

Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

## Request Syntax
<a name="API_DisassociatePermission_RequestSyntax"></a>

```
DELETE /applications/applicationId/policy/statementId HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociatePermission_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_DisassociatePermission_RequestSyntax) **   <a name="qbusiness-DisassociatePermission-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [statementId](#API_DisassociatePermission_RequestSyntax) **   <a name="qbusiness-DisassociatePermission-request-uri-statementId"></a>
The statement ID of the permission to remove.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Request Body
<a name="API_DisassociatePermission_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociatePermission_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociatePermission_ResponseElements"></a>

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

## Errors
<a name="API_DisassociatePermission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_DisassociatePermission_SeeAlso"></a>

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/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/DisassociatePermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/DisassociatePermission) 

# GetApplication
<a name="API_GetApplication"></a>

Gets information about an existing Amazon Q Business application.

## Request Syntax
<a name="API_GetApplication_RequestSyntax"></a>

```
GET /applications/applicationId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetApplication_RequestSyntax) **   <a name="qbusiness-GetApplication-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## Response Elements
<a name="API_GetApplication_ResponseElements"></a>

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

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

 ** [applicationArn](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-applicationArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [applicationId](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-applicationId"></a>
The identifier of the Amazon Q Business application.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [attachmentsConfiguration](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-attachmentsConfiguration"></a>
Settings for whether end users can upload files directly during chat.  
Type: [AppliedAttachmentsConfiguration](API_AppliedAttachmentsConfiguration.md) object

 ** [autoSubscriptionConfiguration](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-autoSubscriptionConfiguration"></a>
Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.  
Type: [AutoSubscriptionConfiguration](API_AutoSubscriptionConfiguration.md) object

 ** [clientIdsForOIDC](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-clientIdsForOIDC"></a>
The OIDC client ID for a Amazon Q Business application.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.:/()*?=-]*` 

 ** [createdAt](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-createdAt"></a>
The Unix timestamp when the Amazon Q Business application was last updated.  
Type: Timestamp

 ** [description](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-description"></a>
A description for the Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*` 

 ** [displayName](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-displayName"></a>
The name of the Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [encryptionConfiguration](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-encryptionConfiguration"></a>
The identifier of the AWS AWS KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object

 ** [error](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-error"></a>
If the `Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.  
Type: [ErrorDetail](API_ErrorDetail.md) object

 ** [iamIdentityProviderArn](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-iamIdentityProviderArn"></a>
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+` 

 ** [identityCenterApplicationArn](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-identityCenterApplicationArn"></a>
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}` 

 ** [identityType](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-identityType"></a>
The authentication type being used by a Amazon Q Business application.  
Type: String  
Valid Values: `AWS_IAM_IDP_SAML | AWS_IAM_IDP_OIDC | AWS_IAM_IDC | AWS_QUICKSIGHT_IDP | ANONYMOUS` 

 ** [personalizationConfiguration](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-personalizationConfiguration"></a>
Configuration information about chat response personalization. For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html).  
Type: [PersonalizationConfiguration](API_PersonalizationConfiguration.md) object

 ** [qAppsConfiguration](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-qAppsConfiguration"></a>
Settings for whether end users can create and use Amazon Q Apps in the web experience.  
Type: [QAppsConfiguration](API_QAppsConfiguration.md) object

 ** [quickSightConfiguration](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-quickSightConfiguration"></a>
The Amazon Quick authentication configuration for the Amazon Q Business application.  
Type: [QuickSightConfiguration](API_QuickSightConfiguration.md) object

 ** [roleArn](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-roleArn"></a>
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [status](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-status"></a>
The status of the Amazon Q Business application.  
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING` 

 ** [updatedAt](#API_GetApplication_ResponseSyntax) **   <a name="qbusiness-GetApplication-response-updatedAt"></a>
The Unix timestamp when the Amazon Q Business application was last updated.  
Type: Timestamp

## Errors
<a name="API_GetApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetApplication_SeeAlso"></a>

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/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetApplication) 

# GetChatControlsConfiguration
<a name="API_GetChatControlsConfiguration"></a>

Gets information about chat controls configured for an existing Amazon Q Business application.

## Request Syntax
<a name="API_GetChatControlsConfiguration_RequestSyntax"></a>

```
GET /applications/applicationId/chatcontrols?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetChatControlsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-request-uri-applicationId"></a>
The identifier of the application for which the chat controls are configured.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_GetChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-request-uri-maxResults"></a>
The maximum number of configured chat controls to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_GetChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_GetChatControlsConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetChatControlsConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "blockedPhrases": { 
      "blockedPhrases": [ "string" ],
      "systemMessageOverride": "string"
   },
   "creatorModeConfiguration": { 
      "creatorModeControl": "string"
   },
   "hallucinationReductionConfiguration": { 
      "hallucinationReductionControl": "string"
   },
   "nextToken": "string",
   "orchestrationConfiguration": { 
      "control": "string"
   },
   "responseScope": "string",
   "topicConfigurations": [ 
      { 
         "description": "string",
         "exampleChatMessages": [ "string" ],
         "name": "string",
         "rules": [ 
            { 
               "excludedUsersAndGroups": { 
                  "userGroups": [ "string" ],
                  "userIds": [ "string" ]
               },
               "includedUsersAndGroups": { 
                  "userGroups": [ "string" ],
                  "userIds": [ "string" ]
               },
               "ruleConfiguration": { ... },
               "ruleType": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_GetChatControlsConfiguration_ResponseElements"></a>

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

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

 ** [blockedPhrases](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-blockedPhrases"></a>
The phrases blocked from chat by your chat control configuration.  
Type: [BlockedPhrasesConfiguration](API_BlockedPhrasesConfiguration.md) object

 ** [creatorModeConfiguration](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-creatorModeConfiguration"></a>
The configuration details for `CREATOR_MODE`.  
Type: [AppliedCreatorModeConfiguration](API_AppliedCreatorModeConfiguration.md) object

 ** [hallucinationReductionConfiguration](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-hallucinationReductionConfiguration"></a>
 The hallucination reduction settings for your application.  
Type: [HallucinationReductionConfiguration](API_HallucinationReductionConfiguration.md) object

 ** [nextToken](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [orchestrationConfiguration](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-orchestrationConfiguration"></a>
 The chat response orchestration settings for your application.  
Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see [Supported languages](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html).
Type: [AppliedOrchestrationConfiguration](API_AppliedOrchestrationConfiguration.md) object

 ** [responseScope](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-responseScope"></a>
The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.  
Type: String  
Valid Values: `ENTERPRISE_CONTENT_ONLY | EXTENDED_KNOWLEDGE_ENABLED` 

 ** [topicConfigurations](#API_GetChatControlsConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatControlsConfiguration-response-topicConfigurations"></a>
The topic specific controls configured for a Amazon Q Business application.  
Type: Array of [TopicConfiguration](API_TopicConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

## Errors
<a name="API_GetChatControlsConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetChatControlsConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetChatControlsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetChatControlsConfiguration) 

# GetChatResponseConfiguration
<a name="API_GetChatResponseConfiguration"></a>

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

## Request Syntax
<a name="API_GetChatResponseConfiguration_RequestSyntax"></a>

```
GET /applications/applicationId/chatresponseconfigurations/chatResponseConfigurationId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetChatResponseConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [chatResponseConfigurationId](#API_GetChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-request-uri-chatResponseConfigurationId"></a>
The unique identifier of the chat response configuration to retrieve from the specified application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetChatResponseConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetChatResponseConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "chatResponseConfigurationArn": "string",
   "chatResponseConfigurationId": "string",
   "createdAt": number,
   "displayName": "string",
   "inUseConfiguration": { 
      "error": { 
         "errorCode": "string",
         "errorMessage": "string"
      },
      "responseConfigurations": { 
         "string" : { 
            "instructionCollection": { 
               "customInstructions": "string",
               "examples": "string",
               "identity": "string",
               "outputStyle": "string",
               "perspective": "string",
               "responseLength": "string",
               "targetAudience": "string",
               "tone": "string"
            }
         }
      },
      "responseConfigurationSummary": "string",
      "status": "string",
      "updatedAt": number
   },
   "lastUpdateConfiguration": { 
      "error": { 
         "errorCode": "string",
         "errorMessage": "string"
      },
      "responseConfigurations": { 
         "string" : { 
            "instructionCollection": { 
               "customInstructions": "string",
               "examples": "string",
               "identity": "string",
               "outputStyle": "string",
               "perspective": "string",
               "responseLength": "string",
               "targetAudience": "string",
               "tone": "string"
            }
         }
      },
      "responseConfigurationSummary": "string",
      "status": "string",
      "updatedAt": number
   }
}
```

## Response Elements
<a name="API_GetChatResponseConfiguration_ResponseElements"></a>

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

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

 ** [chatResponseConfigurationArn](#API_GetChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-response-chatResponseConfigurationArn"></a>
The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all AWS services.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [chatResponseConfigurationId](#API_GetChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-response-chatResponseConfigurationId"></a>
The unique identifier of the retrieved chat response configuration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [createdAt](#API_GetChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-response-createdAt"></a>
The timestamp indicating when the chat response configuration was initially created.  
Type: Timestamp

 ** [displayName](#API_GetChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-response-displayName"></a>
The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [inUseConfiguration](#API_GetChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-response-inUseConfiguration"></a>
The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.  
Type: [ChatResponseConfigurationDetail](API_ChatResponseConfigurationDetail.md) object

 ** [lastUpdateConfiguration](#API_GetChatResponseConfiguration_ResponseSyntax) **   <a name="qbusiness-GetChatResponseConfiguration-response-lastUpdateConfiguration"></a>
Information about the most recent update to the configuration, including timestamp and modification details.  
Type: [ChatResponseConfigurationDetail](API_ChatResponseConfigurationDetail.md) object

## Errors
<a name="API_GetChatResponseConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetChatResponseConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetChatResponseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetChatResponseConfiguration) 

# GetDataAccessor
<a name="API_GetDataAccessor"></a>

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

## Request Syntax
<a name="API_GetDataAccessor_RequestSyntax"></a>

```
GET /applications/applicationId/dataaccessors/dataAccessorId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataAccessor_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetDataAccessor_RequestSyntax) **   <a name="qbusiness-GetDataAccessor-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataAccessorId](#API_GetDataAccessor_RequestSyntax) **   <a name="qbusiness-GetDataAccessor-request-uri-dataAccessorId"></a>
The unique identifier of the data accessor to retrieve.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetDataAccessor_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataAccessor_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionConfigurations": [ 
      { 
         "action": "string",
         "filterConfiguration": { 
            "documentAttributeFilter": { 
               "andAllFilters": [ 
                  "AttributeFilter"
               ],
               "containsAll": { 
                  "name": "string",
                  "value": { ... }
               },
               "containsAny": { 
                  "name": "string",
                  "value": { ... }
               },
               "equalsTo": { 
                  "name": "string",
                  "value": { ... }
               },
               "greaterThan": { 
                  "name": "string",
                  "value": { ... }
               },
               "greaterThanOrEquals": { 
                  "name": "string",
                  "value": { ... }
               },
               "lessThan": { 
                  "name": "string",
                  "value": { ... }
               },
               "lessThanOrEquals": { 
                  "name": "string",
                  "value": { ... }
               },
               "notFilter": "AttributeFilter",
               "orAllFilters": [ 
                  "AttributeFilter"
               ]
            }
         }
      }
   ],
   "applicationId": "string",
   "authenticationDetail": { 
      "authenticationConfiguration": { ... },
      "authenticationType": "string",
      "externalIds": [ "string" ]
   },
   "createdAt": number,
   "dataAccessorArn": "string",
   "dataAccessorId": "string",
   "displayName": "string",
   "idcApplicationArn": "string",
   "principal": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_GetDataAccessor_ResponseElements"></a>

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

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

 ** [actionConfigurations](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-actionConfigurations"></a>
The list of action configurations specifying the allowed actions and any associated filters.  
Type: Array of [ActionConfiguration](API_ActionConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.

 ** [applicationId](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-applicationId"></a>
The unique identifier of the Amazon Q Business application associated with this data accessor.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [authenticationDetail](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-authenticationDetail"></a>
The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.  
Type: [DataAccessorAuthenticationDetail](API_DataAccessorAuthenticationDetail.md) object

 ** [createdAt](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-createdAt"></a>
The timestamp when the data accessor was created.  
Type: Timestamp

 ** [dataAccessorArn](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-dataAccessorArn"></a>
The Amazon Resource Name (ARN) of the data accessor.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [dataAccessorId](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-dataAccessorId"></a>
The unique identifier of the data accessor.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [displayName](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-displayName"></a>
The friendly name of the data accessor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [idcApplicationArn](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-idcApplicationArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}` 

 ** [principal](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-principal"></a>
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1284.  
Pattern: `arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+` 

 ** [updatedAt](#API_GetDataAccessor_ResponseSyntax) **   <a name="qbusiness-GetDataAccessor-response-updatedAt"></a>
The timestamp when the data accessor was last updated.  
Type: Timestamp

## Errors
<a name="API_GetDataAccessor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetDataAccessor_SeeAlso"></a>

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/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetDataAccessor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetDataAccessor) 

# GetDataSource
<a name="API_GetDataSource"></a>

Gets information about an existing Amazon Q Business data source connector.

## Request Syntax
<a name="API_GetDataSource_RequestSyntax"></a>

```
GET /applications/applicationId/indices/indexId/datasources/dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetDataSource_RequestSyntax) **   <a name="qbusiness-GetDataSource-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_GetDataSource_RequestSyntax) **   <a name="qbusiness-GetDataSource-request-uri-dataSourceId"></a>
The identifier of the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_GetDataSource_RequestSyntax) **   <a name="qbusiness-GetDataSource-request-uri-indexId"></a>
The identfier of the index used with the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetDataSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "configuration": JSON value,
   "createdAt": number,
   "dataSourceArn": "string",
   "dataSourceId": "string",
   "description": "string",
   "displayName": "string",
   "documentEnrichmentConfiguration": { 
      "inlineConfigurations": [ 
         { 
            "condition": { 
               "key": "string",
               "operator": "string",
               "value": { ... }
            },
            "documentContentOperator": "string",
            "target": { 
               "attributeValueOperator": "string",
               "key": "string",
               "value": { ... }
            }
         }
      ],
      "postExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      },
      "preExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      }
   },
   "error": { 
      "errorCode": "string",
      "errorMessage": "string"
   },
   "indexId": "string",
   "mediaExtractionConfiguration": { 
      "audioExtractionConfiguration": { 
         "audioExtractionStatus": "string"
      },
      "imageExtractionConfiguration": { 
         "imageExtractionStatus": "string"
      },
      "videoExtractionConfiguration": { 
         "videoExtractionStatus": "string"
      }
   },
   "roleArn": "string",
   "status": "string",
   "syncSchedule": "string",
   "type": "string",
   "updatedAt": number,
   "vpcConfiguration": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_GetDataSource_ResponseElements"></a>

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

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

 ** [applicationId](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-applicationId"></a>
The identifier of the Amazon Q Business application.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [configuration](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-configuration"></a>
The details of how the data source connector is configured.  
Type: JSON value

 ** [createdAt](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-createdAt"></a>
The Unix timestamp when the data source connector was created.  
Type: Timestamp

 ** [dataSourceArn](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-dataSourceArn"></a>
The Amazon Resource Name (ARN) of the data source.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [dataSourceId](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-dataSourceId"></a>
The identifier of the data source connector.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [description](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-description"></a>
The description for the data source connector.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*` 

 ** [displayName](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-displayName"></a>
The name for the data source connector.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [documentEnrichmentConfiguration](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-documentEnrichmentConfiguration"></a>
Provides the configuration information for altering document metadata and content during the document ingestion process.  
For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).  
Type: [DocumentEnrichmentConfiguration](API_DocumentEnrichmentConfiguration.md) object

 ** [error](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-error"></a>
When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.  
Type: [ErrorDetail](API_ErrorDetail.md) object

 ** [indexId](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-indexId"></a>
The identifier of the index linked to the data source connector.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [mediaExtractionConfiguration](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-mediaExtractionConfiguration"></a>
The configuration for extracting information from media in documents for the data source.   
Type: [MediaExtractionConfiguration](API_MediaExtractionConfiguration.md) object

 ** [roleArn](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-roleArn"></a>
The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [status](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-status"></a>
The current status of the data source connector. When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.  
Type: String  
Valid Values: `PENDING_CREATION | CREATING | ACTIVE | DELETING | FAILED | UPDATING` 

 ** [syncSchedule](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-syncSchedule"></a>
The schedule for Amazon Q Business to update the index.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 998.  
Pattern: `[\s\S]*` 

 ** [type](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-type"></a>
The type of the data source connector. For example, `S3`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [updatedAt](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-updatedAt"></a>
The Unix timestamp when the data source connector was last updated.  
Type: Timestamp

 ** [vpcConfiguration](#API_GetDataSource_ResponseSyntax) **   <a name="qbusiness-GetDataSource-response-vpcConfiguration"></a>
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.  
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object

## Errors
<a name="API_GetDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetDataSource_SeeAlso"></a>

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/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetDataSource) 

# GetDocumentContent
<a name="API_GetDocumentContent"></a>

Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.

## Request Syntax
<a name="API_GetDocumentContent_RequestSyntax"></a>

```
GET /applications/applicationId/index/indexId/documents/documentId/content?dataSourceId=dataSourceId&outputFormat=outputFormat HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDocumentContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetDocumentContent_RequestSyntax) **   <a name="qbusiness-GetDocumentContent-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_GetDocumentContent_RequestSyntax) **   <a name="qbusiness-GetDocumentContent-request-uri-dataSourceId"></a>
The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [documentId](#API_GetDocumentContent_RequestSyntax) **   <a name="qbusiness-GetDocumentContent-request-uri-documentId"></a>
The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.  
Length Constraints: Minimum length of 1. Maximum length of 1825.  
Pattern: `\P{C}*`   
Required: Yes

 ** [indexId](#API_GetDocumentContent_RequestSyntax) **   <a name="qbusiness-GetDocumentContent-request-uri-indexId"></a>
The identifier of the index where documents are indexed.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [outputFormat](#API_GetDocumentContent_RequestSyntax) **   <a name="qbusiness-GetDocumentContent-request-uri-outputFormat"></a>
Document outputFormat. Defaults to RAW if not selected.  
Valid Values: `RAW | EXTRACTED` 

## Request Body
<a name="API_GetDocumentContent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDocumentContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "mimeType": "string",
   "presignedUrl": "string"
}
```

## Response Elements
<a name="API_GetDocumentContent_ResponseElements"></a>

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

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

 ** [mimeType](#API_GetDocumentContent_ResponseSyntax) **   <a name="qbusiness-GetDocumentContent-response-mimeType"></a>
The MIME type of the document content. When outputFormat is RAW, this corresponds to the original document's MIME type (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document). When outputFormat is EXTRACTED, the MIME type is always application/json.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [presignedUrl](#API_GetDocumentContent_ResponseSyntax) **   <a name="qbusiness-GetDocumentContent-response-presignedUrl"></a>
A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_GetDocumentContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetDocumentContent_SeeAlso"></a>

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/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetDocumentContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetDocumentContent) 

# GetGroup
<a name="API_GetGroup"></a>

Describes a group by group name.

## Request Syntax
<a name="API_GetGroup_RequestSyntax"></a>

```
GET /applications/applicationId/indices/indexId/groups/groupName?dataSourceId=dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetGroup_RequestSyntax) **   <a name="qbusiness-GetGroup-request-uri-applicationId"></a>
The identifier of the application id the group is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_GetGroup_RequestSyntax) **   <a name="qbusiness-GetGroup-request-uri-dataSourceId"></a>
The identifier of the data source the group is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [groupName](#API_GetGroup_RequestSyntax) **   <a name="qbusiness-GetGroup-request-uri-groupName"></a>
The name of the group.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*`   
Required: Yes

 ** [indexId](#API_GetGroup_RequestSyntax) **   <a name="qbusiness-GetGroup-request-uri-indexId"></a>
The identifier of the index the group is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": { 
      "errorDetail": { 
         "errorCode": "string",
         "errorMessage": "string"
      },
      "lastUpdatedAt": number,
      "status": "string"
   },
   "statusHistory": [ 
      { 
         "errorDetail": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "lastUpdatedAt": number,
         "status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetGroup_ResponseElements"></a>

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

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

 ** [status](#API_GetGroup_ResponseSyntax) **   <a name="qbusiness-GetGroup-response-status"></a>
The current status of the group.  
Type: [GroupStatusDetail](API_GroupStatusDetail.md) object

 ** [statusHistory](#API_GetGroup_ResponseSyntax) **   <a name="qbusiness-GetGroup-response-statusHistory"></a>
The status history of the group.  
Type: Array of [GroupStatusDetail](API_GroupStatusDetail.md) objects

## Errors
<a name="API_GetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetGroup_SeeAlso"></a>

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/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetGroup) 

# GetIndex
<a name="API_GetIndex"></a>

Gets information about an existing Amazon Q Business index.

## Request Syntax
<a name="API_GetIndex_RequestSyntax"></a>

```
GET /applications/applicationId/indices/indexId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIndex_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetIndex_RequestSyntax) **   <a name="qbusiness-GetIndex-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application connected to the index.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_GetIndex_RequestSyntax) **   <a name="qbusiness-GetIndex-request-uri-indexId"></a>
The identifier of the Amazon Q Business index you want information on.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetIndex_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIndex_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "capacityConfiguration": { 
      "units": number
   },
   "createdAt": number,
   "description": "string",
   "displayName": "string",
   "documentAttributeConfigurations": [ 
      { 
         "name": "string",
         "search": "string",
         "type": "string"
      }
   ],
   "error": { 
      "errorCode": "string",
      "errorMessage": "string"
   },
   "indexArn": "string",
   "indexId": "string",
   "indexStatistics": { 
      "textDocumentStatistics": { 
         "indexedTextBytes": number,
         "indexedTextDocumentCount": number
      }
   },
   "status": "string",
   "type": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_GetIndex_ResponseElements"></a>

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

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

 ** [applicationId](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-applicationId"></a>
The identifier of the Amazon Q Business application associated with the index.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [capacityConfiguration](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-capacityConfiguration"></a>
The storage capacity units chosen for your Amazon Q Business index.  
Type: [IndexCapacityConfiguration](API_IndexCapacityConfiguration.md) object

 ** [createdAt](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-createdAt"></a>
The Unix timestamp when the Amazon Q Business index was created.  
Type: Timestamp

 ** [description](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-description"></a>
The description for the Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*` 

 ** [displayName](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-displayName"></a>
The name of the Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [documentAttributeConfigurations](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-documentAttributeConfigurations"></a>
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes).  
Type: Array of [DocumentAttributeConfiguration](API_DocumentAttributeConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.

 ** [error](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-error"></a>
When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.  
Type: [ErrorDetail](API_ErrorDetail.md) object

 ** [indexArn](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-indexArn"></a>
 The Amazon Resource Name (ARN) of the Amazon Q Business index.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [indexId](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-indexId"></a>
The identifier of the Amazon Q Business index.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [indexStatistics](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-indexStatistics"></a>
Provides information about the number of documents indexed.  
Type: [IndexStatistics](API_IndexStatistics.md) object

 ** [status](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-status"></a>
The current status of the index. When the value is `ACTIVE`, the index is ready for use. If the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.  
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING` 

 ** [type](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-type"></a>
The type of index attached to your Amazon Q Business application.  
Type: String  
Valid Values: `ENTERPRISE | STARTER` 

 ** [updatedAt](#API_GetIndex_ResponseSyntax) **   <a name="qbusiness-GetIndex-response-updatedAt"></a>
The Unix timestamp when the Amazon Q Business index was last updated.  
Type: Timestamp

## Errors
<a name="API_GetIndex_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetIndex_SeeAlso"></a>

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/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetIndex) 

# GetMedia
<a name="API_GetMedia"></a>

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses.

For more information, see [Extracting semantic meaning from images and visuals](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html).

## Request Syntax
<a name="API_GetMedia_RequestSyntax"></a>

```
GET /applications/applicationId/conversations/conversationId/messages/messageId/media/mediaId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMedia_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetMedia_RequestSyntax) **   <a name="qbusiness-GetMedia-request-uri-applicationId"></a>
The identifier of the Amazon Q Business which contains the media object.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [conversationId](#API_GetMedia_RequestSyntax) **   <a name="qbusiness-GetMedia-request-uri-conversationId"></a>
The identifier of the Amazon Q Business conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [mediaId](#API_GetMedia_RequestSyntax) **   <a name="qbusiness-GetMedia-request-uri-mediaId"></a>
The identifier of the media object. You can find this in the `sourceAttributions` returned by the `Chat`, `ChatSync`, and `ListMessages` API responses.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [messageId](#API_GetMedia_RequestSyntax) **   <a name="qbusiness-GetMedia-request-uri-messageId"></a>
The identifier of the Amazon Q Business message.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetMedia_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMedia_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "mediaBytes": blob,
   "mediaMimeType": "string"
}
```

## Response Elements
<a name="API_GetMedia_ResponseElements"></a>

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

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

 ** [mediaBytes](#API_GetMedia_ResponseSyntax) **   <a name="qbusiness-GetMedia-response-mediaBytes"></a>
The base64-encoded bytes of the media object.  
Type: Base64-encoded binary data object

 ** [mediaMimeType](#API_GetMedia_ResponseSyntax) **   <a name="qbusiness-GetMedia-response-mediaMimeType"></a>
The MIME type of the media object (image/png).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_GetMedia_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** MediaTooLargeException **   
The requested media object is too large to be returned.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetMedia_SeeAlso"></a>

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/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetMedia) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetMedia) 

# GetPlugin
<a name="API_GetPlugin"></a>

Gets information about an existing Amazon Q Business plugin.

## Request Syntax
<a name="API_GetPlugin_RequestSyntax"></a>

```
GET /applications/applicationId/plugins/pluginId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetPlugin_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetPlugin_RequestSyntax) **   <a name="qbusiness-GetPlugin-request-uri-applicationId"></a>
The identifier of the application which contains the plugin.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [pluginId](#API_GetPlugin_RequestSyntax) **   <a name="qbusiness-GetPlugin-request-uri-pluginId"></a>
The identifier of the plugin.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetPlugin_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetPlugin_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "authConfiguration": { ... },
   "buildStatus": "string",
   "createdAt": number,
   "customPluginConfiguration": { 
      "apiSchema": { ... },
      "apiSchemaType": "string",
      "description": "string"
   },
   "displayName": "string",
   "pluginArn": "string",
   "pluginId": "string",
   "serverUrl": "string",
   "state": "string",
   "type": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_GetPlugin_ResponseElements"></a>

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

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

 ** [applicationId](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-applicationId"></a>
The identifier of the application which contains the plugin.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [authConfiguration](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-authConfiguration"></a>
Authentication configuration information for an Amazon Q Business plugin.  
Type: [PluginAuthConfiguration](API_PluginAuthConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [buildStatus](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-buildStatus"></a>
The current status of a plugin. A plugin is modified asynchronously.  
Type: String  
Valid Values: `READY | CREATE_IN_PROGRESS | CREATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_FAILED | DELETE_IN_PROGRESS | DELETE_FAILED` 

 ** [createdAt](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-createdAt"></a>
The timestamp for when the plugin was created.  
Type: Timestamp

 ** [customPluginConfiguration](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-customPluginConfiguration"></a>
Configuration information required to create a custom plugin.  
Type: [CustomPluginConfiguration](API_CustomPluginConfiguration.md) object

 ** [displayName](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-displayName"></a>
The name of the plugin.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [pluginArn](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-pluginArn"></a>
The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [pluginId](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-pluginId"></a>
The identifier of the plugin.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [serverUrl](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-serverUrl"></a>
The source URL used for plugin configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(https?|ftp|file)://([^\s]*)` 

 ** [state](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-state"></a>
The current state of the plugin.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [type](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-type"></a>
The type of the plugin.  
Type: String  
Valid Values: `SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM | QUICKSIGHT | SERVICENOW_NOW_PLATFORM | JIRA_CLOUD | SALESFORCE_CRM | ZENDESK_SUITE | ATLASSIAN_CONFLUENCE | GOOGLE_CALENDAR | MICROSOFT_TEAMS | MICROSOFT_EXCHANGE | PAGERDUTY_ADVANCE | SMARTSHEET | ASANA` 

 ** [updatedAt](#API_GetPlugin_ResponseSyntax) **   <a name="qbusiness-GetPlugin-response-updatedAt"></a>
The timestamp for when the plugin was last updated.  
Type: Timestamp

## Errors
<a name="API_GetPlugin_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetPlugin_SeeAlso"></a>

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/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetPlugin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetPlugin) 

# GetPolicy
<a name="API_GetPolicy"></a>

Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

## Request Syntax
<a name="API_GetPolicy_RequestSyntax"></a>

```
GET /applications/applicationId/policy HTTP/1.1
```

## URI Request Parameters
<a name="API_GetPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetPolicy_RequestSyntax) **   <a name="qbusiness-GetPolicy-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "policy": "string"
}
```

## Response Elements
<a name="API_GetPolicy_ResponseElements"></a>

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

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

 ** [policy](#API_GetPolicy_ResponseSyntax) **   <a name="qbusiness-GetPolicy-response-policy"></a>
The JSON representation of the permission policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_GetPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetPolicy_SeeAlso"></a>

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/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetPolicy) 

# GetRetriever
<a name="API_GetRetriever"></a>

Gets information about an existing retriever used by an Amazon Q Business application.

## Request Syntax
<a name="API_GetRetriever_RequestSyntax"></a>

```
GET /applications/applicationId/retrievers/retrieverId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRetriever_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetRetriever_RequestSyntax) **   <a name="qbusiness-GetRetriever-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application using the retriever.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [retrieverId](#API_GetRetriever_RequestSyntax) **   <a name="qbusiness-GetRetriever-request-uri-retrieverId"></a>
The identifier of the retriever.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_GetRetriever_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRetriever_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "configuration": { ... },
   "createdAt": number,
   "displayName": "string",
   "retrieverArn": "string",
   "retrieverId": "string",
   "roleArn": "string",
   "status": "string",
   "type": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_GetRetriever_ResponseElements"></a>

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

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

 ** [applicationId](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-applicationId"></a>
The identifier of the Amazon Q Business application using the retriever.   
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [configuration](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-configuration"></a>
Provides information on how the retriever used for your Amazon Q Business application is configured.  
Type: [RetrieverConfiguration](API_RetrieverConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-createdAt"></a>
The Unix timestamp when the retriever was created.  
Type: Timestamp

 ** [displayName](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-displayName"></a>
The name of the retriever.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [retrieverArn](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-retrieverArn"></a>
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [retrieverId](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-retrieverId"></a>
The identifier of the retriever.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [roleArn](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-roleArn"></a>
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [status](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-status"></a>
The status of the retriever.  
Type: String  
Valid Values: `CREATING | ACTIVE | FAILED` 

 ** [type](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-type"></a>
The type of the retriever.  
Type: String  
Valid Values: `NATIVE_INDEX | KENDRA_INDEX` 

 ** [updatedAt](#API_GetRetriever_ResponseSyntax) **   <a name="qbusiness-GetRetriever-response-updatedAt"></a>
The Unix timestamp when the retriever was last updated.  
Type: Timestamp

## Errors
<a name="API_GetRetriever_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetRetriever_SeeAlso"></a>

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/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetRetriever) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetRetriever) 

# GetUser
<a name="API_GetUser"></a>

Describes the universally unique identifier (UUID) associated with a local user in a data source.

## Request Syntax
<a name="API_GetUser_RequestSyntax"></a>

```
GET /applications/applicationId/users/userId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetUser_RequestSyntax) **   <a name="qbusiness-GetUser-request-uri-applicationId"></a>
The identifier of the application connected to the user.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_GetUser_RequestSyntax) **   <a name="qbusiness-GetUser-request-uri-userId"></a>
The user email address attached to the user.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Request Body
<a name="API_GetUser_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUser_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "userAliases": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetUser_ResponseElements"></a>

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

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

 ** [userAliases](#API_GetUser_ResponseSyntax) **   <a name="qbusiness-GetUser-response-userAliases"></a>
A list of user aliases attached to a user.  
Type: Array of [UserAlias](API_UserAlias.md) objects

## Errors
<a name="API_GetUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetUser_SeeAlso"></a>

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/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetUser) 

# GetWebExperience
<a name="API_GetWebExperience"></a>

Gets information about an existing Amazon Q Business web experience.

## Request Syntax
<a name="API_GetWebExperience_RequestSyntax"></a>

```
GET /applications/applicationId/experiences/webExperienceId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetWebExperience_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_GetWebExperience_RequestSyntax) **   <a name="qbusiness-GetWebExperience-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to the web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [webExperienceId](#API_GetWebExperience_RequestSyntax) **   <a name="qbusiness-GetWebExperience-request-uri-webExperienceId"></a>
The identifier of the Amazon Q Business web experience.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

## Request Body
<a name="API_GetWebExperience_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetWebExperience_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "authenticationConfiguration": { ... },
   "browserExtensionConfiguration": { 
      "enabledBrowserExtensions": [ "string" ]
   },
   "createdAt": number,
   "customizationConfiguration": { 
      "customCSSUrl": "string",
      "faviconUrl": "string",
      "fontUrl": "string",
      "logoUrl": "string"
   },
   "defaultEndpoint": "string",
   "error": { 
      "errorCode": "string",
      "errorMessage": "string"
   },
   "identityProviderConfiguration": { ... },
   "origins": [ "string" ],
   "roleArn": "string",
   "samplePromptsControlMode": "string",
   "status": "string",
   "subtitle": "string",
   "title": "string",
   "updatedAt": number,
   "webExperienceArn": "string",
   "webExperienceId": "string",
   "welcomeMessage": "string"
}
```

## Response Elements
<a name="API_GetWebExperience_ResponseElements"></a>

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

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

 ** [applicationId](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-applicationId"></a>
The identifier of the Amazon Q Business application linked to the web experience.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [authenticationConfiguration](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-authenticationConfiguration"></a>
 *This parameter has been deprecated.*   
The authentication configuration information for your Amazon Q Business web experience.  
Type: [WebExperienceAuthConfiguration](API_WebExperienceAuthConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [browserExtensionConfiguration](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-browserExtensionConfiguration"></a>
The browser extension configuration for an Amazon Q Business web experience.  
Type: [BrowserExtensionConfiguration](API_BrowserExtensionConfiguration.md) object

 ** [createdAt](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-createdAt"></a>
The Unix timestamp when the Amazon Q Business web experience was last created.  
Type: Timestamp

 ** [customizationConfiguration](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-customizationConfiguration"></a>
Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.   
Type: [CustomizationConfiguration](API_CustomizationConfiguration.md) object

 ** [defaultEndpoint](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-defaultEndpoint"></a>
The endpoint of your Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(https?|ftp|file)://([^\s]*)` 

 ** [error](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-error"></a>
When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.  
Type: [ErrorDetail](API_ErrorDetail.md) object

 ** [identityProviderConfiguration](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-identityProviderConfiguration"></a>
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.  
Type: [IdentityProviderConfiguration](API_IdentityProviderConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [origins](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-origins"></a>
Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol (`http/https`), the domain name, and the port number (if specified).   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?` 

 ** [roleArn](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-roleArn"></a>
 The Amazon Resource Name (ARN) of the service role attached to your web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [samplePromptsControlMode](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-samplePromptsControlMode"></a>
Determines whether sample prompts are enabled in the web experience for an end user.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [status](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-status"></a>
The current status of the Amazon Q Business web experience. When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.   
Type: String  
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | PENDING_AUTH_CONFIG` 

 ** [subtitle](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-subtitle"></a>
The subtitle for your Amazon Q Business web experience.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `[\s\S]*` 

 ** [title](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-title"></a>
The title for your Amazon Q Business web experience.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `[\s\S]*` 

 ** [updatedAt](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-updatedAt"></a>
The Unix timestamp when the Amazon Q Business web experience was last updated.  
Type: Timestamp

 ** [webExperienceArn](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-webExperienceArn"></a>
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

 ** [webExperienceId](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-webExperienceId"></a>
The identifier of the Amazon Q Business web experience.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*` 

 ** [welcomeMessage](#API_GetWebExperience_ResponseSyntax) **   <a name="qbusiness-GetWebExperience-response-welcomeMessage"></a>
The customized welcome message for end users of an Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 300.

## Errors
<a name="API_GetWebExperience_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_GetWebExperience_SeeAlso"></a>

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/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/GetWebExperience) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/GetWebExperience) 

# ListApplications
<a name="API_ListApplications"></a>

Lists Amazon Q Business applications.

**Note**  
Amazon Q Business applications may securely transmit data for processing across AWS Regions within your geography. For more information, see [Cross region inference in Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html).

## Request Syntax
<a name="API_ListApplications_RequestSyntax"></a>

```
GET /applications?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListApplications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListApplications_RequestSyntax) **   <a name="qbusiness-ListApplications-request-uri-maxResults"></a>
The maximum number of Amazon Q Business applications to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListApplications_RequestSyntax) **   <a name="qbusiness-ListApplications-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListApplications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListApplications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applications": [ 
      { 
         "applicationId": "string",
         "createdAt": number,
         "displayName": "string",
         "identityType": "string",
         "quickSightConfiguration": { 
            "clientNamespace": "string"
         },
         "status": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListApplications_ResponseElements"></a>

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

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

 ** [applications](#API_ListApplications_ResponseSyntax) **   <a name="qbusiness-ListApplications-response-applications"></a>
An array of summary information on the configuration of one or more Amazon Q Business applications.  
Type: Array of [Application](API_Application.md) objects

 ** [nextToken](#API_ListApplications_ResponseSyntax) **   <a name="qbusiness-ListApplications-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListApplications_SeeAlso"></a>

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/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListApplications) 

# ListAttachments
<a name="API_ListAttachments"></a>

Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.

## Request Syntax
<a name="API_ListAttachments_RequestSyntax"></a>

```
GET /applications/applicationId/attachments?conversationId=conversationId&maxResults=maxResults&nextToken=nextToken&userId=userId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAttachments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListAttachments_RequestSyntax) **   <a name="qbusiness-ListAttachments-request-uri-applicationId"></a>
The unique identifier for the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [conversationId](#API_ListAttachments_RequestSyntax) **   <a name="qbusiness-ListAttachments-request-uri-conversationId"></a>
The unique identifier of the Amazon Q Business web experience conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [maxResults](#API_ListAttachments_RequestSyntax) **   <a name="qbusiness-ListAttachments-request-uri-maxResults"></a>
The maximum number of attachements to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListAttachments_RequestSyntax) **   <a name="qbusiness-ListAttachments-request-uri-nextToken"></a>
If the number of attachments returned exceeds `maxResults`, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [userId](#API_ListAttachments_RequestSyntax) **   <a name="qbusiness-ListAttachments-request-uri-userId"></a>
The unique identifier of the user involved in the Amazon Q Business web experience conversation.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_ListAttachments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAttachments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attachments": [ 
      { 
         "attachmentId": "string",
         "conversationId": "string",
         "copyFrom": { ... },
         "createdAt": number,
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "fileSize": number,
         "fileType": "string",
         "md5chksum": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAttachments_ResponseElements"></a>

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

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

 ** [attachments](#API_ListAttachments_ResponseSyntax) **   <a name="qbusiness-ListAttachments-response-attachments"></a>
An array of information on one or more attachments.  
Type: Array of [Attachment](API_Attachment.md) objects

 ** [nextToken](#API_ListAttachments_ResponseSyntax) **   <a name="qbusiness-ListAttachments-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of attachments.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListAttachments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListAttachments_SeeAlso"></a>

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/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListAttachments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListAttachments) 

# ListChatResponseConfigurations
<a name="API_ListChatResponseConfigurations"></a>

Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.

## Request Syntax
<a name="API_ListChatResponseConfigurations_RequestSyntax"></a>

```
GET /applications/applicationId/chatresponseconfigurations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListChatResponseConfigurations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListChatResponseConfigurations_RequestSyntax) **   <a name="qbusiness-ListChatResponseConfigurations-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application for which to list available chat response configurations.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListChatResponseConfigurations_RequestSyntax) **   <a name="qbusiness-ListChatResponseConfigurations-request-uri-maxResults"></a>
The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.

 ** [nextToken](#API_ListChatResponseConfigurations_RequestSyntax) **   <a name="qbusiness-ListChatResponseConfigurations-request-uri-nextToken"></a>
A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified `maxResults` value.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListChatResponseConfigurations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListChatResponseConfigurations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "chatResponseConfigurations": [ 
      { 
         "chatResponseConfigurationArn": "string",
         "chatResponseConfigurationId": "string",
         "createdAt": number,
         "displayName": "string",
         "responseConfigurationSummary": "string",
         "status": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListChatResponseConfigurations_ResponseElements"></a>

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

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

 ** [chatResponseConfigurations](#API_ListChatResponseConfigurations_ResponseSyntax) **   <a name="qbusiness-ListChatResponseConfigurations-response-chatResponseConfigurations"></a>
A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.  
Type: Array of [ChatResponseConfiguration](API_ChatResponseConfiguration.md) objects

 ** [nextToken](#API_ListChatResponseConfigurations_ResponseSyntax) **   <a name="qbusiness-ListChatResponseConfigurations-response-nextToken"></a>
A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the `maxResults` parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListChatResponseConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListChatResponseConfigurations_SeeAlso"></a>

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/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListChatResponseConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListChatResponseConfigurations) 

# ListConversations
<a name="API_ListConversations"></a>

Lists one or more Amazon Q Business conversations.

## Request Syntax
<a name="API_ListConversations_RequestSyntax"></a>

```
GET /applications/applicationId/conversations?maxResults=maxResults&nextToken=nextToken&userId=userId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListConversations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListConversations_RequestSyntax) **   <a name="qbusiness-ListConversations-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListConversations_RequestSyntax) **   <a name="qbusiness-ListConversations-request-uri-maxResults"></a>
The maximum number of Amazon Q Business conversations to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListConversations_RequestSyntax) **   <a name="qbusiness-ListConversations-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [userId](#API_ListConversations_RequestSyntax) **   <a name="qbusiness-ListConversations-request-uri-userId"></a>
The identifier of the user involved in the Amazon Q Business web experience conversation.   
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_ListConversations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListConversations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "conversations": [ 
      { 
         "conversationId": "string",
         "startTime": number,
         "title": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListConversations_ResponseElements"></a>

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

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

 ** [conversations](#API_ListConversations_ResponseSyntax) **   <a name="qbusiness-ListConversations-response-conversations"></a>
An array of summary information on the configuration of one or more Amazon Q Business web experiences.  
Type: Array of [Conversation](API_Conversation.md) objects

 ** [nextToken](#API_ListConversations_ResponseSyntax) **   <a name="qbusiness-ListConversations-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListConversations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListConversations_SeeAlso"></a>

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/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListConversations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListConversations) 

# ListDataAccessors
<a name="API_ListDataAccessors"></a>

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

## Request Syntax
<a name="API_ListDataAccessors_RequestSyntax"></a>

```
GET /applications/applicationId/dataaccessors?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataAccessors_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListDataAccessors_RequestSyntax) **   <a name="qbusiness-ListDataAccessors-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListDataAccessors_RequestSyntax) **   <a name="qbusiness-ListDataAccessors-request-uri-maxResults"></a>
The maximum number of results to return in a single call.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [nextToken](#API_ListDataAccessors_RequestSyntax) **   <a name="qbusiness-ListDataAccessors-request-uri-nextToken"></a>
The token for the next set of results. (You received this token from a previous call.)  
Length Constraints: Minimum length of 1. Maximum length of 1500.

## Request Body
<a name="API_ListDataAccessors_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataAccessors_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataAccessors": [ 
      { 
         "authenticationDetail": { 
            "authenticationConfiguration": { ... },
            "authenticationType": "string",
            "externalIds": [ "string" ]
         },
         "createdAt": number,
         "dataAccessorArn": "string",
         "dataAccessorId": "string",
         "displayName": "string",
         "idcApplicationArn": "string",
         "principal": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataAccessors_ResponseElements"></a>

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

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

 ** [dataAccessors](#API_ListDataAccessors_ResponseSyntax) **   <a name="qbusiness-ListDataAccessors-response-dataAccessors"></a>
The list of data accessors.  
Type: Array of [DataAccessor](API_DataAccessor.md) objects

 ** [nextToken](#API_ListDataAccessors_ResponseSyntax) **   <a name="qbusiness-ListDataAccessors-response-nextToken"></a>
The token to use to retrieve the next set of results, if there are any.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1500.

## Errors
<a name="API_ListDataAccessors_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListDataAccessors_SeeAlso"></a>

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/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListDataAccessors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListDataAccessors) 

# ListDataSources
<a name="API_ListDataSources"></a>

Lists the Amazon Q Business data source connectors that you have created.

## Request Syntax
<a name="API_ListDataSources_RequestSyntax"></a>

```
GET /applications/applicationId/indices/indexId/datasources?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataSources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListDataSources_RequestSyntax) **   <a name="qbusiness-ListDataSources-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to the data source connectors.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_ListDataSources_RequestSyntax) **   <a name="qbusiness-ListDataSources-request-uri-indexId"></a>
The identifier of the index used with one or more data source connectors.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListDataSources_RequestSyntax) **   <a name="qbusiness-ListDataSources-request-uri-maxResults"></a>
The maximum number of data source connectors to return.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [nextToken](#API_ListDataSources_RequestSyntax) **   <a name="qbusiness-ListDataSources-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListDataSources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataSources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataSources": [ 
      { 
         "createdAt": number,
         "dataSourceId": "string",
         "displayName": "string",
         "status": "string",
         "type": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataSources_ResponseElements"></a>

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

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

 ** [dataSources](#API_ListDataSources_ResponseSyntax) **   <a name="qbusiness-ListDataSources-response-dataSources"></a>
An array of summary information for one or more data source connector.  
Type: Array of [DataSource](API_DataSource.md) objects

 ** [nextToken](#API_ListDataSources_ResponseSyntax) **   <a name="qbusiness-ListDataSources-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListDataSources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListDataSources_SeeAlso"></a>

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/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListDataSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListDataSources) 

# ListDataSourceSyncJobs
<a name="API_ListDataSourceSyncJobs"></a>

Get information about an Amazon Q Business data source connector synchronization.

## Request Syntax
<a name="API_ListDataSourceSyncJobs_RequestSyntax"></a>

```
GET /applications/applicationId/indices/indexId/datasources/dataSourceId/syncjobs?endTime=endTime&maxResults=maxResults&nextToken=nextToken&startTime=startTime&syncStatus=statusFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataSourceSyncJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application connected to the data source.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-dataSourceId"></a>
 The identifier of the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [endTime](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-endTime"></a>
 The end time of the data source connector sync.

 ** [indexId](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-indexId"></a>
The identifier of the index used with the Amazon Q Business data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-maxResults"></a>
The maximum number of synchronization jobs to return in the response.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [nextToken](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-nextToken"></a>
If the `maxResults` response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [startTime](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-startTime"></a>
 The start time of the data source connector sync. 

 ** [statusFilter](#API_ListDataSourceSyncJobs_RequestSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-request-uri-statusFilter"></a>
Only returns synchronization jobs with the `Status` field equal to the specified status.  
Valid Values: `FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXING` 

## Request Body
<a name="API_ListDataSourceSyncJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataSourceSyncJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "history": [ 
      { 
         "dataSourceErrorCode": "string",
         "endTime": number,
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "executionId": "string",
         "metrics": { 
            "documentsAdded": "string",
            "documentsDeleted": "string",
            "documentsFailed": "string",
            "documentsModified": "string",
            "documentsScanned": "string"
         },
         "startTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataSourceSyncJobs_ResponseElements"></a>

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

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

 ** [history](#API_ListDataSourceSyncJobs_ResponseSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-response-history"></a>
A history of synchronization jobs for the data source connector.  
Type: Array of [DataSourceSyncJob](API_DataSourceSyncJob.md) objects

 ** [nextToken](#API_ListDataSourceSyncJobs_ResponseSyntax) **   <a name="qbusiness-ListDataSourceSyncJobs-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListDataSourceSyncJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListDataSourceSyncJobs_SeeAlso"></a>

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/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListDataSourceSyncJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListDataSourceSyncJobs) 

# ListDocuments
<a name="API_ListDocuments"></a>

A list of documents attached to an index.

## Request Syntax
<a name="API_ListDocuments_RequestSyntax"></a>

```
GET /applications/applicationId/index/indexId/documents?dataSourceIds=dataSourceIds&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDocuments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListDocuments_RequestSyntax) **   <a name="qbusiness-ListDocuments-request-uri-applicationId"></a>
The identifier of the application id the documents are attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceIds](#API_ListDocuments_RequestSyntax) **   <a name="qbusiness-ListDocuments-request-uri-dataSourceIds"></a>
The identifier of the data sources the documents are attached to.  
Array Members: Fixed number of 1 item.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [indexId](#API_ListDocuments_RequestSyntax) **   <a name="qbusiness-ListDocuments-request-uri-indexId"></a>
The identifier of the index the documents are attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListDocuments_RequestSyntax) **   <a name="qbusiness-ListDocuments-request-uri-maxResults"></a>
The maximum number of documents to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListDocuments_RequestSyntax) **   <a name="qbusiness-ListDocuments-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListDocuments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDocuments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "documentDetailList": [ 
      { 
         "createdAt": number,
         "documentId": "string",
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "status": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDocuments_ResponseElements"></a>

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

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

 ** [documentDetailList](#API_ListDocuments_ResponseSyntax) **   <a name="qbusiness-ListDocuments-response-documentDetailList"></a>
A list of document details.  
Type: Array of [DocumentDetails](API_DocumentDetails.md) objects

 ** [nextToken](#API_ListDocuments_ResponseSyntax) **   <a name="qbusiness-ListDocuments-response-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListDocuments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListDocuments_SeeAlso"></a>

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/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListDocuments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListDocuments) 

# ListGroups
<a name="API_ListGroups"></a>

Provides a list of groups that are mapped to users.

## Request Syntax
<a name="API_ListGroups_RequestSyntax"></a>

```
GET /applications/applicationId/indices/indexId/groups?dataSourceId=dataSourceId&maxResults=maxResults&nextToken=nextToken&updatedEarlierThan=updatedEarlierThan HTTP/1.1
```

## URI Request Parameters
<a name="API_ListGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListGroups_RequestSyntax) **   <a name="qbusiness-ListGroups-request-uri-applicationId"></a>
The identifier of the application for getting a list of groups mapped to users.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_ListGroups_RequestSyntax) **   <a name="qbusiness-ListGroups-request-uri-dataSourceId"></a>
The identifier of the data source for getting a list of groups mapped to users.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

 ** [indexId](#API_ListGroups_RequestSyntax) **   <a name="qbusiness-ListGroups-request-uri-indexId"></a>
The identifier of the index for getting a list of groups mapped to users.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListGroups_RequestSyntax) **   <a name="qbusiness-ListGroups-request-uri-maxResults"></a>
The maximum number of returned groups that are mapped to users.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [nextToken](#API_ListGroups_RequestSyntax) **   <a name="qbusiness-ListGroups-request-uri-nextToken"></a>
If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [updatedEarlierThan](#API_ListGroups_RequestSyntax) **   <a name="qbusiness-ListGroups-request-uri-updatedEarlierThan"></a>
The timestamp identifier used for the latest `PUT` or `DELETE` action for mapping users to their groups.  
Required: Yes

## Request Body
<a name="API_ListGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "groupName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListGroups_ResponseElements"></a>

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

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

 ** [items](#API_ListGroups_ResponseSyntax) **   <a name="qbusiness-ListGroups-response-items"></a>
Summary information for list of groups that are mapped to users.  
Type: Array of [GroupSummary](API_GroupSummary.md) objects

 ** [nextToken](#API_ListGroups_ResponseSyntax) **   <a name="qbusiness-ListGroups-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListGroups_SeeAlso"></a>

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/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListGroups) 

# ListIndices
<a name="API_ListIndices"></a>

Lists the Amazon Q Business indices you have created.

## Request Syntax
<a name="API_ListIndices_RequestSyntax"></a>

```
GET /applications/applicationId/indices?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListIndices_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListIndices_RequestSyntax) **   <a name="qbusiness-ListIndices-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application connected to the index.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListIndices_RequestSyntax) **   <a name="qbusiness-ListIndices-request-uri-maxResults"></a>
The maximum number of indices to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListIndices_RequestSyntax) **   <a name="qbusiness-ListIndices-request-uri-nextToken"></a>
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListIndices_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListIndices_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "indices": [ 
      { 
         "createdAt": number,
         "displayName": "string",
         "indexId": "string",
         "status": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListIndices_ResponseElements"></a>

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

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

 ** [indices](#API_ListIndices_ResponseSyntax) **   <a name="qbusiness-ListIndices-response-indices"></a>
An array of information on the items in one or more indexes.  
Type: Array of [Index](API_Index.md) objects

 ** [nextToken](#API_ListIndices_ResponseSyntax) **   <a name="qbusiness-ListIndices-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListIndices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListIndices_SeeAlso"></a>

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/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListIndices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListIndices) 

# ListMessages
<a name="API_ListMessages"></a>

Gets a list of messages associated with an Amazon Q Business web experience.

## Request Syntax
<a name="API_ListMessages_RequestSyntax"></a>

```
GET /applications/applicationId/conversations/conversationId?maxResults=maxResults&nextToken=nextToken&userId=userId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListMessages_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListMessages_RequestSyntax) **   <a name="qbusiness-ListMessages-request-uri-applicationId"></a>
The identifier for the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [conversationId](#API_ListMessages_RequestSyntax) **   <a name="qbusiness-ListMessages-request-uri-conversationId"></a>
The identifier of the Amazon Q Business web experience conversation.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListMessages_RequestSyntax) **   <a name="qbusiness-ListMessages-request-uri-maxResults"></a>
The maximum number of messages to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListMessages_RequestSyntax) **   <a name="qbusiness-ListMessages-request-uri-nextToken"></a>
If the number of messages returned exceeds `maxResults`, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [userId](#API_ListMessages_RequestSyntax) **   <a name="qbusiness-ListMessages-request-uri-userId"></a>
The identifier of the user involved in the Amazon Q Business web experience conversation.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_ListMessages_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListMessages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messages": [ 
      { 
         "actionExecution": { 
            "payload": { 
               "string" : { 
                  "value": JSON value
               }
            },
            "payloadFieldNameSeparator": "string",
            "pluginId": "string"
         },
         "actionReview": { 
            "payload": { 
               "string" : { 
                  "allowedFormat": "string",
                  "allowedValues": [ 
                     { 
                        "displayValue": JSON value,
                        "value": JSON value
                     }
                  ],
                  "arrayItemJsonSchema": JSON value,
                  "displayDescription": "string",
                  "displayName": "string",
                  "displayOrder": number,
                  "required": boolean,
                  "type": "string",
                  "value": JSON value
               }
            },
            "payloadFieldNameSeparator": "string",
            "pluginId": "string",
            "pluginType": "string"
         },
         "attachments": [ 
            { 
               "attachmentId": "string",
               "conversationId": "string",
               "error": { 
                  "errorCode": "string",
                  "errorMessage": "string"
               },
               "name": "string",
               "status": "string"
            }
         ],
         "body": "string",
         "messageId": "string",
         "sourceAttribution": [ 
            { 
               "citationNumber": number,
               "datasourceId": "string",
               "documentId": "string",
               "indexId": "string",
               "snippet": "string",
               "textMessageSegments": [ 
                  { 
                     "beginOffset": number,
                     "endOffset": number,
                     "mediaId": "string",
                     "mediaMimeType": "string",
                     "snippetExcerpt": { 
                        "text": "string"
                     },
                     "sourceDetails": { ... }
                  }
               ],
               "title": "string",
               "updatedAt": number,
               "url": "string"
            }
         ],
         "time": number,
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListMessages_ResponseElements"></a>

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

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

 ** [messages](#API_ListMessages_ResponseSyntax) **   <a name="qbusiness-ListMessages-response-messages"></a>
An array of information on one or more messages.  
Type: Array of [Message](API_Message.md) objects

 ** [nextToken](#API_ListMessages_ResponseSyntax) **   <a name="qbusiness-ListMessages-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListMessages_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListMessages_SeeAlso"></a>

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/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListMessages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListMessages) 

# ListPluginActions
<a name="API_ListPluginActions"></a>

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

## Request Syntax
<a name="API_ListPluginActions_RequestSyntax"></a>

```
GET /applications/applicationId/plugins/pluginId/actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPluginActions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListPluginActions_RequestSyntax) **   <a name="qbusiness-ListPluginActions-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application the plugin is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListPluginActions_RequestSyntax) **   <a name="qbusiness-ListPluginActions-request-uri-maxResults"></a>
The maximum number of plugin actions to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListPluginActions_RequestSyntax) **   <a name="qbusiness-ListPluginActions-request-uri-nextToken"></a>
If the number of plugin actions returned exceeds `maxResults`, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [pluginId](#API_ListPluginActions_RequestSyntax) **   <a name="qbusiness-ListPluginActions-request-uri-pluginId"></a>
The identifier of the Amazon Q Business plugin.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_ListPluginActions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPluginActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "actionIdentifier": "string",
         "description": "string",
         "displayName": "string",
         "instructionExample": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListPluginActions_ResponseElements"></a>

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

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

 ** [items](#API_ListPluginActions_ResponseSyntax) **   <a name="qbusiness-ListPluginActions-response-items"></a>
An array of information on one or more plugin actions.  
Type: Array of [ActionSummary](API_ActionSummary.md) objects

 ** [nextToken](#API_ListPluginActions_ResponseSyntax) **   <a name="qbusiness-ListPluginActions-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListPluginActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListPluginActions_SeeAlso"></a>

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/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListPluginActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListPluginActions) 

# ListPlugins
<a name="API_ListPlugins"></a>

Lists configured Amazon Q Business plugins.

## Request Syntax
<a name="API_ListPlugins_RequestSyntax"></a>

```
GET /applications/applicationId/plugins?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPlugins_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListPlugins_RequestSyntax) **   <a name="qbusiness-ListPlugins-request-uri-applicationId"></a>
The identifier of the application the plugin is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListPlugins_RequestSyntax) **   <a name="qbusiness-ListPlugins-request-uri-maxResults"></a>
The maximum number of documents to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListPlugins_RequestSyntax) **   <a name="qbusiness-ListPlugins-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListPlugins_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPlugins_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "plugins": [ 
      { 
         "buildStatus": "string",
         "createdAt": number,
         "displayName": "string",
         "pluginId": "string",
         "serverUrl": "string",
         "state": "string",
         "type": "string",
         "updatedAt": number
      }
   ]
}
```

## Response Elements
<a name="API_ListPlugins_ResponseElements"></a>

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_ListPlugins_ResponseSyntax) **   <a name="qbusiness-ListPlugins-response-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [plugins](#API_ListPlugins_ResponseSyntax) **   <a name="qbusiness-ListPlugins-response-plugins"></a>
Information about a configured plugin.  
Type: Array of [Plugin](API_Plugin.md) objects

## Errors
<a name="API_ListPlugins_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListPlugins_SeeAlso"></a>

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/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListPlugins) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListPlugins) 

# ListPluginTypeActions
<a name="API_ListPluginTypeActions"></a>

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

## Request Syntax
<a name="API_ListPluginTypeActions_RequestSyntax"></a>

```
GET /pluginTypes/pluginType/actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPluginTypeActions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListPluginTypeActions_RequestSyntax) **   <a name="qbusiness-ListPluginTypeActions-request-uri-maxResults"></a>
The maximum number of plugins to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListPluginTypeActions_RequestSyntax) **   <a name="qbusiness-ListPluginTypeActions-request-uri-nextToken"></a>
If the number of plugins returned exceeds `maxResults`, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [pluginType](#API_ListPluginTypeActions_RequestSyntax) **   <a name="qbusiness-ListPluginTypeActions-request-uri-pluginType"></a>
The type of the plugin.  
Valid Values: `SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM | QUICKSIGHT | SERVICENOW_NOW_PLATFORM | JIRA_CLOUD | SALESFORCE_CRM | ZENDESK_SUITE | ATLASSIAN_CONFLUENCE | GOOGLE_CALENDAR | MICROSOFT_TEAMS | MICROSOFT_EXCHANGE | PAGERDUTY_ADVANCE | SMARTSHEET | ASANA`   
Required: Yes

## Request Body
<a name="API_ListPluginTypeActions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPluginTypeActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "actionIdentifier": "string",
         "description": "string",
         "displayName": "string",
         "instructionExample": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListPluginTypeActions_ResponseElements"></a>

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

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

 ** [items](#API_ListPluginTypeActions_ResponseSyntax) **   <a name="qbusiness-ListPluginTypeActions-response-items"></a>
An array of information on one or more plugins.  
Type: Array of [ActionSummary](API_ActionSummary.md) objects

 ** [nextToken](#API_ListPluginTypeActions_ResponseSyntax) **   <a name="qbusiness-ListPluginTypeActions-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListPluginTypeActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListPluginTypeActions_SeeAlso"></a>

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/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListPluginTypeActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListPluginTypeActions) 

# ListPluginTypeMetadata
<a name="API_ListPluginTypeMetadata"></a>

Lists metadata for all Amazon Q Business plugin types.

## Request Syntax
<a name="API_ListPluginTypeMetadata_RequestSyntax"></a>

```
GET /pluginTypeMetadata?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPluginTypeMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListPluginTypeMetadata_RequestSyntax) **   <a name="qbusiness-ListPluginTypeMetadata-request-uri-maxResults"></a>
The maximum number of plugin metadata items to return.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListPluginTypeMetadata_RequestSyntax) **   <a name="qbusiness-ListPluginTypeMetadata-request-uri-nextToken"></a>
If the metadata returned exceeds `maxResults`, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListPluginTypeMetadata_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPluginTypeMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "category": "string",
         "description": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListPluginTypeMetadata_ResponseElements"></a>

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

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

 ** [items](#API_ListPluginTypeMetadata_ResponseSyntax) **   <a name="qbusiness-ListPluginTypeMetadata-response-items"></a>
An array of information on plugin metadata.  
Type: Array of [PluginTypeMetadataSummary](API_PluginTypeMetadataSummary.md) objects

 ** [nextToken](#API_ListPluginTypeMetadata_ResponseSyntax) **   <a name="qbusiness-ListPluginTypeMetadata-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors
<a name="API_ListPluginTypeMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListPluginTypeMetadata_SeeAlso"></a>

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/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListPluginTypeMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListPluginTypeMetadata) 

# ListRetrievers
<a name="API_ListRetrievers"></a>

Lists the retriever used by an Amazon Q Business application.

## Request Syntax
<a name="API_ListRetrievers_RequestSyntax"></a>

```
GET /applications/applicationId/retrievers?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRetrievers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListRetrievers_RequestSyntax) **   <a name="qbusiness-ListRetrievers-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application using the retriever.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListRetrievers_RequestSyntax) **   <a name="qbusiness-ListRetrievers-request-uri-maxResults"></a>
The maximum number of retrievers returned.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListRetrievers_RequestSyntax) **   <a name="qbusiness-ListRetrievers-request-uri-nextToken"></a>
If the number of retrievers returned exceeds `maxResults`, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListRetrievers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRetrievers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "retrievers": [ 
      { 
         "applicationId": "string",
         "displayName": "string",
         "retrieverId": "string",
         "status": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRetrievers_ResponseElements"></a>

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_ListRetrievers_ResponseSyntax) **   <a name="qbusiness-ListRetrievers-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [retrievers](#API_ListRetrievers_ResponseSyntax) **   <a name="qbusiness-ListRetrievers-response-retrievers"></a>
An array of summary information for one or more retrievers.  
Type: Array of [Retriever](API_Retriever.md) objects

## Errors
<a name="API_ListRetrievers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListRetrievers_SeeAlso"></a>

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/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListRetrievers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListRetrievers) 

# ListSubscriptions
<a name="API_ListSubscriptions"></a>

 Lists all subscriptions created in an Amazon Q Business application. 

## Request Syntax
<a name="API_ListSubscriptions_RequestSyntax"></a>

```
GET /applications/applicationId/subscriptions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSubscriptions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListSubscriptions_RequestSyntax) **   <a name="qbusiness-ListSubscriptions-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to the subscription.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListSubscriptions_RequestSyntax) **   <a name="qbusiness-ListSubscriptions-request-uri-maxResults"></a>
The maximum number of Amazon Q Business subscriptions to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListSubscriptions_RequestSyntax) **   <a name="qbusiness-ListSubscriptions-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListSubscriptions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSubscriptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "subscriptions": [ 
      { 
         "currentSubscription": { 
            "type": "string"
         },
         "nextSubscription": { 
            "type": "string"
         },
         "principal": { ... },
         "subscriptionArn": "string",
         "subscriptionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSubscriptions_ResponseElements"></a>

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_ListSubscriptions_ResponseSyntax) **   <a name="qbusiness-ListSubscriptions-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [subscriptions](#API_ListSubscriptions_ResponseSyntax) **   <a name="qbusiness-ListSubscriptions-response-subscriptions"></a>
An array of summary information on the subscriptions configured for an Amazon Q Business application.  
Type: Array of [Subscription](API_Subscription.md) objects

## Errors
<a name="API_ListSubscriptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListSubscriptions_SeeAlso"></a>

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/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListSubscriptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListSubscriptions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /v1/tags/resourceARN HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="qbusiness-ListTagsForResource-request-uri-resourceARN"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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_ListTagsForResource_ResponseSyntax) **   <a name="qbusiness-ListTagsForResource-response-tags"></a>
A list of tags associated with the Amazon Q Business application or data source.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

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/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListTagsForResource) 

# ListWebExperiences
<a name="API_ListWebExperiences"></a>

Lists one or more Amazon Q Business Web Experiences.

## Request Syntax
<a name="API_ListWebExperiences_RequestSyntax"></a>

```
GET /applications/applicationId/experiences?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListWebExperiences_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_ListWebExperiences_RequestSyntax) **   <a name="qbusiness-ListWebExperiences-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application linked to the listed web experiences.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [maxResults](#API_ListWebExperiences_RequestSyntax) **   <a name="qbusiness-ListWebExperiences-request-uri-maxResults"></a>
The maximum number of Amazon Q Business Web Experiences to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListWebExperiences_RequestSyntax) **   <a name="qbusiness-ListWebExperiences-request-uri-nextToken"></a>
If the `maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Request Body
<a name="API_ListWebExperiences_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListWebExperiences_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "webExperiences": [ 
      { 
         "createdAt": number,
         "defaultEndpoint": "string",
         "status": "string",
         "updatedAt": number,
         "webExperienceId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWebExperiences_ResponseElements"></a>

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_ListWebExperiences_ResponseSyntax) **   <a name="qbusiness-ListWebExperiences-response-nextToken"></a>
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [webExperiences](#API_ListWebExperiences_ResponseSyntax) **   <a name="qbusiness-ListWebExperiences-response-webExperiences"></a>
An array of summary information for one or more Amazon Q Business experiences.  
Type: Array of [WebExperience](API_WebExperience.md) objects

## Errors
<a name="API_ListWebExperiences_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_ListWebExperiences_SeeAlso"></a>

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/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/ListWebExperiences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ListWebExperiences) 

# PutFeedback
<a name="API_PutFeedback"></a>

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

## Request Syntax
<a name="API_PutFeedback_RequestSyntax"></a>

```
POST /applications/applicationId/conversations/conversationId/messages/messageId/feedback?userId=userId HTTP/1.1
Content-type: application/json

{
   "messageCopiedAt": number,
   "messageUsefulness": { 
      "comment": "string",
      "reason": "string",
      "submittedAt": number,
      "usefulness": "string"
   }
}
```

## URI Request Parameters
<a name="API_PutFeedback_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_PutFeedback_RequestSyntax) **   <a name="qbusiness-PutFeedback-request-uri-applicationId"></a>
The identifier of the application associated with the feedback.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [conversationId](#API_PutFeedback_RequestSyntax) **   <a name="qbusiness-PutFeedback-request-uri-conversationId"></a>
The identifier of the conversation the feedback is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [messageId](#API_PutFeedback_RequestSyntax) **   <a name="qbusiness-PutFeedback-request-uri-messageId"></a>
The identifier of the chat message that the feedback was given for.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_PutFeedback_RequestSyntax) **   <a name="qbusiness-PutFeedback-request-uri-userId"></a>
The identifier of the user giving the feedback.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*` 

## Request Body
<a name="API_PutFeedback_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [messageCopiedAt](#API_PutFeedback_RequestSyntax) **   <a name="qbusiness-PutFeedback-request-messageCopiedAt"></a>
The timestamp for when the feedback was recorded.  
Type: Timestamp  
Required: No

 ** [messageUsefulness](#API_PutFeedback_RequestSyntax) **   <a name="qbusiness-PutFeedback-request-messageUsefulness"></a>
The feedback usefulness value given by the user to the chat message.  
Type: [MessageUsefulnessFeedback](API_MessageUsefulnessFeedback.md) object  
Required: No

## Response Syntax
<a name="API_PutFeedback_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutFeedback_ResponseElements"></a>

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

## Errors
<a name="API_PutFeedback_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_PutFeedback_SeeAlso"></a>

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/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/PutFeedback) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/PutFeedback) 

# PutGroup
<a name="API_PutGroup"></a>

Create, or updates, a mapping of users—who have access to a document—to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a `RoleArn` for Amazon Q Buisness to access the file.

## Request Syntax
<a name="API_PutGroup_RequestSyntax"></a>

```
PUT /applications/applicationId/indices/indexId/groups HTTP/1.1
Content-type: application/json

{
   "dataSourceId": "string",
   "groupMembers": { 
      "memberGroups": [ 
         { 
            "groupName": "string",
            "type": "string"
         }
      ],
      "memberUsers": [ 
         { 
            "type": "string",
            "userId": "string"
         }
      ],
      "s3PathForGroupMembers": { 
         "bucket": "string",
         "key": "string"
      }
   },
   "groupName": "string",
   "roleArn": "string",
   "type": "string"
}
```

## URI Request Parameters
<a name="API_PutGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-uri-applicationId"></a>
The identifier of the application in which the user and group mapping belongs.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-uri-indexId"></a>
The identifier of the index in which you want to map users to their groups.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_PutGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dataSourceId](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-dataSourceId"></a>
The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: No

 ** [groupMembers](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-groupMembers"></a>
A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.  
Type: [GroupMembers](API_GroupMembers.md) object  
Required: Yes

 ** [groupName](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-groupName"></a>
The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `\P{C}*`   
Required: Yes

 ** [roleArn](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-roleArn"></a>
The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [type](#API_PutGroup_RequestSyntax) **   <a name="qbusiness-PutGroup-request-type"></a>
The type of the group.  
Type: String  
Valid Values: `INDEX | DATASOURCE`   
Required: Yes

## Response Syntax
<a name="API_PutGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutGroup_ResponseElements"></a>

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

## Errors
<a name="API_PutGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## Examples
<a name="API_PutGroup_Examples"></a>

### PutGroup S3 File
<a name="API_PutGroup_Example_1"></a>

The following is an example of an S3 file for declaring a group.

```
{
   "members": [
       {
           "id": "group1",
           "type": "GROUP",
           "dataSourceId": "group-data-source-id"
       },
       {
           "id": "group2",
           "type": "GROUP"
       },
       {
           "id": "user1",
           "type": "USER",
           "dataSourceId": "group-data-source-id"
       },
       {
           "id": "user2",
           "type": "USER",
           "dataSourceId": "group-data-source-id"
       }
   ]
}
```

## See Also
<a name="API_PutGroup_SeeAlso"></a>

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/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/PutGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/PutGroup) 

# SearchRelevantContent
<a name="API_SearchRelevantContent"></a>

Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

## Request Syntax
<a name="API_SearchRelevantContent_RequestSyntax"></a>

```
POST /applications/applicationId/relevant-content HTTP/1.1
Content-type: application/json

{
   "attributeFilter": { 
      "andAllFilters": [ 
         "AttributeFilter"
      ],
      "containsAll": { 
         "name": "string",
         "value": { ... }
      },
      "containsAny": { 
         "name": "string",
         "value": { ... }
      },
      "equalsTo": { 
         "name": "string",
         "value": { ... }
      },
      "greaterThan": { 
         "name": "string",
         "value": { ... }
      },
      "greaterThanOrEquals": { 
         "name": "string",
         "value": { ... }
      },
      "lessThan": { 
         "name": "string",
         "value": { ... }
      },
      "lessThanOrEquals": { 
         "name": "string",
         "value": { ... }
      },
      "notFilter": "AttributeFilter",
      "orAllFilters": [ 
         "AttributeFilter"
      ]
   },
   "contentSource": { ... },
   "maxResults": number,
   "nextToken": "string",
   "queryText": "string"
}
```

## URI Request Parameters
<a name="API_SearchRelevantContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_SearchRelevantContent_RequestSyntax) **   <a name="qbusiness-SearchRelevantContent-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application to search.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_SearchRelevantContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributeFilter](#API_SearchRelevantContent_RequestSyntax) **   <a name="qbusiness-SearchRelevantContent-request-attributeFilter"></a>
Enables filtering of responses based on document attributes or metadata fields.  
Type: [AttributeFilter](API_AttributeFilter.md) object  
Required: No

 ** [contentSource](#API_SearchRelevantContent_RequestSyntax) **   <a name="qbusiness-SearchRelevantContent-request-contentSource"></a>
The source of content to search in.  
Type: [ContentSource](API_ContentSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [maxResults](#API_SearchRelevantContent_RequestSyntax) **   <a name="qbusiness-SearchRelevantContent-request-maxResults"></a>
The maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_SearchRelevantContent_RequestSyntax) **   <a name="qbusiness-SearchRelevantContent-request-nextToken"></a>
The token for the next set of results. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.  
Required: No

 ** [queryText](#API_SearchRelevantContent_RequestSyntax) **   <a name="qbusiness-SearchRelevantContent-request-queryText"></a>
The text to search for.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_SearchRelevantContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relevantContent": [ 
      { 
         "content": "string",
         "documentAttributes": [ 
            { 
               "name": "string",
               "value": { ... }
            }
         ],
         "documentId": "string",
         "documentTitle": "string",
         "documentUri": "string",
         "scoreAttributes": { 
            "scoreConfidence": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchRelevantContent_ResponseElements"></a>

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_SearchRelevantContent_ResponseSyntax) **   <a name="qbusiness-SearchRelevantContent-response-nextToken"></a>
The token to use to retrieve the next set of results, if there are any.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

 ** [relevantContent](#API_SearchRelevantContent_ResponseSyntax) **   <a name="qbusiness-SearchRelevantContent-response-relevantContent"></a>
The list of relevant content items found.  
Type: Array of [RelevantContent](API_RelevantContent.md) objects

## Errors
<a name="API_SearchRelevantContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** LicenseNotFoundException **   
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_SearchRelevantContent_SeeAlso"></a>

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/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/SearchRelevantContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/SearchRelevantContent) 

# StartDataSourceSyncJob
<a name="API_StartDataSourceSyncJob"></a>

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a `ConflictException`.

## Request Syntax
<a name="API_StartDataSourceSyncJob_RequestSyntax"></a>

```
POST /applications/applicationId/indices/indexId/datasources/dataSourceId/startsync HTTP/1.1
```

## URI Request Parameters
<a name="API_StartDataSourceSyncJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_StartDataSourceSyncJob_RequestSyntax) **   <a name="qbusiness-StartDataSourceSyncJob-request-uri-applicationId"></a>
The identifier of Amazon Q Business application the data source is connected to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_StartDataSourceSyncJob_RequestSyntax) **   <a name="qbusiness-StartDataSourceSyncJob-request-uri-dataSourceId"></a>
 The identifier of the data source connector.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_StartDataSourceSyncJob_RequestSyntax) **   <a name="qbusiness-StartDataSourceSyncJob-request-uri-indexId"></a>
The identifier of the index used with the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_StartDataSourceSyncJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StartDataSourceSyncJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "executionId": "string"
}
```

## Response Elements
<a name="API_StartDataSourceSyncJob_ResponseElements"></a>

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

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

 ** [executionId](#API_StartDataSourceSyncJob_ResponseSyntax) **   <a name="qbusiness-StartDataSourceSyncJob-response-executionId"></a>
The identifier for a particular synchronization job.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}` 

## Errors
<a name="API_StartDataSourceSyncJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_StartDataSourceSyncJob_SeeAlso"></a>

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/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/StartDataSourceSyncJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/StartDataSourceSyncJob) 

# StopDataSourceSyncJob
<a name="API_StopDataSourceSyncJob"></a>

Stops an Amazon Q Business data source connector synchronization job already in progress.

## Request Syntax
<a name="API_StopDataSourceSyncJob_RequestSyntax"></a>

```
POST /applications/applicationId/indices/indexId/datasources/dataSourceId/stopsync HTTP/1.1
```

## URI Request Parameters
<a name="API_StopDataSourceSyncJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_StopDataSourceSyncJob_RequestSyntax) **   <a name="qbusiness-StopDataSourceSyncJob-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application that the data source is connected to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_StopDataSourceSyncJob_RequestSyntax) **   <a name="qbusiness-StopDataSourceSyncJob-request-uri-dataSourceId"></a>
 The identifier of the data source connector.   
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_StopDataSourceSyncJob_RequestSyntax) **   <a name="qbusiness-StopDataSourceSyncJob-request-uri-indexId"></a>
The identifier of the index used with the Amazon Q Business data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_StopDataSourceSyncJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopDataSourceSyncJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopDataSourceSyncJob_ResponseElements"></a>

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

## Errors
<a name="API_StopDataSourceSyncJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_StopDataSourceSyncJob_SeeAlso"></a>

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/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/StopDataSourceSyncJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/StopDataSourceSyncJob) 

# TagResource
<a name="API_TagResource"></a>

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /v1/tags/resourceARN HTTP/1.1
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceARN](#API_TagResource_RequestSyntax) **   <a name="qbusiness-TagResource-request-uri-resourceARN"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="qbusiness-TagResource-request-tags"></a>
A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

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

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

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/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes a tag from an Amazon Q Business application or a data source.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /v1/tags/resourceARN?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceARN](#API_UntagResource_RequestSyntax) **   <a name="qbusiness-UntagResource-request-uri-resourceARN"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="qbusiness-UntagResource-request-uri-tagKeys"></a>
A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.  
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
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

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

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

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/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UntagResource) 

# UpdateApplication
<a name="API_UpdateApplication"></a>

Updates an existing Amazon Q Business application.

**Note**  
Amazon Q Business applications may securely transmit data for processing across AWS Regions within your geography. For more information, see [Cross region inference in Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html).

**Note**  
An Amazon Q Apps service-linked role will be created if it's absent in the AWS account when `QAppsConfiguration` is enabled in the request. For more information, see [Using service-linked roles for Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html). 

## Request Syntax
<a name="API_UpdateApplication_RequestSyntax"></a>

```
PUT /applications/applicationId HTTP/1.1
Content-type: application/json

{
   "attachmentsConfiguration": { 
      "attachmentsControlMode": "string"
   },
   "autoSubscriptionConfiguration": { 
      "autoSubscribe": "string",
      "defaultSubscriptionType": "string"
   },
   "description": "string",
   "displayName": "string",
   "identityCenterInstanceArn": "string",
   "personalizationConfiguration": { 
      "personalizationControlMode": "string"
   },
   "qAppsConfiguration": { 
      "qAppsControlMode": "string"
   },
   "roleArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdateApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attachmentsConfiguration](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-attachmentsConfiguration"></a>
An option to allow end users to upload files directly during chat.  
Type: [AttachmentsConfiguration](API_AttachmentsConfiguration.md) object  
Required: No

 ** [autoSubscriptionConfiguration](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-autoSubscriptionConfiguration"></a>
An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.  
Type: [AutoSubscriptionConfiguration](API_AutoSubscriptionConfiguration.md) object  
Required: No

 ** [description](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-description"></a>
A description for the Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*`   
Required: No

 ** [displayName](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-displayName"></a>
A name for the Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [identityCenterInstanceArn](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-identityCenterInstanceArn"></a>
 The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** [personalizationConfiguration](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-personalizationConfiguration"></a>
Configuration information about chat response personalization. For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html).  
Type: [PersonalizationConfiguration](API_PersonalizationConfiguration.md) object  
Required: No

 ** [qAppsConfiguration](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-qAppsConfiguration"></a>
An option to allow end users to create and use Amazon Q Apps in the web experience.  
Type: [QAppsConfiguration](API_QAppsConfiguration.md) object  
Required: No

 ** [roleArn](#API_UpdateApplication_RequestSyntax) **   <a name="qbusiness-UpdateApplication-request-roleArn"></a>
An AWS Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

## Response Syntax
<a name="API_UpdateApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateApplication_ResponseElements"></a>

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

## Errors
<a name="API_UpdateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateApplication_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateApplication) 

# UpdateChatControlsConfiguration
<a name="API_UpdateChatControlsConfiguration"></a>

Updates a set of chat controls configured for an existing Amazon Q Business application.

## Request Syntax
<a name="API_UpdateChatControlsConfiguration_RequestSyntax"></a>

```
PATCH /applications/applicationId/chatcontrols HTTP/1.1
Content-type: application/json

{
   "blockedPhrasesConfigurationUpdate": { 
      "blockedPhrasesToCreateOrUpdate": [ "string" ],
      "blockedPhrasesToDelete": [ "string" ],
      "systemMessageOverride": "string"
   },
   "clientToken": "string",
   "creatorModeConfiguration": { 
      "creatorModeControl": "string"
   },
   "hallucinationReductionConfiguration": { 
      "hallucinationReductionControl": "string"
   },
   "orchestrationConfiguration": { 
      "control": "string"
   },
   "responseScope": "string",
   "topicConfigurationsToCreateOrUpdate": [ 
      { 
         "description": "string",
         "exampleChatMessages": [ "string" ],
         "name": "string",
         "rules": [ 
            { 
               "excludedUsersAndGroups": { 
                  "userGroups": [ "string" ],
                  "userIds": [ "string" ]
               },
               "includedUsersAndGroups": { 
                  "userGroups": [ "string" ],
                  "userIds": [ "string" ]
               },
               "ruleConfiguration": { ... },
               "ruleType": "string"
            }
         ]
      }
   ],
   "topicConfigurationsToDelete": [ 
      { 
         "description": "string",
         "exampleChatMessages": [ "string" ],
         "name": "string",
         "rules": [ 
            { 
               "excludedUsersAndGroups": { 
                  "userGroups": [ "string" ],
                  "userIds": [ "string" ]
               },
               "includedUsersAndGroups": { 
                  "userGroups": [ "string" ],
                  "userIds": [ "string" ]
               },
               "ruleConfiguration": { ... },
               "ruleType": "string"
            }
         ]
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateChatControlsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-uri-applicationId"></a>
The identifier of the application for which the chat controls are configured.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateChatControlsConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blockedPhrasesConfigurationUpdate](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-blockedPhrasesConfigurationUpdate"></a>
The phrases blocked from chat by your chat control configuration.  
Type: [BlockedPhrasesConfigurationUpdate](API_BlockedPhrasesConfigurationUpdate.md) object  
Required: No

 ** [clientToken](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-clientToken"></a>
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [creatorModeConfiguration](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-creatorModeConfiguration"></a>
The configuration details for `CREATOR_MODE`.  
Type: [CreatorModeConfiguration](API_CreatorModeConfiguration.md) object  
Required: No

 ** [hallucinationReductionConfiguration](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-hallucinationReductionConfiguration"></a>
 The hallucination reduction settings for your application.  
Type: [HallucinationReductionConfiguration](API_HallucinationReductionConfiguration.md) object  
Required: No

 ** [orchestrationConfiguration](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-orchestrationConfiguration"></a>
 The chat response orchestration settings for your application.  
Type: [OrchestrationConfiguration](API_OrchestrationConfiguration.md) object  
Required: No

 ** [responseScope](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-responseScope"></a>
The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.  
Type: String  
Valid Values: `ENTERPRISE_CONTENT_ONLY | EXTENDED_KNOWLEDGE_ENABLED`   
Required: No

 ** [topicConfigurationsToCreateOrUpdate](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-topicConfigurationsToCreateOrUpdate"></a>
The configured topic specific chat controls you want to update.  
Type: Array of [TopicConfiguration](API_TopicConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [topicConfigurationsToDelete](#API_UpdateChatControlsConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatControlsConfiguration-request-topicConfigurationsToDelete"></a>
The configured topic specific chat controls you want to delete.  
Type: Array of [TopicConfiguration](API_TopicConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

## Response Syntax
<a name="API_UpdateChatControlsConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateChatControlsConfiguration_ResponseElements"></a>

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

## Errors
<a name="API_UpdateChatControlsConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateChatControlsConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateChatControlsConfiguration) 

# UpdateChatResponseConfiguration
<a name="API_UpdateChatResponseConfiguration"></a>

Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

## Request Syntax
<a name="API_UpdateChatResponseConfiguration_RequestSyntax"></a>

```
PUT /applications/applicationId/chatresponseconfigurations/chatResponseConfigurationId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "displayName": "string",
   "responseConfigurations": { 
      "string" : { 
         "instructionCollection": { 
            "customInstructions": "string",
            "examples": "string",
            "identity": "string",
            "outputStyle": "string",
            "perspective": "string",
            "responseLength": "string",
            "targetAudience": "string",
            "tone": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateChatResponseConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatResponseConfiguration-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application containing the chat response configuration to update.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [chatResponseConfigurationId](#API_UpdateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatResponseConfiguration-request-uri-chatResponseConfigurationId"></a>
The unique identifier of the chat response configuration to update within the specified application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateChatResponseConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatResponseConfiguration-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [displayName](#API_UpdateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatResponseConfiguration-request-displayName"></a>
The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [responseConfigurations](#API_UpdateChatResponseConfiguration_RequestSyntax) **   <a name="qbusiness-UpdateChatResponseConfiguration-request-responseConfigurations"></a>
The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.  
Type: String to [ResponseConfiguration](API_ResponseConfiguration.md) object map  
Map Entries: Maximum number of 1 item.  
Valid Keys: `ALL`   
Required: Yes

## Response Syntax
<a name="API_UpdateChatResponseConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateChatResponseConfiguration_ResponseElements"></a>

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

## Errors
<a name="API_UpdateChatResponseConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateChatResponseConfiguration_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateChatResponseConfiguration) 

# UpdateDataAccessor
<a name="API_UpdateDataAccessor"></a>

Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

## Request Syntax
<a name="API_UpdateDataAccessor_RequestSyntax"></a>

```
PUT /applications/applicationId/dataaccessors/dataAccessorId HTTP/1.1
Content-type: application/json

{
   "actionConfigurations": [ 
      { 
         "action": "string",
         "filterConfiguration": { 
            "documentAttributeFilter": { 
               "andAllFilters": [ 
                  "AttributeFilter"
               ],
               "containsAll": { 
                  "name": "string",
                  "value": { ... }
               },
               "containsAny": { 
                  "name": "string",
                  "value": { ... }
               },
               "equalsTo": { 
                  "name": "string",
                  "value": { ... }
               },
               "greaterThan": { 
                  "name": "string",
                  "value": { ... }
               },
               "greaterThanOrEquals": { 
                  "name": "string",
                  "value": { ... }
               },
               "lessThan": { 
                  "name": "string",
                  "value": { ... }
               },
               "lessThanOrEquals": { 
                  "name": "string",
                  "value": { ... }
               },
               "notFilter": "AttributeFilter",
               "orAllFilters": [ 
                  "AttributeFilter"
               ]
            }
         }
      }
   ],
   "authenticationDetail": { 
      "authenticationConfiguration": { ... },
      "authenticationType": "string",
      "externalIds": [ "string" ]
   },
   "displayName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDataAccessor_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateDataAccessor_RequestSyntax) **   <a name="qbusiness-UpdateDataAccessor-request-uri-applicationId"></a>
The unique identifier of the Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataAccessorId](#API_UpdateDataAccessor_RequestSyntax) **   <a name="qbusiness-UpdateDataAccessor-request-uri-dataAccessorId"></a>
The unique identifier of the data accessor to update.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateDataAccessor_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionConfigurations](#API_UpdateDataAccessor_RequestSyntax) **   <a name="qbusiness-UpdateDataAccessor-request-actionConfigurations"></a>
The updated list of action configurations specifying the allowed actions and any associated filters.  
Type: Array of [ActionConfiguration](API_ActionConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** [authenticationDetail](#API_UpdateDataAccessor_RequestSyntax) **   <a name="qbusiness-UpdateDataAccessor-request-authenticationDetail"></a>
The updated authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.  
Type: [DataAccessorAuthenticationDetail](API_DataAccessorAuthenticationDetail.md) object  
Required: No

 ** [displayName](#API_UpdateDataAccessor_RequestSyntax) **   <a name="qbusiness-UpdateDataAccessor-request-displayName"></a>
The updated friendly name for the data accessor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

## Response Syntax
<a name="API_UpdateDataAccessor_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateDataAccessor_ResponseElements"></a>

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

## Errors
<a name="API_UpdateDataAccessor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateDataAccessor_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateDataAccessor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateDataAccessor) 

# UpdateDataSource
<a name="API_UpdateDataSource"></a>

Updates an existing Amazon Q Business data source connector.

## Request Syntax
<a name="API_UpdateDataSource_RequestSyntax"></a>

```
PUT /applications/applicationId/indices/indexId/datasources/dataSourceId HTTP/1.1
Content-type: application/json

{
   "configuration": JSON value,
   "description": "string",
   "displayName": "string",
   "documentEnrichmentConfiguration": { 
      "inlineConfigurations": [ 
         { 
            "condition": { 
               "key": "string",
               "operator": "string",
               "value": { ... }
            },
            "documentContentOperator": "string",
            "target": { 
               "attributeValueOperator": "string",
               "key": "string",
               "value": { ... }
            }
         }
      ],
      "postExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      },
      "preExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      }
   },
   "mediaExtractionConfiguration": { 
      "audioExtractionConfiguration": { 
         "audioExtractionStatus": "string"
      },
      "imageExtractionConfiguration": { 
         "imageExtractionStatus": "string"
      },
      "videoExtractionConfiguration": { 
         "videoExtractionStatus": "string"
      }
   },
   "roleArn": "string",
   "syncSchedule": "string",
   "vpcConfiguration": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ]
   }
}
```

## URI Request Parameters
<a name="API_UpdateDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-uri-applicationId"></a>
 The identifier of the Amazon Q Business application the data source is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [dataSourceId](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-uri-dataSourceId"></a>
The identifier of the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-uri-indexId"></a>
The identifier of the index attached to the data source connector.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configuration](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-configuration"></a>
Provides the configuration information for an Amazon Q Business data source.  
Type: JSON value  
Required: No

 ** [description](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-description"></a>
The description of the data source connector.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*`   
Required: No

 ** [displayName](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-displayName"></a>
A name of the data source connector.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [documentEnrichmentConfiguration](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-documentEnrichmentConfiguration"></a>
Provides the configuration information for altering document metadata and content during the document ingestion process.  
For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).  
Type: [DocumentEnrichmentConfiguration](API_DocumentEnrichmentConfiguration.md) object  
Required: No

 ** [mediaExtractionConfiguration](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-mediaExtractionConfiguration"></a>
The configuration for extracting information from media in documents for your data source.  
Type: [MediaExtractionConfiguration](API_MediaExtractionConfiguration.md) object  
Required: No

 ** [roleArn](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-roleArn"></a>
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [syncSchedule](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-syncSchedule"></a>
The chosen update frequency for your data source.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 998.  
Pattern: `[\s\S]*`   
Required: No

 ** [vpcConfiguration](#API_UpdateDataSource_RequestSyntax) **   <a name="qbusiness-UpdateDataSource-request-vpcConfiguration"></a>
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).  
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_UpdateDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateDataSource_ResponseElements"></a>

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

## Errors
<a name="API_UpdateDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateDataSource_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateDataSource) 

# UpdateIndex
<a name="API_UpdateIndex"></a>

Updates an Amazon Q Business index.

## Request Syntax
<a name="API_UpdateIndex_RequestSyntax"></a>

```
PUT /applications/applicationId/indices/indexId HTTP/1.1
Content-type: application/json

{
   "capacityConfiguration": { 
      "units": number
   },
   "description": "string",
   "displayName": "string",
   "documentAttributeConfigurations": [ 
      { 
         "name": "string",
         "search": "string",
         "type": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateIndex_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateIndex_RequestSyntax) **   <a name="qbusiness-UpdateIndex-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application connected to the index.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [indexId](#API_UpdateIndex_RequestSyntax) **   <a name="qbusiness-UpdateIndex-request-uri-indexId"></a>
The identifier of the Amazon Q Business index.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateIndex_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [capacityConfiguration](#API_UpdateIndex_RequestSyntax) **   <a name="qbusiness-UpdateIndex-request-capacityConfiguration"></a>
The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.  
Type: [IndexCapacityConfiguration](API_IndexCapacityConfiguration.md) object  
Required: No

 ** [description](#API_UpdateIndex_RequestSyntax) **   <a name="qbusiness-UpdateIndex-request-description"></a>
The description of the Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `[\s\S]*`   
Required: No

 ** [displayName](#API_UpdateIndex_RequestSyntax) **   <a name="qbusiness-UpdateIndex-request-displayName"></a>
The name of the Amazon Q Business index.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [documentAttributeConfigurations](#API_UpdateIndex_RequestSyntax) **   <a name="qbusiness-UpdateIndex-request-documentAttributeConfigurations"></a>
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes).  
Type: Array of [DocumentAttributeConfiguration](API_DocumentAttributeConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.  
Required: No

## Response Syntax
<a name="API_UpdateIndex_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateIndex_ResponseElements"></a>

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

## Errors
<a name="API_UpdateIndex_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateIndex_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateIndex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateIndex) 

# UpdatePlugin
<a name="API_UpdatePlugin"></a>

Updates an Amazon Q Business plugin.

## Request Syntax
<a name="API_UpdatePlugin_RequestSyntax"></a>

```
PUT /applications/applicationId/plugins/pluginId HTTP/1.1
Content-type: application/json

{
   "authConfiguration": { ... },
   "customPluginConfiguration": { 
      "apiSchema": { ... },
      "apiSchemaType": "string",
      "description": "string"
   },
   "displayName": "string",
   "serverUrl": "string",
   "state": "string"
}
```

## URI Request Parameters
<a name="API_UpdatePlugin_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-uri-applicationId"></a>
The identifier of the application the plugin is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [pluginId](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-uri-pluginId"></a>
The identifier of the plugin.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_UpdatePlugin_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [authConfiguration](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-authConfiguration"></a>
The authentication configuration the plugin is using.  
Type: [PluginAuthConfiguration](API_PluginAuthConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [customPluginConfiguration](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-customPluginConfiguration"></a>
The configuration for a custom plugin.  
Type: [CustomPluginConfiguration](API_CustomPluginConfiguration.md) object  
Required: No

 ** [displayName](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-displayName"></a>
The name of the plugin.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [serverUrl](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-serverUrl"></a>
The source URL used for plugin configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(https?|ftp|file)://([^\s]*)`   
Required: No

 ** [state](#API_UpdatePlugin_RequestSyntax) **   <a name="qbusiness-UpdatePlugin-request-state"></a>
The status of the plugin.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_UpdatePlugin_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdatePlugin_ResponseElements"></a>

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

## Errors
<a name="API_UpdatePlugin_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdatePlugin_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdatePlugin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdatePlugin) 

# UpdateRetriever
<a name="API_UpdateRetriever"></a>

Updates the retriever used for your Amazon Q Business application.

## Request Syntax
<a name="API_UpdateRetriever_RequestSyntax"></a>

```
PUT /applications/applicationId/retrievers/retrieverId HTTP/1.1
Content-type: application/json

{
   "configuration": { ... },
   "displayName": "string",
   "roleArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRetriever_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateRetriever_RequestSyntax) **   <a name="qbusiness-UpdateRetriever-request-uri-applicationId"></a>
The identifier of your Amazon Q Business application.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [retrieverId](#API_UpdateRetriever_RequestSyntax) **   <a name="qbusiness-UpdateRetriever-request-uri-retrieverId"></a>
The identifier of your retriever.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

## Request Body
<a name="API_UpdateRetriever_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configuration](#API_UpdateRetriever_RequestSyntax) **   <a name="qbusiness-UpdateRetriever-request-configuration"></a>
Provides information on how the retriever used for your Amazon Q Business application is configured.  
Type: [RetrieverConfiguration](API_RetrieverConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [displayName](#API_UpdateRetriever_RequestSyntax) **   <a name="qbusiness-UpdateRetriever-request-displayName"></a>
The name of your retriever.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [roleArn](#API_UpdateRetriever_RequestSyntax) **   <a name="qbusiness-UpdateRetriever-request-roleArn"></a>
The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

## Response Syntax
<a name="API_UpdateRetriever_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRetriever_ResponseElements"></a>

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

## Errors
<a name="API_UpdateRetriever_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateRetriever_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateRetriever) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateRetriever) 

# UpdateSubscription
<a name="API_UpdateSubscription"></a>

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see [Amazon Q Business pricing](https://aws.amazon.com/q/business/pricing/).

## Request Syntax
<a name="API_UpdateSubscription_RequestSyntax"></a>

```
PUT /applications/applicationId/subscriptions/subscriptionId HTTP/1.1
Content-type: application/json

{
   "type": "string"
}
```

## URI Request Parameters
<a name="API_UpdateSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateSubscription_RequestSyntax) **   <a name="qbusiness-UpdateSubscription-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application where the subscription update should take effect.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [subscriptionId](#API_UpdateSubscription_RequestSyntax) **   <a name="qbusiness-UpdateSubscription-request-uri-subscriptionId"></a>
The identifier of the Amazon Q Business subscription to be updated.  
Length Constraints: Minimum length of 0. Maximum length of 1224.  
Required: Yes

## Request Body
<a name="API_UpdateSubscription_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [type](#API_UpdateSubscription_RequestSyntax) **   <a name="qbusiness-UpdateSubscription-request-type"></a>
The type of the Amazon Q Business subscription to be updated.  
Type: String  
Valid Values: `Q_LITE | Q_BUSINESS`   
Required: Yes

## Response Syntax
<a name="API_UpdateSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "currentSubscription": { 
      "type": "string"
   },
   "nextSubscription": { 
      "type": "string"
   },
   "subscriptionArn": "string"
}
```

## Response Elements
<a name="API_UpdateSubscription_ResponseElements"></a>

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

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

 ** [currentSubscription](#API_UpdateSubscription_ResponseSyntax) **   <a name="qbusiness-UpdateSubscription-response-currentSubscription"></a>
The type of your current Amazon Q Business subscription.  
Type: [SubscriptionDetails](API_SubscriptionDetails.md) object

 ** [nextSubscription](#API_UpdateSubscription_ResponseSyntax) **   <a name="qbusiness-UpdateSubscription-response-nextSubscription"></a>
The type of the Amazon Q Business subscription for the next month.  
Type: [SubscriptionDetails](API_SubscriptionDetails.md) object

 ** [subscriptionArn](#API_UpdateSubscription_ResponseSyntax) **   <a name="qbusiness-UpdateSubscription-response-subscriptionArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` 

## Errors
<a name="API_UpdateSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateSubscription_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateSubscription) 

# UpdateUser
<a name="API_UpdateUser"></a>

Updates a information associated with a user id.

## Request Syntax
<a name="API_UpdateUser_RequestSyntax"></a>

```
PUT /applications/applicationId/users/userId HTTP/1.1
Content-type: application/json

{
   "userAliasesToDelete": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ],
   "userAliasesToUpdate": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateUser_RequestSyntax) **   <a name="qbusiness-UpdateUser-request-uri-applicationId"></a>
The identifier of the application the user is attached to.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [userId](#API_UpdateUser_RequestSyntax) **   <a name="qbusiness-UpdateUser-request-uri-userId"></a>
The email id attached to the user.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Request Body
<a name="API_UpdateUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [userAliasesToDelete](#API_UpdateUser_RequestSyntax) **   <a name="qbusiness-UpdateUser-request-userAliasesToDelete"></a>
The user aliases attached to the user id that are to be deleted.  
Type: Array of [UserAlias](API_UserAlias.md) objects  
Required: No

 ** [userAliasesToUpdate](#API_UpdateUser_RequestSyntax) **   <a name="qbusiness-UpdateUser-request-userAliasesToUpdate"></a>
The user aliases attached to the user id that are to be updated.  
Type: Array of [UserAlias](API_UserAlias.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateUser_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "userAliasesAdded": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ],
   "userAliasesDeleted": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ],
   "userAliasesUpdated": [ 
      { 
         "dataSourceId": "string",
         "indexId": "string",
         "userId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateUser_ResponseElements"></a>

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

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

 ** [userAliasesAdded](#API_UpdateUser_ResponseSyntax) **   <a name="qbusiness-UpdateUser-response-userAliasesAdded"></a>
The user aliases that have been to be added to a user id.  
Type: Array of [UserAlias](API_UserAlias.md) objects

 ** [userAliasesDeleted](#API_UpdateUser_ResponseSyntax) **   <a name="qbusiness-UpdateUser-response-userAliasesDeleted"></a>
The user aliases that have been deleted from a user id.  
Type: Array of [UserAlias](API_UserAlias.md) objects

 ** [userAliasesUpdated](#API_UpdateUser_ResponseSyntax) **   <a name="qbusiness-UpdateUser-response-userAliasesUpdated"></a>
The user aliases attached to a user id that have been updated.  
Type: Array of [UserAlias](API_UserAlias.md) objects

## Errors
<a name="API_UpdateUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Q Business service.     
 ** message **   
The message describing a `ServiceQuotaExceededException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateUser_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateUser) 

# UpdateWebExperience
<a name="API_UpdateWebExperience"></a>

Updates an Amazon Q Business web experience. 

## Request Syntax
<a name="API_UpdateWebExperience_RequestSyntax"></a>

```
PUT /applications/applicationId/experiences/webExperienceId HTTP/1.1
Content-type: application/json

{
   "authenticationConfiguration": { ... },
   "browserExtensionConfiguration": { 
      "enabledBrowserExtensions": [ "string" ]
   },
   "customizationConfiguration": { 
      "customCSSUrl": "string",
      "faviconUrl": "string",
      "fontUrl": "string",
      "logoUrl": "string"
   },
   "identityProviderConfiguration": { ... },
   "origins": [ "string" ],
   "roleArn": "string",
   "samplePromptsControlMode": "string",
   "subtitle": "string",
   "title": "string",
   "welcomeMessage": "string"
}
```

## URI Request Parameters
<a name="API_UpdateWebExperience_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationId](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-uri-applicationId"></a>
The identifier of the Amazon Q Business application attached to the web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]{35}`   
Required: Yes

 ** [webExperienceId](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-uri-webExperienceId"></a>
The identifier of the Amazon Q Business web experience.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

## Request Body
<a name="API_UpdateWebExperience_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [authenticationConfiguration](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-authenticationConfiguration"></a>
 *This parameter has been deprecated.*   
The authentication configuration of the Amazon Q Business web experience.  
Type: [WebExperienceAuthConfiguration](API_WebExperienceAuthConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [browserExtensionConfiguration](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-browserExtensionConfiguration"></a>
The browser extension configuration for an Amazon Q Business web experience.  
 For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see [Configure external OIDC identity provider for your browser extensions.](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html). 
Type: [BrowserExtensionConfiguration](API_BrowserExtensionConfiguration.md) object  
Required: No

 ** [customizationConfiguration](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-customizationConfiguration"></a>
Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.   
Type: [CustomizationConfiguration](API_CustomizationConfiguration.md) object  
Required: No

 ** [identityProviderConfiguration](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-identityProviderConfiguration"></a>
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.  
Type: [IdentityProviderConfiguration](API_IdentityProviderConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [origins](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-origins"></a>
Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the *base URL* for accessing a website including the protocol (`http/https`), the domain name, and the port number (if specified).  
+ Any values except `null` submitted as part of this update will replace all previous values.
+ You must only submit a *base URL* and not a full path. For example, `https://docs.aws.amazon.com`.
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?`   
Required: No

 ** [roleArn](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-roleArn"></a>
The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [samplePromptsControlMode](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-samplePromptsControlMode"></a>
Determines whether sample prompts are enabled in the web experience for an end user.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [subtitle](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-subtitle"></a>
The subtitle of the Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `[\s\S]*`   
Required: No

 ** [title](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-title"></a>
The title of the Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `[\s\S]*`   
Required: No

 ** [welcomeMessage](#API_UpdateWebExperience_RequestSyntax) **   <a name="qbusiness-UpdateWebExperience-request-welcomeMessage"></a>
A customized welcome message for an end user in an Amazon Q Business web experience.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 300.  
Required: No

## Response Syntax
<a name="API_UpdateWebExperience_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateWebExperience_ResponseElements"></a>

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

## Errors
<a name="API_UpdateWebExperience_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 403

 ** ConflictException **   
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.    
 ** message **   
The message describing a `ConflictException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 409

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.    
 ** message **   
The message describing a `ResourceNotFoundException`.  
 ** resourceId **   
The identifier of the resource affected.  
 ** resourceType **   
The type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to throttling. Reduce the number of requests and try again.  
HTTP Status Code: 429

 ** ValidationException **   
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.    
 ** fields **   
The input field(s) that failed validation.  
 ** message **   
The message describing the `ValidationException`.  
 ** reason **   
The reason for the `ValidationException`.
HTTP Status Code: 400

## See Also
<a name="API_UpdateWebExperience_SeeAlso"></a>

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/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qbusiness-2023-11-27/UpdateWebExperience) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/UpdateWebExperience) 

# QApps
<a name="API_Operations_QApps"></a>

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
<a name="API_qapps_AssociateLibraryItemReview"></a>

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
<a name="API_qapps_AssociateLibraryItemReview_RequestSyntax"></a>

```
POST /catalog.associateItemRating HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "libraryItemId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_AssociateLibraryItemReview_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_AssociateLibraryItemReview_RequestSyntax) **   <a name="qbusiness-qapps_AssociateLibraryItemReview-request-instanceId"></a>
The unique identifier for the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_AssociateLibraryItemReview_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [libraryItemId](#API_qapps_AssociateLibraryItemReview_RequestSyntax) **   <a name="qbusiness-qapps_AssociateLibraryItemReview-request-libraryItemId"></a>
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
<a name="API_qapps_AssociateLibraryItemReview_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_AssociateLibraryItemReview_ResponseElements"></a>

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

## Errors
<a name="API_qapps_AssociateLibraryItemReview_Errors"></a>

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
<a name="API_qapps_AssociateLibraryItemReview_SeeAlso"></a>

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
<a name="API_qapps_AssociateQAppWithUser"></a>

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
<a name="API_qapps_AssociateQAppWithUser_RequestSyntax"></a>

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

{
   "appId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_AssociateQAppWithUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_AssociateQAppWithUser_RequestSyntax) **   <a name="qbusiness-qapps_AssociateQAppWithUser-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_AssociateQAppWithUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_AssociateQAppWithUser_RequestSyntax) **   <a name="qbusiness-qapps_AssociateQAppWithUser-request-appId"></a>
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
<a name="API_qapps_AssociateQAppWithUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_AssociateQAppWithUser_ResponseElements"></a>

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

## Errors
<a name="API_qapps_AssociateQAppWithUser_Errors"></a>

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
<a name="API_qapps_AssociateQAppWithUser_SeeAlso"></a>

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
<a name="API_qapps_BatchCreateCategory"></a>

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
<a name="API_qapps_BatchCreateCategory_RequestSyntax"></a>

```
POST /catalog.createCategories HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "categories": [ 
      { 
         "color": "string",
         "id": "string",
         "title": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_qapps_BatchCreateCategory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_BatchCreateCategory_RequestSyntax) **   <a name="qbusiness-qapps_BatchCreateCategory-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_BatchCreateCategory_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [categories](#API_qapps_BatchCreateCategory_RequestSyntax) **   <a name="qbusiness-qapps_BatchCreateCategory-request-categories"></a>
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
<a name="API_qapps_BatchCreateCategory_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_BatchCreateCategory_ResponseElements"></a>

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

## Errors
<a name="API_qapps_BatchCreateCategory_Errors"></a>

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
<a name="API_qapps_BatchCreateCategory_SeeAlso"></a>

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
<a name="API_qapps_BatchDeleteCategory"></a>

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
<a name="API_qapps_BatchDeleteCategory_RequestSyntax"></a>

```
POST /catalog.deleteCategories HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "categories": [ "string" ]
}
```

## URI Request Parameters
<a name="API_qapps_BatchDeleteCategory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_BatchDeleteCategory_RequestSyntax) **   <a name="qbusiness-qapps_BatchDeleteCategory-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_BatchDeleteCategory_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [categories](#API_qapps_BatchDeleteCategory_RequestSyntax) **   <a name="qbusiness-qapps_BatchDeleteCategory-request-categories"></a>
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
<a name="API_qapps_BatchDeleteCategory_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_BatchDeleteCategory_ResponseElements"></a>

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

## Errors
<a name="API_qapps_BatchDeleteCategory_Errors"></a>

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
<a name="API_qapps_BatchDeleteCategory_SeeAlso"></a>

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
<a name="API_qapps_BatchUpdateCategory"></a>

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
<a name="API_qapps_BatchUpdateCategory_RequestSyntax"></a>

```
POST /catalog.updateCategories HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "categories": [ 
      { 
         "color": "string",
         "id": "string",
         "title": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_qapps_BatchUpdateCategory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_BatchUpdateCategory_RequestSyntax) **   <a name="qbusiness-qapps_BatchUpdateCategory-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_BatchUpdateCategory_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [categories](#API_qapps_BatchUpdateCategory_RequestSyntax) **   <a name="qbusiness-qapps_BatchUpdateCategory-request-categories"></a>
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
<a name="API_qapps_BatchUpdateCategory_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_BatchUpdateCategory_ResponseElements"></a>

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

## Errors
<a name="API_qapps_BatchUpdateCategory_Errors"></a>

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
<a name="API_qapps_BatchUpdateCategory_SeeAlso"></a>

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
<a name="API_qapps_CreateLibraryItem"></a>

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users. 

## Request Syntax
<a name="API_qapps_CreateLibraryItem_RequestSyntax"></a>

```
POST /catalog.createItem HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "appId": "string",
   "appVersion": number,
   "categories": [ "string" ]
}
```

## URI Request Parameters
<a name="API_qapps_CreateLibraryItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_CreateLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_CreateLibraryItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_CreateLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-request-appId"></a>
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) **   <a name="qbusiness-qapps_CreateLibraryItem-request-appVersion"></a>
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) **   <a name="qbusiness-qapps_CreateLibraryItem-request-categories"></a>
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
<a name="API_qapps_CreateLibraryItem_ResponseSyntax"></a>

```
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
<a name="API_qapps_CreateLibraryItem_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_CreateLibraryItem-response-createdAt"></a>
The date and time the library item was created.  
Type: Timestamp

 ** [createdBy](#API_qapps_CreateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-response-createdBy"></a>
The user who created the library item.  
Type: String

 ** [isVerified](#API_qapps_CreateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-response-isVerified"></a>
Indicates whether the library item has been verified.  
Type: Boolean

 ** [libraryItemId](#API_qapps_CreateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-response-libraryItemId"></a>
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) **   <a name="qbusiness-qapps_CreateLibraryItem-response-ratingCount"></a>
The number of ratings the library item has received from users.  
Type: Integer

 ** [status](#API_qapps_CreateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-response-status"></a>
The status of the new library item, such as "Published".  
Type: String

 ** [updatedAt](#API_qapps_CreateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-response-updatedAt"></a>
The date and time the library item was last updated.  
Type: Timestamp

 ** [updatedBy](#API_qapps_CreateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_CreateLibraryItem-response-updatedBy"></a>
The user who last updated the library item.  
Type: String

## Errors
<a name="API_qapps_CreateLibraryItem_Errors"></a>

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
<a name="API_qapps_CreateLibraryItem_SeeAlso"></a>

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
<a name="API_qapps_CreatePresignedUrl"></a>

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
<a name="API_qapps_CreatePresignedUrl_RequestSyntax"></a>

```
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
<a name="API_qapps_CreatePresignedUrl_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_CreatePresignedUrl_RequestSyntax) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_CreatePresignedUrl_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_CreatePresignedUrl_RequestSyntax) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-appId"></a>
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) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-cardId"></a>
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) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-fileContentsSha256"></a>
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) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-fileName"></a>
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) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-scope"></a>
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) **   <a name="qbusiness-qapps_CreatePresignedUrl-request-sessionId"></a>
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
<a name="API_qapps_CreatePresignedUrl_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fileId": "string",
   "presignedUrl": "string",
   "presignedUrlExpiration": "string",
   "presignedUrlFields": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_qapps_CreatePresignedUrl_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_CreatePresignedUrl-response-fileId"></a>
The unique identifier assigned to the file to be uploaded.  
Type: String

 ** [presignedUrl](#API_qapps_CreatePresignedUrl_ResponseSyntax) **   <a name="qbusiness-qapps_CreatePresignedUrl-response-presignedUrl"></a>
The URL for a presigned S3 POST operation used to upload a file.  
Type: String

 ** [presignedUrlExpiration](#API_qapps_CreatePresignedUrl_ResponseSyntax) **   <a name="qbusiness-qapps_CreatePresignedUrl-response-presignedUrlExpiration"></a>
The date and time that the presigned URL will expire in ISO 8601 format.  
Type: Timestamp

 ** [presignedUrlFields](#API_qapps_CreatePresignedUrl_ResponseSyntax) **   <a name="qbusiness-qapps_CreatePresignedUrl-response-presignedUrlFields"></a>
The form fields to include in the presigned S3 POST operation used to upload a file.  
Type: String to string map

## Errors
<a name="API_qapps_CreatePresignedUrl_Errors"></a>

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
<a name="API_qapps_CreatePresignedUrl_SeeAlso"></a>

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
<a name="API_qapps_CreateQApp"></a>

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
<a name="API_qapps_CreateQApp_RequestSyntax"></a>

```
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
<a name="API_qapps_CreateQApp_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_CreateQApp_RequestSyntax) **   <a name="qbusiness-qapps_CreateQApp-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_CreateQApp_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appDefinition](#API_qapps_CreateQApp_RequestSyntax) **   <a name="qbusiness-qapps_CreateQApp-request-appDefinition"></a>
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) **   <a name="qbusiness-qapps_CreateQApp-request-description"></a>
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) **   <a name="qbusiness-qapps_CreateQApp-request-tags"></a>
Optional tags to associate with the new Q App.  
Type: String to string map  
Required: No

 ** [title](#API_qapps_CreateQApp_RequestSyntax) **   <a name="qbusiness-qapps_CreateQApp-request-title"></a>
The title of the new Q App.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `[^{}\\"<>]+`   
Required: Yes

## Response Syntax
<a name="API_qapps_CreateQApp_ResponseSyntax"></a>

```
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
<a name="API_qapps_CreateQApp_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_CreateQApp-response-appArn"></a>
The Amazon Resource Name (ARN) of the new Q App.  
Type: String

 ** [appId](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-appId"></a>
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) **   <a name="qbusiness-qapps_CreateQApp-response-appVersion"></a>
The version of the new Q App.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.

 ** [createdAt](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-createdAt"></a>
The date and time the Q App was created.  
Type: Timestamp

 ** [createdBy](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-createdBy"></a>
The user who created the Q App.  
Type: String

 ** [description](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-description"></a>
The description of the new Q App.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [initialPrompt](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-initialPrompt"></a>
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) **   <a name="qbusiness-qapps_CreateQApp-response-requiredCapabilities"></a>
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) **   <a name="qbusiness-qapps_CreateQApp-response-status"></a>
The status of the new Q App, such as "Created".  
Type: String  
Valid Values: `PUBLISHED | DRAFT | DELETED` 

 ** [title](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-title"></a>
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) **   <a name="qbusiness-qapps_CreateQApp-response-updatedAt"></a>
The date and time the Q App was last updated.  
Type: Timestamp

 ** [updatedBy](#API_qapps_CreateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_CreateQApp-response-updatedBy"></a>
The user who last updated the Q App.  
Type: String

## Errors
<a name="API_qapps_CreateQApp_Errors"></a>

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
<a name="API_qapps_CreateQApp_SeeAlso"></a>

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
<a name="API_qapps_DeleteLibraryItem"></a>

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
<a name="API_qapps_DeleteLibraryItem_RequestSyntax"></a>

```
POST /catalog.deleteItem HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "libraryItemId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_DeleteLibraryItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_DeleteLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_DeleteLibraryItem-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_DeleteLibraryItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [libraryItemId](#API_qapps_DeleteLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_DeleteLibraryItem-request-libraryItemId"></a>
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
<a name="API_qapps_DeleteLibraryItem_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_DeleteLibraryItem_ResponseElements"></a>

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

## Errors
<a name="API_qapps_DeleteLibraryItem_Errors"></a>

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
<a name="API_qapps_DeleteLibraryItem_SeeAlso"></a>

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
<a name="API_qapps_DeleteQApp"></a>

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
<a name="API_qapps_DeleteQApp_RequestSyntax"></a>

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

{
   "appId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_DeleteQApp_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_DeleteQApp_RequestSyntax) **   <a name="qbusiness-qapps_DeleteQApp-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_DeleteQApp_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_DeleteQApp_RequestSyntax) **   <a name="qbusiness-qapps_DeleteQApp-request-appId"></a>
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
<a name="API_qapps_DeleteQApp_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_DeleteQApp_ResponseElements"></a>

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

## Errors
<a name="API_qapps_DeleteQApp_Errors"></a>

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
<a name="API_qapps_DeleteQApp_SeeAlso"></a>

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
<a name="API_qapps_DescribeQAppPermissions"></a>

 Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

## Request Syntax
<a name="API_qapps_DescribeQAppPermissions_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_qapps_DescribeQAppPermissions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [appId](#API_qapps_DescribeQAppPermissions_RequestSyntax) **   <a name="qbusiness-qapps_DescribeQAppPermissions-request-uri-appId"></a>
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) **   <a name="qbusiness-qapps_DescribeQAppPermissions-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_DescribeQAppPermissions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_DescribeQAppPermissions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "appId": "string",
   "permissions": [ 
      { 
         "action": "string",
         "principal": { 
            "email": "string",
            "userId": "string",
            "userType": "string"
         }
      }
   ],
   "resourceArn": "string"
}
```

## Response Elements
<a name="API_qapps_DescribeQAppPermissions_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_DescribeQAppPermissions-response-appId"></a>
The unique identifier of the Amazon Q App for which permissions are returned.  
Type: String

 ** [permissions](#API_qapps_DescribeQAppPermissions_ResponseSyntax) **   <a name="qbusiness-qapps_DescribeQAppPermissions-response-permissions"></a>
The list of permissions granted for the Amazon Q App.  
Type: Array of [PermissionOutput](API_qapps_PermissionOutput.md) objects

 ** [resourceArn](#API_qapps_DescribeQAppPermissions_ResponseSyntax) **   <a name="qbusiness-qapps_DescribeQAppPermissions-response-resourceArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.  
Type: String

## Errors
<a name="API_qapps_DescribeQAppPermissions_Errors"></a>

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
<a name="API_qapps_DescribeQAppPermissions_SeeAlso"></a>

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
<a name="API_qapps_DisassociateLibraryItemReview"></a>

Removes a rating or review previously submitted by the user for a library item.

## Request Syntax
<a name="API_qapps_DisassociateLibraryItemReview_RequestSyntax"></a>

```
POST /catalog.disassociateItemRating HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "libraryItemId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_DisassociateLibraryItemReview_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_DisassociateLibraryItemReview_RequestSyntax) **   <a name="qbusiness-qapps_DisassociateLibraryItemReview-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_DisassociateLibraryItemReview_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [libraryItemId](#API_qapps_DisassociateLibraryItemReview_RequestSyntax) **   <a name="qbusiness-qapps_DisassociateLibraryItemReview-request-libraryItemId"></a>
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
<a name="API_qapps_DisassociateLibraryItemReview_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_DisassociateLibraryItemReview_ResponseElements"></a>

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

## Errors
<a name="API_qapps_DisassociateLibraryItemReview_Errors"></a>

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
<a name="API_qapps_DisassociateLibraryItemReview_SeeAlso"></a>

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
<a name="API_qapps_DisassociateQAppFromUser"></a>

Disassociates a Q App from a user removing the user's access to run the Q App.

## Request Syntax
<a name="API_qapps_DisassociateQAppFromUser_RequestSyntax"></a>

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

{
   "appId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_DisassociateQAppFromUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_DisassociateQAppFromUser_RequestSyntax) **   <a name="qbusiness-qapps_DisassociateQAppFromUser-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_DisassociateQAppFromUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_DisassociateQAppFromUser_RequestSyntax) **   <a name="qbusiness-qapps_DisassociateQAppFromUser-request-appId"></a>
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
<a name="API_qapps_DisassociateQAppFromUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_DisassociateQAppFromUser_ResponseElements"></a>

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

## Errors
<a name="API_qapps_DisassociateQAppFromUser_Errors"></a>

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
<a name="API_qapps_DisassociateQAppFromUser_SeeAlso"></a>

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
<a name="API_qapps_ExportQAppSessionData"></a>

Exports the collected data of a Q App data collection session.

## Request Syntax
<a name="API_qapps_ExportQAppSessionData_RequestSyntax"></a>

```
POST /runtime.exportQAppSessionData HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "sessionId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_ExportQAppSessionData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_ExportQAppSessionData_RequestSyntax) **   <a name="qbusiness-qapps_ExportQAppSessionData-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_ExportQAppSessionData_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionId](#API_qapps_ExportQAppSessionData_RequestSyntax) **   <a name="qbusiness-qapps_ExportQAppSessionData-request-sessionId"></a>
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
<a name="API_qapps_ExportQAppSessionData_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "csvFileLink": "string",
   "expiresAt": "string",
   "sessionArn": "string"
}
```

## Response Elements
<a name="API_qapps_ExportQAppSessionData_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ExportQAppSessionData-response-csvFileLink"></a>
The link where the exported Q App session data can be downloaded from.  
Type: String

 ** [expiresAt](#API_qapps_ExportQAppSessionData_ResponseSyntax) **   <a name="qbusiness-qapps_ExportQAppSessionData-response-expiresAt"></a>
The date and time when the link for the exported Q App session data expires.  
Type: Timestamp

 ** [sessionArn](#API_qapps_ExportQAppSessionData_ResponseSyntax) **   <a name="qbusiness-qapps_ExportQAppSessionData-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the Q App data collection session.  
Type: String

## Errors
<a name="API_qapps_ExportQAppSessionData_Errors"></a>

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
<a name="API_qapps_ExportQAppSessionData_SeeAlso"></a>

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
<a name="API_qapps_GetLibraryItem"></a>

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

## Request Syntax
<a name="API_qapps_GetLibraryItem_RequestSyntax"></a>

```
GET /catalog.getItem?appId=appId&libraryItemId=libraryItemId HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_GetLibraryItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [appId](#API_qapps_GetLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-request-uri-appId"></a>
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) **   <a name="qbusiness-qapps_GetLibraryItem-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

 ** [libraryItemId](#API_qapps_GetLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-request-uri-libraryItemId"></a>
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
<a name="API_qapps_GetLibraryItem_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_GetLibraryItem_ResponseSyntax"></a>

```
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
<a name="API_qapps_GetLibraryItem_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_GetLibraryItem-response-appId"></a>
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) **   <a name="qbusiness-qapps_GetLibraryItem-response-appVersion"></a>
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) **   <a name="qbusiness-qapps_GetLibraryItem-response-categories"></a>
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) **   <a name="qbusiness-qapps_GetLibraryItem-response-createdAt"></a>
The date and time the library item was created.  
Type: Timestamp

 ** [createdBy](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-createdBy"></a>
The user who created the library item.  
Type: String

 ** [isRatedByUser](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-isRatedByUser"></a>
Whether the current user has rated the library item.  
Type: Boolean

 ** [isVerified](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-isVerified"></a>
Indicates whether the library item has been verified.  
Type: Boolean

 ** [libraryItemId](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-libraryItemId"></a>
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) **   <a name="qbusiness-qapps_GetLibraryItem-response-ratingCount"></a>
The number of ratings the library item has received from users.  
Type: Integer

 ** [status](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-status"></a>
The status of the library item, such as "Published".  
Type: String

 ** [updatedAt](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-updatedAt"></a>
The date and time the library item was last updated.  
Type: Timestamp

 ** [updatedBy](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-updatedBy"></a>
The user who last updated the library item.  
Type: String

 ** [userCount](#API_qapps_GetLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_GetLibraryItem-response-userCount"></a>
The number of users who have associated the Q App with their account.  
Type: Integer

## Errors
<a name="API_qapps_GetLibraryItem_Errors"></a>

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
<a name="API_qapps_GetLibraryItem_SeeAlso"></a>

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
<a name="API_qapps_GetQApp"></a>

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

## Request Syntax
<a name="API_qapps_GetQApp_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_qapps_GetQApp_RequestParameters"></a>

The request uses the following URI parameters.

 ** [appId](#API_qapps_GetQApp_RequestSyntax) **   <a name="qbusiness-qapps_GetQApp-request-uri-appId"></a>
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) **   <a name="qbusiness-qapps_GetQApp-request-uri-appVersion"></a>
The version of the Q App.  
Valid Range: Minimum value of 0. Maximum value of 2147483647.

 ** [instanceId](#API_qapps_GetQApp_RequestSyntax) **   <a name="qbusiness-qapps_GetQApp-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_GetQApp_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_GetQApp_ResponseSyntax"></a>

```
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
<a name="API_qapps_GetQApp_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_GetQApp-response-appArn"></a>
The Amazon Resource Name (ARN) of the Q App.  
Type: String

 ** [appDefinition](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-appDefinition"></a>
The full definition of the Q App, specifying the cards and flow.  
Type: [AppDefinition](API_qapps_AppDefinition.md) object

 ** [appId](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-appId"></a>
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) **   <a name="qbusiness-qapps_GetQApp-response-appVersion"></a>
The version of the Q App.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.

 ** [createdAt](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-createdAt"></a>
The date and time the Q App was created.  
Type: Timestamp

 ** [createdBy](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-createdBy"></a>
The user who created the Q App.  
Type: String

 ** [description](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-description"></a>
The description of the Q App.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [initialPrompt](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-initialPrompt"></a>
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) **   <a name="qbusiness-qapps_GetQApp-response-requiredCapabilities"></a>
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) **   <a name="qbusiness-qapps_GetQApp-response-status"></a>
The status of the Q App.  
Type: String  
Valid Values: `PUBLISHED | DRAFT | DELETED` 

 ** [title](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-title"></a>
The title of the Q App.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `[^{}\\"<>]+` 

 ** [updatedAt](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-updatedAt"></a>
The date and time the Q App was last updated.  
Type: Timestamp

 ** [updatedBy](#API_qapps_GetQApp_ResponseSyntax) **   <a name="qbusiness-qapps_GetQApp-response-updatedBy"></a>
The user who last updated the Q App.  
Type: String

## Errors
<a name="API_qapps_GetQApp_Errors"></a>

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
<a name="API_qapps_GetQApp_SeeAlso"></a>

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
<a name="API_qapps_GetQAppSession"></a>

Retrieves the current state and results for an active session of an Amazon Q App.

## Request Syntax
<a name="API_qapps_GetQAppSession_RequestSyntax"></a>

```
GET /runtime.getQAppSession?sessionId=sessionId HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_GetQAppSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_GetQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_GetQAppSession-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

 ** [sessionId](#API_qapps_GetQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_GetQAppSession-request-uri-sessionId"></a>
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
<a name="API_qapps_GetQAppSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_GetQAppSession_ResponseSyntax"></a>

```
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
<a name="API_qapps_GetQAppSession_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_GetQAppSession-response-appVersion"></a>
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) **   <a name="qbusiness-qapps_GetQAppSession-response-cardStatus"></a>
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) **   <a name="qbusiness-qapps_GetQAppSession-response-latestPublishedAppVersion"></a>
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) **   <a name="qbusiness-qapps_GetQAppSession-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the Q App session.  
Type: String

 ** [sessionId](#API_qapps_GetQAppSession_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSession-response-sessionId"></a>
The unique identifier of the Q App session.  
Type: String

 ** [sessionName](#API_qapps_GetQAppSession_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSession-response-sessionName"></a>
The name of the Q App session.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.

 ** [status](#API_qapps_GetQAppSession_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSession-response-status"></a>
The current status of the Q App session.  
Type: String  
Valid Values: `IN_PROGRESS | WAITING | COMPLETED | ERROR` 

 ** [userIsHost](#API_qapps_GetQAppSession_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSession-response-userIsHost"></a>
Indicates whether the current user is the owner of the Q App data collection session.  
Type: Boolean

## Errors
<a name="API_qapps_GetQAppSession_Errors"></a>

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
<a name="API_qapps_GetQAppSession_SeeAlso"></a>

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
<a name="API_qapps_GetQAppSessionMetadata"></a>

Retrieves the current configuration of a Q App session.

## Request Syntax
<a name="API_qapps_GetQAppSessionMetadata_RequestSyntax"></a>

```
GET /runtime.getQAppSessionMetadata?sessionId=sessionId HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_GetQAppSessionMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_GetQAppSessionMetadata_RequestSyntax) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

 ** [sessionId](#API_qapps_GetQAppSessionMetadata_RequestSyntax) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-request-uri-sessionId"></a>
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
<a name="API_qapps_GetQAppSessionMetadata_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_GetQAppSessionMetadata_ResponseSyntax"></a>

```
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
<a name="API_qapps_GetQAppSessionMetadata_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the Q App session.  
Type: String

 ** [sessionId](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-response-sessionId"></a>
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) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-response-sessionName"></a>
The name of the Q App session.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.

 ** [sessionOwner](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-response-sessionOwner"></a>
Indicates whether the current user is the owner of the Q App session.  
Type: Boolean

 ** [sharingConfiguration](#API_qapps_GetQAppSessionMetadata_ResponseSyntax) **   <a name="qbusiness-qapps_GetQAppSessionMetadata-response-sharingConfiguration"></a>
The sharing configuration of the Q App data collection session.  
Type: [SessionSharingConfiguration](API_qapps_SessionSharingConfiguration.md) object

## Errors
<a name="API_qapps_GetQAppSessionMetadata_Errors"></a>

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
<a name="API_qapps_GetQAppSessionMetadata_SeeAlso"></a>

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
<a name="API_qapps_ImportDocument"></a>

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
<a name="API_qapps_ImportDocument_RequestSyntax"></a>

```
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
<a name="API_qapps_ImportDocument_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_ImportDocument_RequestSyntax) **   <a name="qbusiness-qapps_ImportDocument-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_ImportDocument_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_ImportDocument_RequestSyntax) **   <a name="qbusiness-qapps_ImportDocument-request-appId"></a>
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) **   <a name="qbusiness-qapps_ImportDocument-request-cardId"></a>
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) **   <a name="qbusiness-qapps_ImportDocument-request-fileContentsBase64"></a>
The base64-encoded contents of the file to upload.  
Type: String  
Required: Yes

 ** [fileName](#API_qapps_ImportDocument_RequestSyntax) **   <a name="qbusiness-qapps_ImportDocument-request-fileName"></a>
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) **   <a name="qbusiness-qapps_ImportDocument-request-scope"></a>
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) **   <a name="qbusiness-qapps_ImportDocument-request-sessionId"></a>
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
<a name="API_qapps_ImportDocument_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fileId": "string"
}
```

## Response Elements
<a name="API_qapps_ImportDocument_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ImportDocument-response-fileId"></a>
The unique identifier assigned to the uploaded file.  
Type: String

## Errors
<a name="API_qapps_ImportDocument_Errors"></a>

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
<a name="API_qapps_ImportDocument_SeeAlso"></a>

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
<a name="API_qapps_ListCategories"></a>

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
<a name="API_qapps_ListCategories_RequestSyntax"></a>

```
GET /catalog.listCategories HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_ListCategories_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_ListCategories_RequestSyntax) **   <a name="qbusiness-qapps_ListCategories-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_ListCategories_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_ListCategories_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "categories": [ 
      { 
         "appCount": number,
         "color": "string",
         "id": "string",
         "title": "string"
      }
   ]
}
```

## Response Elements
<a name="API_qapps_ListCategories_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ListCategories-response-categories"></a>
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
<a name="API_qapps_ListCategories_Errors"></a>

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
<a name="API_qapps_ListCategories_SeeAlso"></a>

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
<a name="API_qapps_ListLibraryItems"></a>

Lists the library items for Amazon Q Apps that are published and available for users in your AWS account.

## Request Syntax
<a name="API_qapps_ListLibraryItems_RequestSyntax"></a>

```
GET /catalog.list?categoryId=categoryId&limit=limit&nextToken=nextToken HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_ListLibraryItems_RequestParameters"></a>

The request uses the following URI parameters.

 ** [categoryId](#API_qapps_ListLibraryItems_RequestSyntax) **   <a name="qbusiness-qapps_ListLibraryItems-request-uri-categoryId"></a>
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) **   <a name="qbusiness-qapps_ListLibraryItems-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

 ** [limit](#API_qapps_ListLibraryItems_RequestSyntax) **   <a name="qbusiness-qapps_ListLibraryItems-request-uri-limit"></a>
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) **   <a name="qbusiness-qapps_ListLibraryItems-request-uri-nextToken"></a>
The token to request the next page of results.  
Length Constraints: Minimum length of 0. Maximum length of 300.

## Request Body
<a name="API_qapps_ListLibraryItems_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_ListLibraryItems_ResponseSyntax"></a>

```
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
<a name="API_qapps_ListLibraryItems_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ListLibraryItems-response-libraryItems"></a>
The list of library items meeting the request criteria.  
Type: Array of [LibraryItemMember](API_qapps_LibraryItemMember.md) objects

 ** [nextToken](#API_qapps_ListLibraryItems_ResponseSyntax) **   <a name="qbusiness-qapps_ListLibraryItems-response-nextToken"></a>
The token to use to request the next page of results.  
Type: String

## Errors
<a name="API_qapps_ListLibraryItems_Errors"></a>

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
<a name="API_qapps_ListLibraryItems_SeeAlso"></a>

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
<a name="API_qapps_ListQApps"></a>

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
<a name="API_qapps_ListQApps_RequestSyntax"></a>

```
GET /apps.list?limit=limit&nextToken=nextToken HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_ListQApps_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_ListQApps_RequestSyntax) **   <a name="qbusiness-qapps_ListQApps-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

 ** [limit](#API_qapps_ListQApps_RequestSyntax) **   <a name="qbusiness-qapps_ListQApps-request-uri-limit"></a>
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) **   <a name="qbusiness-qapps_ListQApps-request-uri-nextToken"></a>
The token to request the next page of results.  
Length Constraints: Minimum length of 0. Maximum length of 300.

## Request Body
<a name="API_qapps_ListQApps_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_ListQApps_ResponseSyntax"></a>

```
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
<a name="API_qapps_ListQApps_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ListQApps-response-apps"></a>
The list of Amazon Q Apps meeting the request criteria.  
Type: Array of [UserAppItem](API_qapps_UserAppItem.md) objects

 ** [nextToken](#API_qapps_ListQApps_ResponseSyntax) **   <a name="qbusiness-qapps_ListQApps-response-nextToken"></a>
The token to use to request the next page of results.  
Type: String

## Errors
<a name="API_qapps_ListQApps_Errors"></a>

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
<a name="API_qapps_ListQApps_SeeAlso"></a>

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
<a name="API_qapps_ListQAppSessionData"></a>

Lists the collected data of a Q App data collection session.

## Request Syntax
<a name="API_qapps_ListQAppSessionData_RequestSyntax"></a>

```
GET /runtime.listQAppSessionData?sessionId=sessionId HTTP/1.1
instance-id: instanceId
```

## URI Request Parameters
<a name="API_qapps_ListQAppSessionData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_ListQAppSessionData_RequestSyntax) **   <a name="qbusiness-qapps_ListQAppSessionData-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

 ** [sessionId](#API_qapps_ListQAppSessionData_RequestSyntax) **   <a name="qbusiness-qapps_ListQAppSessionData-request-uri-sessionId"></a>
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
<a name="API_qapps_ListQAppSessionData_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_ListQAppSessionData_ResponseSyntax"></a>

```
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
<a name="API_qapps_ListQAppSessionData_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ListQAppSessionData-response-nextToken"></a>
 The pagination token that indicates the next set of results to retrieve.  
Type: String

 ** [sessionArn](#API_qapps_ListQAppSessionData_ResponseSyntax) **   <a name="qbusiness-qapps_ListQAppSessionData-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the Q App data collection session.  
Type: String

 ** [sessionData](#API_qapps_ListQAppSessionData_ResponseSyntax) **   <a name="qbusiness-qapps_ListQAppSessionData-response-sessionData"></a>
The collected responses of a Q App session.  
Type: Array of [QAppSessionData](API_qapps_QAppSessionData.md) objects

 ** [sessionId](#API_qapps_ListQAppSessionData_ResponseSyntax) **   <a name="qbusiness-qapps_ListQAppSessionData-response-sessionId"></a>
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
<a name="API_qapps_ListQAppSessionData_Errors"></a>

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
<a name="API_qapps_ListQAppSessionData_SeeAlso"></a>

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
<a name="API_qapps_ListTagsForResource"></a>

Lists the tags associated with an Amazon Q Apps resource.

## Request Syntax
<a name="API_qapps_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceARN HTTP/1.1
```

## URI Request Parameters
<a name="API_qapps_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceARN](#API_qapps_ListTagsForResource_RequestSyntax) **   <a name="qbusiness-qapps_ListTagsForResource-request-uri-resourceARN"></a>
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
<a name="API_qapps_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_qapps_ListTagsForResource_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_ListTagsForResource-response-tags"></a>
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
<a name="API_qapps_ListTagsForResource_Errors"></a>

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
<a name="API_qapps_ListTagsForResource_SeeAlso"></a>

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
<a name="API_qapps_PredictQApp"></a>

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
<a name="API_qapps_PredictQApp_RequestSyntax"></a>

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

{
   "options": { ... }
}
```

## URI Request Parameters
<a name="API_qapps_PredictQApp_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_PredictQApp_RequestSyntax) **   <a name="qbusiness-qapps_PredictQApp-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_PredictQApp_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [options](#API_qapps_PredictQApp_RequestSyntax) **   <a name="qbusiness-qapps_PredictQApp-request-options"></a>
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
<a name="API_qapps_PredictQApp_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "app": { 
      "appDefinition": { 
         "cards": [ 
            { ... }
         ],
         "initialPrompt": "string"
      },
      "description": "string",
      "title": "string"
   },
   "problemStatement": "string"
}
```

## Response Elements
<a name="API_qapps_PredictQApp_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_PredictQApp-response-app"></a>
The generated Q App definition.  
Type: [PredictAppDefinition](API_qapps_PredictAppDefinition.md) object

 ** [problemStatement](#API_qapps_PredictQApp_ResponseSyntax) **   <a name="qbusiness-qapps_PredictQApp-response-problemStatement"></a>
The problem statement extracted from the input conversation, if provided.  
Type: String

## Errors
<a name="API_qapps_PredictQApp_Errors"></a>

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
<a name="API_qapps_PredictQApp_SeeAlso"></a>

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
<a name="API_qapps_StartQAppSession"></a>

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
<a name="API_qapps_StartQAppSession_RequestSyntax"></a>

```
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
<a name="API_qapps_StartQAppSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_StartQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_StartQAppSession-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_StartQAppSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_StartQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_StartQAppSession-request-appId"></a>
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) **   <a name="qbusiness-qapps_StartQAppSession-request-appVersion"></a>
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) **   <a name="qbusiness-qapps_StartQAppSession-request-initialValues"></a>
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) **   <a name="qbusiness-qapps_StartQAppSession-request-sessionId"></a>
The unique identifier of the a Q App session.  
Type: String  
Required: No

 ** [tags](#API_qapps_StartQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_StartQAppSession-request-tags"></a>
Optional tags to associate with the new Q App session.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_qapps_StartQAppSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "sessionArn": "string",
   "sessionId": "string"
}
```

## Response Elements
<a name="API_qapps_StartQAppSession_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_StartQAppSession-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the new Q App session.  
Type: String

 ** [sessionId](#API_qapps_StartQAppSession_ResponseSyntax) **   <a name="qbusiness-qapps_StartQAppSession-response-sessionId"></a>
The unique identifier of the new or retrieved Q App session.  
Type: String

## Errors
<a name="API_qapps_StartQAppSession_Errors"></a>

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
<a name="API_qapps_StartQAppSession_SeeAlso"></a>

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
<a name="API_qapps_StopQAppSession"></a>

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
<a name="API_qapps_StopQAppSession_RequestSyntax"></a>

```
POST /runtime.deleteMiniAppRun HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "sessionId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_StopQAppSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_StopQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_StopQAppSession-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_StopQAppSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionId](#API_qapps_StopQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_StopQAppSession-request-sessionId"></a>
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
<a name="API_qapps_StopQAppSession_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_StopQAppSession_ResponseElements"></a>

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

## Errors
<a name="API_qapps_StopQAppSession_Errors"></a>

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
<a name="API_qapps_StopQAppSession_SeeAlso"></a>

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
<a name="API_qapps_TagResource"></a>

Associates tags with an Amazon Q Apps resource.

## Request Syntax
<a name="API_qapps_TagResource_RequestSyntax"></a>

```
POST /tags/resourceARN HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_qapps_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceARN](#API_qapps_TagResource_RequestSyntax) **   <a name="qbusiness-qapps_TagResource-request-uri-resourceARN"></a>
The Amazon Resource Name (ARN) of the resource to tag.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_qapps_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_qapps_TagResource_RequestSyntax) **   <a name="qbusiness-qapps_TagResource-request-tags"></a>
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
<a name="API_qapps_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_TagResource_ResponseElements"></a>

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

## Errors
<a name="API_qapps_TagResource_Errors"></a>

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
<a name="API_qapps_TagResource_SeeAlso"></a>

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
<a name="API_qapps_UntagResource"></a>

Disassociates tags from an Amazon Q Apps resource.

## Request Syntax
<a name="API_qapps_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceARN?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_qapps_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceARN](#API_qapps_UntagResource_RequestSyntax) **   <a name="qbusiness-qapps_UntagResource-request-uri-resourceARN"></a>
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) **   <a name="qbusiness-qapps_UntagResource-request-uri-tagKeys"></a>
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
<a name="API_qapps_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_qapps_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_UntagResource_ResponseElements"></a>

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

## Errors
<a name="API_qapps_UntagResource_Errors"></a>

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
<a name="API_qapps_UntagResource_SeeAlso"></a>

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
<a name="API_qapps_UpdateLibraryItem"></a>

Updates the library item for an Amazon Q App.

## Request Syntax
<a name="API_qapps_UpdateLibraryItem_RequestSyntax"></a>

```
POST /catalog.updateItem HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "categories": [ "string" ],
   "libraryItemId": "string",
   "status": "string"
}
```

## URI Request Parameters
<a name="API_qapps_UpdateLibraryItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_UpdateLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_UpdateLibraryItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [categories](#API_qapps_UpdateLibraryItem_RequestSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-request-categories"></a>
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) **   <a name="qbusiness-qapps_UpdateLibraryItem-request-libraryItemId"></a>
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) **   <a name="qbusiness-qapps_UpdateLibraryItem-request-status"></a>
The new status to set for the library item, such as "Published" or "Hidden".  
Type: String  
Valid Values: `PUBLISHED | DISABLED`   
Required: No

## Response Syntax
<a name="API_qapps_UpdateLibraryItem_ResponseSyntax"></a>

```
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
<a name="API_qapps_UpdateLibraryItem_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-appId"></a>
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) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-appVersion"></a>
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) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-categories"></a>
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) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-createdAt"></a>
The date and time the library item was originally created.  
Type: Timestamp

 ** [createdBy](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-createdBy"></a>
The user who originally created the library item.  
Type: String

 ** [isRatedByUser](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-isRatedByUser"></a>
Whether the current user has rated the library item.  
Type: Boolean

 ** [isVerified](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-isVerified"></a>
Indicates whether the library item has been verified.  
Type: Boolean

 ** [libraryItemId](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-libraryItemId"></a>
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) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-ratingCount"></a>
The number of ratings the library item has received.  
Type: Integer

 ** [status](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-status"></a>
The new status of the updated library item.  
Type: String

 ** [updatedAt](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-updatedAt"></a>
The date and time the library item was last updated.  
Type: Timestamp

 ** [updatedBy](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-updatedBy"></a>
The user who last updated the library item.  
Type: String

 ** [userCount](#API_qapps_UpdateLibraryItem_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItem-response-userCount"></a>
The number of users who have the associated Q App.  
Type: Integer

## Errors
<a name="API_qapps_UpdateLibraryItem_Errors"></a>

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
<a name="API_qapps_UpdateLibraryItem_SeeAlso"></a>

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
<a name="API_qapps_UpdateLibraryItemMetadata"></a>

Updates the verification status of a library item for an Amazon Q App.

## Request Syntax
<a name="API_qapps_UpdateLibraryItemMetadata_RequestSyntax"></a>

```
POST /catalog.updateItemMetadata HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "isVerified": boolean,
   "libraryItemId": "string"
}
```

## URI Request Parameters
<a name="API_qapps_UpdateLibraryItemMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_UpdateLibraryItemMetadata_RequestSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItemMetadata-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_UpdateLibraryItemMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [isVerified](#API_qapps_UpdateLibraryItemMetadata_RequestSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItemMetadata-request-isVerified"></a>
The verification status of the library item  
Type: Boolean  
Required: No

 ** [libraryItemId](#API_qapps_UpdateLibraryItemMetadata_RequestSyntax) **   <a name="qbusiness-qapps_UpdateLibraryItemMetadata-request-libraryItemId"></a>
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
<a name="API_qapps_UpdateLibraryItemMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_qapps_UpdateLibraryItemMetadata_ResponseElements"></a>

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

## Errors
<a name="API_qapps_UpdateLibraryItemMetadata_Errors"></a>

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
<a name="API_qapps_UpdateLibraryItemMetadata_SeeAlso"></a>

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
<a name="API_qapps_UpdateQApp"></a>

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

## Request Syntax
<a name="API_qapps_UpdateQApp_RequestSyntax"></a>

```
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
<a name="API_qapps_UpdateQApp_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_UpdateQApp_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQApp-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_UpdateQApp_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appDefinition](#API_qapps_UpdateQApp_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQApp-request-appDefinition"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-request-appId"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-request-description"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-request-title"></a>
The new title for the Q App.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `[^{}\\"<>]+`   
Required: No

## Response Syntax
<a name="API_qapps_UpdateQApp_ResponseSyntax"></a>

```
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
<a name="API_qapps_UpdateQApp_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_UpdateQApp-response-appArn"></a>
The Amazon Resource Name (ARN) of the updated Q App.  
Type: String

 ** [appId](#API_qapps_UpdateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQApp-response-appId"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-response-appVersion"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-response-createdAt"></a>
The date and time the Q App was originally created.  
Type: Timestamp

 ** [createdBy](#API_qapps_UpdateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQApp-response-createdBy"></a>
The user who originally created the Q App.  
Type: String

 ** [description](#API_qapps_UpdateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQApp-response-description"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-response-initialPrompt"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-response-requiredCapabilities"></a>
The capabilities required for the updated Q App.  
Type: Array of strings  
Valid Values: `FileUpload | CreatorMode | RetrievalMode | PluginMode` 

 ** [status](#API_qapps_UpdateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQApp-response-status"></a>
The status of the updated Q App.  
Type: String  
Valid Values: `PUBLISHED | DRAFT | DELETED` 

 ** [title](#API_qapps_UpdateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQApp-response-title"></a>
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) **   <a name="qbusiness-qapps_UpdateQApp-response-updatedAt"></a>
The date and time the Q App was last updated.  
Type: Timestamp

 ** [updatedBy](#API_qapps_UpdateQApp_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQApp-response-updatedBy"></a>
The user who last updated the Q App.  
Type: String

## Errors
<a name="API_qapps_UpdateQApp_Errors"></a>

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
<a name="API_qapps_UpdateQApp_SeeAlso"></a>

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
<a name="API_qapps_UpdateQAppPermissions"></a>

Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

## Request Syntax
<a name="API_qapps_UpdateQAppPermissions_RequestSyntax"></a>

```
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
<a name="API_qapps_UpdateQAppPermissions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_UpdateQAppPermissions_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQAppPermissions-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_UpdateQAppPermissions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [appId](#API_qapps_UpdateQAppPermissions_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQAppPermissions-request-appId"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppPermissions-request-grantPermissions"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppPermissions-request-revokePermissions"></a>
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
<a name="API_qapps_UpdateQAppPermissions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "appId": "string",
   "permissions": [ 
      { 
         "action": "string",
         "principal": { 
            "email": "string",
            "userId": "string",
            "userType": "string"
         }
      }
   ],
   "resourceArn": "string"
}
```

## Response Elements
<a name="API_qapps_UpdateQAppPermissions_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_UpdateQAppPermissions-response-appId"></a>
The unique identifier of the Amazon Q App for which permissions were updated.  
Type: String

 ** [permissions](#API_qapps_UpdateQAppPermissions_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQAppPermissions-response-permissions"></a>
The updated list of permissions for the Amazon Q App.  
Type: Array of [PermissionOutput](API_qapps_PermissionOutput.md) objects

 ** [resourceArn](#API_qapps_UpdateQAppPermissions_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQAppPermissions-response-resourceArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.  
Type: String

## Errors
<a name="API_qapps_UpdateQAppPermissions_Errors"></a>

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
<a name="API_qapps_UpdateQAppPermissions_SeeAlso"></a>

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
<a name="API_qapps_UpdateQAppSession"></a>

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
<a name="API_qapps_UpdateQAppSession_RequestSyntax"></a>

```
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
<a name="API_qapps_UpdateQAppSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_UpdateQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQAppSession-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_UpdateQAppSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionId](#API_qapps_UpdateQAppSession_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQAppSession-request-sessionId"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppSession-request-values"></a>
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
<a name="API_qapps_UpdateQAppSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "sessionArn": "string",
   "sessionId": "string"
}
```

## Response Elements
<a name="API_qapps_UpdateQAppSession_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_UpdateQAppSession-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the updated Q App session.  
Type: String

 ** [sessionId](#API_qapps_UpdateQAppSession_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQAppSession-response-sessionId"></a>
The unique identifier of the updated Q App session.  
Type: String

## Errors
<a name="API_qapps_UpdateQAppSession_Errors"></a>

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
<a name="API_qapps_UpdateQAppSession_SeeAlso"></a>

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
<a name="API_qapps_UpdateQAppSessionMetadata"></a>

Updates the configuration metadata of a session for a given Q App `sessionId`.

## Request Syntax
<a name="API_qapps_UpdateQAppSessionMetadata_RequestSyntax"></a>

```
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
<a name="API_qapps_UpdateQAppSessionMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_qapps_UpdateQAppSessionMetadata_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-request-instanceId"></a>
The unique identifier of the Amazon Q Business application environment instance.  
Required: Yes

## Request Body
<a name="API_qapps_UpdateQAppSessionMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionId](#API_qapps_UpdateQAppSessionMetadata_RequestSyntax) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-request-sessionId"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-request-sessionName"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-request-sharingConfiguration"></a>
The new sharing configuration for the Q App data collection session.  
Type: [SessionSharingConfiguration](API_qapps_SessionSharingConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_qapps_UpdateQAppSessionMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "sessionArn": "string",
   "sessionId": "string",
   "sessionName": "string",
   "sharingConfiguration": { 
      "acceptResponses": boolean,
      "enabled": boolean,
      "revealCards": boolean
   }
}
```

## Response Elements
<a name="API_qapps_UpdateQAppSessionMetadata_ResponseElements"></a>

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) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the updated Q App session.  
Type: String

 ** [sessionId](#API_qapps_UpdateQAppSessionMetadata_ResponseSyntax) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-response-sessionId"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-response-sessionName"></a>
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) **   <a name="qbusiness-qapps_UpdateQAppSessionMetadata-response-sharingConfiguration"></a>
The new sharing configuration of the updated Q App data collection session.  
Type: [SessionSharingConfiguration](API_qapps_SessionSharingConfiguration.md) object

## Errors
<a name="API_qapps_UpdateQAppSessionMetadata_Errors"></a>

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
<a name="API_qapps_UpdateQAppSessionMetadata_SeeAlso"></a>

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)