Serialized Form (AWS Java SDK for QBusiness 1.12.641 API)

Package com.amazonaws.services.qbusiness.model
- Class com.amazonaws.services.qbusiness.model.AccessConfiguration extends Object implements Serializable
  - Serialized Fields
    - accessControls
```
List<E> accessControls
```
      A list of AccessControlList objects.
    - memberRelation
```
String memberRelation
```
      Describes the member relation within the AccessControlList object.
- Class com.amazonaws.services.qbusiness.model.AccessControl extends Object implements Serializable
  - Serialized Fields
    - memberRelation
```
String memberRelation
```
      Describes the member relation within a principal list.
    - principals
```
List<E> principals
```
      Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.
- Class com.amazonaws.services.qbusiness.model.AccessDeniedException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.qbusiness.model.ActionReview extends Object implements Serializable
  - Serialized Fields
    - payload
```
Map<K,V> payload
```
      Field values that an end user needs to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    - payloadFieldNameSeparator
```
String payloadFieldNameSeparator
```
      A string used to retain information about the hierarchical contexts within an action review payload.
    - pluginId
```
String pluginId
```
      The identifier of the plugin associated with the action review.
    - pluginType
```
String pluginType
```
      The type of plugin.
- Class com.amazonaws.services.qbusiness.model.ActionReviewPayloadField extends Object implements Serializable
  - Serialized Fields
    - allowedValues
```
List<E> allowedValues
```
      Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
    - displayName
```
String displayName
```
      The name of the field.
    - displayOrder
```
Integer displayOrder
```
      The display order of fields in a payload.
    - required
```
Boolean required
```
      Information about whether the field is required.
    - type
```
String type
```
      The type of field.
- Class com.amazonaws.services.qbusiness.model.ActionReviewPayloadFieldAllowedValue extends Object implements Serializable
- Class com.amazonaws.services.qbusiness.model.Application extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier for the Amazon Q application.
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the Amazon Q application was created.
    - displayName
```
String displayName
```
      The name of the Amazon Q application.
    - status
```
String status
```
      The status of the Amazon Q application. The application is ready to use when the status is ACTIVE.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the Amazon Q application was last updated.
- Class com.amazonaws.services.qbusiness.model.AppliedAttachmentsConfiguration extends Object implements Serializable
  - Serialized Fields
    - attachmentsControlMode
```
String attachmentsControlMode
```
      Information about whether file upload during chat functionality is activated for your application.
- Class com.amazonaws.services.qbusiness.model.AttachmentInput extends Object implements Serializable
  - Serialized Fields
    - data
```
ByteBuffer data
```
      The data contained within the uploaded file.
    - name
```
String name
```
      The name of the file.
- Class com.amazonaws.services.qbusiness.model.AttachmentOutput extends Object implements Serializable
  - Serialized Fields
    - error
```
ErrorDetail error
```
      An error associated with a file uploaded during chat.
    - name
```
String name
```
      The name of a file uploaded during chat.
    - status
```
String status
```
      The status of a file uploaded during chat.
- Class com.amazonaws.services.qbusiness.model.AttachmentsConfiguration extends Object implements Serializable
  - Serialized Fields
    - attachmentsControlMode
```
String attachmentsControlMode
```
      Status information about whether file upload functionality is activated or deactivated for your end user.
- Class com.amazonaws.services.qbusiness.model.AttributeFilter extends Object implements Serializable
  - Serialized Fields
    - andAllFilters
```
List<E> andAllFilters
```
      Performs a logical AND operation on all supplied filters.
    - containsAll
```
DocumentAttribute containsAll
```
      Returns true when a document contains all the specified document attributes or metadata fields.
    - containsAny
```
DocumentAttribute containsAny
```
      Returns true when a document contains any of the specified document attributes or metadata fields.
    - equalsTo
```
DocumentAttribute equalsTo
```
      Performs an equals operation on two document attributes or metadata fields.
    - greaterThan
```
DocumentAttribute greaterThan
```
      Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    - greaterThanOrEquals
```
DocumentAttribute greaterThanOrEquals
```
      Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    - lessThan
```
DocumentAttribute lessThan
```
      Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    - lessThanOrEquals
```
DocumentAttribute lessThanOrEquals
```
      Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    - notFilter
```
AttributeFilter notFilter
```
      Performs a logical NOT operation on all supplied filters.
    - orAllFilters
```
List<E> orAllFilters
```
      Performs a logical OR operation on all supplied filters.
- Class com.amazonaws.services.qbusiness.model.AWSQBusinessException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.qbusiness.model.BasicAuthConfiguration extends Object implements Serializable
  - Serialized Fields
    - roleArn
```
String roleArn
```
      The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
    - secretArn
```
String secretArn
```
      The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
- Class com.amazonaws.services.qbusiness.model.BatchDeleteDocumentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - dataSourceSyncId
```
String dataSourceSyncId
```
      The identifier of the data source sync during which the documents were deleted.
    - documents
```
List<E> documents
```
      Documents deleted from the Amazon Q index.
    - indexId
```
String indexId
```
      The identifier of the Amazon Q index that contains the documents to delete.
- Class com.amazonaws.services.qbusiness.model.BatchDeleteDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedDocuments
```
List<E> failedDocuments
```
      A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
- Class com.amazonaws.services.qbusiness.model.BatchPutDocumentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - dataSourceSyncId
```
String dataSourceSyncId
```
      The identifier of the data source sync during which the documents were added.
    - documents
```
List<E> documents
```
      One or more documents to add to the index.
    - indexId
```
String indexId
```
      The identifier of the Amazon Q index to add the documents to.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
- Class com.amazonaws.services.qbusiness.model.BatchPutDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedDocuments
```
List<E> failedDocuments
```
      A list of documents that were not added to the Amazon Q 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.
- Class com.amazonaws.services.qbusiness.model.BlockedPhrasesConfiguration extends Object implements Serializable
  - Serialized Fields
    - blockedPhrases
```
List<E> blockedPhrases
```
      A list of phrases blocked from a Amazon Q web experience chat.
    - systemMessageOverride
```
String systemMessageOverride
```
      The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
- Class com.amazonaws.services.qbusiness.model.BlockedPhrasesConfigurationUpdate extends Object implements Serializable
  - Serialized Fields
    - blockedPhrasesToCreateOrUpdate
```
List<E> blockedPhrasesToCreateOrUpdate
```
      Creates or updates a blocked phrases configuration in your Amazon Q application.
    - blockedPhrasesToDelete
```
List<E> blockedPhrasesToDelete
```
      Deletes a blocked phrases configuration in your Amazon Q application.
    - systemMessageOverride
```
String systemMessageOverride
```
      The configured custom message displayed to your end user when they use blocked phrase during chat.
- Class com.amazonaws.services.qbusiness.model.ChatSyncRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application linked to the Amazon Q conversation.
    - attachments
```
List<E> attachments
```
      A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
    - attributeFilter
```
AttributeFilter attributeFilter
```
      Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
    - clientToken
```
String clientToken
```
      A token that you provide to identify a chat request.
    - conversationId
