Package qbusinessiface provides an interface to enable mocking the QBusiness service client for testing your code.

ActionPayloadFieldType_Values returns all elements of the ActionPayloadFieldType enum.

APISchemaType_Values returns all elements of the APISchemaType enum.

ApplicationStatus_Values returns all elements of the ApplicationStatus enum.

AttachmentsControlMode_Values returns all elements of the AttachmentsControlMode enum.

AttachmentStatus_Values returns all elements of the AttachmentStatus enum.

AttributeType_Values returns all elements of the AttributeType enum.

AttributeValueOperator_Values returns all elements of the AttributeValueOperator enum.

ChatMode_Values returns all elements of the ChatMode enum.

ContentType_Values returns all elements of the ContentType enum.

CreatorModeControl_Values returns all elements of the CreatorModeControl enum.

DataSourceStatus_Values returns all elements of the DataSourceStatus enum.

DataSourceSyncJobStatus_Values returns all elements of the DataSourceSyncJobStatus enum.

DocumentAttributeBoostingLevel_Values returns all elements of the DocumentAttributeBoostingLevel enum.

DocumentContentOperator_Values returns all elements of the DocumentContentOperator enum.

DocumentEnrichmentConditionOperator_Values returns all elements of the DocumentEnrichmentConditionOperator enum.

DocumentStatus_Values returns all elements of the DocumentStatus enum.

ErrorCode_Values returns all elements of the ErrorCode enum.

GroupStatus_Values returns all elements of the GroupStatus enum.

IndexStatus_Values returns all elements of the IndexStatus enum.

IndexType_Values returns all elements of the IndexType enum.

MemberRelation_Values returns all elements of the MemberRelation enum.

MembershipType_Values returns all elements of the MembershipType enum.

MessageType_Values returns all elements of the MessageType enum.

MessageUsefulness_Values returns all elements of the MessageUsefulness enum.

MessageUsefulnessReason_Values returns all elements of the MessageUsefulnessReason enum.

New creates a new instance of the QBusiness client with a session.

NewChatEventStream initializes an ChatEventStream.

NumberAttributeBoostingType_Values returns all elements of the NumberAttributeBoostingType enum.

PersonalizationControlMode_Values returns all elements of the PersonalizationControlMode enum.

PluginBuildStatus_Values returns all elements of the PluginBuildStatus enum.

PluginState_Values returns all elements of the PluginState enum.

PluginType_Values returns all elements of the PluginType enum.

QAppsControlMode_Values returns all elements of the QAppsControlMode enum.

ReadAccessType_Values returns all elements of the ReadAccessType enum.

ResponseScope_Values returns all elements of the ResponseScope enum.

RetrieverStatus_Values returns all elements of the RetrieverStatus enum.

RetrieverType_Values returns all elements of the RetrieverType enum.

RuleType_Values returns all elements of the RuleType enum.

Status_Values returns all elements of the Status enum.

StringAttributeValueBoostingLevel_Values returns all elements of the StringAttributeValueBoostingLevel enum.

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum.

WebExperienceSamplePromptsControlMode_Values returns all elements of the WebExperienceSamplePromptsControlMode enum.

WebExperienceStatus_Values returns all elements of the WebExperienceStatus enum.

ActionPayloadFieldTypeArray is a ActionPayloadFieldType enum value.

ActionPayloadFieldTypeBoolean is a ActionPayloadFieldType enum value.

ActionPayloadFieldTypeNumber is a ActionPayloadFieldType enum value.

ActionPayloadFieldTypeString is a ActionPayloadFieldType enum value.

APISchemaTypeOpenApiV3 is a APISchemaType enum value.

ApplicationStatusActive is a ApplicationStatus enum value.

ApplicationStatusCreating is a ApplicationStatus enum value.

ApplicationStatusDeleting is a ApplicationStatus enum value.

ApplicationStatusFailed is a ApplicationStatus enum value.

ApplicationStatusUpdating is a ApplicationStatus enum value.

AttachmentsControlModeDisabled is a AttachmentsControlMode enum value.

AttachmentsControlModeEnabled is a AttachmentsControlMode enum value.

AttachmentStatusFailed is a AttachmentStatus enum value.

AttachmentStatusSucceeded is a AttachmentStatus enum value.

