Module Awso_qbusiness.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule S3ObjectKey : sig ... end
Sourcemodule S3BucketName : sig ... end
Sourcemodule S3 : sig ... end

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

Sourcemodule Payload : sig ... end
Sourcemodule APISchema : sig ... end

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

Sourcemodule APISchemaType : sig ... end
Sourcemodule MemberRelation : sig ... end
Sourcemodule UserId : sig ... end
Sourcemodule ReadAccessType : sig ... end
Sourcemodule MembershipType : sig ... end
Sourcemodule PrincipalUser : sig ... end

Provides information about a user associated with a principal.

Sourcemodule GroupName : sig ... end
Sourcemodule PrincipalGroup : sig ... end

Provides information about a group associated with the principal.

Sourcemodule Principal : sig ... end

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

Sourcemodule Principals : sig ... end
Sourcemodule AccessControl : sig ... end

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

Sourcemodule AccessControls : sig ... end
Sourcemodule AccessConfiguration : sig ... end

Used to configure access permissions for a document.

Sourcemodule ErrorMessage : sig ... end
Sourcemodule AccessDeniedException : sig ... end

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

Sourcemodule QIamAction : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule DocumentAttributeValue : sig ... end

The value of a document attribute. You can only provide one value for a document attribute.

Sourcemodule DocumentAttributeKey : sig ... end
Sourcemodule DocumentAttribute : sig ... end

A document attribute or metadata field.

module AttributeFilter : sig ... end

Enables filtering of responses based on document attributes or metadata fields.

module AttributeFilters : sig ... end
Sourcemodule ActionFilterConfiguration : sig ... end

Specifies filters to apply to an allowed action.

Sourcemodule ActionConfiguration : sig ... end

Specifies an allowed action and its associated filter configuration.

Sourcemodule ActionConfigurationList : sig ... end
Sourcemodule PluginId : sig ... end
Sourcemodule ActionPayloadFieldKey : sig ... end
Sourcemodule ActionPayloadFieldValue : sig ... end

A user input field in an plugin action execution payload.

Sourcemodule ActionExecutionPayload : sig ... end
Sourcemodule ActionExecution : sig ... end

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

Sourcemodule ActionExecutionEvent : sig ... end

A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.

Sourcemodule ActionPayloadFieldType : sig ... end
Sourcemodule PluginType : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule Boolean : sig ... end

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

Sourcemodule ActionReviewPayloadField : sig ... end

A user input field in an plugin action review payload.

Sourcemodule ActionReviewPayload : sig ... end
Sourcemodule ActionReview : sig ... end

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

Sourcemodule MessageId : sig ... end
Sourcemodule ConversationId : sig ... end
Sourcemodule ActionReviewEvent : sig ... end

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

Sourcemodule ActionSummary : sig ... end

Summary information for an Amazon Q Business plugin action.

Sourcemodule Actions : sig ... end
Sourcemodule AmazonResourceName : sig ... end
Sourcemodule ClientNamespace : sig ... end
Sourcemodule QuickSightConfiguration : sig ... end

The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider. For more information, see Creating an Amazon Quick Suite integrated application.

Sourcemodule IdentityType : sig ... end
Sourcemodule ApplicationStatus : sig ... end
Sourcemodule ApplicationName : sig ... end
Sourcemodule ApplicationId : sig ... end
Sourcemodule Application : sig ... end

Summary information for an Amazon Q Business application.

Sourcemodule ApplicationArn : sig ... end
Sourcemodule Applications : sig ... end
Sourcemodule AttachmentsControlMode : sig ... end

Configuration information about the file upload during chat feature for your application.

Sourcemodule CreatorModeControl : sig ... end

The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience. For more information, see Admin controls and guardrails and Conversation settings.

Sourcemodule OrchestrationControl : sig ... end

The chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application. For more information, see Chat orchestration settings.

Sourcemodule StatementId : sig ... end
Sourcemodule QIamActions : sig ... end
Sourcemodule PrincipalRoleArn : sig ... end
Sourcemodule PermissionConditionValue : sig ... end
Sourcemodule PermissionConditionValues : sig ... end
Sourcemodule PermissionConditionKey : sig ... end
Sourcemodule PermissionCondition : sig ... end

Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request.

Sourcemodule PermissionConditions : sig ... end

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

Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule ValidationExceptionField : sig ... end

The input failed to meet the constraints specified by Amazon Q Business in a specified field.

