qbusiness

package module
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 47 Imported by: 0

Documentation

Overview

Package qbusiness provides the API client, operations, and parameter types for QBusiness.

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide.

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Businessin the Amazon Q Business User Guide.

You can use the following AWS SDKs to access Amazon Q Business APIs:

AWS SDK for C++

AWS SDK for Go

AWS SDK for Java

AWS SDK for JavaScript

AWS SDK for .NET

AWS SDK for Python (Boto3)

AWS SDK for Ruby

The following resources provide additional information about using the Amazon Q Business API:

Setting up for Amazon Q Business

Amazon Q Business CLI Reference

Amazon Web Services General Reference

Index

Constants

View Source 
const ServiceAPIVersion = "2023-11-27"
View Source 
const ServiceID = "QBusiness"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

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

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

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

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

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchDeleteDocumentInput 

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 

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 

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 

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 ChatEventStream 

type ChatEventStream struct {
	// ChatInputStreamWriter is the EventStream writer for the ChatInputStream events.
	// This value is automatically set by the SDK when the API call is made Use this
	// member when unit testing your code with the SDK to mock out the EventStream
	// Writer.
	//
	// Must not be nil.
	Writer ChatInputStreamWriter

	// ChatOutputStreamReader is the EventStream reader for the ChatOutputStream
	// events. This value is automatically set by the SDK when the API call is made Use
	// this member when unit testing your code with the SDK to mock out the EventStream
	// Reader.
	//
	// Must not be nil.
	Reader ChatOutputStreamReader
	// contains filtered or unexported fields
}

ChatEventStream provides the event stream handling for the Chat operation.

For testing and mocking the event stream this type should be initialized via the NewChatEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewChatEventStream 

func NewChatEventStream(optFns ...func(*ChatEventStream)) *ChatEventStream

NewChatEventStream initializes an ChatEventStream. This function should only be used for testing and mocking the ChatEventStream stream within your application.

The Writer member must be set before writing events to the stream.

The Reader member must be set before reading events from the stream.

func (*ChatEventStream) Close 

func (es *ChatEventStream) Close() error

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

Will close the underlying EventStream writer and reader, and no more events can be sent or received.

func (*ChatEventStream) Err 

func (es *ChatEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*ChatEventStream) Events 

func (es *ChatEventStream) Events() <-chan types.ChatOutputStream

Events returns a channel to read events from.

func (*ChatEventStream) Send 

func (es *ChatEventStream) Send(ctx context.Context, event types.ChatInputStream) error

Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.

type ChatInput 

type ChatInput struct {

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

	// A token that you provide to identify the chat input.
	ClientToken *string

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

	// The identifier used to associate a user message with a AI generated response.
	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
	// contains filtered or unexported fields
}

type ChatInputStreamWriter 

type ChatInputStreamWriter interface {
	Send(context.Context, types.ChatInputStream) error
	Close() error
	Err() error
}

ChatInputStreamWriter provides the interface for writing events to a stream.

The writer's Close method must allow multiple concurrent calls.

type ChatOutput 

type ChatOutput struct {

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

func (*ChatOutput) GetStream 

func (o *ChatOutput) GetStream() *ChatEventStream

GetStream returns the type to interact with the event stream.

type ChatOutputStreamReader 

type ChatOutputStreamReader interface {
	Events() <-chan types.ChatOutputStream
	Close() error
	Err() error
}

ChatOutputStreamReader provides the interface for reading events from a stream.

The writer's Close method must allow multiple concurrent calls.

type ChatSyncInput 

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

	// An authentication verification event response by a third party authentication
	// server to Amazon Q Business.
	AuthChallengeResponse *types.AuthChallengeResponse

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

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

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

	// 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 

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

Client provides the API client to make operations call for QBusiness.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchDeleteDocument 

func (c *Client) BatchDeleteDocument(ctx context.Context, params *BatchDeleteDocumentInput, optFns ...func(*Options)) (*BatchDeleteDocumentOutput, error)

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

func (*Client) BatchPutDocument 

func (c *Client) BatchPutDocument(ctx context.Context, params *BatchPutDocumentInput, optFns ...func(*Options)) (*BatchPutDocumentOutput, error)

Adds one or more documents to an Amazon Q Business index.

You use this API to:

  • ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.

  • add custom attributes to documents in an Amazon Q Business index.

  • attach an access control list to the documents added to an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

func (*Client) Chat 

func (c *Client) Chat(ctx context.Context, params *ChatInput, optFns ...func(*Options)) (*ChatOutput, error)

Starts or continues a streaming Amazon Q Business conversation.

func (*Client) ChatSync 

func (c *Client) ChatSync(ctx context.Context, params *ChatSyncInput, optFns ...func(*Options)) (*ChatSyncOutput, error)

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

func (*Client) CreateApplication 

func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)