AttributeTypeDate is a AttributeType enum value.

AttributeTypeNumber is a AttributeType enum value.

AttributeTypeString is a AttributeType enum value.

AttributeTypeStringList is a AttributeType enum value.

AttributeValueOperatorDelete is a AttributeValueOperator enum value.

ChatModeCreatorMode is a ChatMode enum value.

ChatModePluginMode is a ChatMode enum value.

ChatModeRetrievalMode is a ChatMode enum value.

ContentTypeCsv is a ContentType enum value.

ContentTypeHtml is a ContentType enum value.

ContentTypeJson is a ContentType enum value.

ContentTypeMd is a ContentType enum value.

ContentTypeMsExcel is a ContentType enum value.

ContentTypeMsWord is a ContentType enum value.

ContentTypePdf is a ContentType enum value.

ContentTypePlainText is a ContentType enum value.

ContentTypePpt is a ContentType enum value.

ContentTypeRtf is a ContentType enum value.

ContentTypeXml is a ContentType enum value.

ContentTypeXslt is a ContentType enum value.

CreatorModeControlDisabled is a CreatorModeControl enum value.

CreatorModeControlEnabled is a CreatorModeControl enum value.

DataSourceStatusActive is a DataSourceStatus enum value.

DataSourceStatusCreating is a DataSourceStatus enum value.

DataSourceStatusDeleting is a DataSourceStatus enum value.

DataSourceStatusFailed is a DataSourceStatus enum value.

DataSourceStatusPendingCreation is a DataSourceStatus enum value.

DataSourceStatusUpdating is a DataSourceStatus enum value.

DataSourceSyncJobStatusAborted is a DataSourceSyncJobStatus enum value.

DataSourceSyncJobStatusFailed is a DataSourceSyncJobStatus enum value.

DataSourceSyncJobStatusIncomplete is a DataSourceSyncJobStatus enum value.

DataSourceSyncJobStatusStopping is a DataSourceSyncJobStatus enum value.

DataSourceSyncJobStatusSucceeded is a DataSourceSyncJobStatus enum value.

DataSourceSyncJobStatusSyncing is a DataSourceSyncJobStatus enum value.

DataSourceSyncJobStatusSyncingIndexing is a DataSourceSyncJobStatus enum value.

DocumentAttributeBoostingLevelHigh is a DocumentAttributeBoostingLevel enum value.

DocumentAttributeBoostingLevelLow is a DocumentAttributeBoostingLevel enum value.

DocumentAttributeBoostingLevelMedium is a DocumentAttributeBoostingLevel enum value.

DocumentAttributeBoostingLevelNone is a DocumentAttributeBoostingLevel enum value.

DocumentAttributeBoostingLevelVeryHigh is a DocumentAttributeBoostingLevel enum value.

DocumentContentOperatorDelete is a DocumentContentOperator enum value.

DocumentEnrichmentConditionOperatorBeginsWith is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorContains is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorEquals is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorExists is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorGreaterThan is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorGreaterThanOrEquals is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorLessThan is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorLessThanOrEquals is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorNotContains is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorNotEquals is a DocumentEnrichmentConditionOperator enum value.

DocumentEnrichmentConditionOperatorNotExists is a DocumentEnrichmentConditionOperator enum value.

DocumentStatusDeleted is a DocumentStatus enum value.

DocumentStatusDeleting is a DocumentStatus enum value.

DocumentStatusDocumentFailedToIndex is a DocumentStatus enum value.

DocumentStatusFailed is a DocumentStatus enum value.

DocumentStatusIndexed is a DocumentStatus enum value.

DocumentStatusProcessing is a DocumentStatus enum value.

DocumentStatusReceived is a DocumentStatus enum value.

DocumentStatusUpdated is a DocumentStatus enum value.

ID to lookup a service endpoint with.

ErrCodeAccessDeniedException for service response error code "AccessDeniedException".

ErrCodeConflictException for service response error code "ConflictException".

ErrCodeInternalServerException for service response error code "InternalServerException".

ErrCodeLicenseNotFoundException for service response error code "LicenseNotFoundException".

ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".

ErrCodeServiceQuotaExceededException for service response error code "ServiceQuotaExceededException".

ErrCodeThrottlingException for service response error code "ThrottlingException".

ErrCodeValidationException for service response error code "ValidationException".