Sourcemodule ValidationExceptionFields : sig ... end
Sourcemodule ValidationException : sig ... end

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to throttling. Reduce the number of requests and try again.

You have exceeded the set limits for your Amazon Q Business service.

Sourcemodule ResourceNotFoundException : sig ... end

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

Sourcemodule InternalServerException : sig ... end

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

Sourcemodule ConflictException : sig ... end

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

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

Sourcemodule AssociatedGroup : sig ... end

Represents a group associated with a given user in the access control system.

Sourcemodule AssociatedGroups : sig ... end
Sourcemodule AssociatedUser : sig ... end

Represents an associated user in the access control system.

Sourcemodule AssociatedUsers : sig ... end
Sourcemodule ErrorCode : sig ... end
Sourcemodule ErrorDetail : sig ... end

Provides information about a Amazon Q Business request error.

Sourcemodule AttachmentId : sig ... end
Sourcemodule ConversationSource : sig ... end

The source reference for an existing attachment in an existing conversation.

Sourcemodule CopyFromSource : sig ... end

The source reference for an existing attachment.

Sourcemodule AttachmentStatus : sig ... end
Sourcemodule AttachmentName : sig ... end
Sourcemodule Attachment : sig ... end

An attachment in an Amazon Q Business conversation.

Sourcemodule Blob : sig ... end
Sourcemodule AttachmentInput : sig ... end

This is either a file directly uploaded into a web experience chat or a reference to an existing attachment that is part of a web experience chat.

Sourcemodule AttachmentInputEvent : sig ... end

A file input event activated by a end user request to upload files into their web experience chat.

Sourcemodule AttachmentList : sig ... end
Sourcemodule AttachmentOutput : sig ... end

The details of a file uploaded during chat.

Sourcemodule AttachmentsConfiguration : sig ... end

Configuration information for the file upload during chat feature.

Sourcemodule AttachmentsInput : sig ... end
Sourcemodule AttachmentsOutput : sig ... end
Sourcemodule AttributeType : sig ... end
Sourcemodule AttributeValueOperator : sig ... end
Sourcemodule AudioExtractionStatus : sig ... end

Configuration settings for audio content extraction and processing.

Sourcemodule AudioExtractionType : sig ... end
Sourcemodule MediaId : sig ... end
Sourcemodule AudioSourceDetails : sig ... end

Details about an audio source, including its identifier, format, and time information.

Sourcemodule Url : sig ... end
Sourcemodule AuthChallengeRequest : sig ... end

A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.

Sourcemodule AuthChallengeRequestEvent : sig ... end

An authentication verification event activated by an end user request to use a custom plugin.

Sourcemodule AuthResponseValue : sig ... end
Sourcemodule AuthResponseKey : sig ... end
Sourcemodule AuthorizationResponseMap : sig ... end
Sourcemodule AuthChallengeResponse : sig ... end

Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.

An authentication verification event response by a third party authentication server to Amazon Q Business.

Sourcemodule SubscriptionType : sig ... end
Sourcemodule AutoSubscriptionStatus : sig ... end

Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

Sourcemodule SecretArn : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule BasicAuthConfiguration : sig ... end

Information about the basic authentication credentials used to configure a plugin.

Sourcemodule IndexId : sig ... end
Sourcemodule ExecutionId : sig ... end
Sourcemodule DocumentId : sig ... end
Sourcemodule DeleteDocument : sig ... end

A document deleted from an Amazon Q Business data source connector.

Sourcemodule DeleteDocuments : sig ... end

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Sourcemodule DataSourceId : sig ... end
Sourcemodule FailedDocument : sig ... end

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

Sourcemodule FailedDocuments : sig ... end

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Sourcemodule Title : sig ... end
Sourcemodule VideoExtractionStatus : sig ... end

Configuration settings for video content extraction and processing.

Sourcemodule ImageExtractionStatus : sig ... end

The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.

The configuration for extracting information from media in documents.

Sourcemodule DocumentContentOperator : sig ... end
Sourcemodule DocumentAttributeTarget : sig ... end

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with DocumentAttributeCondition .

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration . For more information, see Custom document enrichment.

Sourcemodule LambdaArn : sig ... end
Sourcemodule HookConfiguration : sig ... end

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment.

Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment.

Sourcemodule DocumentContent : sig ... end

The contents of a document. Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.

Sourcemodule DocumentAttributes : sig ... end
Sourcemodule ContentType : sig ... end
Sourcemodule Document : sig ... end

A document in an Amazon Q Business application.