```
String conversationId
```
      The identifier of the Amazon Q conversation.
    - parentMessageId
```
String parentMessageId
```
      The identifier of the previous end user text input message in a conversation.
    - userGroups
```
List<E> userGroups
```
      The groups that a user associated with the chat input belongs to.
    - userId
```
String userId
```
      The identifier of the user attached to the chat input.
    - userMessage
```
String userMessage
```
      A end user message in a conversation.
- Class com.amazonaws.services.qbusiness.model.ChatSyncResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - actionReview
```
ActionReview actionReview
```
      A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.
    - conversationId
```
String conversationId
```
      The identifier of the Amazon Q conversation.
    - failedAttachments
```
List<E> failedAttachments
```
      A list of files which failed to upload during chat.
    - sourceAttributions
```
List<E> sourceAttributions
```
      The source documents used to generate the conversation response.
    - systemMessage
```
String systemMessage
```
      An AI-generated message in a conversation.
    - systemMessageId
```
String systemMessageId
```
      The identifier of an Amazon Q AI generated message within the conversation.
    - userMessageId
```
String userMessageId
```
      The identifier of an Amazon Q end user text input message within the conversation.
- Class com.amazonaws.services.qbusiness.model.ConflictException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The identifier of the resource affected.
    - resourceType
```
String resourceType
```
      The type of the resource affected.
- Class com.amazonaws.services.qbusiness.model.ContentBlockerRule extends Object implements Serializable
  - Serialized Fields
    - systemMessageOverride
```
String systemMessageOverride
```
      The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
- Class com.amazonaws.services.qbusiness.model.ContentRetrievalRule extends Object implements Serializable
  - Serialized Fields
    - eligibleDataSources
```
List<E> eligibleDataSources
```
      Specifies data sources in a Amazon Q application to use for content generation.
- Class com.amazonaws.services.qbusiness.model.Conversation extends Object implements Serializable
  - Serialized Fields
    - conversationId
```
String conversationId
```
      The identifier of the Amazon Q conversation.
    - startTime
```
Date startTime
```
      The start time of the conversation.
    - title
```
String title
```
      The title of the conversation.
- Class com.amazonaws.services.qbusiness.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attachmentsConfiguration
```
AttachmentsConfiguration attachmentsConfiguration
```
      An option to allow end users to upload files directly during chat.
    - clientToken
```
String clientToken
```
      A token that you provide to identify the request to create your Amazon Q application.
    - description
```
String description
```
      A description for the Amazon Q application.
    - displayName
```
String displayName
```
      A name for the Amazon Q application.
    - encryptionConfiguration
```
EncryptionConfiguration encryptionConfiguration
```
      The identifier of the KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
    - tags
```
List<E> tags
```
      A list of key-value pairs that identify or categorize your Amazon Q 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: _ . : / = + - @.
- Class com.amazonaws.services.qbusiness.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationArn
```
String applicationArn
```
      The Amazon Resource Name (ARN) of the Amazon Q application.
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
- Class com.amazonaws.services.qbusiness.model.CreateIndexRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application using the index.
    - capacityConfiguration
```
IndexCapacityConfiguration capacityConfiguration
```
      The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
    - clientToken
```
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.
    - description
```
String description
```
      A description for the Amazon Q index.
    - displayName
```
String displayName
```
      A name for the Amazon Q index.
    - tags
```
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: _ . : / = + - @.
- Class com.amazonaws.services.qbusiness.model.CreateIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - indexArn
```
String indexArn
```
      The Amazon Resource Name (ARN) of an Amazon Q index.
    - indexId
```
String indexId
```
      The identifier for the Amazon Q index.
- Class com.amazonaws.services.qbusiness.model.CreatePluginRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application that will contain the plugin.
    - authConfiguration
```
PluginAuthConfiguration authConfiguration
```
    - clientToken
```
String clientToken
```
      A token that you provide to identify the request to create your Amazon Q plugin.
    - displayName
```
String displayName
```
      A the name for your plugin.
    - serverUrl
```
String serverUrl
```
      The source URL used for plugin configuration.
    - tags
```
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: _ . : / = + - @.
    - type
```
String type
```
      The type of plugin you want to create.
- Class com.amazonaws.services.qbusiness.model.CreatePluginResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - pluginArn
```
String pluginArn
```
      The Amazon Resource Name (ARN) of a plugin.
    - pluginId
```
String pluginId
```
      The identifier of the plugin created.
- Class com.amazonaws.services.qbusiness.model.CreateRetrieverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of your Amazon Q application.
    - clientToken
```
String clientToken
```
      A token that you provide to identify the request to create your Amazon Q application retriever.
    - configuration
```
RetrieverConfiguration configuration
```
    - displayName
```
String displayName
```
      The name of your retriever.
    - roleArn
```
String roleArn
```
      The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
    - tags
```
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: _ . : / = + - @.
    - type
```
String type
```
      The type of retriever you are using.
- Class com.amazonaws.services.qbusiness.model.CreateRetrieverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - retrieverArn
```
String retrieverArn
```
      The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
    - retrieverId
```
String retrieverId
```
      The identifier of the retriever you are using.
- Class com.amazonaws.services.qbusiness.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application for which the user mapping will be created.
    - clientToken
```
String clientToken
```
      A token that you provide to identify the request to create your Amazon Q user mapping.
    - userAliases
```
List<E> userAliases
```
      The list of user aliases in the mapping.
    - userId
```
String userId
```
      The user emails attached to a user mapping.
- Class com.amazonaws.services.qbusiness.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.CreateWebExperienceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q web experience.
    - clientToken
```
String clientToken
```
      A token you provide to identify a request to create an Amazon Q web experience.
    - samplePromptsControlMode
```
String samplePromptsControlMode
```
      Determines whether sample prompts are enabled in the web experience for an end user.
    - subtitle
```
String subtitle
```
      A subtitle to personalize your Amazon Q web experience.
    - tags
```
List<E> tags
```
      A list of key-value pairs that identify or categorize your Amazon Q 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
```
String title
```
      The title for your Amazon Q web experience.
    - welcomeMessage
```
String welcomeMessage
```
      The customized welcome message for end users of an Amazon Q web experience.
- Class com.amazonaws.services.qbusiness.model.CreateWebExperienceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webExperienceArn
```
String webExperienceArn
```
      The Amazon Resource Name (ARN) of an Amazon Q web experience.
    - webExperienceId
```
String webExperienceId
```
      The identifier of the Amazon Q web experience.
- Class com.amazonaws.services.qbusiness.model.DataSource extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the Amazon Q data source was created.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the Amazon Q data source.
    - displayName
```
String displayName
```
      The name of the Amazon Q data source.
    - status
```
String status
```
      The status of the Amazon Q data source.
    - type
```
String type
```
      The type of the Amazon Q data source.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the Amazon Q data source was last updated.
- Class com.amazonaws.services.qbusiness.model.DataSourceSyncJob extends Object implements Serializable
  - Serialized Fields
    - dataSourceErrorCode