ErrorCodeInternalError is a ErrorCode enum value.

ErrorCodeInvalidRequest is a ErrorCode enum value.

ErrorCodeResourceInactive is a ErrorCode enum value.

ErrorCodeResourceNotFound is a ErrorCode enum value.

GroupStatusDeleted is a GroupStatus enum value.

GroupStatusDeleting is a GroupStatus enum value.

GroupStatusFailed is a GroupStatus enum value.

GroupStatusProcessing is a GroupStatus enum value.

GroupStatusSucceeded is a GroupStatus enum value.

IndexStatusActive is a IndexStatus enum value.

IndexStatusCreating is a IndexStatus enum value.

IndexStatusDeleting is a IndexStatus enum value.

IndexStatusFailed is a IndexStatus enum value.

IndexStatusUpdating is a IndexStatus enum value.

IndexTypeEnterprise is a IndexType enum value.

IndexTypeStarter is a IndexType enum value.

MemberRelationAnd is a MemberRelation enum value.

MemberRelationOr is a MemberRelation enum value.

MembershipTypeDatasource is a MembershipType enum value.

MembershipTypeIndex is a MembershipType enum value.

MessageTypeSystem is a MessageType enum value.

MessageTypeUser is a MessageType enum value.

MessageUsefulnessNotUseful is a MessageUsefulness enum value.

MessageUsefulnessReasonComplete is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonFactuallyCorrect is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonHarmfulOrUnsafe is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonHelpful is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonIncorrectOrMissingSources is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonNotBasedOnDocuments is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonNotComplete is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonNotConcise is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonNotFactuallyCorrect is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonNotHelpful is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonOther is a MessageUsefulnessReason enum value.

MessageUsefulnessReasonRelevantSources is a MessageUsefulnessReason enum value.

MessageUsefulnessUseful is a MessageUsefulness enum value.

NumberAttributeBoostingTypePrioritizeLargerValues is a NumberAttributeBoostingType enum value.

NumberAttributeBoostingTypePrioritizeSmallerValues is a NumberAttributeBoostingType enum value.

PersonalizationControlModeDisabled is a PersonalizationControlMode enum value.

PersonalizationControlModeEnabled is a PersonalizationControlMode enum value.

PluginBuildStatusCreateFailed is a PluginBuildStatus enum value.

PluginBuildStatusCreateInProgress is a PluginBuildStatus enum value.

PluginBuildStatusDeleteFailed is a PluginBuildStatus enum value.

PluginBuildStatusDeleteInProgress is a PluginBuildStatus enum value.

PluginBuildStatusReady is a PluginBuildStatus enum value.

PluginBuildStatusUpdateFailed is a PluginBuildStatus enum value.

PluginBuildStatusUpdateInProgress is a PluginBuildStatus enum value.

PluginStateDisabled is a PluginState enum value.

PluginStateEnabled is a PluginState enum value.

PluginTypeCustom is a PluginType enum value.

PluginTypeJira is a PluginType enum value.

PluginTypeSalesforce is a PluginType enum value.

PluginTypeServiceNow is a PluginType enum value.

PluginTypeZendesk is a PluginType enum value.

QAppsControlModeDisabled is a QAppsControlMode enum value.

QAppsControlModeEnabled is a QAppsControlMode enum value.

ReadAccessTypeAllow is a ReadAccessType enum value.

ReadAccessTypeDeny is a ReadAccessType enum value.

ResponseScopeEnterpriseContentOnly is a ResponseScope enum value.

ResponseScopeExtendedKnowledgeEnabled is a ResponseScope enum value.

RetrieverStatusActive is a RetrieverStatus enum value.

RetrieverStatusCreating is a RetrieverStatus enum value.

RetrieverStatusFailed is a RetrieverStatus enum value.

RetrieverTypeKendraIndex is a RetrieverType enum value.

RetrieverTypeNativeIndex is a RetrieverType enum value.

RuleTypeContentBlockerRule is a RuleType enum value.

RuleTypeContentRetrievalRule is a RuleType enum value.

ServiceID is a unique identifier of a specific service.

Name of service.

StatusDisabled is a Status enum value.

StatusEnabled is a Status enum value.

StringAttributeValueBoostingLevelHigh is a StringAttributeValueBoostingLevel enum value.