Sourcemodule Documents : sig ... end
Sourcemodule BatchPutDocumentRequest : sig ... end

Adds one or more documents to an Amazon Q Business index. You use this API to: ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. add custom attributes to documents in an Amazon Q Business index. attach an access control list to the documents added to an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Sourcemodule BatchPutDocumentResponse : sig ... end

Adds one or more documents to an Amazon Q Business index. You use this API to: ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. add custom attributes to documents in an Amazon Q Business index. attach an access control list to the documents added to an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Sourcemodule BlockedPhrase : sig ... end
Sourcemodule BlockedPhrases : sig ... end
Sourcemodule SystemMessageOverride : sig ... end

Provides information about the phrases blocked from chat by your chat control configuration.

Updates a blocked phrases configuration in your Amazon Q Business application.

Sourcemodule BoostingDurationInSeconds : sig ... end
Sourcemodule BrowserExtension : sig ... end
Sourcemodule BrowserExtensionList : sig ... end

The container for browser extension configuration for an Amazon Q Business web experience.

Sourcemodule SubscriptionId : sig ... end
Sourcemodule CancelSubscriptionRequest : sig ... end

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

Sourcemodule SubscriptionDetails : sig ... end

The details of an Amazon Q Business subscription.

Sourcemodule SubscriptionArn : sig ... end

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

Sourcemodule UserGroups : sig ... end
Sourcemodule ClientToken : sig ... end
Sourcemodule UserMessage : sig ... end
Sourcemodule TextInputEvent : sig ... end

An input event for a end user message in an Amazon Q Business web experience.

Sourcemodule EndOfInputEvent : sig ... end

The end of the streaming input for the Chat API.

Sourcemodule PluginConfiguration : sig ... end

Configuration information required to invoke chat in PLUGIN_MODE. For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

Sourcemodule ChatModeConfiguration : sig ... end

Configuration information for Amazon Q Business conversation modes. For more information, see Admin controls and guardrails and Conversation settings.

Sourcemodule ChatMode : sig ... end
Sourcemodule ConfigurationEvent : sig ... end

A configuration event activated by an end user request to select a specific chat mode.

Sourcemodule ChatInputStream : sig ... end

The streaming input for the Chat API.

Sourcemodule ChatInput : sig ... end

Starts or continues a streaming Amazon Q Business conversation.

Sourcemodule LicenseNotFoundException : sig ... end

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

Sourcemodule ExternalResourceException : sig ... end

An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.

Sourcemodule SystemMessageType : sig ... end
Sourcemodule TextOutputEvent : sig ... end

An output event for an AI-generated response in an Amazon Q Business web experience.

Sourcemodule VideoExtractionType : sig ... end
Sourcemodule VideoSourceDetails : sig ... end

Details about a video source, including its identifier, format, and time information.

Sourcemodule ImageSourceDetails : sig ... end

Details about an image source, including its identifier and format.

Sourcemodule SourceDetails : sig ... end

Container for details about different types of media sources (image, audio, or video).

Sourcemodule SourceAttributionMediaId : sig ... end
Sourcemodule SnippetExcerptText : sig ... end
Sourcemodule SnippetExcerpt : sig ... end

Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Sourcemodule TextSegment : sig ... end

Provides information about a text extract in a chat response that can be attributed to a source document.

Sourcemodule TextSegmentList : sig ... end
Sourcemodule SourceAttribution : sig ... end

The documents used to generate an Amazon Q Business web experience response.

Sourcemodule SourceAttributions : sig ... end
Sourcemodule MetadataEvent : sig ... end

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

Sourcemodule FailedAttachmentEvent : sig ... end

A failed file upload during web experience chat.

Sourcemodule ChatOutputStream : sig ... end

The streaming output for the Chat API.

Sourcemodule ChatOutput : sig ... end

Starts or continues a streaming Amazon Q Business conversation.

Sourcemodule DisplayName : sig ... end
Sourcemodule ChatResponseConfiguration : sig ... end

Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.

Sourcemodule ResponseConfigurationType : sig ... end
Sourcemodule Instruction : sig ... end
Sourcemodule InstructionCollection : sig ... end

A set of instructions that define how Amazon Q Business should generate and format responses to user queries. This collection includes parameters for controlling response characteristics such as length, audience targeting, perspective, style, identity, tone, and custom instructions.

Sourcemodule ResponseConfiguration : sig ... end

Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.

Sourcemodule ResponseConfigurations : sig ... end

Detailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses.