```
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.
    - endTime
```
Date endTime
```
      The Unix timestamp when the synchronization job completed.
    - error
```
ErrorDetail error
```
      If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    - executionId
```
String executionId
```
      The identifier of a data source synchronization job.
    - metrics
```
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.
    - startTime
```
Date startTime
```
      The Unix time stamp when the data source synchronization job started.
    - status
```
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.
- Class com.amazonaws.services.qbusiness.model.DataSourceSyncJobMetrics extends Object implements Serializable
  - Serialized Fields
    - documentsAdded
```
String documentsAdded
```
      The current count of documents added from the data source during the data source sync.
    - documentsDeleted
```
String documentsDeleted
```
      The current count of documents deleted from the data source during the data source sync.
    - documentsFailed
```
String documentsFailed
```
      The current count of documents that failed to sync from the data source during the data source sync.
    - documentsModified
```
String documentsModified
```
      The current count of documents modified in the data source during the data source sync.
    - documentsScanned
```
String documentsScanned
```
      The current count of documents crawled by the ongoing sync job in the data source.
- Class com.amazonaws.services.qbusiness.model.DataSourceVpcConfiguration extends Object implements Serializable
  - Serialized Fields
    - securityGroupIds
```
List<E> securityGroupIds
```
      A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q to connect to the data source.
    - subnetIds
```
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.
- Class com.amazonaws.services.qbusiness.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
- Class com.amazonaws.services.qbusiness.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteChatControlsConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application the chat controls have been configured for.
- Class com.amazonaws.services.qbusiness.model.DeleteChatControlsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteConversationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application associated with the conversation.
    - conversationId
```
String conversationId
```
      The identifier of the Amazon Q web experience conversation being deleted.
    - userId
```
String userId
```
      The identifier of the user who is deleting the conversation.
- Class com.amazonaws.services.qbusiness.model.DeleteConversationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application used with the data source connector.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector that you want to delete.
    - indexId
```
String indexId
```
      The identifier of the index used with the data source connector.
- Class com.amazonaws.services.qbusiness.model.DeleteDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteDocument extends Object implements Serializable
  - Serialized Fields
    - documentId
```
String documentId
```
      The identifier of the deleted document.
- Class com.amazonaws.services.qbusiness.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application in which the group mapping belongs.
    - dataSourceId
```
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.
    - groupName
```
String groupName
```
      The name of the group you want to delete.
    - indexId
```
String indexId
```
      The identifier of the index you want to delete the group from.
- Class com.amazonaws.services.qbusiness.model.DeleteGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteIndexRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application the Amazon Q index is linked to.
    - indexId
```
String indexId
```
      The identifier of the Amazon Q index.
- Class com.amazonaws.services.qbusiness.model.DeleteIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeletePluginRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier the application attached to the Amazon Q plugin.
    - pluginId
```
String pluginId
```
      The identifier of the plugin being deleted.
- Class com.amazonaws.services.qbusiness.model.DeletePluginResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteRetrieverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application using the retriever.
    - retrieverId
```
String retrieverId
```
      The identifier of the retriever being deleted.
- Class com.amazonaws.services.qbusiness.model.DeleteRetrieverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application from which the user is being deleted.
    - userId
```
String userId
```
      The user email being deleted.
- Class com.amazonaws.services.qbusiness.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.DeleteWebExperienceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application linked to the Amazon Q web experience.
    - webExperienceId
```
String webExperienceId
```
      The identifier of the Amazon Q web experience being deleted.
- Class com.amazonaws.services.qbusiness.model.DeleteWebExperienceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.Document extends Object implements Serializable
  - Serialized Fields
    - accessConfiguration
```
AccessConfiguration accessConfiguration
```
      Configuration information for access permission to a document.
    - attributes
```
List<E> attributes
```
      Custom attributes to apply to the document for refining Amazon Q web experience responses.
    - content
```
DocumentContent content
```
      The contents of the document.
    - contentType
```
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.
    - documentEnrichmentConfiguration
```
DocumentEnrichmentConfiguration documentEnrichmentConfiguration
```
      The configuration information for altering document metadata and content during the document ingestion process.
    - id
```
String id
```
      The identifier of the document.
    - title
```
String title
```
      The title of the document.
- Class com.amazonaws.services.qbusiness.model.DocumentAttribute extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The identifier for the attribute.
    - value
```
DocumentAttributeValue value
```
      The value of the attribute.
- Class com.amazonaws.services.qbusiness.model.DocumentAttributeCondition extends Object implements Serializable
  - Serialized Fields
    - key
```
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 currently doesn't support _document_body as an attribute key used for the condition.
    - operator
```
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 Kendra currently does not support _document_body as an attribute key used for the condition.
    - value
```
DocumentAttributeValue value
```
- Class com.amazonaws.services.qbusiness.model.DocumentAttributeConfiguration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the document attribute.
    - search
```
String search
```
      Information about whether the document attribute can be used by an end user to search for information on their web experience.
    - type
```
String type
```
      The type of document attribute.
- Class com.amazonaws.services.qbusiness.model.DocumentAttributeTarget extends Object implements Serializable
  - Serialized Fields
    - attributeValueOperator
```
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.
    - key
```
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.
    - value
```
DocumentAttributeValue value
```
- Class com.amazonaws.services.qbusiness.model.DocumentAttributeValue extends Object implements Serializable
  - Serialized Fields
    - dateValue
```
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.
    - longValue
```
Long longValue
```
      A long integer value.
    - stringListValue
```
List<E> stringListValue
```
      A list of strings.
    - stringValue
```
String stringValue
```
      A string.
- Class com.amazonaws.services.qbusiness.model.DocumentContent extends Object implements Serializable
  - Serialized Fields
    - blob
```
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 APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.
    - s3
```
S3 s3
```
      The path to the document in an Amazon S3 bucket.
- Class com.amazonaws.services.qbusiness.model.DocumentDetails extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The timestamp for when the document was created.
    - documentId
```
String documentId
```
      The identifier of the document.
    - error
```
ErrorDetail error
```
      An error message associated with the document.
    - status
```
String status
```
      The current status of the document.
    - updatedAt
```
Date updatedAt
```
      The timestamp for when the document was last updated.
- Class com.amazonaws.services.qbusiness.model.DocumentEnrichmentConfiguration extends Object implements Serializable
  - Serialized Fields
    - inlineConfigurations
```
List<E> inlineConfigurations
```
      Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.
    - postExtractionHookConfiguration
```
HookConfiguration postExtractionHookConfiguration
```
    - preExtractionHookConfiguration
```
HookConfiguration preExtractionHookConfiguration
```
- Class com.amazonaws.services.qbusiness.model.EligibleDataSource extends Object implements Serializable
  - Serialized Fields
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source.
    - indexId
```
String indexId
```
      The identifier of the index the data source is attached to.
- Class com.amazonaws.services.qbusiness.model.EncryptionConfiguration extends Object implements Serializable
  - Serialized Fields
    - kmsKeyId
```
String kmsKeyId
```
      The identifier of the KMS key. Amazon Q doesn't support asymmetric keys.