Creates an Amazon Q Business application.

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.

func (*Client) CreateDataSource 

func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

func (*Client) CreateIndex 

func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error)

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument BatchPutDocument API or the CreateDataSourceCreateDataSource API.

func (*Client) CreatePlugin 

func (c *Client) CreatePlugin(ctx context.Context, params *CreatePluginInput, optFns ...func(*Options)) (*CreatePluginOutput, error)

Creates an Amazon Q Business plugin.

func (*Client) CreateRetriever 

func (c *Client) CreateRetriever(ctx context.Context, params *CreateRetrieverInput, optFns ...func(*Options)) (*CreateRetrieverOutput, error)

Adds a retriever to your Amazon Q Business application.

func (*Client) CreateUser 

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

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

func (*Client) CreateWebExperience 

func (c *Client) CreateWebExperience(ctx context.Context, params *CreateWebExperienceInput, optFns ...func(*Options)) (*CreateWebExperienceOutput, error)

Creates an Amazon Q Business web experience.

func (*Client) DeleteApplication 

func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)

Deletes an Amazon Q Business application.

func (*Client) DeleteChatControlsConfiguration 

func (c *Client) DeleteChatControlsConfiguration(ctx context.Context, params *DeleteChatControlsConfigurationInput, optFns ...func(*Options)) (*DeleteChatControlsConfigurationOutput, error)

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

func (*Client) DeleteConversation 

func (c *Client) DeleteConversation(ctx context.Context, params *DeleteConversationInput, optFns ...func(*Options)) (*DeleteConversationOutput, error)

Deletes an Amazon Q Business web experience conversation.

func (*Client) DeleteDataSource 

func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)

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

func (*Client) DeleteGroup 

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.

If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup .

func (*Client) DeleteIndex 

func (c *Client) DeleteIndex(ctx context.Context, params *DeleteIndexInput, optFns ...func(*Options)) (*DeleteIndexOutput, error)

Deletes an Amazon Q Business index.

func (*Client) DeletePlugin 

func (c *Client) DeletePlugin(ctx context.Context, params *DeletePluginInput, optFns ...func(*Options)) (*DeletePluginOutput, error)

Deletes an Amazon Q Business plugin.

func (*Client) DeleteRetriever 

func (c *Client) DeleteRetriever(ctx context.Context, params *DeleteRetrieverInput, optFns ...func(*Options)) (*DeleteRetrieverOutput, error)

Deletes the retriever used by an Amazon Q Business application.

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Deletes a user by email id.

func (*Client) DeleteWebExperience 

func (c *Client) DeleteWebExperience(ctx context.Context, params *DeleteWebExperienceInput, optFns ...func(*Options)) (*DeleteWebExperienceOutput, error)

Deletes an Amazon Q Business web experience.

func (*Client) GetApplication 

func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)

Gets information about an existing Amazon Q Business application.

func (*Client) GetChatControlsConfiguration 

func (c *Client) GetChatControlsConfiguration(ctx context.Context, params *GetChatControlsConfigurationInput, optFns ...func(*Options)) (*GetChatControlsConfigurationOutput, error)

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

func (*Client) GetDataSource 

func (c *Client) GetDataSource(ctx context.Context, params *GetDataSourceInput, optFns ...func(*Options)) (*GetDataSourceOutput, error)

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

