String pluginId
The identifier of the plugin associated with the action review.
String pluginType
The type of plugin.
Map<K,V> payload
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
String payloadFieldNameSeparator
A string used to retain information about the hierarchical contexts within an action review payload.
String displayName
The name of the field.
Integer displayOrder
The display order of fields in a payload.
String displayDescription
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.
String type
The type of field.
List<E> allowedValues
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.
String allowedFormat
The expected data format for the action review input field value. For example, in PTO request, from
and to would be of datetime allowed format.
Boolean required
Information about whether the field is required.
String displayName
The name of the Amazon Q Business application.
String applicationId
The identifier for the Amazon Q Business application.
Date createdAt
The Unix timestamp when the Amazon Q Business application was created.
Date updatedAt
The Unix timestamp when the Amazon Q Business application was last updated.
String status
The status of the Amazon Q Business application. The application is ready to use when the status is
ACTIVE.
String attachmentsControlMode
Information about whether file upload during chat functionality is activated for your application.
String creatorModeControl
Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
String name
The name of the file.
ByteBuffer data
The data contained within the uploaded file.
String name
The name of a file uploaded during chat.
String status
The status of a file uploaded during chat.
ErrorDetail error
An error associated with a file uploaded during chat.
String attachmentsControlMode
Status information about whether file upload functionality is activated or deactivated for your end user.
List<E> andAllFilters
Performs a logical AND operation on all supplied filters.
List<E> orAllFilters
Performs a logical OR operation on all supplied filters.
AttributeFilter notFilter
Performs a logical NOT operation on all supplied filters.
DocumentAttribute equalsTo
Performs an equals operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue, longValue, stringListValue and
stringValue.
DocumentAttribute containsAll
Returns true when a document contains all the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue.
DocumentAttribute containsAny
Returns true when a document contains any of the specified document attributes or metadata fields.
Supported for the following document
attribute value types: dateValue, longValue, stringListValue and
stringValue.
DocumentAttribute greaterThan
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue and longValue.
DocumentAttribute greaterThanOrEquals
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue and longValue.
DocumentAttribute lessThan
Performs a less than operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue and longValue.
DocumentAttribute lessThanOrEquals
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type: dateValue and longValue.
String authorizationUrl
The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.
String secretArn
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
String roleArn
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
String applicationId
The identifier of the Amazon Q Business application.
String indexId
The identifier of the Amazon Q Business index that contains the documents to delete.
List<E> documents
Documents deleted from the Amazon Q Business index.
String dataSourceSyncId
The identifier of the data source sync during which the documents were deleted.
String applicationId
The identifier of the Amazon Q Business application.
String indexId
The identifier of the Amazon Q Business index to add the documents to.
List<E> documents
One or more documents to add to the index.
String roleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
String dataSourceSyncId
The identifier of the data source sync during which the documents were added.
List<E> blockedPhrasesToCreateOrUpdate
Creates or updates a blocked phrases configuration in your Amazon Q Business application.
List<E> blockedPhrasesToDelete
Deletes a blocked phrases configuration in your Amazon Q Business application.
String systemMessageOverride
The configured custom message displayed to your end user when they use blocked phrase during chat.
PluginConfiguration pluginConfiguration
Configuration information required to invoke chat in PLUGIN_MODE.
String applicationId
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
String userId
The identifier of the user attached to the chat input.
List<E> userGroups
The groups that a user associated with the chat input belongs to.
String userMessage
A end user message in a conversation.
List<E> attachments
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
AuthChallengeResponse authChallengeResponse
An authentication verification event response by a third party authentication server to Amazon Q Business.
String conversationId
The identifier of the Amazon Q Business conversation.
String parentMessageId
The identifier of the previous end user text input message in a conversation.
AttributeFilter attributeFilter
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
String chatMode
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 chatModeConfiguration
The chat mode configuration for an Amazon Q Business application.
String clientToken
A token that you provide to identify a chat request.
String conversationId
The identifier of the Amazon Q Business conversation.
String systemMessage
An AI-generated message in a conversation.
String systemMessageId
The identifier of an Amazon Q Business AI generated message within the conversation.
String userMessageId
The identifier of an Amazon Q Business end user text input message within the conversation.
ActionReview actionReview
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
AuthChallengeRequest authChallengeRequest
An authentication verification event activated by an end user request to use a custom plugin.
List<E> sourceAttributions
The source documents used to generate the conversation response.
List<E> failedAttachments
A list of files which failed to upload during chat.
String systemMessageOverride
The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
String displayName
A name for the Amazon Q Business application.
String roleArn
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
String identityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
String description
A description for the Amazon Q Business application.
EncryptionConfiguration encryptionConfiguration
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
List<E> tags
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: _ . : / = + - @.
String clientToken
A token that you provide to identify the request to create your Amazon Q Business application.
AttachmentsConfiguration attachmentsConfiguration
An option to allow end users to upload files directly during chat.
String applicationId
The identifier of the Amazon Q Business application using the index.
String displayName
A name for the Amazon Q Business index.
String type
The index type that's suitable for your needs. For more information on what's included in each type of index or index tier, see Amazon Q Business tiers.
String description
A description for the Amazon Q Business index.
List<E> tags
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: _ . : / = + - @.
IndexCapacityConfiguration capacityConfiguration
The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
String clientToken
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.
String applicationId
The identifier of the application that will contain the plugin.
String displayName
A the name for your plugin.
String type
The type of plugin you want to create.
PluginAuthConfiguration authConfiguration
String serverUrl
The source URL used for plugin configuration.
CustomPluginConfiguration customPluginConfiguration
Contains configuration for a custom plugin.
List<E> tags
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: _ . : / = + - @.
String clientToken
A token that you provide to identify the request to create your Amazon Q Business plugin.
String applicationId
The identifier of your Amazon Q Business application.
String type
The type of retriever you are using.
String displayName
The name of your retriever.
RetrieverConfiguration configuration
String roleArn
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
String clientToken
A token that you provide to identify the request to create your Amazon Q Business application retriever.
List<E> tags
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: _ . : / = + - @.
String applicationId
The identifier of the application for which the user mapping will be created.
String userId
The user emails attached to a user mapping.
List<E> userAliases
The list of user aliases in the mapping.
String clientToken
A token that you provide to identify the request to create your Amazon Q Business user mapping.
String applicationId
The identifier of the Amazon Q Business web experience.
String title
The title for your Amazon Q Business web experience.
String subtitle
A subtitle to personalize your Amazon Q Business web experience.
String welcomeMessage
The customized welcome message for end users of an Amazon Q Business web experience.
String samplePromptsControlMode
Determines whether sample prompts are enabled in the web experience for an end user.
String roleArn
The Amazon Resource Name (ARN) of the service role attached to your web experience.
List<E> tags
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: _ . : / = + - @.
String clientToken
A token you provide to identify a request to create an Amazon Q Business web experience.
String creatorModeControl
Status information about whether CREATOR_MODE has been enabled or disabled. The default status is
DISABLED.
String description
A description for your custom plugin configuration.
String apiSchemaType
The type of OpenAPI schema to use.
APISchema apiSchema
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.
String displayName
The name of the Amazon Q Business data source.
String dataSourceId
The identifier of the Amazon Q Business data source.
String type
The type of the Amazon Q Business data source.
Date createdAt
The Unix timestamp when the Amazon Q Business data source was created.
Date updatedAt
The Unix timestamp when the Amazon Q Business data source was last updated.
String status
The status of the Amazon Q Business data source.
String executionId
The identifier of a data source synchronization job.
Date startTime
The Unix time stamp when the data source synchronization job started.
Date endTime
The Unix timestamp when the synchronization job completed.
String status
The status of the synchronization job. When the Status field is set to SUCCEEDED, the
synchronization job is done. If the status code is FAILED, the ErrorCode and
ErrorMessage fields give you the reason for the failure.
ErrorDetail error
If the Status field is set to FAILED, the ErrorCode field indicates the
reason the synchronization failed.
String dataSourceErrorCode
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.
DataSourceSyncJobMetrics metrics
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.
String documentsAdded
The current count of documents added from the data source during the data source sync.
String documentsModified
The current count of documents modified in the data source during the data source sync.
String documentsDeleted
The current count of documents deleted from the data source during the data source sync.
String documentsFailed
The current count of documents that failed to sync from the data source during the data source sync.
String documentsScanned
The current count of documents crawled by the ongoing sync job in the data source.
List<E> subnetIds
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.
List<E> securityGroupIds
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.
String applicationId
The identifier of the Amazon Q Business application.
String applicationId
The identifier of the application the chat controls have been configured for.
String conversationId
The identifier of the Amazon Q Business web experience conversation being deleted.
String applicationId
The identifier of the Amazon Q Business application associated with the conversation.
String userId
The identifier of the user who is deleting the conversation.
String applicationId
The identifier of the Amazon Q Business application used with the data source connector.
String indexId
The identifier of the index used with the data source connector.
String dataSourceId
The identifier of the data source connector that you want to delete.
String documentId
The identifier of the deleted document.
String applicationId
The identifier of the application in which the group mapping belongs.
String indexId
The identifier of the index you want to delete the group from.
String groupName
The name of the group you want to delete.
String dataSourceId
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.
String id
The identifier of the document.
List<E> attributes
Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
DocumentContent content
The contents of the document.
String contentType
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.
String title
The title of the document.
AccessConfiguration accessConfiguration
Configuration information for access permission to a document.
DocumentEnrichmentConfiguration documentEnrichmentConfiguration
The configuration information for altering document metadata and content during the document ingestion process.
String name
The identifier for the attribute.
DocumentAttributeValue value
The value of the attribute.
NumberAttributeBoostingConfiguration numberConfiguration
Provides information on boosting NUMBER type document attributes.
StringAttributeBoostingConfiguration stringConfiguration
Provides information on boosting STRING type document attributes.
DateAttributeBoostingConfiguration dateConfiguration
Provides information on boosting DATE type document attributes.
StringListAttributeBoostingConfiguration stringListConfiguration
Provides information on boosting STRING_LIST type document attributes.
String key
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.
String operator
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.
DocumentAttributeValue value
String key
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.
DocumentAttributeValue value
String attributeValueOperator
TRUE to delete the existing target value for your specified target attribute key. You cannot create
a target value and set this to TRUE.
String stringValue
A string.
List<E> stringListValue
A list of strings.
Long longValue
A long integer value.
Date dateValue
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.
ByteBuffer blob
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 s3
The path to the document in an Amazon S3 bucket.
String documentId
The identifier of the document.
String status
The current status of the document.
ErrorDetail error
An error message associated with the document.
Date createdAt
The timestamp for when the document was created.
Date updatedAt
The timestamp for when the document was last updated.
List<E> inlineConfigurations
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
HookConfiguration preExtractionHookConfiguration
HookConfiguration postExtractionHookConfiguration
String kmsKeyId
The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
String id
The identifier of the document that couldn't be removed from the Amazon Q Business index.
ErrorDetail error
An explanation for why the document couldn't be removed from the index.
String dataSourceId
The identifier of the Amazon Q Business data source connector that contains the failed document.
String applicationId
The identifier of the Amazon Q Business application.
String displayName
The name of the Amazon Q Business application.
String applicationId
The identifier of the Amazon Q Business application.
String applicationArn
The Amazon Resource Name (ARN) of the Amazon Q Business application.
String identityCenterApplicationArn
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
String roleArn
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
String status
The status of the Amazon Q Business application.
String description
A description for the Amazon Q Business application.
EncryptionConfiguration encryptionConfiguration
The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
Date createdAt
The Unix timestamp when the Amazon Q Business application was last updated.
Date updatedAt
The Unix timestamp when the Amazon Q Business application was last updated.
ErrorDetail error
If the Status field is set to ERROR, the ErrorMessage field contains a
description of the error that caused the synchronization to fail.
AppliedAttachmentsConfiguration attachmentsConfiguration
Settings for whether end users can upload files directly during chat.
String applicationId
The identifier of the application for which the chat controls are configured.
Integer maxResults
The maximum number of configured chat controls to return.
String nextToken
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.
String responseScope
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.
BlockedPhrasesConfiguration blockedPhrases
The phrases blocked from chat by your chat control configuration.
List<E> topicConfigurations
The topic specific controls configured for a Amazon Q Business application.
AppliedCreatorModeConfiguration creatorModeConfiguration
The configuration details for CREATOR_MODE.
String nextToken
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.
String applicationId
The identifier of the Amazon Q Business application.
String indexId
The identifier of the index linked to the data source connector.
String dataSourceId
The identifier of the data source connector.
String dataSourceArn
The Amazon Resource Name (ARN) of the data source.
String displayName
The name for the data source connector.
String type
The type of the data source connector. For example, S3.
DataSourceVpcConfiguration vpcConfiguration
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
Date createdAt
The Unix timestamp when the data source connector was created.
Date updatedAt
The Unix timestamp when the data source connector was last updated.
String description
The description for the data source connector.
String status
The current status of the data source connector. When the Status field value is FAILED,
the ErrorMessage field contains a description of the error that caused the data source connector to
fail.
String syncSchedule
The schedule for Amazon Q Business to update the index.
String roleArn
The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
ErrorDetail error
When the Status field value is FAILED, the ErrorMessage field contains a
description of the error that caused the data source connector to fail.
DocumentEnrichmentConfiguration documentEnrichmentConfiguration
String applicationId
The identifier of the application id the group is attached to.
String indexId
The identifier of the index the group is attached to.
String groupName
The name of the group.
String dataSourceId
The identifier of the data source the group is attached to.
GroupStatusDetail status
The current status of the group.
List<E> statusHistory
The status history of the group.
String applicationId
The identifier of the Amazon Q Business application associated with the index.
String indexId
The identifier of the Amazon Q Business index.
String displayName
The name of the Amazon Q Business index.
String type
The type of index attached to your Amazon Q Business application.
String indexArn
The Amazon Resource Name (ARN) of the Amazon Q Business index.
String status
The current status of the index. When the value is ACTIVE, the index is ready for use. If the
Status field value is FAILED, the ErrorMessage field contains a message
that explains why.
String description
The description for the Amazon Q Business index.
Date createdAt
The Unix timestamp when the Amazon Q Business index was created.
Date updatedAt
The Unix timestamp when the Amazon Q Business index was last updated.
IndexCapacityConfiguration capacityConfiguration
The storage capacity units chosen for your Amazon Q Business index.
List<E> documentAttributeConfigurations
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.
ErrorDetail error
When the Status field value is FAILED, the ErrorMessage field contains a
message that explains why.
IndexStatistics indexStatistics
Provides information about the number of documents indexed.
String applicationId
The identifier of the application which contains the plugin.
String pluginId
The identifier of the plugin.
String displayName
The name of the plugin.
String type
The type of the plugin.
String serverUrl
The source URL used for plugin configuration.
PluginAuthConfiguration authConfiguration
CustomPluginConfiguration customPluginConfiguration
Configuration information required to create a custom plugin.
String buildStatus
The current status of a plugin. A plugin is modified asynchronously.
String pluginArn
The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
String state
The current state of the plugin.
Date createdAt
The timestamp for when the plugin was created.
Date updatedAt
The timestamp for when the plugin was last updated.
String applicationId
The identifier of the Amazon Q Business application using the retriever.
String retrieverId
The identifier of the retriever.
String retrieverArn
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
String type
The type of the retriever.
String status
The status of the retriever.
String displayName
The name of the retriever.
RetrieverConfiguration configuration
String roleArn
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
Date createdAt
The Unix timestamp when the retriever was created.
Date updatedAt
The Unix timestamp when the retriever was last updated.
String applicationId
The identifier of the Amazon Q Business application linked to the web experience.
String webExperienceId
The identifier of the Amazon Q Business web experience.
String webExperienceArn
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
String defaultEndpoint
The endpoint of your Amazon Q Business web experience.
String status
The current status of the Amazon Q Business web experience. When the Status field value is
FAILED, the ErrorMessage field contains a description of the error that caused the data
source connector to fail.
Date createdAt
The Unix timestamp when the Amazon Q Business web experience was last created.
Date updatedAt
The Unix timestamp when the Amazon Q Business web experience was last updated.
String title
The title for your Amazon Q Business web experience.
String subtitle
The subtitle for your Amazon Q Business web experience.
String welcomeMessage
The customized welcome message for end users of an Amazon Q Business web experience.
String samplePromptsControlMode
Determines whether sample prompts are enabled in the web experience for an end user.
String roleArn
The Amazon Resource Name (ARN) of the service role attached to your web experience.
WebExperienceAuthConfiguration authenticationConfiguration
The authentication configuration information for your Amazon Q Business web experience.
ErrorDetail error
When the Status field value is FAILED, the ErrorMessage field contains a
description of the error that caused the data source connector to fail.
List<E> memberGroups
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".
List<E> memberUsers
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
String status
The status of a group.
Date lastUpdatedAt
The Unix timestamp when the Amazon Q Business application was last updated.
ErrorDetail errorDetail
The details of an error associated a group status.
String groupName
The name of the group the summary information is for.
DocumentAttributeCondition invocationCondition
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.
String lambdaArn
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).
String s3BucketName
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
String roleArn
The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and
PostExtractionHookConfiguration for altering document metadata and content during the document
ingestion process.
String displayName
The name of the index.
String indexId
The identifier for the index.
Date createdAt
The Unix timestamp when the index was created.
Date updatedAt
The Unix timestamp when the index was last updated.
String status
The current status of the index. When the status is ACTIVE, the index is ready.
Integer units
The number of storage units configured for an Amazon Q Business index.
TextDocumentStatistics textDocumentStatistics
The number of documents indexed.
DocumentAttributeCondition condition
DocumentAttributeTarget target
String documentContentOperator
TRUE to delete content if the condition used for the target attribute is met.
String indexId
The identifier of the Amazon Kendra index.
String nextToken
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.
Integer maxResults
The maximum number of Amazon Q Business applications to return.
String nextToken
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.
List<E> applications
An array of summary information on the configuration of one or more Amazon Q Business applications.
String applicationId
The identifier of the Amazon Q Business application.
String userId
The identifier of the user involved in the Amazon Q Business web experience conversation.
String nextToken
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.
Integer maxResults
The maximum number of Amazon Q Business conversations to return.
String nextToken
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.
List<E> conversations
An array of summary information on the configuration of one or more Amazon Q Business web experiences.
String applicationId
The identifier of the Amazon Q Business application linked to the data source connectors.
String indexId
The identifier of the index used with one or more data source connectors.
String nextToken
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.
Integer maxResults
The maximum number of data source connectors to return.
String dataSourceId
The identifier of the data source connector.
String applicationId
The identifier of the Amazon Q Business application connected to the data source.
String indexId
The identifier of the index used with the Amazon Q Business data source connector.
String nextToken
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.
Integer maxResults
The maximum number of synchronization jobs to return in the response.
Date startTime
The start time of the data source connector sync.
Date endTime
The end time of the data source connector sync.
String statusFilter
Only returns synchronization jobs with the Status field equal to the specified status.
String applicationId
The identifier of the application id the documents are attached to.
String indexId
The identifier of the index the documents are attached to.
List<E> dataSourceIds
The identifier of the data sources the documents are attached to.
String nextToken
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.
Integer maxResults
The maximum number of documents to return.
List<E> documentDetailList
A list of document details.
String nextToken
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.
String applicationId
The identifier of the application for getting a list of groups mapped to users.
String indexId
The identifier of the index for getting a list of groups mapped to users.
Date updatedEarlierThan
The timestamp identifier used for the latest PUT or DELETE action for mapping users to
their groups.
String dataSourceId
The identifier of the data source for getting a list of groups mapped to users.
String nextToken
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.
Integer maxResults
The maximum number of returned groups that are mapped to users.
String applicationId
The identifier of the Amazon Q Business application connected to the index.
String nextToken
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.
Integer maxResults
The maximum number of indices to return.
String conversationId
The identifier of the Amazon Q Business web experience conversation.
String applicationId
The identifier for the Amazon Q Business application.
String userId
The identifier of the user involved in the Amazon Q Business web experience conversation.
String nextToken
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.
Integer maxResults
The maximum number of messages to return.
String applicationId
The identifier of the application the plugin is attached to.
String nextToken
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.
Integer maxResults
The maximum number of documents to return.
String nextToken
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.
List<E> plugins
Information about a configured plugin.
String applicationId
The identifier of the Amazon Q Business application using the retriever.
String nextToken
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.
Integer maxResults
The maximum number of retrievers returned.
String resourceARN
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
String applicationId
The identifier of the Amazon Q Business application linked to the listed web experiences.
String nextToken
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.
Integer maxResults
The maximum number of Amazon Q Business Web Experiences to return.
String messageId
The identifier of the Amazon Q Business web experience message.
String body
The content of the Amazon Q Business web experience message.
Date time
The timestamp of the first Amazon Q Business web experience message.
String type
The type of Amazon Q Business message, whether HUMAN or AI generated.
List<E> attachments
A file directly uploaded into an Amazon Q Business web experience chat.
List<E> sourceAttribution
The source documents used to generate Amazon Q Business web experience message.
ActionReview actionReview
String usefulness
The usefulness value assigned by an end user to a message.
String reason
The reason for a usefulness rating.
String comment
A comment given by an end user on the usefulness of an AI-generated chat message.
Date submittedAt
The timestamp for when the feedback was submitted.
String pluginId
The identifier of the plugin.
String displayName
The name of the plugin.
String type
The type of the plugin.
String serverUrl
The plugin server URL used for configuration.
String state
The current status of the plugin.
String buildStatus
The status of the plugin.
Date createdAt
The timestamp for when the plugin was created.
Date updatedAt
The timestamp for when the plugin was last updated.
BasicAuthConfiguration basicAuthConfiguration
Information about the basic authentication credentials used to configure a plugin.
OAuth2ClientCredentialConfiguration oAuth2ClientCredentialConfiguration
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
NoAuthConfiguration noAuthConfiguration
Information about invoking a custom plugin without any authentication.
String pluginId
The identifier of the plugin you want to use.
PrincipalUser user
The user associated with the principal.
PrincipalGroup group
The group associated with the principal.
String applicationId
The identifier of the application associated with the feedback.
String userId
The identifier of the user giving the feedback.
String conversationId
The identifier of the conversation the feedback is attached to.
String messageId
The identifier of the chat message that the feedback was given for.
Date messageCopiedAt
The timestamp for when the feedback was recorded.
MessageUsefulnessFeedback messageUsefulness
The feedback usefulness value given by the user to the chat message.
String applicationId
The identifier of the application in which the user and group mapping belongs.
String indexId
The identifier of the index in which you want to map users to their groups.
String groupName
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".
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
String dataSourceId
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.
String type
The type of the group.
GroupMembers groupMembers
String applicationId
The identifier of the Amazon Q Business application using the retriever.
String retrieverId
The identifier of the retriever used by your Amazon Q Business application.
String type
The type of your retriever.
String status
The status of your retriever.
String displayName
The name of your retriever.
NativeIndexConfiguration nativeIndexConfiguration
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
KendraIndexConfiguration kendraIndexConfiguration
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
UsersAndGroups includedUsersAndGroups
Users and groups to be included in a rule.
UsersAndGroups excludedUsersAndGroups
Users and groups to be excluded from a rule.
String ruleType
The type of rule.
RuleConfiguration ruleConfiguration
The configuration information for a rule.
ContentBlockerRule contentBlockerRule
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
ContentRetrievalRule contentRetrievalRule
String metadataXML
The metadata XML that your IdP generated.
String roleArn
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.
String userIdAttribute
The user attribute name in your IdP that maps to the user email.
String userGroupAttribute
The group attribute name in your IdP that maps to user groups.
String text
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
String title
The title of the document which is the source for the Amazon Q Business generated response.
String snippet
The content extract from the document on which the generated response is based.
String url
The URL of the document which is the source for the Amazon Q Business generated response.
Integer citationNumber
The number attached to a citation in an Amazon Q Business generated response.
Date updatedAt
The Unix timestamp when the Amazon Q Business application was last updated.
List<E> textMessageSegments
A text extract from a source document that is used for source attribution.
String executionId
The identifier for a particular synchronization job.
String dataSourceId
The identifier of the data source connector.
String applicationId
The identifier of the Amazon Q Business application that the data source is connected to.
String indexId
The identifier of the index used with the Amazon Q Business data source connector.
String boostingLevel
Specifies how much a document attribute is boosted.
Integer beginOffset
The zero-based location in the response string where the source attribution starts.
Integer endOffset
The zero-based location in the response string where the source attribution ends.
SnippetExcerpt snippetExcerpt
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
String name
A name for your topic control configuration.
String description
A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
List<E> exampleChatMessages
A list of example phrases that you expect the end user to use in relation to the topic.
List<E> rules
Rules defined for a topic configuration.
String resourceARN
The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
List<E> tagKeys
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.
String applicationId
The identifier of the Amazon Q Business application.
String identityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
String displayName
A name for the Amazon Q Business application.
String description
A description for the Amazon Q Business application.
String roleArn
An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
AttachmentsConfiguration attachmentsConfiguration
An option to allow end users to upload files directly during chat.
String applicationId
The identifier of the application for which the chat controls are configured.
String clientToken
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
String responseScope
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.
BlockedPhrasesConfigurationUpdate blockedPhrasesConfigurationUpdate
The phrases blocked from chat by your chat control configuration.
List<E> topicConfigurationsToCreateOrUpdate
The configured topic specific chat controls you want to update.
List<E> topicConfigurationsToDelete
The configured topic specific chat controls you want to delete.
CreatorModeConfiguration creatorModeConfiguration
The configuration details for CREATOR_MODE.
String applicationId
The identifier of the Amazon Q Business application the data source is attached to.
String indexId
The identifier of the index attached to the data source connector.
String dataSourceId
The identifier of the data source connector.
String displayName
A name of the data source connector.
DataSourceVpcConfiguration vpcConfiguration
String description
The description of the data source connector.
String syncSchedule
The chosen update frequency for your data source.
String roleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
DocumentEnrichmentConfiguration documentEnrichmentConfiguration
String applicationId
The identifier of the Amazon Q Business application connected to the index.
String indexId
The identifier of the Amazon Q Business index.
String displayName
The name of the Amazon Q Business index.
String description
The description of the Amazon Q Business index.
IndexCapacityConfiguration capacityConfiguration
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.
List<E> documentAttributeConfigurations
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.
String applicationId
The identifier of the application the plugin is attached to.
String pluginId
The identifier of the plugin.
String displayName
The name of the plugin.
String state
The status of the plugin.
String serverUrl
The source URL used for plugin configuration.
CustomPluginConfiguration customPluginConfiguration
The configuration for a custom plugin.
PluginAuthConfiguration authConfiguration
The authentication configuration the plugin is using.
String applicationId
The identifier of your Amazon Q Business application.
String retrieverId
The identifier of your retriever.
RetrieverConfiguration configuration
String displayName
The name of your retriever.
String roleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
String applicationId
The identifier of the application the user is attached to.
String userId
The email id attached to the user.
List<E> userAliasesToUpdate
The user aliases attached to the user id that are to be updated.
List<E> userAliasesToDelete
The user aliases attached to the user id that are to be deleted.
List<E> userAliasesAdded
The user aliases that have been to be added to a user id.
List<E> userAliasesUpdated
The user aliases attached to a user id that have been updated.
List<E> userAliasesDeleted
The user aliases that have been deleted from a user id.
String applicationId
The identifier of the Amazon Q Business application attached to the web experience.
String webExperienceId
The identifier of the Amazon Q Business web experience.
String roleArn
The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
WebExperienceAuthConfiguration authenticationConfiguration
The authentication configuration of the Amazon Q Business web experience.
String title
The title of the Amazon Q Business web experience.
String subtitle
The subtitle of the Amazon Q Business web experience.
String welcomeMessage
A customized welcome message for an end user in an Amazon Q Business web experience.
String samplePromptsControlMode
Determines whether sample prompts are enabled in the web experience for an end user.
String webExperienceId
The identifier of your Amazon Q Business web experience.
Date createdAt
The Unix timestamp when the Amazon Q Business application was last updated.
Date updatedAt
The Unix timestamp when your Amazon Q Business web experience was updated.
String defaultEndpoint
The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
String status
The status of your Amazon Q Business web experience.
SamlConfiguration samlConfiguration
Copyright © 2024. All rights reserved.