- Class com.amazonaws.services.qbusiness.model.ErrorDetail extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The code associated with the data source sync error.
    - errorMessage
```
String errorMessage
```
      The message explaining the data source sync error.
- Class com.amazonaws.services.qbusiness.model.FailedDocument extends Object implements Serializable
  - Serialized Fields
    - dataSourceId
```
String dataSourceId
```
      The identifier of the Amazon Q data source connector that contains the failed document.
    - error
```
ErrorDetail error
```
      An explanation for why the document couldn't be removed from the index.
    - id
```
String id
```
      The identifier of the document that couldn't be removed from the Amazon Q index.
- Class com.amazonaws.services.qbusiness.model.GetApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
- Class com.amazonaws.services.qbusiness.model.GetApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationArn
```
String applicationArn
```
      The Amazon Resource Name (ARN) of the Amazon Q application.
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - attachmentsConfiguration
```
AppliedAttachmentsConfiguration attachmentsConfiguration
```
      Settings for whether end users can upload files directly during chat.
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the Amazon Q application was last updated.
    - description
```
String description
```
      A description for the Amazon Q application.
    - displayName
```
String displayName
```
      The name of the Amazon Q application.
    - encryptionConfiguration
```
EncryptionConfiguration encryptionConfiguration
```
      The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.
    - error
```
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.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
    - status
```
String status
```
      The status of the Amazon Q application.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the Amazon Q application was last updated.
- Class com.amazonaws.services.qbusiness.model.GetChatControlsConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application for which the chat controls are configured.
    - maxResults
```
Integer maxResults
```
      The maximum number of configured chat controls to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.
- Class com.amazonaws.services.qbusiness.model.GetChatControlsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - blockedPhrases
```
BlockedPhrasesConfiguration blockedPhrases
```
      The phrases blocked from chat by your chat control configuration.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.
    - responseScope
```
String responseScope
```
      The response scope configured for a Amazon Q 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
```
List<E> topicConfigurations
```
      The topic specific controls configured for a Amazon Q application.
- Class com.amazonaws.services.qbusiness.model.GetDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector.
    - indexId
```
String indexId
```
      The identfier of the index used with the data source connector.
- Class com.amazonaws.services.qbusiness.model.GetDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the data source connector was created.
    - dataSourceArn
```
String dataSourceArn
```
      The Amazon Resource Name (ARN) of the data source.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector.
    - description
```
String description
```
      The description for the data source connector.
    - displayName
```
String displayName
```
      The name for the data source connector.
    - documentEnrichmentConfiguration
```
DocumentEnrichmentConfiguration documentEnrichmentConfiguration
```
    - error
```
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.
    - indexId
```
String indexId
```
      The identifier of the index linked to the data source connector.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
    - status
```
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.
    - syncSchedule
```
String syncSchedule
```
      The schedule for Amazon Q to update the index.
    - type
```
String type
```
      The type of the data source connector. For example, S3.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the data source connector was last updated.
    - vpcConfiguration
```
DataSourceVpcConfiguration vpcConfiguration
```
      Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
- Class com.amazonaws.services.qbusiness.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application id the group is attached to.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source the group is attached to.
    - groupName
```
String groupName
```
      The name of the group.
    - indexId
```
String indexId
```
      The identifier of the index the group is attached to.
- Class com.amazonaws.services.qbusiness.model.GetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
GroupStatusDetail status
```
      The current status of the group.
    - statusHistory
```
List<E> statusHistory
```
      The status history of the group.
- Class com.amazonaws.services.qbusiness.model.GetIndexRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application connected to the index.
    - indexId
```
String indexId
```
      The identifier of the Amazon Q index you want information on.
- Class com.amazonaws.services.qbusiness.model.GetIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application associated with the index.
    - capacityConfiguration
```
IndexCapacityConfiguration capacityConfiguration
```
      The storage capacity units chosen for your Amazon Q index.
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the Amazon Q index was created.
    - description
```
String description
```
      The description for the Amazon Q index.
    - displayName
```
String displayName
```
      The name of the Amazon Q index.
    - documentAttributeConfigurations
```
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.
    - error
```
ErrorDetail error
```
      When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    - indexArn
```
String indexArn
```
      The Amazon Resource Name (ARN) of the Amazon Q index.
    - indexId
```
String indexId
```
      The identifier of the Amazon Q index.
    - indexStatistics
```
IndexStatistics indexStatistics
```
      Provides information about the number of documents indexed.
    - status
```
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.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the Amazon Q index was last updated.
- Class com.amazonaws.services.qbusiness.model.GetPluginRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application which contains the plugin.
    - pluginId
```
String pluginId
```
      The identifier of the plugin.
- Class com.amazonaws.services.qbusiness.model.GetPluginResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application which contains the plugin.
    - authConfiguration
```
PluginAuthConfiguration authConfiguration
```
    - createdAt
```
Date createdAt
```
      The timestamp for when the plugin was created.
    - displayName
```
String displayName
```
      The name of the plugin.
    - pluginArn
```
String pluginArn
```
      The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
    - pluginId
```
String pluginId
```
      The identifier of the plugin.
    - serverUrl
```
String serverUrl
```
      The source URL used for plugin configuration.
    - state
```
String state
```
      The current state of the plugin.
    - type
```
String type
```
      The type of the plugin.
    - updatedAt
```
Date updatedAt
```
      The timestamp for when the plugin was last updated.
- Class com.amazonaws.services.qbusiness.model.GetRetrieverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application using the retriever.
    - retrieverId
```
String retrieverId
```
      The identifier of the retriever.
- Class com.amazonaws.services.qbusiness.model.GetRetrieverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application using the retriever.
    - configuration
```
RetrieverConfiguration configuration
```
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the retriever was created.
    - displayName
```
String displayName
```
      The name of the retriever.
    - retrieverArn
```
String retrieverArn
```
      The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    - retrieverId
```
String retrieverId
```
      The identifier of the retriever.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
    - status
```
String status
```
      The status of the retriever.
    - type
```
String type
```
      The type of the retriever.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the retriever was last updated.
- Class com.amazonaws.services.qbusiness.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application connected to the user.
    - userId
```
String userId
```
      The user email address attached to the user.
- Class com.amazonaws.services.qbusiness.model.GetUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userAliases
```
List<E> userAliases
```
      A list of user aliases attached to a user.
- Class com.amazonaws.services.qbusiness.model.GetWebExperienceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application linked to the web experience.
    - webExperienceId
```
String webExperienceId
```
      The identifier of the Amazon Q web experience.
- Class com.amazonaws.services.qbusiness.model.GetWebExperienceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application linked to the web experience.
    - authenticationConfiguration
```
WebExperienceAuthConfiguration authenticationConfiguration
```
      The authentication configuration information for your Amazon Q web experience.
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the retriever was created.
    - defaultEndpoint
```
String defaultEndpoint
```
      The endpoint of your Amazon Q web experience.
    - error