Sourcemodule ChatSyncInput : sig ... end

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

Sourcemodule ChatSyncOutput : sig ... end

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

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

Sourcemodule DocumentAclUser : sig ... end

Represents a user in the document's ACL, used to define access permissions for individual users.

Sourcemodule DocumentAclUsers : sig ... end
Sourcemodule DocumentAclGroup : sig ... end

Represents a group in the document's ACL, used to define access permissions for multiple users collectively.

Sourcemodule DocumentAclGroups : sig ... end
Sourcemodule DocumentAclCondition : sig ... end

Represents a condition in the document's ACL, specifying access rules for users and groups.

Sourcemodule DocumentAclConditions : sig ... end
Sourcemodule DocumentAclMembership : sig ... end

Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions.

Sourcemodule DocumentAcl : sig ... end

Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions.

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

Sourcemodule ClientIdForOIDC : sig ... end
Sourcemodule ClientIdsForOIDC : sig ... end
Sourcemodule ContentBlockerRule : sig ... end

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

Sourcemodule EligibleDataSource : sig ... end

The identifier of the data source Amazon Q Business will generate responses from.

Sourcemodule EligibleDataSources : sig ... end
Sourcemodule ContentRetrievalRule : sig ... end

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

Sourcemodule RetrieverId : sig ... end
Sourcemodule RetrieverContentSource : sig ... end

Specifies a retriever as the content source for a search.

Sourcemodule ContentSource : sig ... end

Specifies the source of content to search in.

Sourcemodule ConversationTitle : sig ... end
Sourcemodule Conversation : sig ... end

A conversation in an Amazon Q Business application.

Sourcemodule Conversations : sig ... end
Sourcemodule WebExperienceId : sig ... end
Sourcemodule SessionDurationInMinutes : sig ... end

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

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

Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule Tag : sig ... end

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Sourcemodule Tags : sig ... end
Sourcemodule QAppsControlMode : sig ... end
Sourcemodule QAppsConfiguration : sig ... end

Configuration information about Amazon Q Apps.

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

Sourcemodule InstanceArn : sig ... end
Sourcemodule IAMIdentityProviderArn : sig ... end
Sourcemodule KmsKeyId : sig ... end
Sourcemodule EncryptionConfiguration : sig ... end

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

Sourcemodule Description : sig ... end
Sourcemodule CreateApplicationRequest : sig ... end

Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps. When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

Sourcemodule CreateApplicationResponse : sig ... end

Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps. When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.

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

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

Sourcemodule DataAccessorName : sig ... end
Sourcemodule DataAccessorExternalId : sig ... end
Sourcemodule DataAccessorExternalIds : sig ... end
Sourcemodule IdcTrustedTokenIssuerArn : sig ... end

Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.

A union type that contains the specific authentication configuration based on the authentication type selected.

Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.

Sourcemodule CreateDataAccessorRequest : sig ... end

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

Sourcemodule IdcApplicationArn : sig ... end
Sourcemodule DataAccessorId : sig ... end
Sourcemodule DataAccessorArn : sig ... end

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

Sourcemodule SyncSchedule : sig ... end
Sourcemodule SubnetId : sig ... end
Sourcemodule SubnetIds : sig ... end
Sourcemodule SecurityGroupId : sig ... end
Sourcemodule SecurityGroupIds : sig ... end

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

Sourcemodule DataSourceName : sig ... end
Sourcemodule DataSourceConfiguration : sig ... end

Provides the configuration information for an Amazon Q Business data source.

Sourcemodule CreateDataSourceRequest : sig ... end

Creates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Sourcemodule DataSourceArn : sig ... end
Sourcemodule CreateDataSourceResponse : sig ... end

Creates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Sourcemodule IndexType : sig ... end
Sourcemodule IndexName : sig ... end
Sourcemodule IndexCapacityInteger : sig ... end

Provides information about index capacity configuration.

Sourcemodule CreateIndexRequest : sig ... end

Creates an Amazon Q Business index. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Sourcemodule IndexArn : sig ... end
Sourcemodule CreateIndexResponse : sig ... end

Creates an Amazon Q Business index. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Sourcemodule PluginName : sig ... end

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Sourcemodule NoAuthConfiguration : sig ... end

Information about invoking a custom plugin without any authentication or authorization requirement.

Sourcemodule IdcAuthConfiguration : sig ... end

Information about the IAM Identity Center Application used to configure authentication for a plugin.

Sourcemodule PluginAuthConfiguration : sig ... end

