qbusiness

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

type BatchDeleteDocumentInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// Documents deleted from the Amazon Q Business index.
	//
	// This member is required.
	Documents []types.DeleteDocument

	// The identifier of the Amazon Q Business index that contains the documents to
	// delete.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data source sync during which the documents were deleted.
	DataSourceSyncId *string
	// contains filtered or unexported fields
}

type BatchDeleteDocumentOutput struct {

	// A list of documents that couldn't be removed from the Amazon Q Business index.
	// Each entry contains an error message that indicates why the document couldn't be
	// removed from the index.
	FailedDocuments []types.FailedDocument

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchPutDocumentInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// One or more documents to add to the index.
	//
	// This member is required.
	Documents []types.Document

	// The identifier of the Amazon Q Business index to add the documents to.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data source sync during which the documents were added.
	DataSourceSyncId *string

	// The Amazon Resource Name (ARN) of an IAM role with permission to access your S3
	// bucket.
	RoleArn *string
	// contains filtered or unexported fields
}

type BatchPutDocumentOutput struct {

	// A list of documents that were not added to the Amazon Q Business index because
	// the document failed a validation check. Each document contains an error message
	// that indicates why the document couldn't be added to the index.
	FailedDocuments []types.FailedDocument

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ChatSyncInput struct {

	// The identifier of the Amazon Q Business application linked to the Amazon Q
	// Business conversation.
	//
	// This member is required.
	ApplicationId *string

	// A request from an end user to perform an Amazon Q Business plugin action.
	ActionExecution *types.ActionExecution

	// A list of files uploaded directly during chat. You can upload a maximum of 5
	// files of upto 10 MB each.
	Attachments []types.AttachmentInput

	// Enables filtering of Amazon Q Business web experience responses based on
	// document attributes or metadata fields.
	AttributeFilter *types.AttributeFilter

	// The chat modes available in an Amazon Q Business web experience.
	//   - RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application.
	//   When this mode is enabled, Amazon Q Business generates responses only from data
	//   sources connected to an Amazon Q Business application.
	//   - CREATOR_MODE - By selecting this mode, users can choose to generate
	//   responses only from the LLM knowledge, without consulting connected data
	//   sources, for a chat request.
	//   - PLUGIN_MODE - By selecting this mode, users can choose to use plugins in
	//   chat.
	// For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html)
	// , Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html)
	// , and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope)
	// .
	ChatMode types.ChatMode

	// The chat mode configuration for an Amazon Q Business application.
	ChatModeConfiguration types.ChatModeConfiguration

	// A token that you provide to identify a chat request.
	ClientToken *string

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string

	// The identifier of the previous end user text input message in a conversation.
	ParentMessageId *string

	// The groups that a user associated with the chat input belongs to.
	UserGroups []string

	// The identifier of the user attached to the chat input.
	UserId *string

	// A end user message in a conversation.
	UserMessage *string
	// contains filtered or unexported fields
}

type ChatSyncOutput struct {

	// A request from Amazon Q Business to the end user for information Amazon Q
	// Business needs to successfully complete a requested plugin action.
	ActionReview *types.ActionReview

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string

	// A list of files which failed to upload during chat.
	FailedAttachments []types.AttachmentOutput

	// The source documents used to generate the conversation response.
	SourceAttributions []*types.SourceAttribution

	// An AI-generated message in a conversation.
	SystemMessage *string

	// The identifier of an Amazon Q Business AI generated message within the
	// conversation.
	SystemMessageId *string

	// The identifier of an Amazon Q Business end user text input message within the
	// conversation.
	UserMessageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client struct {
	// contains filtered or unexported fields
}

type CreateApplicationInput struct {

	// A name for the Amazon Q Business application.
	//
	// This member is required.
	DisplayName *string

	// The Amazon Resource Name (ARN) of an IAM role with permissions to access your
	// Amazon CloudWatch logs and metrics.
	//
	// This member is required.
	RoleArn *string

	// An option to allow end users to upload files directly during chat.
	AttachmentsConfiguration *types.AttachmentsConfiguration

	// A token that you provide to identify the request to create your Amazon Q
	// Business application.
	ClientToken *string

	// A description for the Amazon Q Business application.
	Description *string

	// The identifier of the KMS key that is used to encrypt your data. Amazon Q
	// Business doesn't support asymmetric keys.
	EncryptionConfiguration *types.EncryptionConfiguration

	// The Amazon Resource Name (ARN) of the IAM Identity Center instance you are
	// either creating for—or connecting to—your Amazon Q Business application.
	IdentityCenterInstanceArn *string

	// A list of key-value pairs that identify or categorize your Amazon Q Business
	// application. You can also use tags to help control access to the application.
	// Tag keys and values can consist of Unicode letters, digits, white space, and any
	// of the following symbols: _ . : / = + - @.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application.
	ApplicationArn *string

	// The identifier of the Amazon Q Business application.
	ApplicationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDataSourceInput struct {

	// The identifier of the Amazon Q Business application the data source will be
	// attached to.
	//
	// This member is required.
	ApplicationId *string

	// Configuration information to connect to your data source repository. For
	// configuration templates for your specific data source, see Supported connectors (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html)
	// .
	//
	// This member is required.
	Configuration document.Interface

	// A name for the data source connector.
	//
	// This member is required.
	DisplayName *string

	// The identifier of the index that you want to use with the data source connector.
	//
	// This member is required.
	IndexId *string

	// A token you provide to identify a request to create a data source connector.
	// Multiple calls to the CreateDataSource API with the same client token will
	// create only one data source connector.
	ClientToken *string

	// A description for the data source connector.
	Description *string

	// Provides the configuration information for altering document metadata and
	// content during the document ingestion process. For more information, see Custom
	// document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html)
	// .
	DocumentEnrichmentConfiguration *types.DocumentEnrichmentConfiguration

	// The Amazon Resource Name (ARN) of an IAM role with permission to access the
	// data source and required resources.
	RoleArn *string

	// Sets the frequency for Amazon Q Business to check the documents in your data
	// source repository and update your index. If you don't set a schedule, Amazon Q
	// Business won't periodically update the index. Specify a cron- format schedule
	// string or an empty string to indicate that the index is updated on demand. You
	// can't specify the Schedule parameter when the Type parameter is set to CUSTOM .
	// If you do, you receive a ValidationException exception.
	SyncSchedule *string

	// A list of key-value pairs that identify or categorize the data source
	// connector. You can also use tags to help control access to the data source
	// connector. Tag keys and values can consist of Unicode letters, digits, white
	// space, and any of the following symbols: _ . : / = + - @.
	Tags []types.Tag

	// Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
	// to your data source. For more information, see Using Amazon VPC with Amazon Q
	// Business connectors (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html)
	// .
	VpcConfiguration *types.DataSourceVpcConfiguration
	// contains filtered or unexported fields
}

type CreateDataSourceOutput struct {

	// The Amazon Resource Name (ARN) of a data source in an Amazon Q Business
	// application.
	DataSourceArn *string

	// The identifier of the data source connector.
	DataSourceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateIndexInput struct {

	// The identifier of the Amazon Q Business application using the index.
	//
	// This member is required.
	ApplicationId *string

	// A name for the Amazon Q Business index.
	//
	// This member is required.
	DisplayName *string

	// The capacity units you want to provision for your index. You can add and remove
	// capacity to fit your usage needs.
	CapacityConfiguration *types.IndexCapacityConfiguration

	// A token that you provide to identify the request to create an index. Multiple
	// calls to the CreateIndex API with the same client token will create only one
	// index.
	ClientToken *string

	// A description for the Amazon Q Business index.
	Description *string

	// A list of key-value pairs that identify or categorize the index. You can also
	// use tags to help control access to the index. Tag keys and values can consist of
	// Unicode letters, digits, white space, and any of the following symbols: _ . : /
	// = + - @.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateIndexOutput struct {

	// The Amazon Resource Name (ARN) of an Amazon Q Business index.
	IndexArn *string

	// The identifier for the Amazon Q Business index.
	IndexId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePluginInput struct {

	// The identifier of the application that will contain the plugin.
	//
	// This member is required.
	ApplicationId *string

	// Authentication configuration information for an Amazon Q Business plugin.
	//
	// This member is required.
	AuthConfiguration types.PluginAuthConfiguration

	// A the name for your plugin.
	//
	// This member is required.
	DisplayName *string

	// The source URL used for plugin configuration.
	//
	// This member is required.
	ServerUrl *string

	// The type of plugin you want to create.
	//
	// This member is required.
	Type types.PluginType

	// A token that you provide to identify the request to create your Amazon Q
	// Business plugin.
	ClientToken *string

	// A list of key-value pairs that identify or categorize the data source
	// connector. You can also use tags to help control access to the data source
	// connector. Tag keys and values can consist of Unicode letters, digits, white
	// space, and any of the following symbols: _ . : / = + - @.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreatePluginOutput struct {

	// The Amazon Resource Name (ARN) of a plugin.
	PluginArn *string

	// The identifier of the plugin created.
	PluginId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRetrieverInput struct {

	// The identifier of your Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// Provides information on how the retriever used for your Amazon Q Business
	// application is configured.
	//
	// This member is required.
	Configuration types.RetrieverConfiguration

	// The name of your retriever.
	//
	// This member is required.
	DisplayName *string

	// The type of retriever you are using.
	//
	// This member is required.
	Type types.RetrieverType

	// A token that you provide to identify the request to create your Amazon Q
	// Business application retriever.
	ClientToken *string

	// The ARN of an IAM role used by Amazon Q Business to access the basic
	// authentication credentials stored in a Secrets Manager secret.
	RoleArn *string

	// A list of key-value pairs that identify or categorize the retriever. You can
	// also use tags to help control access to the retriever. Tag keys and values can
	// consist of Unicode letters, digits, white space, and any of the following
	// symbols: _ . : / = + - @.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRetrieverOutput struct {

	// The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
	RetrieverArn *string

	// The identifier of the retriever you are using.
	RetrieverId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateUserInput struct {

	// The identifier of the application for which the user mapping will be created.
	//
	// This member is required.
	ApplicationId *string

	// The user emails attached to a user mapping.
	//
	// This member is required.
	UserId *string

	// A token that you provide to identify the request to create your Amazon Q
	// Business user mapping.
	ClientToken *string

	// The list of user aliases in the mapping.
	UserAliases []types.UserAlias
	// contains filtered or unexported fields
}

type CreateUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWebExperienceInput struct {

	// The identifier of the Amazon Q Business web experience.
	//
	// This member is required.
	ApplicationId *string

	// A token you provide to identify a request to create an Amazon Q Business web
	// experience.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the service role attached to your web
	// experience.
	RoleArn *string

	// Determines whether sample prompts are enabled in the web experience for an end
	// user.
	SamplePromptsControlMode types.WebExperienceSamplePromptsControlMode

	// A subtitle to personalize your Amazon Q Business web experience.
	Subtitle *string

	// A list of key-value pairs that identify or categorize your Amazon Q Business
	// web experience. You can also use tags to help control access to the web
	// experience. Tag keys and values can consist of Unicode letters, digits, white
	// space, and any of the following symbols: _ . : / = + - @.
	Tags []types.Tag

	// The title for your Amazon Q Business web experience.
	Title *string

	// The customized welcome message for end users of an Amazon Q Business web
	// experience.
	WelcomeMessage *string
	// contains filtered or unexported fields
}

type CreateWebExperienceOutput struct {

	// The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
	WebExperienceArn *string

	// The identifier of the Amazon Q Business web experience.
	WebExperienceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteApplicationInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string
	// contains filtered or unexported fields
}

type DeleteApplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteChatControlsConfigurationInput struct {

	// The identifier of the application the chat controls have been configured for.
	//
	// This member is required.
	ApplicationId *string
	// contains filtered or unexported fields
}

type DeleteChatControlsConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConversationInput struct {

	// The identifier of the Amazon Q Business application associated with the
	// conversation.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business web experience conversation being
	// deleted.
	//
	// This member is required.
	ConversationId *string

	// The identifier of the user who is deleting the conversation.
	UserId *string
	// contains filtered or unexported fields
}

type DeleteConversationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataSourceInput struct {

	// The identifier of the Amazon Q Business application used with the data source
	// connector.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the data source connector that you want to delete.
	//
	// This member is required.
	DataSourceId *string

	// The identifier of the index used with the data source connector.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DeleteDataSourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGroupInput struct {

	// The identifier of the application in which the group mapping belongs.
	//
	// This member is required.
	ApplicationId *string

	// The name of the group you want to delete.
	//
	// This member is required.
	GroupName *string

	// The identifier of the index you want to delete the group from.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data source linked to the group A group can be tied to
	// multiple data sources. You can delete a group from accessing documents in a
	// certain data source. For example, the groups "Research", "Engineering", and
	// "Sales and Marketing" are all tied to the company's documents stored in the data
	// sources Confluence and Salesforce. You want to delete "Research" and
	// "Engineering" groups from Salesforce, so that these groups cannot access
	// customer-related documents stored in Salesforce. Only "Sales and Marketing"
	// should access documents in the Salesforce data source.
	DataSourceId *string
	// contains filtered or unexported fields
}

type DeleteGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteIndexInput struct {

	// The identifier of the Amazon Q Business application the Amazon Q Business index
	// is linked to.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business index.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DeleteIndexOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePluginInput struct {

	// The identifier the application attached to the Amazon Q Business plugin.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the plugin being deleted.
	//
	// This member is required.
	PluginId *string
	// contains filtered or unexported fields
}

type DeletePluginOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRetrieverInput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the retriever being deleted.
	//
	// This member is required.
	RetrieverId *string
	// contains filtered or unexported fields
}

type DeleteRetrieverOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUserInput struct {

	// The identifier of the application from which the user is being deleted.
	//
	// This member is required.
	ApplicationId *string

	// The user email being deleted.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWebExperienceInput struct {

	// The identifier of the Amazon Q Business application linked to the Amazon Q
	// Business web experience.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business web experience being deleted.
	//
	// This member is required.
	WebExperienceId *string
	// contains filtered or unexported fields
}

type DeleteWebExperienceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

type EndpointResolverOptions = internalendpoints.Options

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

type GetApplicationInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string
	// contains filtered or unexported fields
}

type GetApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application.
	ApplicationArn *string

	// The identifier of the Amazon Q Business application.
	ApplicationId *string

	// Settings for whether end users can upload files directly during chat.
	AttachmentsConfiguration *types.AppliedAttachmentsConfiguration

	// The Unix timestamp when the Amazon Q Business application was last updated.
	CreatedAt *time.Time

	// A description for the Amazon Q Business application.
	Description *string

	// The name of the Amazon Q Business application.
	DisplayName *string

	// The identifier of the Amazon Web Services KMS key that is used to encrypt your
	// data. Amazon Q Business doesn't support asymmetric keys.
	EncryptionConfiguration *types.EncryptionConfiguration

	// If the Status field is set to ERROR , the ErrorMessage field contains a
	// description of the error that caused the synchronization to fail.
	Error *types.ErrorDetail

	// The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached
	// to your Amazon Q Business application.
	IdentityCenterApplicationArn *string

	// The Amazon Resource Name (ARN) of the IAM with permissions to access your
	// CloudWatch logs and metrics.
	RoleArn *string

	// The status of the Amazon Q Business application.
	Status types.ApplicationStatus

	// The Unix timestamp when the Amazon Q Business application was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetChatControlsConfigurationAPIClient interface {
	GetChatControlsConfiguration(context.Context, *GetChatControlsConfigurationInput, ...func(*Options)) (*GetChatControlsConfigurationOutput, error)
}

type GetChatControlsConfigurationInput struct {

	// The identifier of the application for which the chat controls are configured.
	//
	// This member is required.
	ApplicationId *string

	// The maximum number of configured chat controls to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business chat
	// controls configured.
	NextToken *string
	// contains filtered or unexported fields
}

type GetChatControlsConfigurationOutput struct {

	// The phrases blocked from chat by your chat control configuration.
	BlockedPhrases *types.BlockedPhrasesConfiguration

	// The configuration details for CREATOR_MODE .
	CreatorModeConfiguration *types.AppliedCreatorModeConfiguration

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business chat
	// controls configured.
	NextToken *string

	// The response scope configured for a Amazon Q Business application. This
	// determines whether your application uses its retrieval augmented generation
	// (RAG) system to generate answers only from your enterprise data, or also uses
	// the large language models (LLM) knowledge to respons to end user questions in
	// chat.
	ResponseScope types.ResponseScope

	// The topic specific controls configured for a Amazon Q Business application.
	TopicConfigurations []types.TopicConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetChatControlsConfigurationPaginator struct {
	// contains filtered or unexported fields
}

type GetChatControlsConfigurationPaginatorOptions struct {
	// The maximum number of configured chat controls to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type GetDataSourceInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the data source connector.
	//
	// This member is required.
	DataSourceId *string

	// The identfier of the index used with the data source connector.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type GetDataSourceOutput struct {

	// The identifier of the Amazon Q Business application.
	ApplicationId *string

	// The details of how the data source connector is configured.
	Configuration document.Interface

	// The Unix timestamp when the data source connector was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the data source.
	DataSourceArn *string

	// The identifier of the data source connector.
	DataSourceId *string

	// The description for the data source connector.
	Description *string

	// The name for the data source connector.
	DisplayName *string

	// Provides the configuration information for altering document metadata and
	// content during the document ingestion process. For more information, see Custom
	// document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html)
	// .
	DocumentEnrichmentConfiguration *types.DocumentEnrichmentConfiguration

	// When the Status field value is FAILED , the ErrorMessage field contains a
	// description of the error that caused the data source connector to fail.
	Error *types.ErrorDetail

	// The identifier of the index linked to the data source connector.
	IndexId *string

	// The Amazon Resource Name (ARN) of the role with permission to access the data
	// source and required resources.
	RoleArn *string

	// The current status of the data source connector. When the Status field value is
	// FAILED , the ErrorMessage field contains a description of the error that caused
	// the data source connector to fail.
	Status types.DataSourceStatus

	// The schedule for Amazon Q Business to update the index.
	SyncSchedule *string

	// The type of the data source connector. For example, S3 .
	Type *string

	// The Unix timestamp when the data source connector was last updated.
	UpdatedAt *time.Time

	// Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
	// to your data source.
	VpcConfiguration *types.DataSourceVpcConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGroupInput struct {

	// The identifier of the application id the group is attached to.
	//
	// This member is required.
	ApplicationId *string

	// The name of the group.
	//
	// This member is required.
	GroupName *string

	// The identifier of the index the group is attached to.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data source the group is attached to.
	DataSourceId *string
	// contains filtered or unexported fields
}

type GetGroupOutput struct {

	// The current status of the group.
	Status *types.GroupStatusDetail

	// The status history of the group.
	StatusHistory []types.GroupStatusDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetIndexInput struct {

	// The identifier of the Amazon Q Business application connected to the index.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business index you want information on.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type GetIndexOutput struct {

	// The identifier of the Amazon Q Business application associated with the index.
	ApplicationId *string

	// The storage capacity units chosen for your Amazon Q Business index.
	CapacityConfiguration *types.IndexCapacityConfiguration

	// The Unix timestamp when the Amazon Q Business index was created.
	CreatedAt *time.Time

	// The description for the Amazon Q Business index.
	Description *string

	// The name of the Amazon Q Business index.
	DisplayName *string

	// Configuration information for document attributes or metadata. Document
	// metadata are fields associated with your documents. For example, the company
	// department name associated with each document. For more information, see
	// Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes)
	// .
	DocumentAttributeConfigurations []types.DocumentAttributeConfiguration

	// When the Status field value is FAILED , the ErrorMessage field contains a
	// message that explains why.
	Error *types.ErrorDetail

	// The Amazon Resource Name (ARN) of the Amazon Q Business index.
	IndexArn *string

	// The identifier of the Amazon Q Business index.
	IndexId *string

	// Provides information about the number of documents indexed.
	IndexStatistics *types.IndexStatistics

	// The current status of the index. When the value is ACTIVE , the index is ready
	// for use. If the Status field value is FAILED , the ErrorMessage field contains
	// a message that explains why.
	Status types.IndexStatus

	// The Unix timestamp when the Amazon Q Business index was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPluginInput struct {

	// The identifier of the application which contains the plugin.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the plugin.
	//
	// This member is required.
	PluginId *string
	// contains filtered or unexported fields
}

type GetPluginOutput struct {

	// The identifier of the application which contains the plugin.
	ApplicationId *string

	// Authentication configuration information for an Amazon Q Business plugin.
	AuthConfiguration types.PluginAuthConfiguration

	// The timestamp for when the plugin was created.
	CreatedAt *time.Time

	// The name of the plugin.
	DisplayName *string

	// The Amazon Resource Name (ARN) of the role with permission to access resources
	// needed to create the plugin.
	PluginArn *string

	// The identifier of the plugin.
	PluginId *string

	// The source URL used for plugin configuration.
	ServerUrl *string

	// The current state of the plugin.
	State types.PluginState

	// The type of the plugin.
	Type types.PluginType

	// The timestamp for when the plugin was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRetrieverInput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the retriever.
	//
	// This member is required.
	RetrieverId *string
	// contains filtered or unexported fields
}

type GetRetrieverOutput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	ApplicationId *string

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

	// The Unix timestamp when the retriever was created.
	CreatedAt *time.Time

	// The name of the retriever.
	DisplayName *string

	// The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
	RetrieverArn *string

	// The identifier of the retriever.
	RetrieverId *string

	// The Amazon Resource Name (ARN) of the role with the permission to access the
	// retriever and required resources.
	RoleArn *string

	// The status of the retriever.
	Status types.RetrieverStatus

	// The type of the retriever.
	Type types.RetrieverType

	// The Unix timestamp when the retriever was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetUserInput struct {

	// The identifier of the application connected to the user.
	//
	// This member is required.
	ApplicationId *string

	// The user email address attached to the user.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type GetUserOutput struct {

	// A list of user aliases attached to a user.
	UserAliases []types.UserAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWebExperienceInput struct {

	// The identifier of the Amazon Q Business application linked to the web
	// experience.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business web experience.
	//
	// This member is required.
	WebExperienceId *string
	// contains filtered or unexported fields
}

type GetWebExperienceOutput struct {

	// The identifier of the Amazon Q Business application linked to the web
	// experience.
	ApplicationId *string

	// The authentication configuration information for your Amazon Q Business web
	// experience.
	AuthenticationConfiguration types.WebExperienceAuthConfiguration

	// The Unix timestamp when the retriever was created.
	CreatedAt *time.Time

	// The endpoint of your Amazon Q Business web experience.
	DefaultEndpoint *string

	// When the Status field value is FAILED , the ErrorMessage field contains a
	// description of the error that caused the data source connector to fail.
	Error *types.ErrorDetail

	// The Amazon Resource Name (ARN) of the service role attached to your web
	// experience.
	RoleArn *string

	// Determines whether sample prompts are enabled in the web experience for an end
	// user.
	SamplePromptsControlMode types.WebExperienceSamplePromptsControlMode

	// The current status of the Amazon Q Business web experience. When the Status
	// field value is FAILED , the ErrorMessage field contains a description of the
	// error that caused the data source connector to fail.
	Status types.WebExperienceStatus

	// The subtitle for your Amazon Q Business web experience.
	Subtitle *string

	// The title for your Amazon Q Business web experience.
	Title *string

	// The Unix timestamp when the data source connector was last updated.
	UpdatedAt *time.Time

	// The Amazon Resource Name (ARN) of the role with the permission to access the
	// Amazon Q Business web experience and required resources.
	WebExperienceArn *string

	// The identifier of the Amazon Q Business web experience.
	WebExperienceId *string

	// The customized welcome message for end users of an Amazon Q Business web
	// experience.
	WelcomeMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

type ListApplicationsAPIClient interface {
	ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}

type ListApplicationsInput struct {

	// The maximum number of Amazon Q Business applications to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business
	// applications.
	NextToken *string
	// contains filtered or unexported fields
}

type ListApplicationsOutput struct {

	// An array of summary information on the configuration of one or more Amazon Q
	// Business applications.
	Applications []types.Application

	// If the response is truncated, Amazon Q Business returns this token. You can use
	// this token in a subsequent request to retrieve the next set of applications.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListApplicationsPaginator struct {
	// contains filtered or unexported fields
}

type ListApplicationsPaginatorOptions struct {
	// The maximum number of Amazon Q Business applications to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListConversationsAPIClient interface {
	ListConversations(context.Context, *ListConversationsInput, ...func(*Options)) (*ListConversationsOutput, error)
}

type ListConversationsInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// The maximum number of Amazon Q Business conversations to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business
	// conversations.
	NextToken *string

	// The identifier of the user involved in the Amazon Q Business web experience
	// conversation.
	UserId *string
	// contains filtered or unexported fields
}

type ListConversationsOutput struct {

	// An array of summary information on the configuration of one or more Amazon Q
	// Business web experiences.
	Conversations []types.Conversation

	// If the response is truncated, Amazon Q Business returns this token, which you
	// can use in a later request to list the next set of messages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListConversationsPaginator struct {
	// contains filtered or unexported fields
}

type ListConversationsPaginatorOptions struct {
	// The maximum number of Amazon Q Business conversations to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListDataSourceSyncJobsAPIClient interface {
	ListDataSourceSyncJobs(context.Context, *ListDataSourceSyncJobsInput, ...func(*Options)) (*ListDataSourceSyncJobsOutput, error)
}

type ListDataSourceSyncJobsInput struct {

	// The identifier of the Amazon Q Business application connected to the data
	// source.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the data source connector.
	//
	// This member is required.
	DataSourceId *string

	// The identifier of the index used with the Amazon Q Business data source
	// connector.
	//
	// This member is required.
	IndexId *string

	// The end time of the data source connector sync.
	EndTime *time.Time

	// The maximum number of synchronization jobs to return in the response.
	MaxResults *int32

	// If the maxResults response was incpmplete because there is more data to
	// retriever, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of responses.
	NextToken *string

	// The start time of the data source connector sync.
	StartTime *time.Time

	// Only returns synchronization jobs with the Status field equal to the specified
	// status.
	StatusFilter types.DataSourceSyncJobStatus
	// contains filtered or unexported fields
}

type ListDataSourceSyncJobsOutput struct {

	// A history of synchronization jobs for the data source connector.
	History []types.DataSourceSyncJob

	// If the response is truncated, Amazon Q Business returns this token. You can use
	// this token in any subsequent request to retrieve the next set of jobs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSourceSyncJobsPaginator struct {
	// contains filtered or unexported fields
}

type ListDataSourceSyncJobsPaginatorOptions struct {
	// The maximum number of synchronization jobs to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListDataSourcesAPIClient interface {
	ListDataSources(context.Context, *ListDataSourcesInput, ...func(*Options)) (*ListDataSourcesOutput, error)
}

type ListDataSourcesInput struct {

	// The identifier of the Amazon Q Business application linked to the data source
	// connectors.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the index used with one or more data source connectors.
	//
	// This member is required.
	IndexId *string

	// The maximum number of data source connectors to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business data
	// source connectors.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDataSourcesOutput struct {

	// An array of summary information for one or more data source connector.
	DataSources []types.DataSource

	// If the response is truncated, Amazon Q Business returns this token. You can use
	// this token in a subsequent request to retrieve the next set of data source
	// connectors.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSourcesPaginator struct {
	// contains filtered or unexported fields
}

type ListDataSourcesPaginatorOptions struct {
	// The maximum number of data source connectors to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListDocumentsAPIClient interface {
	ListDocuments(context.Context, *ListDocumentsInput, ...func(*Options)) (*ListDocumentsOutput, error)
}

type ListDocumentsInput struct {

	// The identifier of the application id the documents are attached to.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the index the documents are attached to.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data sources the documents are attached to.
	DataSourceIds []string

	// The maximum number of documents to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of documents.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDocumentsOutput struct {

	// A list of document details.
	DocumentDetailList []types.DocumentDetails

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of documents.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDocumentsPaginator struct {
	// contains filtered or unexported fields
}

type ListDocumentsPaginatorOptions struct {
	// The maximum number of documents to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListGroupsAPIClient interface {
	ListGroups(context.Context, *ListGroupsInput, ...func(*Options)) (*ListGroupsOutput, error)
}

type ListGroupsInput struct {

	// The identifier of the application for getting a list of groups mapped to users.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the index for getting a list of groups mapped to users.
	//
	// This member is required.
	IndexId *string

	// The timestamp identifier used for the latest PUT or DELETE action for mapping
	// users to their groups.
	//
	// This member is required.
	UpdatedEarlierThan *time.Time

	// The identifier of the data source for getting a list of groups mapped to users.
	DataSourceId *string

	// The maximum number of returned groups that are mapped to users.
	MaxResults *int32

	// If the previous response was incomplete (because there is more data to
	// retrieve), Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of groups that are mapped to
	// users.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupsOutput struct {

	// Summary information for list of groups that are mapped to users.
	Items []types.GroupSummary

	// If the response is truncated, Amazon Q Business returns this token that you can
	// use in the subsequent request to retrieve the next set of groups that are mapped
	// to users.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupsPaginator struct {
	// contains filtered or unexported fields
}

type ListGroupsPaginatorOptions struct {
	// The maximum number of returned groups that are mapped to users.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListIndicesAPIClient interface {
	ListIndices(context.Context, *ListIndicesInput, ...func(*Options)) (*ListIndicesOutput, error)
}

type ListIndicesInput struct {

	// The identifier of the Amazon Q Business application connected to the index.
	//
	// This member is required.
	ApplicationId *string

	// The maximum number of indices to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business indices.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIndicesOutput struct {

	// An array of information on the items in one or more indexes.
	Indices []types.Index

	// If the response is truncated, Amazon Q Business returns this token that you can
	// use in the subsequent request to retrieve the next set of indexes.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIndicesPaginator struct {
	// contains filtered or unexported fields
}

type ListIndicesPaginatorOptions struct {
	// The maximum number of indices to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListMessagesAPIClient interface {
	ListMessages(context.Context, *ListMessagesInput, ...func(*Options)) (*ListMessagesOutput, error)
}

type ListMessagesInput struct {

	// The identifier for the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business web experience conversation.
	//
	// This member is required.
	ConversationId *string

	// The maximum number of messages to return.
	MaxResults *int32

	// If the number of retrievers returned exceeds maxResults , Amazon Q Business
	// returns a next token as a pagination token to retrieve the next set of messages.
	NextToken *string

	// The identifier of the user involved in the Amazon Q Business web experience
	// conversation.
	UserId *string
	// contains filtered or unexported fields
}

type ListMessagesOutput struct {

	// An array of information on one or more messages.
	Messages []types.Message

	// If the response is truncated, Amazon Q Business returns this token, which you
	// can use in a later request to list the next set of messages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMessagesPaginator struct {
	// contains filtered or unexported fields
}

type ListMessagesPaginatorOptions struct {
	// The maximum number of messages to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListPluginsAPIClient interface {
	ListPlugins(context.Context, *ListPluginsInput, ...func(*Options)) (*ListPluginsOutput, error)
}

type ListPluginsInput struct {

	// The identifier of the application the plugin is attached to.
	//
	// This member is required.
	ApplicationId *string

	// The maximum number of documents to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of plugins.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPluginsOutput struct {

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of plugins.
	NextToken *string

	// Information about a configured plugin.
	Plugins []types.Plugin

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPluginsPaginator struct {
	// contains filtered or unexported fields
}

type ListPluginsPaginatorOptions struct {
	// The maximum number of documents to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListRetrieversAPIClient interface {
	ListRetrievers(context.Context, *ListRetrieversInput, ...func(*Options)) (*ListRetrieversOutput, error)
}

type ListRetrieversInput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	//
	// This member is required.
	ApplicationId *string

	// The maximum number of retrievers returned.
	MaxResults *int32

	// If the number of retrievers returned exceeds maxResults , Amazon Q Business
	// returns a next token as a pagination token to retrieve the next set of
	// retrievers.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRetrieversOutput struct {

	// If the response is truncated, Amazon Q Business returns this token, which you
	// can use in a later request to list the next set of retrievers.
	NextToken *string

	// An array of summary information for one or more retrievers.
	Retrievers []types.Retriever

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRetrieversPaginator struct {
	// contains filtered or unexported fields
}

type ListRetrieversPaginatorOptions struct {
	// The maximum number of retrievers returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application or data
	// source to get a list of tags for.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput struct {

	// A list of tags associated with the Amazon Q Business application or data source.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWebExperiencesAPIClient interface {
	ListWebExperiences(context.Context, *ListWebExperiencesInput, ...func(*Options)) (*ListWebExperiencesOutput, error)
}

type ListWebExperiencesInput struct {

	// The identifier of the Amazon Q Business application linked to the listed web
	// experiences.
	//
	// This member is required.
	ApplicationId *string

	// The maximum number of Amazon Q Business Web Experiences to return.
	MaxResults *int32

	// If the maxResults response was incomplete because there is more data to
	// retrieve, Amazon Q Business returns a pagination token in the response. You can
	// use this pagination token to retrieve the next set of Amazon Q Business
	// conversations.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWebExperiencesOutput struct {

	// If the response is truncated, Amazon Q Business returns this token, which you
	// can use in a later request to list the next set of messages.
	NextToken *string

	// An array of summary information for one or more Amazon Q Business experiences.
	WebExperiences []types.WebExperience

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWebExperiencesPaginator struct {
	// contains filtered or unexported fields
}

type ListWebExperiencesPaginatorOptions struct {
	// The maximum number of Amazon Q Business Web Experiences to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

type PutFeedbackInput struct {

	// The identifier of the application associated with the feedback.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the conversation the feedback is attached to.
	//
	// This member is required.
	ConversationId *string

	// The identifier of the chat message that the feedback was given for.
	//
	// This member is required.
	MessageId *string

	// The timestamp for when the feedback was recorded.
	MessageCopiedAt *time.Time

	// The feedback usefulness value given by the user to the chat message.
	MessageUsefulness *types.MessageUsefulnessFeedback

	// The identifier of the user giving the feedback.
	UserId *string
	// contains filtered or unexported fields
}

type PutFeedbackOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutGroupInput struct {

	// The identifier of the application in which the user and group mapping belongs.
	//
	// This member is required.
	ApplicationId *string

	// 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.
	//
	// This member is required.
	GroupMembers *types.GroupMembers

	// The list that contains your users or sub groups that belong the same group. For
	// example, the group "Company" includes the user "CEO" and the sub groups
	// "Research", "Engineering", and "Sales and Marketing". If you have more than 1000
	// users and/or sub groups for a single group, you need to provide the path to the
	// S3 file that lists your users and sub groups for a group. Your sub groups can
	// contain more than 1000 users, but the list of sub groups that belong to a group
	// (and/or users) must be no more than 1000.
	//
	// This member is required.
	GroupName *string

	// The identifier of the index in which you want to map users to their groups.
	//
	// This member is required.
	IndexId *string

	// The type of the group.
	//
	// This member is required.
	Type types.MembershipType

	// The identifier of the data source for which you want to map users to their
	// groups. This is useful if a group is tied to multiple data sources, but you only
	// want the group to access documents of a certain data source. For example, the
	// groups "Research", "Engineering", and "Sales and Marketing" are all tied to the
	// company's documents stored in the data sources Confluence and Salesforce.
	// However, "Sales and Marketing" team only needs access to customer-related
	// documents stored in Salesforce.
	DataSourceId *string
	// contains filtered or unexported fields
}

type PutGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

type StartDataSourceSyncJobInput struct {

	// The identifier of Amazon Q Business application the data source is connected to.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the data source connector.
	//
	// This member is required.
	DataSourceId *string

	// The identifier of the index used with the data source connector.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type StartDataSourceSyncJobOutput struct {

	// The identifier for a particular synchronization job.
	ExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopDataSourceSyncJobInput struct {

	// The identifier of the Amazon Q Business application that the data source is
	// connected to.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the data source connector.
	//
	// This member is required.
	DataSourceId *string

	// The identifier of the index used with the Amazon Q Business data source
	// connector.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type StopDataSourceSyncJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application or data
	// source to tag.
	//
	// This member is required.
	ResourceARN *string

	// A list of tag keys to add to the Amazon Q Business application or data source.
	// If a tag already exists, the existing value is replaced with the new value.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application, or data
	// source to remove the tag from.
	//
	// This member is required.
	ResourceARN *string

	// A list of tag keys to remove from the Amazon Q Business application or data
	// source. If a tag key does not exist on the resource, it is ignored.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateApplicationInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// An option to allow end users to upload files directly during chat.
	AttachmentsConfiguration *types.AttachmentsConfiguration

	// A description for the Amazon Q Business application.
	Description *string

	// A name for the Amazon Q Business application.
	DisplayName *string

	// An Amazon Web Services Identity and Access Management (IAM) role that gives
	// Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateApplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateChatControlsConfigurationInput struct {

	// The identifier of the application for which the chat controls are configured.
	//
	// This member is required.
	ApplicationId *string

	// The phrases blocked from chat by your chat control configuration.
	BlockedPhrasesConfigurationUpdate *types.BlockedPhrasesConfigurationUpdate

	// A token that you provide to identify the request to update a Amazon Q Business
	// application chat configuration.
	ClientToken *string

	// The configuration details for CREATOR_MODE .
	CreatorModeConfiguration *types.CreatorModeConfiguration

	// The response scope configured for your application. This determines whether
	// your application uses its retrieval augmented generation (RAG) system to
	// generate answers only from your enterprise data, or also uses the large language
	// models (LLM) knowledge to respons to end user questions in chat.
	ResponseScope types.ResponseScope

	// The configured topic specific chat controls you want to update.
	TopicConfigurationsToCreateOrUpdate []types.TopicConfiguration

	// The configured topic specific chat controls you want to delete.
	TopicConfigurationsToDelete []types.TopicConfiguration
	// contains filtered or unexported fields
}

type UpdateChatControlsConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSourceInput struct {

	// The identifier of the Amazon Q Business application the data source is attached
	// to.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the data source connector.
	//
	// This member is required.
	DataSourceId *string

	// The identifier of the index attached to the data source connector.
	//
	// This member is required.
	IndexId *string

	// Provides the configuration information for an Amazon Q Business data source.
	Configuration document.Interface

	// The description of the data source connector.
	Description *string

	// A name of the data source connector.
	DisplayName *string

	// Provides the configuration information for altering document metadata and
	// content during the document ingestion process. For more information, see Custom
	// document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html)
	// .
	DocumentEnrichmentConfiguration *types.DocumentEnrichmentConfiguration

	// The Amazon Resource Name (ARN) of an IAM role with permission to access the
	// data source and required resources.
	RoleArn *string

	// The chosen update frequency for your data source.
	SyncSchedule *string

	// Provides configuration information needed to connect to an Amazon VPC (Virtual
	// Private Cloud).
	VpcConfiguration *types.DataSourceVpcConfiguration
	// contains filtered or unexported fields
}

type UpdateDataSourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIndexInput struct {

	// The identifier of the Amazon Q Business application connected to the index.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business index.
	//
	// This member is required.
	IndexId *string

	// The storage capacity units you want to provision for your Amazon Q Business
	// index. You can add and remove capacity to fit your usage needs.
	CapacityConfiguration *types.IndexCapacityConfiguration

	// The description of the Amazon Q Business index.
	Description *string

	// The name of the Amazon Q Business index.
	DisplayName *string

	// Configuration information for document metadata or fields. Document metadata
	// are fields or attributes associated with your documents. For example, the
	// company department name associated with each document. For more information, see
	// Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes)
	// .
	DocumentAttributeConfigurations []types.DocumentAttributeConfiguration
	// contains filtered or unexported fields
}

type UpdateIndexOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePluginInput struct {

	// The identifier of the application the plugin is attached to.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the plugin.
	//
	// This member is required.
	PluginId *string

	// The authentication configuration the plugin is using.
	AuthConfiguration types.PluginAuthConfiguration

	// The name of the plugin.
	DisplayName *string

	// The source URL used for plugin configuration.
	ServerUrl *string

	// The status of the plugin.
	State types.PluginState
	// contains filtered or unexported fields
}

type UpdatePluginOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRetrieverInput struct {

	// The identifier of your Amazon Q Business application.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of your retriever.
	//
	// This member is required.
	RetrieverId *string

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

	// The name of your retriever.
	DisplayName *string

	// The Amazon Resource Name (ARN) of an IAM role with permission to access the
	// retriever and required resources.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateRetrieverOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateUserInput struct {

	// The identifier of the application the user is attached to.
	//
	// This member is required.
	ApplicationId *string

	// The email id attached to the user.
	//
	// This member is required.
	UserId *string

	// The user aliases attached to the user id that are to be deleted.
	UserAliasesToDelete []types.UserAlias

	// The user aliases attached to the user id that are to be updated.
	UserAliasesToUpdate []types.UserAlias
	// contains filtered or unexported fields
}

type UpdateUserOutput struct {

	// The user aliases that have been to be added to a user id.
	UserAliasesAdded []types.UserAlias

	// The user aliases that have been deleted from a user id.
	UserAliasesDeleted []types.UserAlias

	// The user aliases attached to a user id that have been updated.
	UserAliasesUpdated []types.UserAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWebExperienceInput struct {

	// The identifier of the Amazon Q Business application attached to the web
	// experience.
	//
	// This member is required.
	ApplicationId *string

	// The identifier of the Amazon Q Business web experience.
	//
	// This member is required.
	WebExperienceId *string

	// The authentication configuration of the Amazon Q Business web experience.
	AuthenticationConfiguration types.WebExperienceAuthConfiguration

	// Determines whether sample prompts are enabled in the web experience for an end
	// user.
	SamplePromptsControlMode types.WebExperienceSamplePromptsControlMode

	// The subtitle of the Amazon Q Business web experience.
	Subtitle *string

	// The title of the Amazon Q Business web experience.
	Title *string

	// A customized welcome message for an end user in an Amazon Q Business web
	// experience.
	WelcomeMessage *string
	// contains filtered or unexported fields
}

type UpdateWebExperienceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}