```
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.
    - samplePromptsControlMode
```
String samplePromptsControlMode
```
      Determines whether sample prompts are enabled in the web experience for an end user.
    - status
```
String status
```
      The current status of the Amazon Q 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.
    - subtitle
```
String subtitle
```
      The subtitle for your Amazon Q web experience.
    - title
```
String title
```
      The title for your Amazon Q web experience.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the data source connector was last updated.
    - webExperienceArn
```
String webExperienceArn
```
      The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
    - webExperienceId
```
String webExperienceId
```
      The identifier of the Amazon Q web experience.
    - welcomeMessage
```
String welcomeMessage
```
      The customized welcome message for end users of an Amazon Q web experience.
- Class com.amazonaws.services.qbusiness.model.GroupMembers extends Object implements Serializable
  - Serialized Fields
    - memberGroups
```
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".
    - memberUsers
```
List<E> memberUsers
```
      A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
- Class com.amazonaws.services.qbusiness.model.GroupStatusDetail extends Object implements Serializable
  - Serialized Fields
    - errorDetail
```
ErrorDetail errorDetail
```
      The details of an error associated a group status.
    - lastUpdatedAt
```
Date lastUpdatedAt
```
      The Unix timestamp when the Amazon Q application was last updated.
    - status
```
String status
```
      The status of a group.
- Class com.amazonaws.services.qbusiness.model.GroupSummary extends Object implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the group the summary information is for.
- Class com.amazonaws.services.qbusiness.model.HookConfiguration extends Object implements Serializable
  - Serialized Fields
    - invocationCondition
```
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 should invoke a function that inserts the current date-time.
    - lambdaArn
```
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).
    - roleArn
```
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.
    - s3BucketName
```
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.
- Class com.amazonaws.services.qbusiness.model.Index extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the index was created.
    - displayName
```
String displayName
```
      The name of the index.
    - indexId
```
String indexId
```
      The identifier for the index.
    - status
```
String status
```
      The current status of the index. When the status is ACTIVE, the index is ready.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the index was last updated.
- Class com.amazonaws.services.qbusiness.model.IndexCapacityConfiguration extends Object implements Serializable
  - Serialized Fields
    - units
```
Integer units
```
      The number of storage units configured for an Amazon Q index.
- Class com.amazonaws.services.qbusiness.model.IndexStatistics extends Object implements Serializable
  - Serialized Fields
    - textDocumentStatistics
```
TextDocumentStatistics textDocumentStatistics
```
      The number of documents indexed.
- Class com.amazonaws.services.qbusiness.model.InlineDocumentEnrichmentConfiguration extends Object implements Serializable
  - Serialized Fields
    - condition
```
DocumentAttributeCondition condition
```
    - documentContentOperator
```
String documentContentOperator
```
      TRUE to delete content if the condition used for the target attribute is met.
    - target
```
DocumentAttributeTarget target
```
- Class com.amazonaws.services.qbusiness.model.InternalServerException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.qbusiness.model.KendraIndexConfiguration extends Object implements Serializable
  - Serialized Fields
    - indexId
```
String indexId
```
      The identifier of the Amazon Kendra index.
- Class com.amazonaws.services.qbusiness.model.LicenseNotFoundException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.qbusiness.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of Amazon Q applications to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q applications.
- Class com.amazonaws.services.qbusiness.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applications
```
List<E> applications
```
      An array of summary information on the configuration of one or more Amazon Q applications.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
- Class com.amazonaws.services.qbusiness.model.ListConversationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - maxResults
```
Integer maxResults
```
      The maximum number of Amazon Q conversations to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
    - userId
```
String userId
```
      The identifier of the user involved in the Amazon Q web experience conversation.
- Class com.amazonaws.services.qbusiness.model.ListConversationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - conversations
```
List<E> conversations
```
      An array of summary information on the configuration of one or more Amazon Q web experiences.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
- Class com.amazonaws.services.qbusiness.model.ListDataSourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application linked to the data source connectors.
    - indexId
```
String indexId
```
      The identifier of the index used with one or more data source connectors.
    - maxResults
```
Integer maxResults
```
      The maximum number of data source connectors to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q data source connectors.
- Class com.amazonaws.services.qbusiness.model.ListDataSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dataSources
```
List<E> dataSources
```
      An array of summary information for one or more data source connector.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
- Class com.amazonaws.services.qbusiness.model.ListDataSourceSyncJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application connected to the data source.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector.
    - endTime
```
Date endTime
```
      The end time of the data source connector sync.
    - indexId
```
String indexId
```
      The identifier of the index used with the Amazon Q data source connector.
    - maxResults
```
Integer maxResults
```
      The maximum number of synchronization jobs to return in the response.
    - nextToken
```
String nextToken
```
      If the maxResults response was incpmplete because there is more data to retriever, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.
    - startTime
```
Date startTime
```
      The start time of the data source connector sync.
    - statusFilter
```
String statusFilter
```
      Only returns synchronization jobs with the Status field equal to the specified status.
- Class com.amazonaws.services.qbusiness.model.ListDataSourceSyncJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - history
```
List<E> history
```
      A history of synchronization jobs for the data source connector.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
- Class com.amazonaws.services.qbusiness.model.ListDocumentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application id the documents are attached to.
    - dataSourceIds
```
List<E> dataSourceIds
```
      The identifier of the data sources the documents are attached to.
    - indexId
```
String indexId
```
      The identifier of the index the documents are attached to.
    - maxResults
```
Integer maxResults
```
      The maximum number of documents to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
- Class com.amazonaws.services.qbusiness.model.ListDocumentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentDetailList
```
List<E> documentDetailList
```
      A list of document details.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
- Class com.amazonaws.services.qbusiness.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application for getting a list of groups mapped to users.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source for getting a list of groups mapped to users.
    - indexId
```
String indexId
```
      The identifier of the index for getting a list of groups mapped to users.
    - maxResults
```
Integer maxResults
```
      The maximum number of returned groups that are mapped to users.
    - nextToken
```
String nextToken
```
      If the previous response was incomplete (because there is more data to retrieve), Amazon Q 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
```
Date updatedEarlierThan
```
      The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
- Class com.amazonaws.services.qbusiness.model.ListGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      Summary information for list of groups that are mapped to users.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
- Class com.amazonaws.services.qbusiness.model.ListIndicesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application connected to the index.
    - maxResults
```
Integer maxResults
```
      The maximum number of indices to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q indices.
- Class com.amazonaws.services.qbusiness.model.ListIndicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - indices
```
List<E> indices
```
      An array of information on the items in one or more indexes.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of indexes.
- Class com.amazonaws.services.qbusiness.model.ListMessagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier for the Amazon Q application.
    - conversationId
```
String conversationId
```
      The identifier of the Amazon Q web experience conversation.
    - maxResults
```
Integer maxResults
```
      The maximum number of messages to return.
    - nextToken
```
String nextToken
```
      If the number of retrievers returned exceeds maxResults, Amazon Q returns a next token as a pagination token to retrieve the next set of messages.
    - userId
```
String userId
```
      The identifier of the user involved in the Amazon Q web experience conversation.
- Class com.amazonaws.services.qbusiness.model.ListMessagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - messages
```
List<E> messages
```
      An array of information on one or more messages.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