Authentication configuration information for an Amazon Q Business plugin.

Sourcemodule PluginDescription : sig ... end
Sourcemodule CustomPluginConfiguration : sig ... end

Configuration information required to create a custom plugin.

Sourcemodule CreatePluginRequest : sig ... end

Creates an Amazon Q Business plugin.

Sourcemodule PluginBuildStatus : sig ... end
Sourcemodule PluginArn : sig ... end
Sourcemodule CreatePluginResponse : sig ... end

Creates an Amazon Q Business plugin.

Sourcemodule RetrieverType : sig ... end
Sourcemodule RetrieverName : sig ... end

Provides information on boosting STRING_LIST type document attributes. In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2. For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

Provides information on boosting STRING type document attributes. For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

Provides information on boosting NUMBER type document attributes. In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

Provides information on boosting DATE type document attributes. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes. In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results. For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

Sourcemodule NativeIndexConfiguration : sig ... end

Configuration information for an Amazon Q Business index.

Sourcemodule KendraIndexId : sig ... end
Sourcemodule KendraIndexConfiguration : sig ... end

Stores an Amazon Kendra index as a retriever.

Sourcemodule RetrieverConfiguration : sig ... end

Provides information on how the retriever used for your Amazon Q Business application is configured.

Sourcemodule CreateRetrieverRequest : sig ... end

Adds a retriever to your Amazon Q Business application.

Sourcemodule RetrieverArn : sig ... end
Sourcemodule CreateRetrieverResponse : sig ... end

Adds a retriever to your Amazon Q Business application.

Sourcemodule UserIdentifier : sig ... end
Sourcemodule GroupIdentifier : sig ... end
Sourcemodule SubscriptionPrincipal : sig ... end

A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

Sourcemodule CreateSubscriptionRequest : sig ... end

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.

Sourcemodule UserAlias : sig ... end

Aliases attached to a user id within an Amazon Q Business application.

Sourcemodule CreateUserRequest : sig ... end

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

Sourcemodule CreateUserResponse : sig ... end

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

Sourcemodule WebExperienceTitle : sig ... end
Sourcemodule WebExperienceSubtitle : sig ... end
Sourcemodule Origin : sig ... end
Sourcemodule WebExperienceOrigins : sig ... end
Sourcemodule SamlAuthenticationUrl : sig ... end
Sourcemodule SamlProviderConfiguration : sig ... end

Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Sourcemodule LogoUrl : sig ... end
Sourcemodule FontUrl : sig ... end
Sourcemodule FaviconUrl : sig ... end
Sourcemodule CustomCSSUrl : sig ... end

Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

Creates an Amazon Q Business web experience.

Sourcemodule WebExperienceArn : sig ... end

Creates an Amazon Q Business web experience.

Sourcemodule CreatorModeConfiguration : sig ... end

Configuration information required to invoke chat in CREATOR_MODE. For more information, see Admin controls and guardrails and Conversation settings.

Sourcemodule DataAccessor : sig ... end

Provides summary information about a data accessor.

Sourcemodule DataAccessors : sig ... end
Sourcemodule DataSourceStatus : sig ... end
Sourcemodule DataSource : sig ... end

A data source in an Amazon Q Business application.

Sourcemodule DataSourceIds : sig ... end
Sourcemodule DataSourceSyncJobStatus : sig ... end
Sourcemodule MetricValue : sig ... end
Sourcemodule DataSourceSyncJobMetrics : sig ... end

Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.

Sourcemodule DataSourceSyncJob : sig ... end

Provides information about an Amazon Q Business data source connector synchronization job.

Sourcemodule DataSourceSyncJobs : sig ... end
Sourcemodule DataSourceUserId : sig ... end
Sourcemodule DataSources : sig ... end
Sourcemodule DeleteApplicationRequest : sig ... end

Deletes an Amazon Q Business application.

Sourcemodule DeleteApplicationResponse : sig ... end

Deletes an Amazon Q Business application.

Sourcemodule DeleteAttachmentRequest : sig ... end

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

Sourcemodule DeleteAttachmentResponse : sig ... end

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

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

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

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

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

Sourcemodule DeleteConversationRequest : sig ... end

Deletes an Amazon Q Business web experience conversation.

Deletes an Amazon Q Business web experience conversation.

Sourcemodule DeleteDataAccessorRequest : sig ... end

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

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

Sourcemodule DeleteDataSourceRequest : sig ... end

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