func (*Client) GetGroup 

func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)

Describes a group by group name.

func (*Client) GetIndex 

func (c *Client) GetIndex(ctx context.Context, params *GetIndexInput, optFns ...func(*Options)) (*GetIndexOutput, error)

Gets information about an existing Amazon Q Business index.

func (*Client) GetPlugin 

func (c *Client) GetPlugin(ctx context.Context, params *GetPluginInput, optFns ...func(*Options)) (*GetPluginOutput, error)

Gets information about an existing Amazon Q Business plugin.

func (*Client) GetRetriever 

func (c *Client) GetRetriever(ctx context.Context, params *GetRetrieverInput, optFns ...func(*Options)) (*GetRetrieverOutput, error)

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

func (*Client) GetUser 

func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error)

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

func (*Client) GetWebExperience 

func (c *Client) GetWebExperience(ctx context.Context, params *GetWebExperienceInput, optFns ...func(*Options)) (*GetWebExperienceOutput, error)

Gets information about an existing Amazon Q Business web experience.

func (*Client) ListApplications 

func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)

Lists Amazon Q Business applications.

func (*Client) ListConversations 

func (c *Client) ListConversations(ctx context.Context, params *ListConversationsInput, optFns ...func(*Options)) (*ListConversationsOutput, error)

Lists one or more Amazon Q Business conversations.

func (*Client) ListDataSourceSyncJobs 

func (c *Client) ListDataSourceSyncJobs(ctx context.Context, params *ListDataSourceSyncJobsInput, optFns ...func(*Options)) (*ListDataSourceSyncJobsOutput, error)

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

func (*Client) ListDataSources 

func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

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

func (*Client) ListDocuments 

func (c *Client) ListDocuments(ctx context.Context, params *ListDocumentsInput, optFns ...func(*Options)) (*ListDocumentsOutput, error)

A list of documents attached to an index.

func (*Client) ListGroups 

func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

Provides a list of groups that are mapped to users.

func (*Client) ListIndices 

func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optFns ...func(*Options)) (*ListIndicesOutput, error)

Lists the Amazon Q Business indices you have created.

func (*Client) ListMessages 

func (c *Client) ListMessages(ctx context.Context, params *ListMessagesInput, optFns ...func(*Options)) (*ListMessagesOutput, error)

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

func (*Client) ListPlugins 

func (c *Client) ListPlugins(ctx context.Context, params *ListPluginsInput, optFns ...func(*Options)) (*ListPluginsOutput, error)

Lists configured Amazon Q Business plugins.

func (*Client) ListRetrievers 

func (c *Client) ListRetrievers(ctx context.Context, params *ListRetrieversInput, optFns ...func(*Options)) (*ListRetrieversOutput, error)

Lists the retriever used by an Amazon Q Business application.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

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

func (*Client) ListWebExperiences 

func (c *Client) ListWebExperiences(ctx context.Context, params *ListWebExperiencesInput, optFns ...func(*Options)) (*ListWebExperiencesOutput, error)

Lists one or more Amazon Q Business Web Experiences.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutFeedback 

func (c *Client) PutFeedback(ctx context.Context, params *PutFeedbackInput, optFns ...func(*Options)) (*PutFeedbackOutput, error)

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

func (*Client) PutGroup 

func (c *Client) PutGroup(ctx context.Context, params *PutGroupInput, optFns ...func(*Options)) (*PutGroupOutput, error)

Create, or updates, a mapping of users—who have access to a document—to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

func (*Client) StartDataSourceSyncJob 

func (c *Client) StartDataSourceSyncJob(ctx context.Context, params *StartDataSourceSyncJobInput, optFns ...func(*Options)) (*StartDataSourceSyncJobOutput, error)

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

func (*Client) StopDataSourceSyncJob 

func (c *Client) StopDataSourceSyncJob(ctx context.Context, params *StopDataSourceSyncJobInput, optFns ...func(*Options)) (*StopDataSourceSyncJobOutput, error)

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

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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

func (*Client) UpdateApplication 

func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)

Updates an existing Amazon Q Business application.