- Class com.amazonaws.services.qbusiness.model.ListPluginsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application the plugin is attached to.
    - maxResults
```
Integer maxResults
```
      The maximum number of documents to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
- Class com.amazonaws.services.qbusiness.model.ListPluginsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
    - plugins
```
List<E> plugins
```
      Information about a configured plugin.
- Class com.amazonaws.services.qbusiness.model.ListRetrieversRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application using the retriever.
    - maxResults
```
Integer maxResults
```
      The maximum number of retrievers returned.
    - nextToken
```
String nextToken
```
      If the number of retrievers returned exceeds maxResults, Amazon Q returns a next token as a pagination token to retrieve the next set of retrievers.
- Class com.amazonaws.services.qbusiness.model.ListRetrieversResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of retrievers.
    - retrievers
```
List<E> retrievers
```
      An array of summary information for one or more retrievers.
- Class com.amazonaws.services.qbusiness.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the Amazon Q application or data source to get a list of tags for.
- Class com.amazonaws.services.qbusiness.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      A list of tags associated with the Amazon Q application or data source.
- Class com.amazonaws.services.qbusiness.model.ListWebExperiencesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application linked to the listed web experiences.
    - maxResults
```
Integer maxResults
```
      The maximum number of Amazon Q Web Experiences to return.
    - nextToken
```
String nextToken
```
      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
- Class com.amazonaws.services.qbusiness.model.ListWebExperiencesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
    - webExperiences
```
List<E> webExperiences
```
      An array of summary information for one or more Amazon Q experiences.
- Class com.amazonaws.services.qbusiness.model.MemberGroup extends Object implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the sub group.
    - type
```
String type
```
      The type of the sub group.
- Class com.amazonaws.services.qbusiness.model.MemberUser extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of the user.
    - userId
```
String userId
```
      The identifier of the user you want to map to a group.
- Class com.amazonaws.services.qbusiness.model.Message extends Object implements Serializable
  - Serialized Fields
    - actionReview
```
ActionReview actionReview
```
    - attachments
```
List<E> attachments
```
      A file directly uploaded into an Amazon Q web experience chat.
    - body
```
String body
```
      The content of the Amazon Q web experience message.
    - messageId
```
String messageId
```
      The identifier of the Amazon Q web experience message.
    - sourceAttribution
```
List<E> sourceAttribution
```
      The source documents used to generate Amazon Q web experience message.
    - time
```
Date time
```
      The timestamp of the first Amazon Q web experience message.
    - type
```
String type
```
      The type of Amazon Q message, whether HUMAN or AI generated.
- Class com.amazonaws.services.qbusiness.model.MessageUsefulnessFeedback extends Object implements Serializable
  - Serialized Fields
    - comment
```
String comment
```
      A comment given by an end user on the usefulness of an AI-generated chat message.
    - reason
```
String reason
```
      The reason for a usefulness rating.
    - submittedAt
```
Date submittedAt
```
      The timestamp for when the feedback was submitted.
    - usefulness
```
String usefulness
```
      The usefulness value assigned by an end user to a message.
- Class com.amazonaws.services.qbusiness.model.NativeIndexConfiguration extends Object implements Serializable
  - Serialized Fields
    - indexId
```
String indexId
```
      The identifier for the Amazon Q index.
- Class com.amazonaws.services.qbusiness.model.OAuth2ClientCredentialConfiguration extends Object implements Serializable
  - Serialized Fields
    - roleArn
```
String roleArn
```
      The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
    - secretArn
```
String secretArn
```
      The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
- Class com.amazonaws.services.qbusiness.model.Plugin extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The timestamp for when the plugin was created.
    - displayName
```
String displayName
```
      The name of the plugin.
    - pluginId
```
String pluginId
```
      The identifier of the plugin.
    - serverUrl
```
String serverUrl
```
      The plugin server URL used for configuration.
    - state
```
String state
```
      The current status of the plugin.
    - type
```
String type
```
      The type of the plugin.
    - updatedAt
```
Date updatedAt
```
      The timestamp for when the plugin was last updated.
- Class com.amazonaws.services.qbusiness.model.PluginAuthConfiguration extends Object implements Serializable
  - Serialized Fields
    - basicAuthConfiguration
```
BasicAuthConfiguration basicAuthConfiguration
```
      Information about the basic authentication credentials used to configure a plugin.
    - oAuth2ClientCredentialConfiguration
```
OAuth2ClientCredentialConfiguration oAuth2ClientCredentialConfiguration
```
      Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
- Class com.amazonaws.services.qbusiness.model.Principal extends Object implements Serializable
  - Serialized Fields
    - group
```
PrincipalGroup group
```
      The group associated with the principal.
    - user
```
PrincipalUser user
```
      The user associated with the principal.
- Class com.amazonaws.services.qbusiness.model.PrincipalGroup extends Object implements Serializable
  - Serialized Fields
    - access
```
String access
```
      Provides information about whether to allow or deny access to the principal.
    - membershipType
```
String membershipType
```
      The type of group.
    - name
```
String name
```
      The name of the group.
- Class com.amazonaws.services.qbusiness.model.PrincipalUser extends Object implements Serializable
  - Serialized Fields
    - access
```
String access
```
      Provides information about whether to allow or deny access to the principal.
    - id
```
String id
```
      The identifier of the user.
    - membershipType
```
String membershipType
```
      The type of group.
- Class com.amazonaws.services.qbusiness.model.PutFeedbackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application associated with the feedback.
    - conversationId
```
String conversationId
```
      The identifier of the conversation the feedback is attached to.
    - messageCopiedAt
```
Date messageCopiedAt
```
      The timestamp for when the feedback was recorded.
    - messageId
```
String messageId
```
      The identifier of the chat message that the feedback was given for.
    - messageUsefulness
```
MessageUsefulnessFeedback messageUsefulness
```
      The feedback usefulness value given by the user to the chat message.
    - userId
```
String userId
```
      The identifier of the user giving the feedback.
- Class com.amazonaws.services.qbusiness.model.PutFeedbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.PutGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application in which the user and group mapping belongs.
    - dataSourceId
```
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.
    - groupMembers
```
GroupMembers groupMembers
```
    - groupName
```
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.
    - indexId
```
String indexId
```
      The identifier of the index in which you want to map users to their groups.
    - type
```
String type
```
      The type of the group.
- Class com.amazonaws.services.qbusiness.model.PutGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.ResourceNotFoundException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The identifier of the resource affected.
    - resourceType
```
String resourceType
```
      The type of the resource affected.
- Class com.amazonaws.services.qbusiness.model.Retriever extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application using the retriever.
    - displayName
```
String displayName
```
      The name of your retriever.
    - retrieverId
```
String retrieverId
```
      The identifier of the retriever used by your Amazon Q application.
    - status
```
String status
```
      The status of your retriever.
    - type
```
String type
```
      The type of your retriever.
- Class com.amazonaws.services.qbusiness.model.RetrieverConfiguration extends Object implements Serializable
  - Serialized Fields
    - kendraIndexConfiguration