Sourcemodule DeleteDataSourceResponse : sig ... end

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

Sourcemodule DeleteGroupRequest : sig ... end

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.

Sourcemodule DeleteGroupResponse : sig ... end

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.

Sourcemodule DeleteIndexRequest : sig ... end

Deletes an Amazon Q Business index.

Sourcemodule DeleteIndexResponse : sig ... end

Deletes an Amazon Q Business index.

Sourcemodule DeletePluginRequest : sig ... end

Deletes an Amazon Q Business plugin.

Sourcemodule DeletePluginResponse : sig ... end

Deletes an Amazon Q Business plugin.

Sourcemodule DeleteRetrieverRequest : sig ... end

Deletes the retriever used by an Amazon Q Business application.

Sourcemodule DeleteRetrieverResponse : sig ... end

Deletes the retriever used by an Amazon Q Business application.

Sourcemodule DeleteUserRequest : sig ... end

Deletes a user by email id.

Sourcemodule DeleteUserResponse : sig ... end

Deletes a user by email id.

Deletes an Amazon Q Business web experience.

Deletes an Amazon Q Business web experience.

Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

Sourcemodule Status : sig ... end

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Sourcemodule DocumentStatus : sig ... end
Sourcemodule DocumentDetails : sig ... end

The details of a document within an Amazon Q Business index.

Sourcemodule DocumentDetailList : sig ... end
Sourcemodule ExampleChatMessage : sig ... end
Sourcemodule ExampleChatMessages : sig ... end
Sourcemodule GetApplicationRequest : sig ... end

Gets information about an existing Amazon Q Business application.

Sourcemodule GetApplicationResponse : sig ... end

Gets information about an existing Amazon Q Business application.

Sourcemodule NextToken : sig ... end

Gets information about chat controls configured for an existing Amazon Q Business application.

Sourcemodule TopicDescription : sig ... end
Sourcemodule TopicConfigurationName : sig ... end
Sourcemodule UserIds : sig ... end
Sourcemodule UsersAndGroups : sig ... end

Provides information about users and group names associated with a topic control rule.

Sourcemodule RuleType : sig ... end
Sourcemodule RuleConfiguration : sig ... end

Provides configuration information about a rule.

Sourcemodule Rule : sig ... end

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

Sourcemodule Rules : sig ... end
Sourcemodule TopicConfiguration : sig ... end

The topic specific controls configured for an Amazon Q Business application.

Sourcemodule TopicConfigurations : sig ... end
Sourcemodule ResponseScope : sig ... end

Configuration information required to setup hallucination reduction. For more information, see hallucination reduction. The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.

Gets information about chat controls configured for an existing Amazon Q Business application.

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

Sourcemodule GetDataAccessorRequest : sig ... end

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

Sourcemodule GetDataAccessorResponse : sig ... end

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

Sourcemodule GetDataSourceRequest : sig ... end

Gets information about an existing Amazon Q Business data source connector.

Sourcemodule GetDataSourceResponse : sig ... end

Gets information about an existing Amazon Q Business data source connector.

Sourcemodule OutputFormat : sig ... end
Sourcemodule GetDocumentContentRequest : sig ... end

Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.

Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.

Sourcemodule GetGroupRequest : sig ... end

Describes a group by group name.

Sourcemodule GroupStatus : sig ... end
Sourcemodule GroupStatusDetail : sig ... end

Provides the details of a group's status.

Sourcemodule GroupStatusDetails : sig ... end
Sourcemodule GetGroupResponse : sig ... end

Describes a group by group name.

Sourcemodule GetIndexRequest : sig ... end

Gets information about an existing Amazon Q Business index.

Sourcemodule IndexStatus : sig ... end
Sourcemodule IndexedTextDocument : sig ... end
Sourcemodule IndexedTextBytes : sig ... end
Sourcemodule TextDocumentStatistics : sig ... end

Provides information about text documents in an index.

Sourcemodule IndexStatistics : sig ... end

Provides information about the number of documents in an index.

Sourcemodule GetIndexResponse : sig ... end

Gets information about an existing Amazon Q Business index.

Sourcemodule GetMediaRequest : sig ... end

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.

Sourcemodule MediaTooLargeException : sig ... end

The requested media object is too large to be returned.

Sourcemodule GetMediaResponse : sig ... end

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.

Sourcemodule GetPluginRequest : sig ... end

Gets information about an existing Amazon Q Business plugin.

Sourcemodule PluginState : sig ... end
Sourcemodule GetPluginResponse : sig ... end

