QBusiness 2023-11-27
- Client: Aws\QBusiness\QBusinessClient
- Service ID: qbusiness
- Version: 2023-11-27
This page describes the parameters and results for the operations of the QBusiness (2023-11-27), and shows how to use the Aws\QBusiness\QBusinessClient object to call the described operations. This documentation is specific to the 2023-11-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BatchDeleteDocument ( array $params = [] )
- Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.
- BatchPutDocument ( array $params = [] )
- Adds one or more documents to an Amazon Q Business index.
- ChatSync ( array $params = [] )
- Starts or continues a non-streaming Amazon Q Business conversation.
- CreateApplication ( array $params = [] )
- Creates an Amazon Q Business application.
- CreateDataSource ( array $params = [] )
- Creates a data source connector for an Amazon Q Business application.
- CreateIndex ( array $params = [] )
- Creates an Amazon Q Business index.
- CreatePlugin ( array $params = [] )
- Creates an Amazon Q Business plugin.
- CreateRetriever ( array $params = [] )
- Adds a retriever to your Amazon Q Business application.
- CreateUser ( array $params = [] )
- Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
- CreateWebExperience ( array $params = [] )
- Creates an Amazon Q Business web experience.
- DeleteApplication ( array $params = [] )
- Deletes an Amazon Q Business application.
- DeleteChatControlsConfiguration ( array $params = [] )
- Deletes chat controls configured for an existing Amazon Q Business application.
- DeleteConversation ( array $params = [] )
- Deletes an Amazon Q Business web experience conversation.
- DeleteDataSource ( array $params = [] )
- Deletes an Amazon Q Business data source connector.
- DeleteGroup ( array $params = [] )
- 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.
- DeleteIndex ( array $params = [] )
- Deletes an Amazon Q Business index.
- DeletePlugin ( array $params = [] )
- Deletes an Amazon Q Business plugin.
- DeleteRetriever ( array $params = [] )
- Deletes the retriever used by an Amazon Q Business application.
- DeleteUser ( array $params = [] )
- Deletes a user by email id.
- DeleteWebExperience ( array $params = [] )
- Deletes an Amazon Q Business web experience.
- GetApplication ( array $params = [] )
- Gets information about an existing Amazon Q Business application.
- GetChatControlsConfiguration ( array $params = [] )
- Gets information about an chat controls configured for an existing Amazon Q Business application.
- GetDataSource ( array $params = [] )
- Gets information about an existing Amazon Q Business data source connector.
- GetGroup ( array $params = [] )
- Describes a group by group name.
- GetIndex ( array $params = [] )
- Gets information about an existing Amazon Q Business index.
- GetPlugin ( array $params = [] )
- Gets information about an existing Amazon Q Business plugin.
- GetRetriever ( array $params = [] )
- Gets information about an existing retriever used by an Amazon Q Business application.
- GetUser ( array $params = [] )
- Describes the universally unique identifier (UUID) associated with a local user in a data source.
- GetWebExperience ( array $params = [] )
- Gets information about an existing Amazon Q Business web experience.
- ListApplications ( array $params = [] )
- Lists Amazon Q Business applications.
- ListConversations ( array $params = [] )
- Lists one or more Amazon Q Business conversations.
- ListDataSourceSyncJobs ( array $params = [] )
- Get information about an Amazon Q Business data source connector synchronization.
- ListDataSources ( array $params = [] )
- Lists the Amazon Q Business data source connectors that you have created.
- ListDocuments ( array $params = [] )
- A list of documents attached to an index.
- ListGroups ( array $params = [] )
- Provides a list of groups that are mapped to users.
- ListIndices ( array $params = [] )
- Lists the Amazon Q Business indices you have created.
- ListMessages ( array $params = [] )
- Gets a list of messages associated with an Amazon Q Business web experience.
- ListPlugins ( array $params = [] )
- Lists configured Amazon Q Business plugins.
- ListRetrievers ( array $params = [] )
- Lists the retriever used by an Amazon Q Business application.
- ListTagsForResource ( array $params = [] )
- Gets a list of tags associated with a specified resource.
- ListWebExperiences ( array $params = [] )
- Lists one or more Amazon Q Business Web Experiences.
- PutFeedback ( array $params = [] )
- Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
- PutGroup ( array $params = [] )
- Create, or updates, a mapping of users—who have access to a document—to groups.
- StartDataSourceSyncJob ( array $params = [] )
- Starts a data source connector synchronization job.
- StopDataSourceSyncJob ( array $params = [] )
- Stops an Amazon Q Business data source connector synchronization job already in progress.
- TagResource ( array $params = [] )
- Adds the specified tag to the specified Amazon Q Business application or data source resource.
- UntagResource ( array $params = [] )
- Removes a tag from an Amazon Q Business application or a data source.
- UpdateApplication ( array $params = [] )
- Updates an existing Amazon Q Business application.
- UpdateChatControlsConfiguration ( array $params = [] )
- Updates an set of chat controls configured for an existing Amazon Q Business application.
- UpdateDataSource ( array $params = [] )
- Updates an existing Amazon Q Business data source connector.
- UpdateIndex ( array $params = [] )
- Updates an Amazon Q Business index.
- UpdatePlugin ( array $params = [] )
- Updates an Amazon Q Business plugin.
- UpdateRetriever ( array $params = [] )
- Updates the retriever used for your Amazon Q Business application.
- UpdateUser ( array $params = [] )
- Updates a information associated with a user id.
- UpdateWebExperience ( array $params = [] )
- Updates an Amazon Q Business web experience.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- GetChatControlsConfiguration
- ListApplications
- ListConversations
- ListDataSourceSyncJobs
- ListDataSources
- ListDocuments
- ListGroups
- ListIndices
- ListMessages
- ListPlugins
- ListRetrievers
- ListWebExperiences
Operations
BatchDeleteDocument
$result = $client->batchDeleteDocument
([/* ... */]); $promise = $client->batchDeleteDocumentAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchDeleteDocument([ 'applicationId' => '<string>', // REQUIRED 'dataSourceSyncId' => '<string>', 'documents' => [ // REQUIRED [ 'documentId' => '<string>', // REQUIRED ], // ... ], 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
- dataSourceSyncId
-
- Type: string
The identifier of the data source sync during which the documents were deleted.
- documents
-
- Required: Yes
- Type: Array of DeleteDocument structures
Documents deleted from the Amazon Q Business index.
- indexId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business index that contains the documents to delete.
Result Syntax
[ 'failedDocuments' => [ [ 'dataSourceId' => '<string>', 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'id' => '<string>', ], // ... ], ]
Result Details
Members
- failedDocuments
-
- Type: Array of FailedDocument structures
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
BatchPutDocument
$result = $client->batchPutDocument
([/* ... */]); $promise = $client->batchPutDocumentAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchPutDocument([ 'applicationId' => '<string>', // REQUIRED 'dataSourceSyncId' => '<string>', 'documents' => [ // REQUIRED [ 'accessConfiguration' => [ 'accessControls' => [ // REQUIRED [ 'memberRelation' => 'AND|OR', 'principals' => [ // REQUIRED [ 'group' => [ 'access' => 'ALLOW|DENY', // REQUIRED 'membershipType' => 'INDEX|DATASOURCE', 'name' => '<string>', ], 'user' => [ 'access' => 'ALLOW|DENY', // REQUIRED 'id' => '<string>', 'membershipType' => 'INDEX|DATASOURCE', ], ], // ... ], ], // ... ], 'memberRelation' => 'AND|OR', ], 'attributes' => [ [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], // ... ], 'content' => [ 'blob' => <string || resource || Psr\Http\Message\StreamInterface>, 's3' => [ 'bucket' => '<string>', // REQUIRED 'key' => '<string>', // REQUIRED ], ], 'contentType' => 'PDF|HTML|MS_WORD|PLAIN_TEXT|PPT|RTF|XML|XSLT|MS_EXCEL|CSV|JSON|MD', 'documentEnrichmentConfiguration' => [ 'inlineConfigurations' => [ [ 'condition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'documentContentOperator' => 'DELETE', 'target' => [ 'attributeValueOperator' => 'DELETE', 'key' => '<string>', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], ], // ... ], 'postExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], 'preExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], ], 'id' => '<string>', // REQUIRED 'title' => '<string>', ], // ... ], 'indexId' => '<string>', // REQUIRED 'roleArn' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
- dataSourceSyncId
-
- Type: string
The identifier of the data source sync during which the documents were added.
- documents
-
- Required: Yes
- Type: Array of Document structures
One or more documents to add to the index.
- indexId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business index to add the documents to.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
Result Syntax
[ 'failedDocuments' => [ [ 'dataSourceId' => '<string>', 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'id' => '<string>', ], // ... ], ]
Result Details
Members
- failedDocuments
-
- Type: Array of FailedDocument structures
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
ChatSync
$result = $client->chatSync
([/* ... */]); $promise = $client->chatSyncAsync
([/* ... */]);
Starts or continues a non-streaming Amazon Q Business conversation.
Parameter Syntax
$result = $client->chatSync([ 'actionExecution' => [ 'payload' => [ // REQUIRED '<ActionPayloadFieldKey>' => [ 'value' => [ // REQUIRED ], ], // ... ], 'payloadFieldNameSeparator' => '<string>', // REQUIRED 'pluginId' => '<string>', // REQUIRED ], 'applicationId' => '<string>', // REQUIRED 'attachments' => [ [ 'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'name' => '<string>', // REQUIRED ], // ... ], 'attributeFilter' => [ 'andAllFilters' => [ [...], // RECURSIVE // ... ], 'containsAll' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'containsAny' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'equalsTo' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'greaterThan' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'greaterThanOrEquals' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lessThan' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lessThanOrEquals' => [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'notFilter' => [...], // RECURSIVE 'orAllFilters' => [ [...], // RECURSIVE // ... ], ], 'authChallengeResponse' => [ 'responseMap' => ['<string>', ...], // REQUIRED ], 'chatMode' => 'RETRIEVAL_MODE|CREATOR_MODE|PLUGIN_MODE', 'chatModeConfiguration' => [ 'pluginConfiguration' => [ 'pluginId' => '<string>', // REQUIRED ], ], 'clientToken' => '<string>', 'conversationId' => '<string>', 'parentMessageId' => '<string>', 'userGroups' => ['<string>', ...], 'userId' => '<string>', 'userMessage' => '<string>', ]);
Parameter Details
Members
- actionExecution
-
- Type: ActionExecution structure
A request from an end user to perform an Amazon Q Business plugin action.
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
- attachments
-
- Type: Array of AttachmentInput structures
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
- attributeFilter
-
- Type: AttributeFilter structure
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
- authChallengeResponse
-
- Type: AuthChallengeResponse structure
An authentication verification event response by a third party authentication server to Amazon Q Business.
- chatMode
-
- Type: string
The chat modes available to an Amazon Q Business end user.
-
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application. -
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request. -
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
- chatModeConfiguration
-
- Type: ChatModeConfiguration structure
The chat mode configuration for an Amazon Q Business application.
- clientToken
-
- Type: string
A token that you provide to identify a chat request.
- conversationId
-
- Type: string
The identifier of the Amazon Q Business conversation.
- parentMessageId
-
- Type: string
The identifier of the previous system message in a conversation.
- userGroups
-
- Type: Array of strings
The groups that a user associated with the chat input belongs to.
- userId
-
- Type: string
The identifier of the user attached to the chat input.
- userMessage
-
- Type: string
A end user message in a conversation.
Result Syntax
[ 'actionReview' => [ 'payload' => [ '<ActionPayloadFieldKey>' => [ 'allowedFormat' => '<string>', 'allowedValues' => [ [ 'displayValue' => [ ], 'value' => [ ], ], // ... ], 'displayDescription' => '<string>', 'displayName' => '<string>', 'displayOrder' => <integer>, 'required' => true || false, 'type' => 'STRING|NUMBER|ARRAY|BOOLEAN', 'value' => [ ], ], // ... ], 'payloadFieldNameSeparator' => '<string>', 'pluginId' => '<string>', 'pluginType' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM', ], 'authChallengeRequest' => [ 'authorizationUrl' => '<string>', ], 'conversationId' => '<string>', 'failedAttachments' => [ [ 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'name' => '<string>', 'status' => 'FAILED|SUCCEEDED', ], // ... ], 'sourceAttributions' => [ [ 'citationNumber' => <integer>, 'snippet' => '<string>', 'textMessageSegments' => [ [ 'beginOffset' => <integer>, 'endOffset' => <integer>, 'snippetExcerpt' => [ 'text' => '<string>', ], ], // ... ], 'title' => '<string>', 'updatedAt' => <DateTime>, 'url' => '<string>', ], // ... ], 'systemMessage' => '<string>', 'systemMessageId' => '<string>', 'userMessageId' => '<string>', ]
Result Details
Members
- actionReview
-
- Type: ActionReview structure
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
- authChallengeRequest
-
- Type: AuthChallengeRequest structure
An authentication verification event activated by an end user request to use a custom plugin.
- conversationId
-
- Type: string
The identifier of the Amazon Q Business conversation.
- failedAttachments
-
- Type: Array of AttachmentOutput structures
A list of files which failed to upload during chat.
- sourceAttributions
-
- Type: Array of SourceAttribution structures
The source documents used to generate the conversation response.
- systemMessage
-
- Type: string
An AI-generated message in a conversation.
- systemMessageId
-
- Type: string
The identifier of an Amazon Q Business AI generated message within the conversation.
- userMessageId
-
- Type: string
The identifier of an Amazon Q Business end user text input message within the conversation.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- 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.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
CreateApplication
$result = $client->createApplication
([/* ... */]); $promise = $client->createApplicationAsync
([/* ... */]);
Creates an Amazon Q Business application.
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. You must use the Amazon Q Business console to assign subscription tiers to users.
Parameter Syntax
$result = $client->createApplication([ 'attachmentsConfiguration' => [ 'attachmentsControlMode' => 'ENABLED|DISABLED', // REQUIRED ], 'clientIdsForOIDC' => ['<string>', ...], 'clientToken' => '<string>', 'description' => '<string>', 'displayName' => '<string>', // REQUIRED 'encryptionConfiguration' => [ 'kmsKeyId' => '<string>', ], 'iamIdentityProviderArn' => '<string>', 'identityCenterInstanceArn' => '<string>', 'identityType' => 'AWS_IAM_IDP_SAML|AWS_IAM_IDP_OIDC|AWS_IAM_IDC', 'personalizationConfiguration' => [ 'personalizationControlMode' => 'ENABLED|DISABLED', // REQUIRED ], 'qAppsConfiguration' => [ 'qAppsControlMode' => 'ENABLED|DISABLED', // REQUIRED ], 'roleArn' => '<string>', 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- attachmentsConfiguration
-
- Type: AttachmentsConfiguration structure
An option to allow end users to upload files directly during chat.
- clientIdsForOIDC
-
- Type: Array of strings
The OIDC client ID for a Amazon Q Business application.
- clientToken
-
- Type: string
A token that you provide to identify the request to create your Amazon Q Business application.
- description
-
- Type: string
A description for the Amazon Q Business application.
- displayName
-
- Required: Yes
- Type: string
A name for the Amazon Q Business application.
- encryptionConfiguration
-
- Type: EncryptionConfiguration structure
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
- iamIdentityProviderArn
-
- Type: string
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
- identityCenterInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
- identityType
-
- Type: string
The authentication type being used by a Amazon Q Business application.
- personalizationConfiguration
-
- Type: PersonalizationConfiguration structure
Configuration information about chat response personalization. For more information, see Personalizing chat responses
- qAppsConfiguration
-
- Type: QAppsConfiguration structure
An option to allow end users to create and use Amazon Q Apps in the web experience.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
- tags
-
- Type: Array of Tag structures
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: _ . : / = + - @.
Result Syntax
[ 'applicationArn' => '<string>', 'applicationId' => '<string>', ]
Result Details
Members
- applicationArn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q Business application.
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
CreateDataSource
$result = $client->createDataSource
([/* ... */]); $promise = $client->createDataSourceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createDataSource([ 'applicationId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'configuration' => [ // REQUIRED ], 'description' => '<string>', 'displayName' => '<string>', // REQUIRED 'documentEnrichmentConfiguration' => [ 'inlineConfigurations' => [ [ 'condition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'documentContentOperator' => 'DELETE', 'target' => [ 'attributeValueOperator' => 'DELETE', 'key' => '<string>', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], ], // ... ], 'postExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], 'preExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], ], 'indexId' => '<string>', // REQUIRED 'roleArn' => '<string>', 'syncSchedule' => '<string>', 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'vpcConfiguration' => [ 'securityGroupIds' => ['<string>', ...], // REQUIRED 'subnetIds' => ['<string>', ...], // REQUIRED ], ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application the data source will be attached to.
- clientToken
-
- Type: string
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. - configuration
-
- Required: Yes
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
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:
You can find configuration templates for your specific data source using the following steps:
-
Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
-
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.
- description
-
- Type: string
A description for the data source connector.
- displayName
-
- Required: Yes
- Type: string
A name for the data source connector.
- documentEnrichmentConfiguration
-
- Type: DocumentEnrichmentConfiguration structure
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index that you want to use with the data source connector.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- syncSchedule
-
- Type: string
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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception. - tags
-
- Type: Array of Tag structures
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: _ . : / = + - @.
- vpcConfiguration
-
- Type: DataSourceVpcConfiguration structure
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.
Result Syntax
[ 'dataSourceArn' => '<string>', 'dataSourceId' => '<string>', ]
Result Details
Members
- dataSourceArn
-
- Type: string
The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- dataSourceId
-
- Type: string
The identifier of the data source connector.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
CreateIndex
$result = $client->createIndex
([/* ... */]); $promise = $client->createIndexAsync
([/* ... */]);
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 BatchPutDocument
API or the CreateDataSource
API.
Parameter Syntax
$result = $client->createIndex([ 'applicationId' => '<string>', // REQUIRED 'capacityConfiguration' => [ 'units' => <integer>, ], 'clientToken' => '<string>', 'description' => '<string>', 'displayName' => '<string>', // REQUIRED 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'type' => 'ENTERPRISE|STARTER', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application using the index.
- capacityConfiguration
-
- Type: IndexCapacityConfiguration structure
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
- clientToken
-
- Type: string
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. - description
-
- Type: string
A description for the Amazon Q Business index.
- displayName
-
- Required: Yes
- Type: string
A name for the Amazon Q Business index.
- tags
-
- Type: Array of Tag structures
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: _ . : / = + - @.
- type
-
- Type: string
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.
Result Syntax
[ 'indexArn' => '<string>', 'indexId' => '<string>', ]
Result Details
Members
- indexArn
-
- Type: string
The Amazon Resource Name (ARN) of an Amazon Q Business index.
- indexId
-
- Type: string
The identifier for the Amazon Q Business index.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
CreatePlugin
$result = $client->createPlugin
([/* ... */]); $promise = $client->createPluginAsync
([/* ... */]);
Creates an Amazon Q Business plugin.
Parameter Syntax
$result = $client->createPlugin([ 'applicationId' => '<string>', // REQUIRED 'authConfiguration' => [ // REQUIRED 'basicAuthConfiguration' => [ 'roleArn' => '<string>', // REQUIRED 'secretArn' => '<string>', // REQUIRED ], 'noAuthConfiguration' => [ ], 'oAuth2ClientCredentialConfiguration' => [ 'roleArn' => '<string>', // REQUIRED 'secretArn' => '<string>', // REQUIRED ], ], 'clientToken' => '<string>', 'customPluginConfiguration' => [ 'apiSchema' => [ // REQUIRED 'payload' => '<string>', 's3' => [ 'bucket' => '<string>', // REQUIRED 'key' => '<string>', // REQUIRED ], ], 'apiSchemaType' => 'OPEN_API_V3', // REQUIRED 'description' => '<string>', // REQUIRED ], 'displayName' => '<string>', // REQUIRED 'serverUrl' => '<string>', 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application that will contain the plugin.
- authConfiguration
-
- Required: Yes
- Type: PluginAuthConfiguration structure
Authentication configuration information for an Amazon Q Business plugin.
- clientToken
-
- Type: string
A token that you provide to identify the request to create your Amazon Q Business plugin.
- customPluginConfiguration
-
- Type: CustomPluginConfiguration structure
Contains configuration for a custom plugin.
- displayName
-
- Required: Yes
- Type: string
A the name for your plugin.
- serverUrl
-
- Type: string
The source URL used for plugin configuration.
- tags
-
- Type: Array of Tag structures
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: _ . : / = + - @.
- type
-
- Required: Yes
- Type: string
The type of plugin you want to create.
Result Syntax
[ 'buildStatus' => 'READY|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED', 'pluginArn' => '<string>', 'pluginId' => '<string>', ]
Result Details
Members
- buildStatus
-
- Type: string
The current status of a plugin. A plugin is modified asynchronously.
- pluginArn
-
- Type: string
The Amazon Resource Name (ARN) of a plugin.
- pluginId
-
- Type: string
The identifier of the plugin created.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
CreateRetriever
$result = $client->createRetriever
([/* ... */]); $promise = $client->createRetrieverAsync
([/* ... */]);
Adds a retriever to your Amazon Q Business application.
Parameter Syntax
$result = $client->createRetriever([ 'applicationId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'configuration' => [ // REQUIRED 'kendraIndexConfiguration' => [ 'indexId' => '<string>', // REQUIRED ], 'nativeIndexConfiguration' => [ 'boostingOverride' => [ '<DocumentAttributeKey>' => [ 'dateConfiguration' => [ 'boostingDurationInSeconds' => <integer>, 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED ], 'numberConfiguration' => [ 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED 'boostingType' => 'PRIORITIZE_LARGER_VALUES|PRIORITIZE_SMALLER_VALUES', ], 'stringConfiguration' => [ 'attributeValueBoosting' => ['<string>', ...], 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED ], 'stringListConfiguration' => [ 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED ], ], // ... ], 'indexId' => '<string>', // REQUIRED ], ], 'displayName' => '<string>', // REQUIRED 'roleArn' => '<string>', 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'type' => 'NATIVE_INDEX|KENDRA_INDEX', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of your Amazon Q Business application.
- clientToken
-
- Type: string
A token that you provide to identify the request to create your Amazon Q Business application retriever.
- configuration
-
- Required: Yes
- Type: RetrieverConfiguration structure
Provides information on how the retriever used for your Amazon Q Business application is configured.
- displayName
-
- Required: Yes
- Type: string
The name of your retriever.
- roleArn
-
- Type: string
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
- tags
-
- Type: Array of Tag structures
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: _ . : / = + - @.
- type
-
- Required: Yes
- Type: string
The type of retriever you are using.
Result Syntax
[ 'retrieverArn' => '<string>', 'retrieverId' => '<string>', ]
Result Details
Members
- retrieverArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
- retrieverId
-
- Type: string
The identifier of the retriever you are using.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
CreateUser
$result = $client->createUser
([/* ... */]); $promise = $client->createUserAsync
([/* ... */]);
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Parameter Syntax
$result = $client->createUser([ 'applicationId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'userAliases' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', // REQUIRED ], // ... ], 'userId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application for which the user mapping will be created.
- clientToken
-
- Type: string
A token that you provide to identify the request to create your Amazon Q Business user mapping.
- userAliases
-
- Type: Array of UserAlias structures
The list of user aliases in the mapping.
- userId
-
- Required: Yes
- Type: string
The user emails attached to a user mapping.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
CreateWebExperience
$result = $client->createWebExperience
([/* ... */]); $promise = $client->createWebExperienceAsync
([/* ... */]);
Creates an Amazon Q Business web experience.
Parameter Syntax
$result = $client->createWebExperience([ 'applicationId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'identityProviderConfiguration' => [ 'openIDConnectConfiguration' => [ 'secretsArn' => '<string>', // REQUIRED 'secretsRole' => '<string>', // REQUIRED ], 'samlConfiguration' => [ 'authenticationUrl' => '<string>', // REQUIRED ], ], 'roleArn' => '<string>', 'samplePromptsControlMode' => 'ENABLED|DISABLED', 'subtitle' => '<string>', 'tags' => [ [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'title' => '<string>', 'welcomeMessage' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business web experience.
- clientToken
-
- Type: string
A token you provide to identify a request to create an Amazon Q Business web experience.
- identityProviderConfiguration
-
- Type: IdentityProviderConfiguration structure
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
- samplePromptsControlMode
-
- Type: string
Determines whether sample prompts are enabled in the web experience for an end user.
- subtitle
-
- Type: string
A subtitle to personalize your Amazon Q Business web experience.
- tags
-
- Type: Array of Tag structures
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: _ . : / = + - @.
- title
-
- Type: string
The title for your Amazon Q Business web experience.
- welcomeMessage
-
- Type: string
The customized welcome message for end users of an Amazon Q Business web experience.
Result Syntax
[ 'webExperienceArn' => '<string>', 'webExperienceId' => '<string>', ]
Result Details
Members
- webExperienceArn
-
- Type: string
The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
- webExperienceId
-
- Type: string
The identifier of the Amazon Q Business web experience.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
DeleteApplication
$result = $client->deleteApplication
([/* ... */]); $promise = $client->deleteApplicationAsync
([/* ... */]);
Deletes an Amazon Q Business application.
Parameter Syntax
$result = $client->deleteApplication([ 'applicationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteChatControlsConfiguration
$result = $client->deleteChatControlsConfiguration
([/* ... */]); $promise = $client->deleteChatControlsConfigurationAsync
([/* ... */]);
Deletes chat controls configured for an existing Amazon Q Business application.
Parameter Syntax
$result = $client->deleteChatControlsConfiguration([ 'applicationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application the chat controls have been configured for.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteConversation
$result = $client->deleteConversation
([/* ... */]); $promise = $client->deleteConversationAsync
([/* ... */]);
Deletes an Amazon Q Business web experience conversation.
Parameter Syntax
$result = $client->deleteConversation([ 'applicationId' => '<string>', // REQUIRED 'conversationId' => '<string>', // REQUIRED 'userId' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application associated with the conversation.
- conversationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business web experience conversation being deleted.
- userId
-
- Type: string
The identifier of the user who is deleting the conversation.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- 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.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteDataSource
$result = $client->deleteDataSource
([/* ... */]); $promise = $client->deleteDataSourceAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->deleteDataSource([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application used with the data source connector.
- dataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source connector that you want to delete.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index used with the data source connector.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteGroup
$result = $client->deleteGroup
([/* ... */]); $promise = $client->deleteGroupAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->deleteGroup([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', 'groupName' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application in which the group mapping belongs.
- dataSourceId
-
- Type: string
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.
- groupName
-
- Required: Yes
- Type: string
The name of the group you want to delete.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index you want to delete the group from.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteIndex
$result = $client->deleteIndex
([/* ... */]); $promise = $client->deleteIndexAsync
([/* ... */]);
Deletes an Amazon Q Business index.
Parameter Syntax
$result = $client->deleteIndex([ 'applicationId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
- indexId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business index.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeletePlugin
$result = $client->deletePlugin
([/* ... */]); $promise = $client->deletePluginAsync
([/* ... */]);
Deletes an Amazon Q Business plugin.
Parameter Syntax
$result = $client->deletePlugin([ 'applicationId' => '<string>', // REQUIRED 'pluginId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier the application attached to the Amazon Q Business plugin.
- pluginId
-
- Required: Yes
- Type: string
The identifier of the plugin being deleted.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteRetriever
$result = $client->deleteRetriever
([/* ... */]); $promise = $client->deleteRetrieverAsync
([/* ... */]);
Deletes the retriever used by an Amazon Q Business application.
Parameter Syntax
$result = $client->deleteRetriever([ 'applicationId' => '<string>', // REQUIRED 'retrieverId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application using the retriever.
- retrieverId
-
- Required: Yes
- Type: string
The identifier of the retriever being deleted.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteUser
$result = $client->deleteUser
([/* ... */]); $promise = $client->deleteUserAsync
([/* ... */]);
Deletes a user by email id.
Parameter Syntax
$result = $client->deleteUser([ 'applicationId' => '<string>', // REQUIRED 'userId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application from which the user is being deleted.
- userId
-
- Required: Yes
- Type: string
The user email being deleted.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
DeleteWebExperience
$result = $client->deleteWebExperience
([/* ... */]); $promise = $client->deleteWebExperienceAsync
([/* ... */]);
Deletes an Amazon Q Business web experience.
Parameter Syntax
$result = $client->deleteWebExperience([ 'applicationId' => '<string>', // REQUIRED 'webExperienceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
- webExperienceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business web experience being deleted.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetApplication
$result = $client->getApplication
([/* ... */]); $promise = $client->getApplicationAsync
([/* ... */]);
Gets information about an existing Amazon Q Business application.
Parameter Syntax
$result = $client->getApplication([ 'applicationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
Result Syntax
[ 'applicationArn' => '<string>', 'applicationId' => '<string>', 'attachmentsConfiguration' => [ 'attachmentsControlMode' => 'ENABLED|DISABLED', ], 'autoSubscriptionConfiguration' => [ 'autoSubscribe' => 'ENABLED|DISABLED', 'defaultSubscriptionType' => 'Q_LITE|Q_BUSINESS', ], 'clientIdsForOIDC' => ['<string>', ...], 'createdAt' => <DateTime>, 'description' => '<string>', 'displayName' => '<string>', 'encryptionConfiguration' => [ 'kmsKeyId' => '<string>', ], 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'iamIdentityProviderArn' => '<string>', 'identityCenterApplicationArn' => '<string>', 'identityType' => 'AWS_IAM_IDP_SAML|AWS_IAM_IDP_OIDC|AWS_IAM_IDC', 'personalizationConfiguration' => [ 'personalizationControlMode' => 'ENABLED|DISABLED', ], 'qAppsConfiguration' => [ 'qAppsControlMode' => 'ENABLED|DISABLED', ], 'roleArn' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING', 'updatedAt' => <DateTime>, ]
Result Details
Members
- applicationArn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q Business application.
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application.
- attachmentsConfiguration
-
- Type: AppliedAttachmentsConfiguration structure
Settings for whether end users can upload files directly during chat.
- autoSubscriptionConfiguration
-
- Type: AutoSubscriptionConfiguration structure
Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
- clientIdsForOIDC
-
- Type: Array of strings
The OIDC client ID for a Amazon Q Business application.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was last updated.
- description
-
- Type: string
A description for the Amazon Q Business application.
- displayName
-
- Type: string
The name of the Amazon Q Business application.
- encryptionConfiguration
-
- Type: EncryptionConfiguration structure
The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
- error
-
- Type: ErrorDetail structure
If the
Status
field is set toERROR
, theErrorMessage
field contains a description of the error that caused the synchronization to fail. - iamIdentityProviderArn
-
- Type: string
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
- identityCenterApplicationArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
- identityType
-
- Type: string
The authentication type being used by a Amazon Q Business application.
- personalizationConfiguration
-
- Type: PersonalizationConfiguration structure
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
- qAppsConfiguration
-
- Type: QAppsConfiguration structure
Settings for whether end users can create and use Amazon Q Apps in the web experience.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
- status
-
- Type: string
The status of the Amazon Q Business application.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was last updated.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetChatControlsConfiguration
$result = $client->getChatControlsConfiguration
([/* ... */]); $promise = $client->getChatControlsConfigurationAsync
([/* ... */]);
Gets information about an chat controls configured for an existing Amazon Q Business application.
Parameter Syntax
$result = $client->getChatControlsConfiguration([ 'applicationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application for which the chat controls are configured.
- maxResults
-
- Type: int
The maximum number of configured chat controls to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'blockedPhrases' => [ 'blockedPhrases' => ['<string>', ...], 'systemMessageOverride' => '<string>', ], 'creatorModeConfiguration' => [ 'creatorModeControl' => 'ENABLED|DISABLED', ], 'nextToken' => '<string>', 'responseScope' => 'ENTERPRISE_CONTENT_ONLY|EXTENDED_KNOWLEDGE_ENABLED', 'topicConfigurations' => [ [ 'description' => '<string>', 'exampleChatMessages' => ['<string>', ...], 'name' => '<string>', 'rules' => [ [ 'excludedUsersAndGroups' => [ 'userGroups' => ['<string>', ...], 'userIds' => ['<string>', ...], ], 'includedUsersAndGroups' => [ 'userGroups' => ['<string>', ...], 'userIds' => ['<string>', ...], ], 'ruleConfiguration' => [ 'contentBlockerRule' => [ 'systemMessageOverride' => '<string>', ], 'contentRetrievalRule' => [ 'eligibleDataSources' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', ], // ... ], ], ], 'ruleType' => 'CONTENT_BLOCKER_RULE|CONTENT_RETRIEVAL_RULE', ], // ... ], ], // ... ], ]
Result Details
Members
- blockedPhrases
-
- Type: BlockedPhrasesConfiguration structure
The phrases blocked from chat by your chat control configuration.
- creatorModeConfiguration
-
- Type: AppliedCreatorModeConfiguration structure
The configuration details for
CREATOR_MODE
. - nextToken
-
- Type: string
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. - responseScope
-
- Type: string
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.
- topicConfigurations
-
- Type: Array of TopicConfiguration structures
The topic specific controls configured for a Amazon Q Business application.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetDataSource
$result = $client->getDataSource
([/* ... */]); $promise = $client->getDataSourceAsync
([/* ... */]);
Gets information about an existing Amazon Q Business data source connector.
Parameter Syntax
$result = $client->getDataSource([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
- dataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source connector.
- indexId
-
- Required: Yes
- Type: string
The identfier of the index used with the data source connector.
Result Syntax
[ 'applicationId' => '<string>', 'configuration' => [ ], 'createdAt' => <DateTime>, 'dataSourceArn' => '<string>', 'dataSourceId' => '<string>', 'description' => '<string>', 'displayName' => '<string>', 'documentEnrichmentConfiguration' => [ 'inlineConfigurations' => [ [ 'condition' => [ 'key' => '<string>', 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', 'value' => [ 'dateValue' => <DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'documentContentOperator' => 'DELETE', 'target' => [ 'attributeValueOperator' => 'DELETE', 'key' => '<string>', 'value' => [ 'dateValue' => <DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], ], // ... ], 'postExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', 'value' => [ 'dateValue' => <DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], 'preExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', 'value' => [ 'dateValue' => <DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], ], 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'indexId' => '<string>', 'roleArn' => '<string>', 'status' => 'PENDING_CREATION|CREATING|ACTIVE|DELETING|FAILED|UPDATING', 'syncSchedule' => '<string>', 'type' => '<string>', 'updatedAt' => <DateTime>, 'vpcConfiguration' => [ 'securityGroupIds' => ['<string>', ...], 'subnetIds' => ['<string>', ...], ], ]
Result Details
Members
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application.
- configuration
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The details of how the data source connector is configured.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the data source connector was created.
- dataSourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the data source.
- dataSourceId
-
- Type: string
The identifier of the data source connector.
- description
-
- Type: string
The description for the data source connector.
- displayName
-
- Type: string
The name for the data source connector.
- documentEnrichmentConfiguration
-
- Type: DocumentEnrichmentConfiguration structure
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
- error
-
- Type: ErrorDetail structure
When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. - indexId
-
- Type: string
The identifier of the index linked to the data source connector.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
- status
-
- Type: string
The current status of the data source connector. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. - syncSchedule
-
- Type: string
The schedule for Amazon Q Business to update the index.
- type
-
- Type: string
The type of the data source connector. For example,
S3
. - updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the data source connector was last updated.
- vpcConfiguration
-
- Type: DataSourceVpcConfiguration structure
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetGroup
$result = $client->getGroup
([/* ... */]); $promise = $client->getGroupAsync
([/* ... */]);
Describes a group by group name.
Parameter Syntax
$result = $client->getGroup([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', 'groupName' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application id the group is attached to.
- dataSourceId
-
- Type: string
The identifier of the data source the group is attached to.
- groupName
-
- Required: Yes
- Type: string
The name of the group.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index the group is attached to.
Result Syntax
[ 'status' => [ 'errorDetail' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'lastUpdatedAt' => <DateTime>, 'status' => 'FAILED|SUCCEEDED|PROCESSING|DELETING|DELETED', ], 'statusHistory' => [ [ 'errorDetail' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'lastUpdatedAt' => <DateTime>, 'status' => 'FAILED|SUCCEEDED|PROCESSING|DELETING|DELETED', ], // ... ], ]
Result Details
Members
- status
-
- Type: GroupStatusDetail structure
The current status of the group.
- statusHistory
-
- Type: Array of GroupStatusDetail structures
The status history of the group.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetIndex
$result = $client->getIndex
([/* ... */]); $promise = $client->getIndexAsync
([/* ... */]);
Gets information about an existing Amazon Q Business index.
Parameter Syntax
$result = $client->getIndex([ 'applicationId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application connected to the index.
- indexId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business index you want information on.
Result Syntax
[ 'applicationId' => '<string>', 'capacityConfiguration' => [ 'units' => <integer>, ], 'createdAt' => <DateTime>, 'description' => '<string>', 'displayName' => '<string>', 'documentAttributeConfigurations' => [ [ 'name' => '<string>', 'search' => 'ENABLED|DISABLED', 'type' => 'STRING|STRING_LIST|NUMBER|DATE', ], // ... ], 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'indexArn' => '<string>', 'indexId' => '<string>', 'indexStatistics' => [ 'textDocumentStatistics' => [ 'indexedTextBytes' => <integer>, 'indexedTextDocumentCount' => <integer>, ], ], 'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING', 'type' => 'ENTERPRISE|STARTER', 'updatedAt' => <DateTime>, ]
Result Details
Members
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application associated with the index.
- capacityConfiguration
-
- Type: IndexCapacityConfiguration structure
The storage capacity units chosen for your Amazon Q Business index.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business index was created.
- description
-
- Type: string
The description for the Amazon Q Business index.
- displayName
-
- Type: string
The name of the Amazon Q Business index.
- documentAttributeConfigurations
-
- Type: Array of DocumentAttributeConfiguration structures
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.
- error
-
- Type: ErrorDetail structure
When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why. - indexArn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q Business index.
- indexId
-
- Type: string
The identifier of the Amazon Q Business index.
- indexStatistics
-
- Type: IndexStatistics structure
Provides information about the number of documents indexed.
- status
-
- Type: string
The current status of the index. When the value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why. - type
-
- Type: string
The type of index attached to your Amazon Q Business application.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business index was last updated.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetPlugin
$result = $client->getPlugin
([/* ... */]); $promise = $client->getPluginAsync
([/* ... */]);
Gets information about an existing Amazon Q Business plugin.
Parameter Syntax
$result = $client->getPlugin([ 'applicationId' => '<string>', // REQUIRED 'pluginId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application which contains the plugin.
- pluginId
-
- Required: Yes
- Type: string
The identifier of the plugin.
Result Syntax
[ 'applicationId' => '<string>', 'authConfiguration' => [ 'basicAuthConfiguration' => [ 'roleArn' => '<string>', 'secretArn' => '<string>', ], 'noAuthConfiguration' => [ ], 'oAuth2ClientCredentialConfiguration' => [ 'roleArn' => '<string>', 'secretArn' => '<string>', ], ], 'buildStatus' => 'READY|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED', 'createdAt' => <DateTime>, 'customPluginConfiguration' => [ 'apiSchema' => [ 'payload' => '<string>', 's3' => [ 'bucket' => '<string>', 'key' => '<string>', ], ], 'apiSchemaType' => 'OPEN_API_V3', 'description' => '<string>', ], 'displayName' => '<string>', 'pluginArn' => '<string>', 'pluginId' => '<string>', 'serverUrl' => '<string>', 'state' => 'ENABLED|DISABLED', 'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM', 'updatedAt' => <DateTime>, ]
Result Details
Members
- applicationId
-
- Type: string
The identifier of the application which contains the plugin.
- authConfiguration
-
- Type: PluginAuthConfiguration structure
Authentication configuration information for an Amazon Q Business plugin.
- buildStatus
-
- Type: string
The current status of a plugin. A plugin is modified asynchronously.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the plugin was created.
- customPluginConfiguration
-
- Type: CustomPluginConfiguration structure
Configuration information required to create a custom plugin.
- displayName
-
- Type: string
The name of the plugin.
- pluginArn
-
- Type: string
The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
- pluginId
-
- Type: string
The identifier of the plugin.
- serverUrl
-
- Type: string
The source URL used for plugin configuration.
- state
-
- Type: string
The current state of the plugin.
- type
-
- Type: string
The type of the plugin.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the plugin was last updated.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetRetriever
$result = $client->getRetriever
([/* ... */]); $promise = $client->getRetrieverAsync
([/* ... */]);
Gets information about an existing retriever used by an Amazon Q Business application.
Parameter Syntax
$result = $client->getRetriever([ 'applicationId' => '<string>', // REQUIRED 'retrieverId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application using the retriever.
- retrieverId
-
- Required: Yes
- Type: string
The identifier of the retriever.
Result Syntax
[ 'applicationId' => '<string>', 'configuration' => [ 'kendraIndexConfiguration' => [ 'indexId' => '<string>', ], 'nativeIndexConfiguration' => [ 'boostingOverride' => [ '<DocumentAttributeKey>' => [ 'dateConfiguration' => [ 'boostingDurationInSeconds' => <integer>, 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', ], 'numberConfiguration' => [ 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', 'boostingType' => 'PRIORITIZE_LARGER_VALUES|PRIORITIZE_SMALLER_VALUES', ], 'stringConfiguration' => [ 'attributeValueBoosting' => ['<string>', ...], 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', ], 'stringListConfiguration' => [ 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', ], ], // ... ], 'indexId' => '<string>', ], ], 'createdAt' => <DateTime>, 'displayName' => '<string>', 'retrieverArn' => '<string>', 'retrieverId' => '<string>', 'roleArn' => '<string>', 'status' => 'CREATING|ACTIVE|FAILED', 'type' => 'NATIVE_INDEX|KENDRA_INDEX', 'updatedAt' => <DateTime>, ]
Result Details
Members
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application using the retriever.
- configuration
-
- Type: RetrieverConfiguration structure
Provides information on how the retriever used for your Amazon Q Business application is configured.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the retriever was created.
- displayName
-
- Type: string
The name of the retriever.
- retrieverArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
- retrieverId
-
- Type: string
The identifier of the retriever.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
- status
-
- Type: string
The status of the retriever.
- type
-
- Type: string
The type of the retriever.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the retriever was last updated.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetUser
$result = $client->getUser
([/* ... */]); $promise = $client->getUserAsync
([/* ... */]);
Describes the universally unique identifier (UUID) associated with a local user in a data source.
Parameter Syntax
$result = $client->getUser([ 'applicationId' => '<string>', // REQUIRED 'userId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application connected to the user.
- userId
-
- Required: Yes
- Type: string
The user email address attached to the user.
Result Syntax
[ 'userAliases' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', ], // ... ], ]
Result Details
Members
- userAliases
-
- Type: Array of UserAlias structures
A list of user aliases attached to a user.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
GetWebExperience
$result = $client->getWebExperience
([/* ... */]); $promise = $client->getWebExperienceAsync
([/* ... */]);
Gets information about an existing Amazon Q Business web experience.
Parameter Syntax
$result = $client->getWebExperience([ 'applicationId' => '<string>', // REQUIRED 'webExperienceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application linked to the web experience.
- webExperienceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business web experience.
Result Syntax
[ 'applicationId' => '<string>', 'authenticationConfiguration' => [ 'samlConfiguration' => [ 'metadataXML' => '<string>', 'roleArn' => '<string>', 'userGroupAttribute' => '<string>', 'userIdAttribute' => '<string>', ], ], 'createdAt' => <DateTime>, 'defaultEndpoint' => '<string>', 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'identityProviderConfiguration' => [ 'openIDConnectConfiguration' => [ 'secretsArn' => '<string>', 'secretsRole' => '<string>', ], 'samlConfiguration' => [ 'authenticationUrl' => '<string>', ], ], 'roleArn' => '<string>', 'samplePromptsControlMode' => 'ENABLED|DISABLED', 'status' => 'CREATING|ACTIVE|DELETING|FAILED|PENDING_AUTH_CONFIG', 'subtitle' => '<string>', 'title' => '<string>', 'updatedAt' => <DateTime>, 'webExperienceArn' => '<string>', 'webExperienceId' => '<string>', 'welcomeMessage' => '<string>', ]
Result Details
Members
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application linked to the web experience.
- authenticationConfiguration
-
- Type: WebExperienceAuthConfiguration structure
The authentication configuration information for your Amazon Q Business web experience.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business web experience was last created.
- defaultEndpoint
-
- Type: string
The endpoint of your Amazon Q Business web experience.
- error
-
- Type: ErrorDetail structure
When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. - identityProviderConfiguration
-
- Type: IdentityProviderConfiguration structure
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the service role attached to your web experience.
- samplePromptsControlMode
-
- Type: string
Determines whether sample prompts are enabled in the web experience for an end user.
- status
-
- Type: string
The current status of the Amazon Q Business web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. - subtitle
-
- Type: string
The subtitle for your Amazon Q Business web experience.
- title
-
- Type: string
The title for your Amazon Q Business web experience.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business web experience was last updated.
- webExperienceArn
-
- Type: string
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
- webExperienceId
-
- Type: string
The identifier of the Amazon Q Business web experience.
- welcomeMessage
-
- Type: string
The customized welcome message for end users of an Amazon Q Business web experience.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListApplications
$result = $client->listApplications
([/* ... */]); $promise = $client->listApplicationsAsync
([/* ... */]);
Lists Amazon Q Business applications.
Parameter Syntax
$result = $client->listApplications([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of Amazon Q Business applications to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'applications' => [ [ 'applicationId' => '<string>', 'createdAt' => <DateTime>, 'displayName' => '<string>', 'identityType' => 'AWS_IAM_IDP_SAML|AWS_IAM_IDP_OIDC|AWS_IAM_IDC', 'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- applications
-
- Type: Array of Application structures
An array of summary information on the configuration of one or more Amazon Q Business applications.
- nextToken
-
- Type: string
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.
Errors
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListConversations
$result = $client->listConversations
([/* ... */]); $promise = $client->listConversationsAsync
([/* ... */]);
Lists one or more Amazon Q Business conversations.
Parameter Syntax
$result = $client->listConversations([ 'applicationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'userId' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
- maxResults
-
- Type: int
The maximum number of Amazon Q Business conversations to return.
- nextToken
-
- Type: string
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. - userId
-
- Type: string
The identifier of the user involved in the Amazon Q Business web experience conversation.
Result Syntax
[ 'conversations' => [ [ 'conversationId' => '<string>', 'startTime' => <DateTime>, 'title' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- conversations
-
- Type: Array of Conversation structures
An array of summary information on the configuration of one or more Amazon Q Business web experiences.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- 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.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListDataSourceSyncJobs
$result = $client->listDataSourceSyncJobs
([/* ... */]); $promise = $client->listDataSourceSyncJobsAsync
([/* ... */]);
Get information about an Amazon Q Business data source connector synchronization.
Parameter Syntax
$result = $client->listDataSourceSyncJobs([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', // REQUIRED 'endTime' => <integer || string || DateTime>, 'indexId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'startTime' => <integer || string || DateTime>, 'statusFilter' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED|SYNCING_INDEXING', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application connected to the data source.
- dataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source connector.
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time of the data source connector sync.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index used with the Amazon Q Business data source connector.
- maxResults
-
- Type: int
The maximum number of synchronization jobs to return in the response.
- nextToken
-
- Type: string
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. - startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the data source connector sync.
- statusFilter
-
- Type: string
Only returns synchronization jobs with the
Status
field equal to the specified status.
Result Syntax
[ 'history' => [ [ 'dataSourceErrorCode' => '<string>', 'endTime' => <DateTime>, 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'executionId' => '<string>', 'metrics' => [ 'documentsAdded' => '<string>', 'documentsDeleted' => '<string>', 'documentsFailed' => '<string>', 'documentsModified' => '<string>', 'documentsScanned' => '<string>', ], 'startTime' => <DateTime>, 'status' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED|SYNCING_INDEXING', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- history
-
- Type: Array of DataSourceSyncJob structures
A history of synchronization jobs for the data source connector.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListDataSources
$result = $client->listDataSources
([/* ... */]); $promise = $client->listDataSourcesAsync
([/* ... */]);
Lists the Amazon Q Business data source connectors that you have created.
Parameter Syntax
$result = $client->listDataSources([ 'applicationId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application linked to the data source connectors.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index used with one or more data source connectors.
- maxResults
-
- Type: int
The maximum number of data source connectors to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'dataSources' => [ [ 'createdAt' => <DateTime>, 'dataSourceId' => '<string>', 'displayName' => '<string>', 'status' => 'PENDING_CREATION|CREATING|ACTIVE|DELETING|FAILED|UPDATING', 'type' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- dataSources
-
- Type: Array of DataSource structures
An array of summary information for one or more data source connector.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListDocuments
$result = $client->listDocuments
([/* ... */]); $promise = $client->listDocumentsAsync
([/* ... */]);
A list of documents attached to an index.
Parameter Syntax
$result = $client->listDocuments([ 'applicationId' => '<string>', // REQUIRED 'dataSourceIds' => ['<string>', ...], 'indexId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application id the documents are attached to.
- dataSourceIds
-
- Type: Array of strings
The identifier of the data sources the documents are attached to.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index the documents are attached to.
- maxResults
-
- Type: int
The maximum number of documents to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'documentDetailList' => [ [ 'createdAt' => <DateTime>, 'documentId' => '<string>', 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'status' => 'RECEIVED|PROCESSING|INDEXED|UPDATED|FAILED|DELETING|DELETED|DOCUMENT_FAILED_TO_INDEX', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- documentDetailList
-
- Type: Array of DocumentDetails structures
A list of document details.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListGroups
$result = $client->listGroups
([/* ... */]); $promise = $client->listGroupsAsync
([/* ... */]);
Provides a list of groups that are mapped to users.
Parameter Syntax
$result = $client->listGroups([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', 'indexId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'updatedEarlierThan' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application for getting a list of groups mapped to users.
- dataSourceId
-
- Type: string
The identifier of the data source for getting a list of groups mapped to users.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index for getting a list of groups mapped to users.
- maxResults
-
- Type: int
The maximum number of returned groups that are mapped to users.
- nextToken
-
- Type: string
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.
- updatedEarlierThan
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp identifier used for the latest
PUT
orDELETE
action for mapping users to their groups.
Result Syntax
[ 'items' => [ [ 'groupName' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of GroupSummary structures
Summary information for list of groups that are mapped to users.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListIndices
$result = $client->listIndices
([/* ... */]); $promise = $client->listIndicesAsync
([/* ... */]);
Lists the Amazon Q Business indices you have created.
Parameter Syntax
$result = $client->listIndices([ 'applicationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application connected to the index.
- maxResults
-
- Type: int
The maximum number of indices to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'indices' => [ [ 'createdAt' => <DateTime>, 'displayName' => '<string>', 'indexId' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- indices
-
- Type: Array of Index structures
An array of information on the items in one or more indexes.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListMessages
$result = $client->listMessages
([/* ... */]); $promise = $client->listMessagesAsync
([/* ... */]);
Gets a list of messages associated with an Amazon Q Business web experience.
Parameter Syntax
$result = $client->listMessages([ 'applicationId' => '<string>', // REQUIRED 'conversationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'userId' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier for the Amazon Q Business application.
- conversationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business web experience conversation.
- maxResults
-
- Type: int
The maximum number of messages to return.
- nextToken
-
- Type: string
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 messages. - userId
-
- Type: string
The identifier of the user involved in the Amazon Q Business web experience conversation.
Result Syntax
[ 'messages' => [ [ 'actionExecution' => [ 'payload' => [ '<ActionPayloadFieldKey>' => [ 'value' => [ ], ], // ... ], 'payloadFieldNameSeparator' => '<string>', 'pluginId' => '<string>', ], 'actionReview' => [ 'payload' => [ '<ActionPayloadFieldKey>' => [ 'allowedFormat' => '<string>', 'allowedValues' => [ [ 'displayValue' => [ ], 'value' => [ ], ], // ... ], 'displayDescription' => '<string>', 'displayName' => '<string>', 'displayOrder' => <integer>, 'required' => true || false, 'type' => 'STRING|NUMBER|ARRAY|BOOLEAN', 'value' => [ ], ], // ... ], 'payloadFieldNameSeparator' => '<string>', 'pluginId' => '<string>', 'pluginType' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM', ], 'attachments' => [ [ 'error' => [ 'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound', 'errorMessage' => '<string>', ], 'name' => '<string>', 'status' => 'FAILED|SUCCEEDED', ], // ... ], 'body' => '<string>', 'messageId' => '<string>', 'sourceAttribution' => [ [ 'citationNumber' => <integer>, 'snippet' => '<string>', 'textMessageSegments' => [ [ 'beginOffset' => <integer>, 'endOffset' => <integer>, 'snippetExcerpt' => [ 'text' => '<string>', ], ], // ... ], 'title' => '<string>', 'updatedAt' => <DateTime>, 'url' => '<string>', ], // ... ], 'time' => <DateTime>, 'type' => 'USER|SYSTEM', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- messages
-
- Type: Array of Message structures
An array of information on one or more messages.
- nextToken
-
- Type: string
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.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- 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.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListPlugins
$result = $client->listPlugins
([/* ... */]); $promise = $client->listPluginsAsync
([/* ... */]);
Lists configured Amazon Q Business plugins.
Parameter Syntax
$result = $client->listPlugins([ 'applicationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application the plugin is attached to.
- maxResults
-
- Type: int
The maximum number of documents to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'plugins' => [ [ 'buildStatus' => 'READY|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED', 'createdAt' => <DateTime>, 'displayName' => '<string>', 'pluginId' => '<string>', 'serverUrl' => '<string>', 'state' => 'ENABLED|DISABLED', 'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM', 'updatedAt' => <DateTime>, ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
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. - plugins
-
- Type: Array of Plugin structures
Information about a configured plugin.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListRetrievers
$result = $client->listRetrievers
([/* ... */]); $promise = $client->listRetrieversAsync
([/* ... */]);
Lists the retriever used by an Amazon Q Business application.
Parameter Syntax
$result = $client->listRetrievers([ 'applicationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application using the retriever.
- maxResults
-
- Type: int
The maximum number of retrievers returned.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'retrievers' => [ [ 'applicationId' => '<string>', 'displayName' => '<string>', 'retrieverId' => '<string>', 'status' => 'CREATING|ACTIVE|FAILED', 'type' => 'NATIVE_INDEX|KENDRA_INDEX', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
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.
- retrievers
-
- Type: Array of Retriever structures
An array of summary information for one or more retrievers.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceARN' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
Result Syntax
[ 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ]
Result Details
Members
- tags
-
- Type: Array of Tag structures
A list of tags associated with the Amazon Q Business application or data source.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
ListWebExperiences
$result = $client->listWebExperiences
([/* ... */]); $promise = $client->listWebExperiencesAsync
([/* ... */]);
Lists one or more Amazon Q Business Web Experiences.
Parameter Syntax
$result = $client->listWebExperiences([ 'applicationId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application linked to the listed web experiences.
- maxResults
-
- Type: int
The maximum number of Amazon Q Business Web Experiences to return.
- nextToken
-
- Type: string
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.
Result Syntax
[ 'nextToken' => '<string>', 'webExperiences' => [ [ 'createdAt' => <DateTime>, 'defaultEndpoint' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|FAILED|PENDING_AUTH_CONFIG', 'updatedAt' => <DateTime>, 'webExperienceId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
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.
- webExperiences
-
- Type: Array of WebExperience structures
An array of summary information for one or more Amazon Q Business experiences.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
PutFeedback
$result = $client->putFeedback
([/* ... */]); $promise = $client->putFeedbackAsync
([/* ... */]);
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
Parameter Syntax
$result = $client->putFeedback([ 'applicationId' => '<string>', // REQUIRED 'conversationId' => '<string>', // REQUIRED 'messageCopiedAt' => <integer || string || DateTime>, 'messageId' => '<string>', // REQUIRED 'messageUsefulness' => [ 'comment' => '<string>', 'reason' => 'NOT_FACTUALLY_CORRECT|HARMFUL_OR_UNSAFE|INCORRECT_OR_MISSING_SOURCES|NOT_HELPFUL|FACTUALLY_CORRECT|COMPLETE|RELEVANT_SOURCES|HELPFUL|NOT_BASED_ON_DOCUMENTS|NOT_COMPLETE|NOT_CONCISE|OTHER', 'submittedAt' => <integer || string || DateTime>, // REQUIRED 'usefulness' => 'USEFUL|NOT_USEFUL', // REQUIRED ], 'userId' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application associated with the feedback.
- conversationId
-
- Required: Yes
- Type: string
The identifier of the conversation the feedback is attached to.
- messageCopiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the feedback was recorded.
- messageId
-
- Required: Yes
- Type: string
The identifier of the chat message that the feedback was given for.
- messageUsefulness
-
- Type: MessageUsefulnessFeedback structure
The feedback usefulness value given by the user to the chat message.
- userId
-
- Type: string
The identifier of the user giving the feedback.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
PutGroup
$result = $client->putGroup
([/* ... */]); $promise = $client->putGroupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putGroup([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', 'groupMembers' => [ // REQUIRED 'memberGroups' => [ [ 'groupName' => '<string>', // REQUIRED 'type' => 'INDEX|DATASOURCE', ], // ... ], 'memberUsers' => [ [ 'type' => 'INDEX|DATASOURCE', 'userId' => '<string>', // REQUIRED ], // ... ], ], 'groupName' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED 'type' => 'INDEX|DATASOURCE', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application in which the user and group mapping belongs.
- dataSourceId
-
- Type: string
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.
- groupMembers
-
- Required: Yes
- Type: GroupMembers structure
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.
- groupName
-
- Required: Yes
- Type: string
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".
- indexId
-
- Required: Yes
- Type: string
The identifier of the index in which you want to map users to their groups.
- type
-
- Required: Yes
- Type: string
The type of the group.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
StartDataSourceSyncJob
$result = $client->startDataSourceSyncJob
([/* ... */]); $promise = $client->startDataSourceSyncJobAsync
([/* ... */]);
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException
.
Parameter Syntax
$result = $client->startDataSourceSyncJob([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of Amazon Q Business application the data source is connected to.
- dataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source connector.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index used with the data source connector.
Result Syntax
[ 'executionId' => '<string>', ]
Result Details
Members
- executionId
-
- Type: string
The identifier for a particular synchronization job.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
StopDataSourceSyncJob
$result = $client->stopDataSourceSyncJob
([/* ... */]); $promise = $client->stopDataSourceSyncJobAsync
([/* ... */]);
Stops an Amazon Q Business data source connector synchronization job already in progress.
Parameter Syntax
$result = $client->stopDataSourceSyncJob([ 'applicationId' => '<string>', // REQUIRED 'dataSourceId' => '<string>', // REQUIRED 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application that the data source is connected to.
- dataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source connector.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index used with the Amazon Q Business data source connector.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([ 'resourceARN' => '<string>', // REQUIRED 'tags' => [ // REQUIRED [ 'key' => '<string>', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
- tags
-
- Required: Yes
- Type: Array of Tag structures
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.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes a tag from an Amazon Q Business application or a data source.
Parameter Syntax
$result = $client->untagResource([ 'resourceARN' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
- tagKeys
-
- Required: Yes
- Type: Array of strings
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.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
UpdateApplication
$result = $client->updateApplication
([/* ... */]); $promise = $client->updateApplicationAsync
([/* ... */]);
Updates an existing Amazon Q Business application.
Parameter Syntax
$result = $client->updateApplication([ 'applicationId' => '<string>', // REQUIRED 'attachmentsConfiguration' => [ 'attachmentsControlMode' => 'ENABLED|DISABLED', // REQUIRED ], 'autoSubscriptionConfiguration' => [ 'autoSubscribe' => 'ENABLED|DISABLED', // REQUIRED 'defaultSubscriptionType' => 'Q_LITE|Q_BUSINESS', ], 'description' => '<string>', 'displayName' => '<string>', 'identityCenterInstanceArn' => '<string>', 'personalizationConfiguration' => [ 'personalizationControlMode' => 'ENABLED|DISABLED', // REQUIRED ], 'qAppsConfiguration' => [ 'qAppsControlMode' => 'ENABLED|DISABLED', // REQUIRED ], 'roleArn' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application.
- attachmentsConfiguration
-
- Type: AttachmentsConfiguration structure
An option to allow end users to upload files directly during chat.
- autoSubscriptionConfiguration
-
- Type: AutoSubscriptionConfiguration structure
An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
- description
-
- Type: string
A description for the Amazon Q Business application.
- displayName
-
- Type: string
A name for the Amazon Q Business application.
- identityCenterInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
- personalizationConfiguration
-
- Type: PersonalizationConfiguration structure
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
- qAppsConfiguration
-
- Type: QAppsConfiguration structure
An option to allow end users to create and use Amazon Q Apps in the web experience.
- roleArn
-
- Type: string
An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
UpdateChatControlsConfiguration
$result = $client->updateChatControlsConfiguration
([/* ... */]); $promise = $client->updateChatControlsConfigurationAsync
([/* ... */]);
Updates an set of chat controls configured for an existing Amazon Q Business application.
Parameter Syntax
$result = $client->updateChatControlsConfiguration([ 'applicationId' => '<string>', // REQUIRED 'blockedPhrasesConfigurationUpdate' => [ 'blockedPhrasesToCreateOrUpdate' => ['<string>', ...], 'blockedPhrasesToDelete' => ['<string>', ...], 'systemMessageOverride' => '<string>', ], 'clientToken' => '<string>', 'creatorModeConfiguration' => [ 'creatorModeControl' => 'ENABLED|DISABLED', // REQUIRED ], 'responseScope' => 'ENTERPRISE_CONTENT_ONLY|EXTENDED_KNOWLEDGE_ENABLED', 'topicConfigurationsToCreateOrUpdate' => [ [ 'description' => '<string>', 'exampleChatMessages' => ['<string>', ...], 'name' => '<string>', // REQUIRED 'rules' => [ // REQUIRED [ 'excludedUsersAndGroups' => [ 'userGroups' => ['<string>', ...], 'userIds' => ['<string>', ...], ], 'includedUsersAndGroups' => [ 'userGroups' => ['<string>', ...], 'userIds' => ['<string>', ...], ], 'ruleConfiguration' => [ 'contentBlockerRule' => [ 'systemMessageOverride' => '<string>', ], 'contentRetrievalRule' => [ 'eligibleDataSources' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', ], // ... ], ], ], 'ruleType' => 'CONTENT_BLOCKER_RULE|CONTENT_RETRIEVAL_RULE', // REQUIRED ], // ... ], ], // ... ], 'topicConfigurationsToDelete' => [ [ 'description' => '<string>', 'exampleChatMessages' => ['<string>', ...], 'name' => '<string>', // REQUIRED 'rules' => [ // REQUIRED [ 'excludedUsersAndGroups' => [ 'userGroups' => ['<string>', ...], 'userIds' => ['<string>', ...], ], 'includedUsersAndGroups' => [ 'userGroups' => ['<string>', ...], 'userIds' => ['<string>', ...], ], 'ruleConfiguration' => [ 'contentBlockerRule' => [ 'systemMessageOverride' => '<string>', ], 'contentRetrievalRule' => [ 'eligibleDataSources' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', ], // ... ], ], ], 'ruleType' => 'CONTENT_BLOCKER_RULE|CONTENT_RETRIEVAL_RULE', // REQUIRED ], // ... ], ], // ... ], ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application for which the chat controls are configured.
- blockedPhrasesConfigurationUpdate
-
- Type: BlockedPhrasesConfigurationUpdate structure
The phrases blocked from chat by your chat control configuration.
- clientToken
-
- Type: string
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
- creatorModeConfiguration
-
- Type: CreatorModeConfiguration structure
The configuration details for
CREATOR_MODE
. - responseScope
-
- Type: string
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.
- topicConfigurationsToCreateOrUpdate
-
- Type: Array of TopicConfiguration structures
The configured topic specific chat controls you want to update.
- topicConfigurationsToDelete
-
- Type: Array of TopicConfiguration structures
The configured topic specific chat controls you want to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
UpdateDataSource
$result = $client->updateDataSource
([/* ... */]); $promise = $client->updateDataSourceAsync
([/* ... */]);
Updates an existing Amazon Q Business data source connector.
Parameter Syntax
$result = $client->updateDataSource([ 'applicationId' => '<string>', // REQUIRED 'configuration' => [ ], 'dataSourceId' => '<string>', // REQUIRED 'description' => '<string>', 'displayName' => '<string>', 'documentEnrichmentConfiguration' => [ 'inlineConfigurations' => [ [ 'condition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'documentContentOperator' => 'DELETE', 'target' => [ 'attributeValueOperator' => 'DELETE', 'key' => '<string>', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], ], // ... ], 'postExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], 'preExtractionHookConfiguration' => [ 'invocationCondition' => [ 'key' => '<string>', // REQUIRED 'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED 'value' => [ 'dateValue' => <integer || string || DateTime>, 'longValue' => <integer>, 'stringListValue' => ['<string>', ...], 'stringValue' => '<string>', ], ], 'lambdaArn' => '<string>', 'roleArn' => '<string>', 's3BucketName' => '<string>', ], ], 'indexId' => '<string>', // REQUIRED 'roleArn' => '<string>', 'syncSchedule' => '<string>', 'vpcConfiguration' => [ 'securityGroupIds' => ['<string>', ...], // REQUIRED 'subnetIds' => ['<string>', ...], // REQUIRED ], ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application the data source is attached to.
- configuration
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
Provides the configuration information for an Amazon Q Business data source.
- dataSourceId
-
- Required: Yes
- Type: string
The identifier of the data source connector.
- description
-
- Type: string
The description of the data source connector.
- displayName
-
- Type: string
A name of the data source connector.
- documentEnrichmentConfiguration
-
- Type: DocumentEnrichmentConfiguration structure
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
- indexId
-
- Required: Yes
- Type: string
The identifier of the index attached to the data source connector.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- syncSchedule
-
- Type: string
The chosen update frequency for your data source.
- vpcConfiguration
-
- Type: DataSourceVpcConfiguration structure
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
UpdateIndex
$result = $client->updateIndex
([/* ... */]); $promise = $client->updateIndexAsync
([/* ... */]);
Updates an Amazon Q Business index.
Parameter Syntax
$result = $client->updateIndex([ 'applicationId' => '<string>', // REQUIRED 'capacityConfiguration' => [ 'units' => <integer>, ], 'description' => '<string>', 'displayName' => '<string>', 'documentAttributeConfigurations' => [ [ 'name' => '<string>', 'search' => 'ENABLED|DISABLED', 'type' => 'STRING|STRING_LIST|NUMBER|DATE', ], // ... ], 'indexId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application connected to the index.
- capacityConfiguration
-
- Type: IndexCapacityConfiguration structure
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.
- description
-
- Type: string
The description of the Amazon Q Business index.
- displayName
-
- Type: string
The name of the Amazon Q Business index.
- documentAttributeConfigurations
-
- Type: Array of DocumentAttributeConfiguration structures
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.
- indexId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business index.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
UpdatePlugin
$result = $client->updatePlugin
([/* ... */]); $promise = $client->updatePluginAsync
([/* ... */]);
Updates an Amazon Q Business plugin.
Parameter Syntax
$result = $client->updatePlugin([ 'applicationId' => '<string>', // REQUIRED 'authConfiguration' => [ 'basicAuthConfiguration' => [ 'roleArn' => '<string>', // REQUIRED 'secretArn' => '<string>', // REQUIRED ], 'noAuthConfiguration' => [ ], 'oAuth2ClientCredentialConfiguration' => [ 'roleArn' => '<string>', // REQUIRED 'secretArn' => '<string>', // REQUIRED ], ], 'customPluginConfiguration' => [ 'apiSchema' => [ // REQUIRED 'payload' => '<string>', 's3' => [ 'bucket' => '<string>', // REQUIRED 'key' => '<string>', // REQUIRED ], ], 'apiSchemaType' => 'OPEN_API_V3', // REQUIRED 'description' => '<string>', // REQUIRED ], 'displayName' => '<string>', 'pluginId' => '<string>', // REQUIRED 'serverUrl' => '<string>', 'state' => 'ENABLED|DISABLED', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application the plugin is attached to.
- authConfiguration
-
- Type: PluginAuthConfiguration structure
The authentication configuration the plugin is using.
- customPluginConfiguration
-
- Type: CustomPluginConfiguration structure
The configuration for a custom plugin.
- displayName
-
- Type: string
The name of the plugin.
- pluginId
-
- Required: Yes
- Type: string
The identifier of the plugin.
- serverUrl
-
- Type: string
The source URL used for plugin configuration.
- state
-
- Type: string
The status of the plugin.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
UpdateRetriever
$result = $client->updateRetriever
([/* ... */]); $promise = $client->updateRetrieverAsync
([/* ... */]);
Updates the retriever used for your Amazon Q Business application.
Parameter Syntax
$result = $client->updateRetriever([ 'applicationId' => '<string>', // REQUIRED 'configuration' => [ 'kendraIndexConfiguration' => [ 'indexId' => '<string>', // REQUIRED ], 'nativeIndexConfiguration' => [ 'boostingOverride' => [ '<DocumentAttributeKey>' => [ 'dateConfiguration' => [ 'boostingDurationInSeconds' => <integer>, 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED ], 'numberConfiguration' => [ 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED 'boostingType' => 'PRIORITIZE_LARGER_VALUES|PRIORITIZE_SMALLER_VALUES', ], 'stringConfiguration' => [ 'attributeValueBoosting' => ['<string>', ...], 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED ], 'stringListConfiguration' => [ 'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED ], ], // ... ], 'indexId' => '<string>', // REQUIRED ], ], 'displayName' => '<string>', 'retrieverId' => '<string>', // REQUIRED 'roleArn' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of your Amazon Q Business application.
- configuration
-
- Type: RetrieverConfiguration structure
Provides information on how the retriever used for your Amazon Q Business application is configured.
- displayName
-
- Type: string
The name of your retriever.
- retrieverId
-
- Required: Yes
- Type: string
The identifier of your retriever.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
UpdateUser
$result = $client->updateUser
([/* ... */]); $promise = $client->updateUserAsync
([/* ... */]);
Updates a information associated with a user id.
Parameter Syntax
$result = $client->updateUser([ 'applicationId' => '<string>', // REQUIRED 'userAliasesToDelete' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', // REQUIRED ], // ... ], 'userAliasesToUpdate' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', // REQUIRED ], // ... ], 'userId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the application the user is attached to.
- userAliasesToDelete
-
- Type: Array of UserAlias structures
The user aliases attached to the user id that are to be deleted.
- userAliasesToUpdate
-
- Type: Array of UserAlias structures
The user aliases attached to the user id that are to be updated.
- userId
-
- Required: Yes
- Type: string
The email id attached to the user.
Result Syntax
[ 'userAliasesAdded' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', ], // ... ], 'userAliasesDeleted' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', ], // ... ], 'userAliasesUpdated' => [ [ 'dataSourceId' => '<string>', 'indexId' => '<string>', 'userId' => '<string>', ], // ... ], ]
Result Details
Members
- userAliasesAdded
-
- Type: Array of UserAlias structures
The user aliases that have been to be added to a user id.
- userAliasesDeleted
-
- Type: Array of UserAlias structures
The user aliases that have been deleted from a user id.
- userAliasesUpdated
-
- Type: Array of UserAlias structures
The user aliases attached to a user id that have been updated.
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
- ServiceQuotaExceededException:
You have exceeded the set limits for your Amazon Q Business service.
UpdateWebExperience
$result = $client->updateWebExperience
([/* ... */]); $promise = $client->updateWebExperienceAsync
([/* ... */]);
Updates an Amazon Q Business web experience.
Parameter Syntax
$result = $client->updateWebExperience([ 'applicationId' => '<string>', // REQUIRED 'authenticationConfiguration' => [ 'samlConfiguration' => [ 'metadataXML' => '<string>', // REQUIRED 'roleArn' => '<string>', // REQUIRED 'userGroupAttribute' => '<string>', 'userIdAttribute' => '<string>', // REQUIRED ], ], 'identityProviderConfiguration' => [ 'openIDConnectConfiguration' => [ 'secretsArn' => '<string>', // REQUIRED 'secretsRole' => '<string>', // REQUIRED ], 'samlConfiguration' => [ 'authenticationUrl' => '<string>', // REQUIRED ], ], 'roleArn' => '<string>', 'samplePromptsControlMode' => 'ENABLED|DISABLED', 'subtitle' => '<string>', 'title' => '<string>', 'webExperienceId' => '<string>', // REQUIRED 'welcomeMessage' => '<string>', ]);
Parameter Details
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application attached to the web experience.
- authenticationConfiguration
-
- Type: WebExperienceAuthConfiguration structure
The authentication configuration of the Amazon Q Business web experience.
- identityProviderConfiguration
-
- Type: IdentityProviderConfiguration structure
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
- samplePromptsControlMode
-
- Type: string
Determines whether sample prompts are enabled in the web experience for an end user.
- subtitle
-
- Type: string
The subtitle of the Amazon Q Business web experience.
- title
-
- Type: string
The title of the Amazon Q Business web experience.
- webExperienceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business web experience.
- welcomeMessage
-
- Type: string
A customized welcome message for an end user in an Amazon Q Business web experience.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
- InternalServerException:
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
- ConflictException:
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
- ThrottlingException:
The request was denied due to throttling. Reduce the number of requests and try again.
- ValidationException:
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
- AccessDeniedException:
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
Shapes
APISchema
Description
Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3
field.
Members
- payload
-
- Type: string
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
- s3
-
- Type: S3 structure
Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
AccessConfiguration
Description
Used to configure access permissions for a document.
Members
- accessControls
-
- Required: Yes
- Type: Array of AccessControl structures
A list of
AccessControlList
objects. - memberRelation
-
- Type: string
Describes the member relation within the
AccessControlList
object.
AccessControl
Description
A list of principals. Each principal can be either a USER
or a GROUP
and can be designated document access permissions of either ALLOW
or DENY
.
Members
- memberRelation
-
- Type: string
Describes the member relation within a principal list.
- principals
-
- Required: Yes
- Type: Array of Principal structures
Contains a list of principals, where a principal can be either a
USER
or aGROUP
. Each principal can be have the following type of document access:ALLOW
orDENY
.
AccessDeniedException
Description
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
Members
- message
-
- Required: Yes
- Type: string
ActionExecution
Description
Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
Members
- payload
-
- Required: Yes
- Type: Associative array of custom strings keys (ActionPayloadFieldKey) to ActionExecutionPayloadField structures
A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
- payloadFieldNameSeparator
-
- Required: Yes
- Type: string
A string used to retain information about the hierarchical contexts within an action execution event payload.
- pluginId
-
- Required: Yes
- Type: string
The identifier of the plugin the action is attached to.
ActionExecutionEvent
Description
A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.
Members
- payload
-
- Required: Yes
- Type: Associative array of custom strings keys (ActionPayloadFieldKey) to ActionExecutionPayloadField structures
A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
- payloadFieldNameSeparator
-
- Required: Yes
- Type: string
A string used to retain information about the hierarchical contexts within a action execution event payload.
- pluginId
-
- Required: Yes
- Type: string
The identifier of the plugin for which the action is being requested.
ActionExecutionPayloadField
Description
A user input field in an plugin action execution payload.
Members
- value
-
- Required: Yes
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The content of a user input field in an plugin action execution payload.
ActionPayloadFieldValue
Members
ActionReview
Description
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
Members
- payload
-
- Type: Associative array of custom strings keys (ActionPayloadFieldKey) to ActionReviewPayloadField structures
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
- payloadFieldNameSeparator
-
- Type: string
A string used to retain information about the hierarchical contexts within an action review payload.
- pluginId
-
- Type: string
The identifier of the plugin associated with the action review.
- pluginType
-
- Type: string
The type of plugin.
ActionReviewEvent
Description
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
Members
- conversationId
-
- Type: string
The identifier of the conversation with which the action review event is associated.
- payload
-
- Type: Associative array of custom strings keys (ActionPayloadFieldKey) to ActionReviewPayloadField structures
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
- payloadFieldNameSeparator
-
- Type: string
A string used to retain information about the hierarchical contexts within an action review event payload.
- pluginId
-
- Type: string
The identifier of the plugin associated with the action review event.
- pluginType
-
- Type: string
The type of plugin.
- systemMessageId
-
- Type: string
The identifier of an Amazon Q Business AI generated associated with the action review event.
- userMessageId
-
- Type: string
The identifier of the conversation with which the plugin action is associated.
ActionReviewPayloadField
Description
A user input field in an plugin action review payload.
Members
- allowedFormat
-
- Type: string
The expected data format for the action review input field value. For example, in PTO request,
from
andto
would be ofdatetime
allowed format. - allowedValues
-
- Type: Array of ActionReviewPayloadFieldAllowedValue structures
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
- displayDescription
-
- Type: string
The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.
- displayName
-
- Type: string
The name of the field.
- displayOrder
-
- Type: int
The display order of fields in a payload.
- required
-
- Type: boolean
Information about whether the field is required.
- type
-
- Type: string
The type of field.
- value
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The field value.
ActionReviewPayloadFieldAllowedValue
Description
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
Members
- displayValue
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The name of the field.
- value
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
The field value.
Application
Description
Summary information for an Amazon Q Business application.
Members
- applicationId
-
- Type: string
The identifier for the Amazon Q Business application.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was created.
- displayName
-
- Type: string
The name of the Amazon Q Business application.
- identityType
-
- Type: string
The authentication type being used by a Amazon Q Business application.
- status
-
- Type: string
The status of the Amazon Q Business application. The application is ready to use when the status is
ACTIVE
. - updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was last updated.
AppliedAttachmentsConfiguration
Description
Configuration information about the file upload during chat feature for your application.
Members
- attachmentsControlMode
-
- Type: string
Information about whether file upload during chat functionality is activated for your application.
AppliedCreatorModeConfiguration
Description
The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.
For more information, see Admin controls and guardrails and Conversation settings.
Members
- creatorModeControl
-
- Required: Yes
- Type: string
Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
AttachmentInput
Description
A file directly uploaded into a web experience chat.
Members
- data
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The data contained within the uploaded file.
- name
-
- Required: Yes
- Type: string
The name of the file.
AttachmentInputEvent
Description
A file input event activated by a end user request to upload files into their web experience chat.
Members
- attachment
-
- Type: AttachmentInput structure
A file directly uploaded into a web experience chat.
AttachmentOutput
Description
The details of a file uploaded during chat.
Members
- error
-
- Type: ErrorDetail structure
An error associated with a file uploaded during chat.
- name
-
- Type: string
The name of a file uploaded during chat.
- status
-
- Type: string
The status of a file uploaded during chat.
AttachmentsConfiguration
Description
Configuration information for the file upload during chat feature.
Members
- attachmentsControlMode
-
- Required: Yes
- Type: string
Status information about whether file upload functionality is activated or deactivated for your end user.
AttributeFilter
Description
Enables filtering of responses based on document attributes or metadata fields.
Members
- andAllFilters
-
- Type: Array of AttributeFilter structures
Performs a logical
AND
operation on all supplied filters. - containsAll
-
- Type: DocumentAttribute structure
Returns
true
when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue
. - containsAny
-
- Type: DocumentAttribute structure
Returns
true
when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue
. - equalsTo
-
- Type: DocumentAttribute structure
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
,longValue
,stringListValue
andstringValue
. - greaterThan
-
- Type: DocumentAttribute structure
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
. - greaterThanOrEquals
-
- Type: DocumentAttribute structure
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
. - lessThan
-
- Type: DocumentAttribute structure
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
. - lessThanOrEquals
-
- Type: DocumentAttribute structure
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:
dateValue
andlongValue
. - notFilter
-
- Type: AttributeFilter structure
Performs a logical
NOT
operation on all supplied filters. - orAllFilters
-
- Type: Array of AttributeFilter structures
Performs a logical
OR
operation on all supplied filters.
AuthChallengeRequest
Description
A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.
Members
- authorizationUrl
-
- Required: Yes
- Type: string
The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.
AuthChallengeRequestEvent
Description
An authentication verification event activated by an end user request to use a custom plugin.
Members
- authorizationUrl
-
- Required: Yes
- Type: string
The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.
AuthChallengeResponse
Description
Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.
Members
- responseMap
-
- Required: Yes
- Type: Associative array of custom strings keys (AuthResponseKey) to strings
The mapping of key-value pairs in an authentication challenge response.
AuthChallengeResponseEvent
Description
An authentication verification event response by a third party authentication server to Amazon Q Business.
Members
- responseMap
-
- Required: Yes
- Type: Associative array of custom strings keys (AuthResponseKey) to strings
The mapping of key-value pairs in an authentication challenge response.
AutoSubscriptionConfiguration
Description
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
Members
- autoSubscribe
-
- Required: Yes
- Type: string
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
- defaultSubscriptionType
-
- Type: string
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for
autoSubscribe
is set toENABLED
you must select a value for this field.
BasicAuthConfiguration
Description
Information about the basic authentication credentials used to configure a plugin.
Members
- roleArn
-
- Required: Yes
- Type: string
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
- secretArn
-
- Required: Yes
- Type: string
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
BlockedPhrasesConfiguration
Description
Provides information about the phrases blocked from chat by your chat control configuration.
Members
- blockedPhrases
-
- Type: Array of strings
A list of phrases blocked from a Amazon Q Business web experience chat.
- systemMessageOverride
-
- Type: string
The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
BlockedPhrasesConfigurationUpdate
Description
Updates a blocked phrases configuration in your Amazon Q Business application.
Members
- blockedPhrasesToCreateOrUpdate
-
- Type: Array of strings
Creates or updates a blocked phrases configuration in your Amazon Q Business application.
- blockedPhrasesToDelete
-
- Type: Array of strings
Deletes a blocked phrases configuration in your Amazon Q Business application.
- systemMessageOverride
-
- Type: string
The configured custom message displayed to your end user when they use blocked phrase during chat.
ChatInput
Members
- applicationId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
- clientToken
-
- Type: string
A token that you provide to identify the chat input.
- conversationId
-
- Type: string
The identifier of the Amazon Q Business conversation.
- inputStream
-
- Type: EventParsingIterator supplying the following structures: ConfigurationEvent, TextInputEvent, AttachmentInputEvent, ActionExecutionEvent, EndOfInputEvent, AuthChallengeResponseEvent
The streaming input for the
Chat
API. - parentMessageId
-
- Type: string
The identifier used to associate a user message with a AI generated response.
- userGroups
-
- Type: Array of strings
The groups that a user associated with the chat input belongs to.
- userId
-
- Type: string
The identifier of the user attached to the chat input.
ChatInputStream
Description
The streaming input for the Chat
API.
Members
- actionExecutionEvent
-
- Type: ActionExecutionEvent structure
A request from an end user to perform an Amazon Q Business plugin action.
- attachmentEvent
-
- Type: AttachmentInputEvent structure
A request by an end user to upload a file during chat.
- authChallengeResponseEvent
-
- Type: AuthChallengeResponseEvent structure
An authentication verification event response by a third party authentication server to Amazon Q Business.
- configurationEvent
-
- Type: ConfigurationEvent structure
A configuration event activated by an end user request to select a specific chat mode.
- endOfInputEvent
-
- Type: EndOfInputEvent structure
The end of the streaming input for the
Chat
API. - textEvent
-
- Type: TextInputEvent structure
Information about the payload of the
ChatInputStream
event containing the end user message input.
ChatModeConfiguration
Description
Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.
Members
- pluginConfiguration
-
- Type: PluginConfiguration structure
Configuration information required to invoke chat in
PLUGIN_MODE
.
ChatOutput
Members
- outputStream
-
- Type: EventParsingIterator supplying the following structures: TextOutputEvent, MetadataEvent, ActionReviewEvent, FailedAttachmentEvent, AuthChallengeRequestEvent
The streaming output for the
Chat
API.
ChatOutputStream
Description
The streaming output for the Chat
API.
Members
- actionReviewEvent
-
- Type: ActionReviewEvent structure
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
- authChallengeRequestEvent
-
- Type: AuthChallengeRequestEvent structure
An authentication verification event activated by an end user request to use a custom plugin.
- failedAttachmentEvent
-
- Type: FailedAttachmentEvent structure
A failed file upload event during a web experience chat.
- metadataEvent
-
- Type: MetadataEvent structure
A metadata event for a AI-generated text output message in a Amazon Q Business conversation.
- textEvent
-
- Type: TextOutputEvent structure
Information about the payload of the
ChatOutputStream
event containing the AI-generated message output.
ConfigurationEvent
Description
A configuration event activated by an end user request to select a specific chat mode.
Members
- attributeFilter
-
- Type: AttributeFilter structure
Enables filtering of responses based on document attributes or metadata fields.
- chatMode
-
- Type: string
The chat modes available to an Amazon Q Business end user.
-
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application. -
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request. -
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
- chatModeConfiguration
-
- Type: ChatModeConfiguration structure
Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.
ConflictException
Description
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
Members
- message
-
- Required: Yes
- Type: string
The message describing a
ConflictException
. - resourceId
-
- Required: Yes
- Type: string
The identifier of the resource affected.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource affected.
ContentBlockerRule
Description
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.
Members
- systemMessageOverride
-
- Type: string
The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
ContentRetrievalRule
Description
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
Members
- eligibleDataSources
-
- Type: Array of EligibleDataSource structures
Specifies data sources in a Amazon Q Business application to use for content generation.
Conversation
Description
A conversation in an Amazon Q Business application.
Members
- conversationId
-
- Type: string
The identifier of the Amazon Q Business conversation.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the conversation.
- title
-
- Type: string
The title of the conversation.
CreatorModeConfiguration
Description
Configuration information required to invoke chat in CREATOR_MODE
.
For more information, see Admin controls and guardrails and Conversation settings.
Members
- creatorModeControl
-
- Required: Yes
- Type: string
Status information about whether
CREATOR_MODE
has been enabled or disabled. The default status isDISABLED
.
CustomPluginConfiguration
Description
Configuration information required to create a custom plugin.
Members
- apiSchema
-
- Required: Yes
- Type: APISchema structure
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
- apiSchemaType
-
- Required: Yes
- Type: string
The type of OpenAPI schema to use.
- description
-
- Required: Yes
- Type: string
A description for your custom plugin configuration.
DataSource
Description
A data source in an Amazon Q Business application.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business data source was created.
- dataSourceId
-
- Type: string
The identifier of the Amazon Q Business data source.
- displayName
-
- Type: string
The name of the Amazon Q Business data source.
- status
-
- Type: string
The status of the Amazon Q Business data source.
- type
-
- Type: string
The type of the Amazon Q Business data source.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business data source was last updated.
DataSourceConfiguration
Description
Provides the configuration information for an Amazon Q Business data source.
Members
DataSourceSyncJob
Description
Provides information about an Amazon Q Business data source connector synchronization job.
Members
- dataSourceErrorCode
-
- Type: string
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the synchronization job completed.
- error
-
- Type: ErrorDetail structure
If the
Status
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed. - executionId
-
- Type: string
The identifier of a data source synchronization job.
- metrics
-
- Type: DataSourceSyncJobMetrics structure
Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix time stamp when the data source synchronization job started.
- status
-
- Type: string
The status of the synchronization job. When the
Status
field is set toSUCCEEDED
, the synchronization job is done. If the status code isFAILED
, theErrorCode
andErrorMessage
fields give you the reason for the failure.
DataSourceSyncJobMetrics
Description
Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.
Members
- documentsAdded
-
- Type: string
The current count of documents added from the data source during the data source sync.
- documentsDeleted
-
- Type: string
The current count of documents deleted from the data source during the data source sync.
- documentsFailed
-
- Type: string
The current count of documents that failed to sync from the data source during the data source sync.
- documentsModified
-
- Type: string
The current count of documents modified in the data source during the data source sync.
- documentsScanned
-
- Type: string
The current count of documents crawled by the ongoing sync job in the data source.
DataSourceVpcConfiguration
Description
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
Members
- securityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
- subnetIds
-
- Required: Yes
- Type: Array of strings
A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
DateAttributeBoostingConfiguration
Description
Provides information on boosting DATE
type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
Members
- boostingDurationInSeconds
-
- Type: long (int|float)
Specifies the duration, in seconds, of a boost applies to a
DATE
type document attribute. - boostingLevel
-
- Required: Yes
- Type: string
Specifies how much a document attribute is boosted.
DeleteDocument
Description
A document deleted from an Amazon Q Business data source connector.
Members
- documentId
-
- Required: Yes
- Type: string
The identifier of the deleted document.
Document
Description
A document in an Amazon Q Business application.
Members
- accessConfiguration
-
- Type: AccessConfiguration structure
Configuration information for access permission to a document.
- attributes
-
- Type: Array of DocumentAttribute structures
Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
- content
-
- Type: DocumentContent structure
The contents of the document.
- contentType
-
- Type: string
The file type of the document in the Blob field.
If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the
HTML
start and closing tags (<HTML>content</HTML>
) around the content. - documentEnrichmentConfiguration
-
- Type: DocumentEnrichmentConfiguration structure
The configuration information for altering document metadata and content during the document ingestion process.
- id
-
- Required: Yes
- Type: string
The identifier of the document.
- title
-
- Type: string
The title of the document.
DocumentAttribute
Description
A document attribute or metadata field.
Members
- name
-
- Required: Yes
- Type: string
The identifier for the attribute.
- value
-
- Required: Yes
- Type: DocumentAttributeValue structure
The value of the attribute.
DocumentAttributeBoostingConfiguration
Description
Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
Members
- dateConfiguration
-
- Type: DateAttributeBoostingConfiguration structure
Provides information on boosting
DATE
type document attributes. - numberConfiguration
-
- Type: NumberAttributeBoostingConfiguration structure
Provides information on boosting
NUMBER
type document attributes. - stringConfiguration
-
- Type: StringAttributeBoostingConfiguration structure
Provides information on boosting
STRING
type document attributes. - stringListConfiguration
-
- Type: StringListAttributeBoostingConfiguration structure
Provides information on boosting
STRING_LIST
type document attributes.
DocumentAttributeCondition
Description
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget
to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field.
Members
- key
-
- Required: Yes
- Type: string
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition. - operator
-
- Required: Yes
- Type: string
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
_document_body
as an attribute key used for the condition. - value
-
- Type: DocumentAttributeValue structure
The value of a document attribute. You can only provide one value for a document attribute.
DocumentAttributeConfiguration
Description
Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
For more information, see Understanding document attributes.
Members
- name
-
- Type: string
The name of the document attribute.
- search
-
- Type: string
Information about whether the document attribute can be used by an end user to search for information on their web experience.
- type
-
- Type: string
The type of document attribute.
DocumentAttributeTarget
Description
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.
You can also use this with DocumentAttributeCondition
.
Members
- attributeValueOperator
-
- Type: string
TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
. - key
-
- Required: Yes
- Type: string
The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
- value
-
- Type: DocumentAttributeValue structure
The value of a document attribute. You can only provide one value for a document attribute.
DocumentAttributeValue
Description
The value of a document attribute. You can only provide one value for a document attribute.
Members
- dateValue
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
- longValue
-
- Type: long (int|float)
A long integer value.
- stringListValue
-
- Type: Array of strings
A list of strings.
- stringValue
-
- Type: string
A string.
DocumentContent
Description
The contents of a document.
Members
- blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The contents of the document. Documents passed to the
blob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending. - s3
-
- Type: S3 structure
The path to the document in an Amazon S3 bucket.
DocumentDetails
Description
The details of a document within an Amazon Q Business index.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the document was created.
- documentId
-
- Type: string
The identifier of the document.
- error
-
- Type: ErrorDetail structure
An error message associated with the document.
- status
-
- Type: string
The current status of the document.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the document was last updated.
DocumentEnrichmentConfiguration
Description
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
Members
- inlineConfigurations
-
- Type: Array of InlineDocumentEnrichmentConfiguration structures
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- postExtractionHookConfiguration
-
- Type: HookConfiguration structure
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
- preExtractionHookConfiguration
-
- Type: HookConfiguration structure
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
EligibleDataSource
Description
The identifier of the data source Amazon Q Business will generate responses from.
Members
- dataSourceId
-
- Type: string
The identifier of the data source.
- indexId
-
- Type: string
The identifier of the index the data source is attached to.
EncryptionConfiguration
Description
Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
Members
- kmsKeyId
-
- Type: string
The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
EndOfInputEvent
Description
The end of the streaming input for the Chat
API.
Members
ErrorDetail
Description
Provides information about a data source sync error.
Members
- errorCode
-
- Type: string
The code associated with the data source sync error.
- errorMessage
-
- Type: string
The message explaining the data source sync error.
FailedAttachmentEvent
Description
A failed file upload during web experience chat.
Members
- attachment
-
- Type: AttachmentOutput structure
The details of a file uploaded during chat.
- conversationId
-
- Type: string
The identifier of the conversation associated with the failed file upload.
- systemMessageId
-
- Type: string
The identifier of the AI-generated message associated with the file upload.
- userMessageId
-
- Type: string
The identifier of the end user chat message associated with the file upload.
FailedDocument
Description
A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
Members
- dataSourceId
-
- Type: string
The identifier of the Amazon Q Business data source connector that contains the failed document.
- error
-
- Type: ErrorDetail structure
An explanation for why the document couldn't be removed from the index.
- id
-
- Type: string
The identifier of the document that couldn't be removed from the Amazon Q Business index.
GroupMembers
Description
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.
Members
- memberGroups
-
- Type: Array of MemberGroup structures
A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".
- memberUsers
-
- Type: Array of MemberUser structures
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
GroupStatusDetail
Description
Provides the details of a group's status.
Members
- errorDetail
-
- Type: ErrorDetail structure
The details of an error associated a group status.
- lastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was last updated.
- status
-
- Type: string
The status of a group.
GroupSummary
Description
Summary information for groups.
Members
- groupName
-
- Type: string
The name of the group the summary information is for.
HookConfiguration
Description
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration
.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
Members
- invocationCondition
-
- Type: DocumentAttributeCondition structure
The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
- lambdaArn
-
- Type: string
The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - s3BucketName
-
- Type: string
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
IdentityProviderConfiguration
Description
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Members
- openIDConnectConfiguration
-
- Type: OpenIDConnectProviderConfiguration structure
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
- samlConfiguration
-
- Type: SamlProviderConfiguration structure
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Index
Description
Summary information for your Amazon Q Business index.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the index was created.
- displayName
-
- Type: string
The name of the index.
- indexId
-
- Type: string
The identifier for the index.
- status
-
- Type: string
The current status of the index. When the status is
ACTIVE
, the index is ready. - updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the index was last updated.
IndexCapacityConfiguration
Description
Provides information about index capacity configuration.
Members
- units
-
- Type: int
The number of storage units configured for an Amazon Q Business index.
IndexStatistics
Description
Provides information about the number of documents in an index.
Members
- textDocumentStatistics
-
- Type: TextDocumentStatistics structure
The number of documents indexed.
InlineDocumentEnrichmentConfiguration
Description
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration
.
For more information, see Custom document enrichment.
Members
- condition
-
- Type: DocumentAttributeCondition structure
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with
DocumentAttributeTarget
to apply the condition.For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field. - documentContentOperator
-
- Type: string
TRUE
to delete content if the condition used for the target attribute is met. - target
-
- Type: DocumentAttributeTarget structure
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to
TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.You can also use this with
DocumentAttributeCondition
.
InternalServerException
Description
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
Members
- message
-
- Required: Yes
- Type: string
KendraIndexConfiguration
Description
Stores an Amazon Kendra index as a retriever.
Members
- indexId
-
- Required: Yes
- Type: string
The identifier of the Amazon Kendra index.
LicenseNotFoundException
Description
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.
Members
- message
-
- Required: Yes
- Type: string
MemberGroup
Description
The sub groups that belong to a group.
Members
- groupName
-
- Required: Yes
- Type: string
The name of the sub group.
- type
-
- Type: string
The type of the sub group.
MemberUser
Description
The users that belong to a group.
Members
- type
-
- Type: string
The type of the user.
- userId
-
- Required: Yes
- Type: string
The identifier of the user you want to map to a group.
Message
Description
A message in an Amazon Q Business web experience.
Members
- actionExecution
-
- Type: ActionExecution structure
Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
- actionReview
-
- Type: ActionReview structure
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
- attachments
-
- Type: Array of AttachmentOutput structures
A file directly uploaded into an Amazon Q Business web experience chat.
- body
-
- Type: string
The content of the Amazon Q Business web experience message.
- messageId
-
- Type: string
The identifier of the Amazon Q Business web experience message.
- sourceAttribution
-
- Type: Array of SourceAttribution structures
The source documents used to generate Amazon Q Business web experience message.
- time
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the first Amazon Q Business web experience message.
- type
-
- Type: string
The type of Amazon Q Business message, whether
HUMAN
orAI
generated.
MessageUsefulnessFeedback
Description
End user feedback on an AI-generated web experience chat message usefulness.
Members
- comment
-
- Type: string
A comment given by an end user on the usefulness of an AI-generated chat message.
- reason
-
- Type: string
The reason for a usefulness rating.
- submittedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the feedback was submitted.
- usefulness
-
- Required: Yes
- Type: string
The usefulness value assigned by an end user to a message.
MetadataEvent
Description
A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.
Members
- conversationId
-
- Type: string
The identifier of the conversation with which the generated metadata is associated.
- finalTextMessage
-
- Type: string
The final text output message generated by the system.
- sourceAttributions
-
- Type: Array of SourceAttribution structures
The source documents used to generate the conversation response.
- systemMessageId
-
- Type: string
The identifier of an Amazon Q Business AI generated message within the conversation.
- userMessageId
-
- Type: string
The identifier of an Amazon Q Business end user text input message within the conversation.
NativeIndexConfiguration
Description
Configuration information for an Amazon Q Business index.
Members
- boostingOverride
-
- Type: Associative array of custom strings keys (DocumentAttributeKey) to DocumentAttributeBoostingConfiguration structures
Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
- indexId
-
- Required: Yes
- Type: string
The identifier for the Amazon Q Business index.
NoAuthConfiguration
Description
Information about invoking a custom plugin without any authentication or authorization requirement.
Members
NumberAttributeBoostingConfiguration
Description
Provides information on boosting NUMBER
type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
Members
- boostingLevel
-
- Required: Yes
- Type: string
Specifies the duration, in seconds, of a boost applies to a
NUMBER
type document attribute. - boostingType
-
- Type: string
Specifies how much a document attribute is boosted.
OAuth2ClientCredentialConfiguration
Description
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
Members
- roleArn
-
- Required: Yes
- Type: string
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
- secretArn
-
- Required: Yes
- Type: string
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
OpenIDConnectProviderConfiguration
Description
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Members
- secretsArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
- secretsRole
-
- Required: Yes
- Type: string
An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
PersonalizationConfiguration
Description
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
Members
- personalizationControlMode
-
- Required: Yes
- Type: string
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
Plugin
Description
Information about an Amazon Q Business plugin and its configuration.
Members
- buildStatus
-
- Type: string
The status of the plugin.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the plugin was created.
- displayName
-
- Type: string
The name of the plugin.
- pluginId
-
- Type: string
The identifier of the plugin.
- serverUrl
-
- Type: string
The plugin server URL used for configuration.
- state
-
- Type: string
The current status of the plugin.
- type
-
- Type: string
The type of the plugin.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the plugin was last updated.
PluginAuthConfiguration
Description
Authentication configuration information for an Amazon Q Business plugin.
Members
- basicAuthConfiguration
-
- Type: BasicAuthConfiguration structure
Information about the basic authentication credentials used to configure a plugin.
- noAuthConfiguration
-
- Type: NoAuthConfiguration structure
Information about invoking a custom plugin without any authentication.
- oAuth2ClientCredentialConfiguration
-
- Type: OAuth2ClientCredentialConfiguration structure
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
PluginConfiguration
Description
Configuration information required to invoke chat in PLUGIN_MODE
.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
Members
- pluginId
-
- Required: Yes
- Type: string
The identifier of the plugin you want to use.
Principal
Description
Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
Members
- group
-
- Type: PrincipalGroup structure
The group associated with the principal.
- user
-
- Type: PrincipalUser structure
The user associated with the principal.
PrincipalGroup
Description
Provides information about a group associated with the principal.
Members
- access
-
- Required: Yes
- Type: string
Provides information about whether to allow or deny access to the principal.
- membershipType
-
- Type: string
The type of group.
- name
-
- Type: string
The name of the group.
PrincipalUser
Description
Provides information about a user associated with a principal.
Members
- access
-
- Required: Yes
- Type: string
Provides information about whether to allow or deny access to the principal.
- id
-
- Type: string
The identifier of the user.
- membershipType
-
- Type: string
The type of group.
QAppsConfiguration
Description
Configuration information about Amazon Q Apps. (preview feature)
Members
- qAppsControlMode
-
- Required: Yes
- Type: string
Status information about whether end users can create and use Amazon Q Apps in the web experience.
ResourceNotFoundException
Description
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
Members
- message
-
- Required: Yes
- Type: string
The message describing a
ResourceNotFoundException
. - resourceId
-
- Required: Yes
- Type: string
The identifier of the resource affected.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource affected.
Retriever
Description
Summary information for the retriever used for your Amazon Q Business application.
Members
- applicationId
-
- Type: string
The identifier of the Amazon Q Business application using the retriever.
- displayName
-
- Type: string
The name of your retriever.
- retrieverId
-
- Type: string
The identifier of the retriever used by your Amazon Q Business application.
- status
-
- Type: string
The status of your retriever.
- type
-
- Type: string
The type of your retriever.
RetrieverConfiguration
Description
Provides information on how the retriever used for your Amazon Q Business application is configured.
Members
- kendraIndexConfiguration
-
- Type: KendraIndexConfiguration structure
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
- nativeIndexConfiguration
-
- Type: NativeIndexConfiguration structure
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
Rule
Description
Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.
Members
- excludedUsersAndGroups
-
- Type: UsersAndGroups structure
Users and groups to be excluded from a rule.
- includedUsersAndGroups
-
- Type: UsersAndGroups structure
Users and groups to be included in a rule.
- ruleConfiguration
-
- Type: RuleConfiguration structure
The configuration information for a rule.
- ruleType
-
- Required: Yes
- Type: string
The type of rule.
RuleConfiguration
Description
Provides configuration information about a rule.
Members
- contentBlockerRule
-
- Type: ContentBlockerRule structure
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
- contentRetrievalRule
-
- Type: ContentRetrievalRule structure
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
S3
Description
Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
Members
- bucket
-
- Required: Yes
- Type: string
The name of the S3 bucket that contains the file.
- key
-
- Required: Yes
- Type: string
The name of the file.
SamlConfiguration
Description
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
Members
- metadataXML
-
- Required: Yes
- Type: string
The metadata XML that your IdP generated.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
- userGroupAttribute
-
- Type: string
The group attribute name in your IdP that maps to user groups.
- userIdAttribute
-
- Required: Yes
- Type: string
The user attribute name in your IdP that maps to the user email.
SamlProviderConfiguration
Description
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Members
- authenticationUrl
-
- Required: Yes
- Type: string
The URL where Amazon Q Business end users will be redirected for authentication.
ServiceQuotaExceededException
Description
You have exceeded the set limits for your Amazon Q Business service.
Members
- message
-
- Required: Yes
- Type: string
The message describing a
ServiceQuotaExceededException
. - resourceId
-
- Required: Yes
- Type: string
The identifier of the resource affected.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource affected.
SnippetExcerpt
Description
Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
Members
- text
-
- Type: string
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
SourceAttribution
Description
The documents used to generate an Amazon Q Business web experience response.
Members
- citationNumber
-
- Type: int
The number attached to a citation in an Amazon Q Business generated response.
- snippet
-
- Type: string
The content extract from the document on which the generated response is based.
- textMessageSegments
-
- Type: Array of TextSegment structures
A text extract from a source document that is used for source attribution.
- title
-
- Type: string
The title of the document which is the source for the Amazon Q Business generated response.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was last updated.
- url
-
- Type: string
The URL of the document which is the source for the Amazon Q Business generated response.
StringAttributeBoostingConfiguration
Description
Provides information on boosting STRING
type document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
Members
- attributeValueBoosting
-
- Type: Associative array of custom strings keys (String) to strings
Specifies specific values of a
STRING
type document attribute being boosted. - boostingLevel
-
- Required: Yes
- Type: string
Specifies how much a document attribute is boosted.
StringListAttributeBoostingConfiguration
Description
Provides information on boosting STRING_LIST
type document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
Members
- boostingLevel
-
- Required: Yes
- Type: string
Specifies how much a document attribute is boosted.
Tag
Description
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Members
- key
-
- Required: Yes
- Type: string
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
- value
-
- Required: Yes
- Type: string
The value associated with the tag. The value may be an empty string but it can't be null.
TextDocumentStatistics
Description
Provides information about text documents in an index.
Members
- indexedTextBytes
-
- Type: long (int|float)
The total size, in bytes, of the indexed documents.
- indexedTextDocumentCount
-
- Type: int
The number of text documents indexed.
TextInputEvent
Description
An input event for a end user message in an Amazon Q Business web experience.
Members
- userMessage
-
- Required: Yes
- Type: string
A user message in a text message input event.
TextOutputEvent
Description
An output event for an AI-generated response in an Amazon Q Business web experience.
Members
- conversationId
-
- Type: string
The identifier of the conversation with which the text output event is associated.
- systemMessage
-
- Type: string
An AI-generated message in a
TextOutputEvent
. - systemMessageId
-
- Type: string
The identifier of an AI-generated message in a
TextOutputEvent
. - userMessageId
-
- Type: string
The identifier of an end user message in a
TextOutputEvent
.
TextSegment
Description
Provides information about a text extract in a chat response that can be attributed to a source document.
Members
- beginOffset
-
- Type: int
The zero-based location in the response string where the source attribution starts.
- endOffset
-
- Type: int
The zero-based location in the response string where the source attribution ends.
- snippetExcerpt
-
- Type: SnippetExcerpt structure
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
ThrottlingException
Description
The request was denied due to throttling. Reduce the number of requests and try again.
Members
- message
-
- Required: Yes
- Type: string
TopicConfiguration
Description
The topic specific controls configured for an Amazon Q Business application.
Members
- description
-
- Type: string
A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
- exampleChatMessages
-
- Type: Array of strings
A list of example phrases that you expect the end user to use in relation to the topic.
- name
-
- Required: Yes
- Type: string
A name for your topic control configuration.
- rules
-
- Required: Yes
- Type: Array of Rule structures
Rules defined for a topic configuration.
UserAlias
Description
Aliases attached to a user id within an Amazon Q Business application.
Members
- dataSourceId
-
- Type: string
The identifier of the data source that the user aliases are associated with.
- indexId
-
- Type: string
The identifier of the index that the user aliases are associated with.
- userId
-
- Required: Yes
- Type: string
The identifier of the user id associated with the user aliases.
UsersAndGroups
Description
Provides information about users and groups associated with a topic control rule.
Members
- userGroups
-
- Type: Array of strings
The user groups associated with a topic control rule.
- userIds
-
- Type: Array of strings
The user ids associated with a topic control rule.
ValidationException
Description
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
Members
- fields
-
- Type: Array of ValidationExceptionField structures
The input field(s) that failed validation.
- message
-
- Required: Yes
- Type: string
The message describing the
ValidationException
. - reason
-
- Required: Yes
- Type: string
The reason for the
ValidationException
.
ValidationExceptionField
Description
The input failed to meet the constraints specified by Amazon Q Business in a specified field.
Members
- message
-
- Required: Yes
- Type: string
A message about the validation exception.
- name
-
- Required: Yes
- Type: string
The field name where the invalid entry was detected.
WebExperience
Description
Provides information for an Amazon Q Business web experience.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when the Amazon Q Business application was last updated.
- defaultEndpoint
-
- Type: string
The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
- status
-
- Type: string
The status of your Amazon Q Business web experience.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp when your Amazon Q Business web experience was updated.
- webExperienceId
-
- Type: string
The identifier of your Amazon Q Business web experience.
WebExperienceAuthConfiguration
Description
Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
Members
- samlConfiguration
-
- Type: SamlConfiguration structure
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.