func (*Client) UpdateChatControlsConfiguration 

func (c *Client) UpdateChatControlsConfiguration(ctx context.Context, params *UpdateChatControlsConfigurationInput, optFns ...func(*Options)) (*UpdateChatControlsConfigurationOutput, error)

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

func (*Client) UpdateDataSource 

func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)

Updates an existing Amazon Q Business data source connector.

func (*Client) UpdateIndex 

func (c *Client) UpdateIndex(ctx context.Context, params *UpdateIndexInput, optFns ...func(*Options)) (*UpdateIndexOutput, error)

Updates an Amazon Q Business index.

func (*Client) UpdatePlugin 

func (c *Client) UpdatePlugin(ctx context.Context, params *UpdatePluginInput, optFns ...func(*Options)) (*UpdatePluginOutput, error)

Updates an Amazon Q Business plugin.

func (*Client) UpdateRetriever 

func (c *Client) UpdateRetriever(ctx context.Context, params *UpdateRetrieverInput, optFns ...func(*Options)) (*UpdateRetrieverOutput, error)

Updates the retriever used for your Amazon Q Business application.

func (*Client) UpdateUser 

func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)

Updates a information associated with a user id.

func (*Client) UpdateWebExperience 

func (c *Client) UpdateWebExperience(ctx context.Context, params *UpdateWebExperienceInput, optFns ...func(*Options)) (*UpdateWebExperienceOutput, error)

Updates an Amazon Q Business web experience.

type CreateApplicationInput 

type CreateApplicationInput struct {

	// A name for the Amazon Q Business application.
	//
	// This member is required.
	DisplayName *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

	//  The Amazon Resource Name (ARN) of an IAM role with permissions to access your
	// Amazon CloudWatch logs and metrics.
	RoleArn *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 

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 

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].
	//
	// [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].
	//
	// [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].
	//
	// [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 

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 

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

	// The index type that's suitable for your needs. For more information on what's
	// included in each type of index or index tier, see [Amazon Q Business tiers].
	//
	// [Amazon Q Business tiers]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers
	Type types.IndexType
	// contains filtered or unexported fields
}

type CreateIndexOutput 

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 

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 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

	// Contains configuration for a custom plugin.
	CustomPluginConfiguration *types.CustomPluginConfiguration

	// The source URL used for plugin configuration.
	ServerUrl *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 

type CreatePluginOutput struct {

	// The current status of a plugin. A plugin is modified asynchronously.
	BuildStatus types.PluginBuildStatus

	// 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 

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 

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 

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 

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

type CreateWebExperienceInput 

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 

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 

type DeleteApplicationInput struct {

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

type DeleteApplicationOutput 

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

type DeleteChatControlsConfigurationInput 

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 

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

type DeleteConversationInput 

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 

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

type DeleteDataSourceInput 

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 

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

type DeleteGroupInput 

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 

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

type DeleteIndexInput 

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 

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

type DeletePluginInput 

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 

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

type DeleteRetrieverInput 

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 

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

type DeleteUserInput 

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 

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

type DeleteWebExperienceInput 

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 

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

type EndpointParameters 

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
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

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

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

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,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetApplicationInput 

type GetApplicationInput struct {

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

type GetApplicationOutput 

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 

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

GetChatControlsConfigurationAPIClient is a client that implements the GetChatControlsConfiguration operation.

type GetChatControlsConfigurationInput 

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 

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 

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

GetChatControlsConfigurationPaginator is a paginator for GetChatControlsConfiguration

func NewGetChatControlsConfigurationPaginator 

func NewGetChatControlsConfigurationPaginator(client GetChatControlsConfigurationAPIClient, params *GetChatControlsConfigurationInput, optFns ...func(*GetChatControlsConfigurationPaginatorOptions)) *GetChatControlsConfigurationPaginator

NewGetChatControlsConfigurationPaginator returns a new GetChatControlsConfigurationPaginator

func (*GetChatControlsConfigurationPaginator) HasMorePages 

func (p *GetChatControlsConfigurationPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetChatControlsConfigurationPaginator) NextPage 

func (p *GetChatControlsConfigurationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetChatControlsConfigurationOutput, error)

NextPage retrieves the next GetChatControlsConfiguration page.

type GetChatControlsConfigurationPaginatorOptions 

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
}

GetChatControlsConfigurationPaginatorOptions is the paginator options for GetChatControlsConfiguration

type GetDataSourceInput 

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 

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].
	//
	// [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 

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 

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 

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 

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].
	//
	// [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 type of index attached to your Amazon Q Business application.
	Type types.IndexType

	// 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 

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 

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 current status of a plugin. A plugin is modified asynchronously.
	BuildStatus types.PluginBuildStatus

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

	// Configuration information required to create a custom plugin.
	CustomPluginConfiguration *types.CustomPluginConfiguration

	// 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 

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 

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 

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 

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 

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 

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.
	//
	// Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor
	// of using AWS IAM Identity Center for user management.
	AuthenticationConfiguration types.WebExperienceAuthConfiguration

	// The Unix timestamp when the Amazon Q Business web experience was last 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 Amazon Q Business web experience 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 

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