Gets information about an existing Amazon Q Business plugin.

Sourcemodule GetPolicyRequest : sig ... end

Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

Sourcemodule GetPolicyResponse : sig ... end

Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

Sourcemodule GetRetrieverRequest : sig ... end

Gets information about an existing retriever used by an Amazon Q Business application.

Sourcemodule RetrieverStatus : sig ... end
Sourcemodule GetRetrieverResponse : sig ... end

Gets information about an existing retriever used by an Amazon Q Business application.

Sourcemodule GetUserRequest : sig ... end

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Sourcemodule UserAliases : sig ... end
Sourcemodule GetUserResponse : sig ... end

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Sourcemodule GetWebExperienceRequest : sig ... end

Gets information about an existing Amazon Q Business web experience.

Sourcemodule WebExperienceStatus : sig ... end
Sourcemodule SamlMetadataXML : sig ... end
Sourcemodule SamlAttribute : sig ... end
Sourcemodule SamlConfiguration : sig ... end

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

Sourcemodule GetWebExperienceResponse : sig ... end

Gets information about an existing Amazon Q Business web experience.

Sourcemodule MemberUser : sig ... end

The users that belong to a group.

Sourcemodule MemberUsers : sig ... end
Sourcemodule MemberGroup : sig ... end

The sub groups that belong to a group.

Sourcemodule MemberGroups : sig ... end
Sourcemodule GroupMembers : sig ... end

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

Sourcemodule GroupSummary : sig ... end

Summary information for groups.

Sourcemodule GroupSummaryList : sig ... end
Sourcemodule Index : sig ... end

Summary information for your Amazon Q Business index.

Sourcemodule Indices : sig ... end
Sourcemodule ListApplicationsRequest : sig ... end

Lists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

Sourcemodule ListApplicationsResponse : sig ... end

Lists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.

Sourcemodule ListAttachmentsRequest : sig ... end

Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.

Sourcemodule ListAttachmentsResponse : sig ... end

Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.

Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.

Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.

Sourcemodule ListConversationsRequest : sig ... end

Lists one or more Amazon Q Business conversations.

Sourcemodule ListConversationsResponse : sig ... end

Lists one or more Amazon Q Business conversations.

Sourcemodule NextToken1500 : sig ... end
Sourcemodule ListDataAccessorsRequest : sig ... end

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

Sourcemodule ListDataAccessorsResponse : sig ... end

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

Get information about an Amazon Q Business data source connector synchronization.

Get information about an Amazon Q Business data source connector synchronization.

Sourcemodule ListDataSourcesRequest : sig ... end

Lists the Amazon Q Business data source connectors that you have created.

Sourcemodule ListDataSourcesResponse : sig ... end

Lists the Amazon Q Business data source connectors that you have created.

Sourcemodule ListDocumentsRequest : sig ... end

A list of documents attached to an index.

Sourcemodule ListDocumentsResponse : sig ... end

A list of documents attached to an index.

Sourcemodule ListGroupsRequest : sig ... end

Provides a list of groups that are mapped to users.

Sourcemodule ListGroupsResponse : sig ... end

Provides a list of groups that are mapped to users.

Sourcemodule ListIndicesRequest : sig ... end

Lists the Amazon Q Business indices you have created.

Sourcemodule ListIndicesResponse : sig ... end

Lists the Amazon Q Business indices you have created.

Sourcemodule ListMessagesRequest : sig ... end

Gets a list of messages associated with an Amazon Q Business web experience.

Sourcemodule MessageType : sig ... end
Sourcemodule MessageBody : sig ... end
Sourcemodule Message : sig ... end

A message in an Amazon Q Business web experience.

Sourcemodule Messages : sig ... end
Sourcemodule ListMessagesResponse : sig ... end

Gets a list of messages associated with an Amazon Q Business web experience.

Sourcemodule ListPluginActionsRequest : sig ... end

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Sourcemodule ListPluginActionsResponse : sig ... end

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

Lists metadata for all Amazon Q Business plugin types.

Sourcemodule PluginTypeCategory : sig ... end
Sourcemodule PluginTypeMetadataSummary : sig ... end

Summary metadata information for a Amazon Q Business plugin.

Lists metadata for all Amazon Q Business plugin types.

Sourcemodule ListPluginsRequest : sig ... end

Lists configured Amazon Q Business plugins.

Sourcemodule Plugin : sig ... end

Information about an Amazon Q Business plugin and its configuration.