StringAttributeValueBoostingLevelLow is a StringAttributeValueBoostingLevel enum value.

StringAttributeValueBoostingLevelMedium is a StringAttributeValueBoostingLevel enum value.

StringAttributeValueBoostingLevelVeryHigh is a StringAttributeValueBoostingLevel enum value.

ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value.

ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value.

ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value.

WebExperienceSamplePromptsControlModeDisabled is a WebExperienceSamplePromptsControlMode enum value.

WebExperienceSamplePromptsControlModeEnabled is a WebExperienceSamplePromptsControlMode enum value.

WebExperienceStatusActive is a WebExperienceStatus enum value.

WebExperienceStatusCreating is a WebExperienceStatus enum value.

WebExperienceStatusDeleting is a WebExperienceStatus enum value.

WebExperienceStatusFailed is a WebExperienceStatus enum value.

WebExperienceStatusPendingAuthConfig is a WebExperienceStatus enum value.

Used to configure access permissions for a document.

A list of principals.

You don't have access to perform this action.

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation.

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation.

A user input field in an plugin action review payload.

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.

Contains details about the OpenAPI schema for a custom plugin.

Summary information for an Amazon Q Business application.

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

The creator mode specific admin controls configured for an Amazon Q Business application.

A file directly uploaded into a web experience chat.

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

The details of a file uploaded during chat.

Configuration information for the file upload during chat feature.

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

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

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

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.

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

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

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

ChatEventStream provides the event stream handling for the Chat.

Configuration information for Amazon Q Business conversation modes.

ChatOutputStreamUnknownEvent provides a failsafe event for the ChatOutputStream group of events when an unknown event is received.

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

You are trying to perform an action that conflicts with the current status of your resource.

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

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

A conversation in an Amazon Q Business application.

Configuration information required to invoke chat in CREATOR_MODE.

Configuration information required to create a custom plugin.

A data source in an Amazon Q Business application.

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

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

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

Provides information on boosting DATE type document attributes.

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

A document in an Amazon Q Business application.

A document attribute or metadata field.

Provides information on boosting supported Amazon Q Business document attribute types.

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.

Configuration information for document attributes.

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

The value of a document attribute.

The contents of a document.

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

Provides the configuration information for altering document metadata and content during the document ingestion process.

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

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business.

The end of the streaming input for the Chat API.

Provides information about a data source sync error.

A failed file upload during web experience chat.

A list of documents that could not be removed from an Amazon Q Business index.

A list of users or sub groups that belong to a group.

Provides the details of a group's status.

Summary information for groups.

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

Summary information for your Amazon Q Business index.

Provides information about index capacity configuration.

Provides information about the number of documents in an index.

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

An issue occurred with the internal server used for your Amazon Q Business service.

Stores an Amazon Kendra index as a retriever.

You don't have permissions to perform the action because your license is inactive.

The sub groups that belong to a group.

The users that belong to a group.

A message in an Amazon Q Business web experience.

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

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

Configuration information for an Amazon Q Business index.

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

Provides information on boosting NUMBER type document attributes.

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

Configuration information about chat response personalization.

Information about an Amazon Q Business plugin and its configuration.

Authentication configuration information for an Amazon Q Business plugin.

Configuration information required to invoke chat in PLUGIN_MODE.

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

Provides information about a group associated with the principal.

Provides information about a user associated with a principal.

Configuration information about Amazon Q Apps.

QBusiness provides the API operation methods for making requests to QBusiness.

The resource you want to use doesn’t exist.

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

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

Guardrail rules for an Amazon Q Business application.

Provides configuration information about a rule.

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

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

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

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

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

Provides information on boosting STRING type document attributes.

Provides information on boosting STRING_LIST type document attributes.

A list of key/value pairs that identify an index, FAQ, or data source.

Provides information about text documents in an index.

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

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

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

The request was denied due to throttling.

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

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

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

The input doesn't meet the constraints set by the Amazon Q Business service.

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

Provides information for an Amazon Q Business web experience.

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

ChatInputStreamEvent groups together all EventStream events writes for ChatInputStream.

ChatInputStreamWriter provides the interface for writing events to the stream.

ChatOutputStreamEvent groups together all EventStream events writes for ChatOutputStream.

ChatOutputStreamReader provides the interface for reading to the stream.