type HTTPSignerV4 

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 

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

IdempotencyTokenProvider interface for providing idempotency token

type ListApplicationsAPIClient 

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

ListApplicationsAPIClient is a client that implements the ListApplications operation.

type ListApplicationsInput 

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 

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 

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

ListApplicationsPaginator is a paginator for ListApplications

func NewListApplicationsPaginator 

func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator

NewListApplicationsPaginator returns a new ListApplicationsPaginator

func (*ListApplicationsPaginator) HasMorePages 

func (p *ListApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationsPaginator) NextPage 

func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)

NextPage retrieves the next ListApplications page.

type ListApplicationsPaginatorOptions 

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
}

ListApplicationsPaginatorOptions is the paginator options for ListApplications

type ListConversationsAPIClient 

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

ListConversationsAPIClient is a client that implements the ListConversations operation.

type ListConversationsInput 

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 

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 

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

ListConversationsPaginator is a paginator for ListConversations

func NewListConversationsPaginator 

func NewListConversationsPaginator(client ListConversationsAPIClient, params *ListConversationsInput, optFns ...func(*ListConversationsPaginatorOptions)) *ListConversationsPaginator

NewListConversationsPaginator returns a new ListConversationsPaginator

func (*ListConversationsPaginator) HasMorePages 

func (p *ListConversationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConversationsPaginator) NextPage 

func (p *ListConversationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConversationsOutput, error)

NextPage retrieves the next ListConversations page.

type ListConversationsPaginatorOptions 

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
}

ListConversationsPaginatorOptions is the paginator options for ListConversations

type ListDataSourceSyncJobsAPIClient 

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

ListDataSourceSyncJobsAPIClient is a client that implements the ListDataSourceSyncJobs operation.

type ListDataSourceSyncJobsInput 

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 

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 

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

ListDataSourceSyncJobsPaginator is a paginator for ListDataSourceSyncJobs

func NewListDataSourceSyncJobsPaginator 

func NewListDataSourceSyncJobsPaginator(client ListDataSourceSyncJobsAPIClient, params *ListDataSourceSyncJobsInput, optFns ...func(*ListDataSourceSyncJobsPaginatorOptions)) *ListDataSourceSyncJobsPaginator

NewListDataSourceSyncJobsPaginator returns a new ListDataSourceSyncJobsPaginator

func (*ListDataSourceSyncJobsPaginator) HasMorePages 

func (p *ListDataSourceSyncJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSourceSyncJobsPaginator) NextPage 

func (p *ListDataSourceSyncJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourceSyncJobsOutput, error)

NextPage retrieves the next ListDataSourceSyncJobs page.

type ListDataSourceSyncJobsPaginatorOptions 

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
}

ListDataSourceSyncJobsPaginatorOptions is the paginator options for ListDataSourceSyncJobs

type ListDataSourcesAPIClient 

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

ListDataSourcesAPIClient is a client that implements the ListDataSources operation.

type ListDataSourcesInput 

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 

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 

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