Sourcemodule Plugins : sig ... end
Sourcemodule ListPluginsResponse : sig ... end

Lists configured Amazon Q Business plugins.

Sourcemodule ListRetrieversRequest : sig ... end

Lists the retriever used by an Amazon Q Business application.

Sourcemodule Retriever : sig ... end

Summary information for the retriever used for your Amazon Q Business application.

Sourcemodule Retrievers : sig ... end
Sourcemodule ListRetrieversResponse : sig ... end

Lists the retriever used by an Amazon Q Business application.

Sourcemodule ListSubscriptionsRequest : sig ... end

Lists all subscriptions created in an Amazon Q Business application.

Sourcemodule Subscription : sig ... end

Information about an Amazon Q Business subscription. Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

Sourcemodule Subscriptions : sig ... end
Sourcemodule ListSubscriptionsResponse : sig ... end

Lists all subscriptions created in an Amazon Q Business application.

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

Sourcemodule ListWebExperiencesRequest : sig ... end

Lists one or more Amazon Q Business Web Experiences.

Sourcemodule WebExperience : sig ... end

Provides information for an Amazon Q Business web experience.

Sourcemodule WebExperiences : sig ... end

Lists one or more Amazon Q Business Web Experiences.

Sourcemodule MaxResults : sig ... end
Sourcemodule MessageUsefulness : sig ... end
Sourcemodule MessageUsefulnessComment : sig ... end
Sourcemodule MessageUsefulnessReason : sig ... end
Sourcemodule MessageUsefulnessFeedback : sig ... end

End user feedback on an AI-generated web experience chat message usefulness.

Configuration information required to enable chat orchestration for your Amazon Q Business application. Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.

Sourcemodule SystemMessageId : sig ... end
Sourcemodule PutFeedbackRequest : sig ... end

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

Sourcemodule PutGroupRequest : sig ... end

Create, or updates, a mapping of users—who have access to a document—to groups. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

Sourcemodule PutGroupResponse : sig ... end

Create, or updates, a mapping of users—who have access to a document—to groups. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.

Sourcemodule QueryText : sig ... end
Sourcemodule ScoreConfidence : sig ... end
Sourcemodule ScoreAttributes : sig ... end

Provides information about the relevance score of content.

Sourcemodule RelevantContent : sig ... end

Represents a piece of content that is relevant to a search query.

Sourcemodule RelevantContentList : sig ... end

Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

Stops an Amazon Q Business data source connector synchronization job already in progress.

Stops an Amazon Q Business data source connector synchronization job already in progress.

Sourcemodule TagKeys : sig ... end
Sourcemodule TagResourceRequest : sig ... end

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

Sourcemodule TagResourceResponse : sig ... end

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

Sourcemodule UntagResourceRequest : sig ... end

Removes a tag from an Amazon Q Business application or a data source.

Sourcemodule UntagResourceResponse : sig ... end

Removes a tag from an Amazon Q Business application or a data source.

Sourcemodule UpdateApplicationRequest : sig ... end

Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

Sourcemodule UpdateApplicationResponse : sig ... end

Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.

Updates a set of chat controls configured for an existing Amazon Q Business application.

Updates a set of chat controls configured for an existing Amazon Q Business application.

Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.

Sourcemodule UpdateDataAccessorRequest : sig ... end

Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

Sourcemodule UpdateDataSourceRequest : sig ... end

Updates an existing Amazon Q Business data source connector.

Sourcemodule UpdateDataSourceResponse : sig ... end

Updates an existing Amazon Q Business data source connector.

Sourcemodule UpdateIndexRequest : sig ... end

Updates an Amazon Q Business index.

Sourcemodule UpdateIndexResponse : sig ... end

Updates an Amazon Q Business index.

Sourcemodule UpdatePluginRequest : sig ... end

Updates an Amazon Q Business plugin.

Sourcemodule UpdatePluginResponse : sig ... end

Updates an Amazon Q Business plugin.

Sourcemodule UpdateRetrieverRequest : sig ... end

Updates the retriever used for your Amazon Q Business application.

Sourcemodule UpdateRetrieverResponse : sig ... end

Updates the retriever used for your Amazon Q Business application.

Sourcemodule UpdateSubscriptionRequest : sig ... end

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

Sourcemodule UpdateUserRequest : sig ... end

Updates a information associated with a user id.

Sourcemodule UpdateUserResponse : sig ... end

Updates a information associated with a user id.

Updates an Amazon Q Business web experience.

Updates an Amazon Q Business web experience.