```
KendraIndexConfiguration kendraIndexConfiguration
```
      Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.
    - nativeIndexConfiguration
```
NativeIndexConfiguration nativeIndexConfiguration
```
      Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.
- Class com.amazonaws.services.qbusiness.model.Rule extends Object implements Serializable
  - Serialized Fields
    - excludedUsersAndGroups
```
UsersAndGroups excludedUsersAndGroups
```
      Users and groups to be excluded from a rule.
    - includedUsersAndGroups
```
UsersAndGroups includedUsersAndGroups
```
      Users and groups to be included in a rule.
    - ruleConfiguration
```
RuleConfiguration ruleConfiguration
```
      The configuration information for a rule.
    - ruleType
```
String ruleType
```
      The type fo rule.
- Class com.amazonaws.services.qbusiness.model.RuleConfiguration extends Object implements Serializable
  - Serialized Fields
    - contentBlockerRule
```
ContentBlockerRule contentBlockerRule
```
      A rule for configuring how Amazon Q responds when it encounters a a blocked topic.
    - contentRetrievalRule
```
ContentRetrievalRule contentRetrievalRule
```
- Class com.amazonaws.services.qbusiness.model.S3 extends Object implements Serializable
  - Serialized Fields
    - bucket
```
String bucket
```
      The name of the S3 bucket that contains the file.
    - key
```
String key
```
      The name of the file.
- Class com.amazonaws.services.qbusiness.model.SamlConfiguration extends Object implements Serializable
  - Serialized Fields
    - metadataXML
```
String metadataXML
```
      The metadata XML that your IdP generated.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q web experience, containing the relevant Amazon Q permissions for conversing with Amazon Q.
    - userGroupAttribute
```
String userGroupAttribute
```
      The group attribute name in your IdP that maps to user groups.
    - userIdAttribute
```
String userIdAttribute
```
      The user attribute name in your IdP that maps to the user email.
- Class com.amazonaws.services.qbusiness.model.ServiceQuotaExceededException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The identifier of the resource affected.
    - resourceType
```
String resourceType
```
      The type of the resource affected.
- Class com.amazonaws.services.qbusiness.model.SourceAttribution extends Object implements Serializable
  - Serialized Fields
    - citationNumber
```
Integer citationNumber
```
      The number attached to a citation in an Amazon Q generated response.
    - snippet
```
String snippet
```
      The content extract from the document on which the generated response is based.
    - textMessageSegments
```
List<E> textMessageSegments
```
      A text extract from a source document that is used for source attribution.
    - title
```
String title
```
      The title of the document which is the source for the Amazon Q generated response.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the Amazon Q application was last updated.
    - url
```
String url
```
      The URL of the document which is the source for the Amazon Q generated response.
- Class com.amazonaws.services.qbusiness.model.StartDataSourceSyncJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of Amazon Q application the data source is connected to.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector.
    - indexId
```
String indexId
```
      The identifier of the index used with the data source connector.
- Class com.amazonaws.services.qbusiness.model.StartDataSourceSyncJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - executionId
```
String executionId
```
      The identifier for a particular synchronization job.
- Class com.amazonaws.services.qbusiness.model.StopDataSourceSyncJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application that the data source is connected to.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector.
    - indexId
```
String indexId
```
      The identifier of the index used with the Amazon Q data source connector.
- Class com.amazonaws.services.qbusiness.model.StopDataSourceSyncJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.
    - value
```
String value
```
      The value associated with the tag. The value may be an empty string but it can't be null.
- Class com.amazonaws.services.qbusiness.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the Amazon Q application or data source to tag.
    - tags
```
List<E> tags
```
      A list of tag keys to add to the Amazon Q application or data source. If a tag already exists, the existing value is replaced with the new value.
- Class com.amazonaws.services.qbusiness.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.TextDocumentStatistics extends Object implements Serializable
  - Serialized Fields
    - indexedTextBytes
```
Long indexedTextBytes
```
      The total size, in bytes, of the indexed documents.
    - indexedTextDocumentCount
```
Integer indexedTextDocumentCount
```
      The number of text documents indexed.
- Class com.amazonaws.services.qbusiness.model.TextSegment extends Object implements Serializable
  - Serialized Fields
    - beginOffset
```
Integer beginOffset
```
      The zero-based location in the response string where the source attribution starts.
    - endOffset
```
Integer endOffset
```
      The zero-based location in the response string where the source attribution ends.
- Class com.amazonaws.services.qbusiness.model.ThrottlingException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.qbusiness.model.TopicConfiguration extends Object implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description for your topic control configuration. Use this outline how the large language model (LLM) should use this topic control configuration.
    - exampleChatMessages
```
List<E> exampleChatMessages
```
      A list of example phrases that you expect the end user to use in relation to the topic.
    - name
```
String name
```
      A name for your topic control configuration.
    - rules
```
List<E> rules
```
      Rules defined for a topic configuration.
- Class com.amazonaws.services.qbusiness.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the Amazon Q application, or data source to remove the tag from.
    - tagKeys
```
List<E> tagKeys
```
      A list of tag keys to remove from the Amazon Q application or data source. If a tag key does not exist on the resource, it is ignored.
- Class com.amazonaws.services.qbusiness.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application.
    - attachmentsConfiguration
```
AttachmentsConfiguration attachmentsConfiguration
```
      An option to allow end users to upload files directly during chat.
    - description
```
String description
```
      A description for the Amazon Q application.
    - displayName
```
String displayName
```
      A name for the Amazon Q application.
    - roleArn
```
String roleArn
```
      An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q permission to access Amazon CloudWatch logs and metrics.
- Class com.amazonaws.services.qbusiness.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdateChatControlsConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application for which the chat controls are configured.
    - blockedPhrasesConfigurationUpdate
```
BlockedPhrasesConfigurationUpdate blockedPhrasesConfigurationUpdate
```
      The phrases blocked from chat by your chat control configuration.
    - clientToken
```
String clientToken
```
      A token that you provide to identify the request to update a Amazon Q application chat configuration.
    - responseScope
```
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.
    - topicConfigurationsToCreateOrUpdate
```
List<E> topicConfigurationsToCreateOrUpdate
```
      The configured topic specific chat controls you want to update.
    - topicConfigurationsToDelete
```
List<E> topicConfigurationsToDelete
```
      The configured topic specific chat controls you want to delete.
- Class com.amazonaws.services.qbusiness.model.UpdateChatControlsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdateDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application the data source is attached to.
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source connector.
    - description
```
String description
```
      The description of the data source connector.
    - displayName
```
String displayName
```
      A name of the data source connector.
    - documentEnrichmentConfiguration
```
DocumentEnrichmentConfiguration documentEnrichmentConfiguration
```
    - indexId
```
String indexId
```
      The identifier of the index attached to the data source connector.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    - syncSchedule
```
String syncSchedule
```
      The chosen update frequency for your data source.
    - vpcConfiguration
```
DataSourceVpcConfiguration vpcConfiguration
```
- Class com.amazonaws.services.qbusiness.model.UpdateDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdateIndexRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application connected to the index.
    - capacityConfiguration
```
IndexCapacityConfiguration capacityConfiguration
```
      The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.
    - description
```
String description
```
      The description of the Amazon Q index.
    - displayName
```
String displayName
```
      The name of the Amazon Q index.
    - documentAttributeConfigurations
```
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.
    - indexId