ListDataSourcesPaginator is a paginator for ListDataSources

func NewListDataSourcesPaginator 

func NewListDataSourcesPaginator(client ListDataSourcesAPIClient, params *ListDataSourcesInput, optFns ...func(*ListDataSourcesPaginatorOptions)) *ListDataSourcesPaginator

NewListDataSourcesPaginator returns a new ListDataSourcesPaginator

func (*ListDataSourcesPaginator) HasMorePages 

func (p *ListDataSourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSourcesPaginator) NextPage 

func (p *ListDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

NextPage retrieves the next ListDataSources page.

type ListDataSourcesPaginatorOptions 

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
}

ListDataSourcesPaginatorOptions is the paginator options for ListDataSources

type ListDocumentsAPIClient 

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

ListDocumentsAPIClient is a client that implements the ListDocuments operation.

type ListDocumentsInput 

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 

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 

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

ListDocumentsPaginator is a paginator for ListDocuments

func NewListDocumentsPaginator 

func NewListDocumentsPaginator(client ListDocumentsAPIClient, params *ListDocumentsInput, optFns ...func(*ListDocumentsPaginatorOptions)) *ListDocumentsPaginator

NewListDocumentsPaginator returns a new ListDocumentsPaginator

func (*ListDocumentsPaginator) HasMorePages 

func (p *ListDocumentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDocumentsPaginator) NextPage 

func (p *ListDocumentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDocumentsOutput, error)

NextPage retrieves the next ListDocuments page.

type ListDocumentsPaginatorOptions 

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
}

ListDocumentsPaginatorOptions is the paginator options for ListDocuments

type ListGroupsAPIClient 

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

ListGroupsAPIClient is a client that implements the ListGroups operation.

type ListGroupsInput 

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 

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 

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

ListGroupsPaginator is a paginator for ListGroups

func NewListGroupsPaginator 

func NewListGroupsPaginator(client ListGroupsAPIClient, params *ListGroupsInput, optFns ...func(*ListGroupsPaginatorOptions)) *ListGroupsPaginator

NewListGroupsPaginator returns a new ListGroupsPaginator

func (*ListGroupsPaginator) HasMorePages 

func (p *ListGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGroupsPaginator) NextPage 

func (p *ListGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOutput, error)

NextPage retrieves the next ListGroups page.

type ListGroupsPaginatorOptions 

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
}

ListGroupsPaginatorOptions is the paginator options for ListGroups

type ListIndicesAPIClient 

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

ListIndicesAPIClient is a client that implements the ListIndices operation.

type ListIndicesInput 

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 

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 

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

ListIndicesPaginator is a paginator for ListIndices

func NewListIndicesPaginator 

func NewListIndicesPaginator(client ListIndicesAPIClient, params *ListIndicesInput, optFns ...func(*ListIndicesPaginatorOptions)) *ListIndicesPaginator

NewListIndicesPaginator returns a new ListIndicesPaginator

func (*ListIndicesPaginator) HasMorePages 

func (p *ListIndicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIndicesPaginator) NextPage 

func (p *ListIndicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIndicesOutput, error)

NextPage retrieves the next ListIndices page.

type ListIndicesPaginatorOptions 

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
}

ListIndicesPaginatorOptions is the paginator options for ListIndices

type ListMessagesAPIClient 

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

ListMessagesAPIClient is a client that implements the ListMessages operation.

type ListMessagesInput 

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 

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 

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

ListMessagesPaginator is a paginator for ListMessages

func NewListMessagesPaginator 

func NewListMessagesPaginator(client ListMessagesAPIClient, params *ListMessagesInput, optFns ...func(*ListMessagesPaginatorOptions)) *ListMessagesPaginator

NewListMessagesPaginator returns a new ListMessagesPaginator

func (*ListMessagesPaginator) HasMorePages 

func (p *ListMessagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMessagesPaginator) NextPage 

func (p *ListMessagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMessagesOutput, error)

NextPage retrieves the next ListMessages page.

type ListMessagesPaginatorOptions 

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
}

ListMessagesPaginatorOptions is the paginator options for ListMessages

type ListPluginsAPIClient 

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

ListPluginsAPIClient is a client that implements the ListPlugins operation.

type ListPluginsInput 

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 

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 

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

ListPluginsPaginator is a paginator for ListPlugins

func NewListPluginsPaginator 

func NewListPluginsPaginator(client ListPluginsAPIClient, params *ListPluginsInput, optFns ...func(*ListPluginsPaginatorOptions)) *ListPluginsPaginator

NewListPluginsPaginator returns a new ListPluginsPaginator

func (*ListPluginsPaginator) HasMorePages 

func (p *ListPluginsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPluginsPaginator) NextPage 

func (p *ListPluginsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPluginsOutput, error)

NextPage retrieves the next ListPlugins page.

type ListPluginsPaginatorOptions 

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
}

ListPluginsPaginatorOptions is the paginator options for ListPlugins

type ListRetrieversAPIClient 

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

ListRetrieversAPIClient is a client that implements the ListRetrievers operation.

type ListRetrieversInput 

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 

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 

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

ListRetrieversPaginator is a paginator for ListRetrievers

func NewListRetrieversPaginator 

func NewListRetrieversPaginator(client ListRetrieversAPIClient, params *ListRetrieversInput, optFns ...func(*ListRetrieversPaginatorOptions)) *ListRetrieversPaginator

NewListRetrieversPaginator returns a new ListRetrieversPaginator

func (*ListRetrieversPaginator) HasMorePages 

func (p *ListRetrieversPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRetrieversPaginator) NextPage 

func (p *ListRetrieversPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRetrieversOutput, error)

NextPage retrieves the next ListRetrievers page.

type ListRetrieversPaginatorOptions 

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
}

ListRetrieversPaginatorOptions is the paginator options for ListRetrievers

type ListTagsForResourceInput 

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 

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 

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

ListWebExperiencesAPIClient is a client that implements the ListWebExperiences operation.

type ListWebExperiencesInput 

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 

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 

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

ListWebExperiencesPaginator is a paginator for ListWebExperiences

func NewListWebExperiencesPaginator 

func NewListWebExperiencesPaginator(client ListWebExperiencesAPIClient, params *ListWebExperiencesInput, optFns ...func(*ListWebExperiencesPaginatorOptions)) *ListWebExperiencesPaginator

NewListWebExperiencesPaginator returns a new ListWebExperiencesPaginator

func (*ListWebExperiencesPaginator) HasMorePages 

func (p *ListWebExperiencesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWebExperiencesPaginator) NextPage 

func (p *ListWebExperiencesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWebExperiencesOutput, error)

NextPage retrieves the next ListWebExperiences page.

type ListWebExperiencesPaginatorOptions 

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
}

ListWebExperiencesPaginatorOptions is the paginator options for ListWebExperiences

type Options 

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
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutFeedbackInput 

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 

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

type PutGroupInput 

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 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartDataSourceSyncJobInput 

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 

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 

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 

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

type TagResourceInput 

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 

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

type UnknownEventMessageError 

type UnknownEventMessageError struct {
	Type    string
	Message *eventstream.Message
}

UnknownEventMessageError provides an error when a message is received from the stream, but the reader is unable to determine what kind of message it is.

func (*UnknownEventMessageError) Error 

func (e *UnknownEventMessageError) Error() string

Error retruns the error message string.

type UntagResourceInput 

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 

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

type UpdateApplicationInput 

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

	//  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

	// 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 

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

type UpdateChatControlsConfigurationInput 

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 

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

type UpdateDataSourceInput 

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].
	//
	// [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 

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

type UpdateIndexInput 

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].
	//
	// [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 

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

type UpdatePluginInput 

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 configuration for a custom plugin.
	CustomPluginConfiguration *types.CustomPluginConfiguration

	// 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 

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

type UpdateRetrieverInput 

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 

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

type UpdateUserInput 

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 

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 

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.
	//
	// Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor
	// of using AWS IAM Identity Center for user management.
	AuthenticationConfiguration types.WebExperienceAuthConfiguration

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

	// 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 

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

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.