```
String indexId
```
      The identifier of the Amazon Q index.
- Class com.amazonaws.services.qbusiness.model.UpdateIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdatePluginRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application the plugin is attached to.
    - authConfiguration
```
PluginAuthConfiguration authConfiguration
```
      The authentication configuration the plugin is using.
    - displayName
```
String displayName
```
      The name of the plugin.
    - pluginId
```
String pluginId
```
      The identifier of the plugin.
    - serverUrl
```
String serverUrl
```
      The source URL used for plugin configuration.
    - state
```
String state
```
      The status of the plugin.
- Class com.amazonaws.services.qbusiness.model.UpdatePluginResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdateRetrieverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of your Amazon Q application.
    - configuration
```
RetrieverConfiguration configuration
```
    - displayName
```
String displayName
```
      The name of your retriever.
    - retrieverId
```
String retrieverId
```
      The identifier of your retriever.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
- Class com.amazonaws.services.qbusiness.model.UpdateRetrieverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the application the user is attached to.
    - userAliasesToDelete
```
List<E> userAliasesToDelete
```
      The user aliases attached to the user id that are to be deleted.
    - userAliasesToUpdate
```
List<E> userAliasesToUpdate
```
      The user aliases attached to the user id that are to be updated.
    - userId
```
String userId
```
      The email id attached to the user.
- Class com.amazonaws.services.qbusiness.model.UpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userAliasesAdded
```
List<E> userAliasesAdded
```
      The user aliases that have been to be added to a user id.
    - userAliasesDeleted
```
List<E> userAliasesDeleted
```
      The user aliases that have been deleted from a user id.
    - userAliasesUpdated
```
List<E> userAliasesUpdated
```
      The user aliases attached to a user id that have been updated.
- Class com.amazonaws.services.qbusiness.model.UpdateWebExperienceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The identifier of the Amazon Q application attached to the web experience.
    - authenticationConfiguration
```
WebExperienceAuthConfiguration authenticationConfiguration
```
      The authentication configuration of the Amazon Q web experience.
    - samplePromptsControlMode
```
String samplePromptsControlMode
```
      Determines whether sample prompts are enabled in the web experience for an end user.
    - subtitle
```
String subtitle
```
      The subtitle of the Amazon Q web experience.
    - title
```
String title
```
      The title of the Amazon Q web experience.
    - webExperienceId
```
String webExperienceId
```
      The identifier of the Amazon Q web experience.
    - welcomeMessage
```
String welcomeMessage
```
      A customized welcome message for an end user in an Amazon Q web experience.
- Class com.amazonaws.services.qbusiness.model.UpdateWebExperienceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.qbusiness.model.UserAlias extends Object implements Serializable
  - Serialized Fields
    - dataSourceId
```
String dataSourceId
```
      The identifier of the data source that the user aliases are associated with.
    - indexId
```
String indexId
```
      The identifier of the index that the user aliases are associated with.
    - userId
```
String userId
```
      The identifier of the user id associated with the user aliases.
- Class com.amazonaws.services.qbusiness.model.UsersAndGroups extends Object implements Serializable
  - Serialized Fields
    - userGroups
```
List<E> userGroups
```
      The user groups associated with a topic control rule.
    - userIds
```
List<E> userIds
```
      The user ids associated with a topic control rule.
- Class com.amazonaws.services.qbusiness.model.ValidationException extends AWSQBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fields
```
List<E> fields
```
      The input field(s) that failed validation.
    - reason
```
String reason
```
      The reason for the ValidationException.
- Class com.amazonaws.services.qbusiness.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A message about the validation exception.
    - name
```
String name
```
      The field name where the invalid entry was detected.
- Class com.amazonaws.services.qbusiness.model.WebExperience extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the Amazon Q application was last updated.
    - defaultEndpoint
```
String defaultEndpoint
```
      The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully hosted by Amazon Web Services.
    - status
```
String status
```
      The status of your Amazon Q web experience.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when your Amazon Q web experience was updated.
    - webExperienceId
```
String webExperienceId
```
      The identifier of your Amazon Q web experience.
- Class com.amazonaws.services.qbusiness.model.WebExperienceAuthConfiguration extends Object implements Serializable
  - Serialized Fields
    - samlConfiguration
```
SamlConfiguration samlConfiguration
```

Serialized Form

Package com.amazonaws.services.qbusiness.model

Class com.amazonaws.services.qbusiness.model.AccessConfiguration extends Object implements Serializable

Serialized Fields

accessControls

memberRelation

Class com.amazonaws.services.qbusiness.model.AccessControl extends Object implements Serializable

Serialized Fields

memberRelation

principals

Class com.amazonaws.services.qbusiness.model.AccessDeniedException extends AWSQBusinessException implements Serializable

Class com.amazonaws.services.qbusiness.model.ActionReview extends Object implements Serializable

Serialized Fields

payload

payloadFieldNameSeparator

pluginId

pluginType

Class com.amazonaws.services.qbusiness.model.ActionReviewPayloadField extends Object implements Serializable

Serialized Fields

allowedValues

displayName

displayOrder

required

type

Class com.amazonaws.services.qbusiness.model.ActionReviewPayloadFieldAllowedValue extends Object implements Serializable

Class com.amazonaws.services.qbusiness.model.Application extends Object implements Serializable

Serialized Fields

applicationId

createdAt

displayName

status

updatedAt

Class com.amazonaws.services.qbusiness.model.AppliedAttachmentsConfiguration extends Object implements Serializable

Serialized Fields

attachmentsControlMode

Class com.amazonaws.services.qbusiness.model.AttachmentInput extends Object implements Serializable

Serialized Fields

data

name

Class com.amazonaws.services.qbusiness.model.AttachmentOutput extends Object implements Serializable

Serialized Fields

error

name

status

Class com.amazonaws.services.qbusiness.model.AttachmentsConfiguration extends Object implements Serializable

Serialized Fields

attachmentsControlMode

Class com.amazonaws.services.qbusiness.model.AttributeFilter extends Object implements Serializable

Serialized Fields

andAllFilters

containsAll

containsAny

equalsTo

greaterThan

greaterThanOrEquals

lessThan

lessThanOrEquals

notFilter

orAllFilters

Class com.amazonaws.services.qbusiness.model.AWSQBusinessException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.qbusiness.model.BasicAuthConfiguration extends Object implements Serializable

Serialized Fields

roleArn

secretArn

Class com.amazonaws.services.qbusiness.model.BatchDeleteDocumentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

dataSourceSyncId

documents

indexId

Class com.amazonaws.services.qbusiness.model.BatchDeleteDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

failedDocuments

Class com.amazonaws.services.qbusiness.model.BatchPutDocumentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

dataSourceSyncId

documents

indexId

roleArn