qconnect

package module
v1.15.1 Latest Latest
Warning

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

 Go to latest Published: Jan 9, 2025 License: Apache-2.0 Imports: 45 Imported by: 5

Documentation

Overview

Package qconnect provides the API client, operations, and parameter types for Amazon Q Connect.

Amazon Q actions

Amazon Q data types

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-10-19"
View Source 
const ServiceID = "QConnect"

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 ActivateMessageTemplateInput added in v1.13.0 

type ActivateMessageTemplateInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The version number of the message template version to activate.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type ActivateMessageTemplateOutput added in v1.13.0 

type ActivateMessageTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The version number of the message template version that is activated.
	//
	// This member is required.
	VersionNumber *int64

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

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 Client 

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

Client provides the API client to make operations call for Amazon Q Connect.

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) ActivateMessageTemplate added in v1.13.0 

func (c *Client) ActivateMessageTemplate(ctx context.Context, params *ActivateMessageTemplateInput, optFns ...func(*Options)) (*ActivateMessageTemplateOutput, error)

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.

func (*Client) CreateAIAgent added in v1.12.0 

func (c *Client) CreateAIAgent(ctx context.Context, params *CreateAIAgentInput, optFns ...func(*Options)) (*CreateAIAgentOutput, error)

Creates an Amazon Q in Connect AI Agent.

func (*Client) CreateAIAgentVersion added in v1.12.0 

func (c *Client) CreateAIAgentVersion(ctx context.Context, params *CreateAIAgentVersionInput, optFns ...func(*Options)) (*CreateAIAgentVersionOutput, error)

Creates and Amazon Q in Connect AI Agent version.

func (*Client) CreateAIGuardrail added in v1.14.0 

func (c *Client) CreateAIGuardrail(ctx context.Context, params *CreateAIGuardrailInput, optFns ...func(*Options)) (*CreateAIGuardrailOutput, error)

Creates an Amazon Q in Connect AI Guardrail.

func (*Client) CreateAIGuardrailVersion added in v1.14.0 

func (c *Client) CreateAIGuardrailVersion(ctx context.Context, params *CreateAIGuardrailVersionInput, optFns ...func(*Options)) (*CreateAIGuardrailVersionOutput, error)

Creates an Amazon Q in Connect AI Guardrail version.

func (*Client) CreateAIPrompt added in v1.12.0 

func (c *Client) CreateAIPrompt(ctx context.Context, params *CreateAIPromptInput, optFns ...func(*Options)) (*CreateAIPromptOutput, error)

Creates an Amazon Q in Connect AI Prompt.

func (*Client) CreateAIPromptVersion added in v1.12.0 

func (c *Client) CreateAIPromptVersion(ctx context.Context, params *CreateAIPromptVersionInput, optFns ...func(*Options)) (*CreateAIPromptVersionOutput, error)

Creates an Amazon Q in Connect AI Prompt version.

func (*Client) CreateAssistant 

func (c *Client) CreateAssistant(ctx context.Context, params *CreateAssistantInput, optFns ...func(*Options)) (*CreateAssistantOutput, error)

Creates an Amazon Q in Connect assistant.

func (*Client) CreateAssistantAssociation 

func (c *Client) CreateAssistantAssociation(ctx context.Context, params *CreateAssistantAssociationInput, optFns ...func(*Options)) (*CreateAssistantAssociationOutput, error)

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

func (*Client) CreateContent 

func (c *Client) CreateContent(ctx context.Context, params *CreateContentInput, optFns ...func(*Options)) (*CreateContentOutput, error)

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

func (*Client) CreateContentAssociation added in v1.9.0 

func (c *Client) CreateContentAssociation(ctx context.Context, params *CreateContentAssociationInput, optFns ...func(*Options)) (*CreateContentAssociationOutput, error)

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

  • You can create only one content association for each content resource in a knowledge base.

  • You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

func (*Client) CreateKnowledgeBase 

func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error)

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

func (*Client) CreateMessageTemplate added in v1.13.0 

func (c *Client) CreateMessageTemplate(ctx context.Context, params *CreateMessageTemplateInput, optFns ...func(*Options)) (*CreateMessageTemplateOutput, error)

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

func (*Client) CreateMessageTemplateAttachment added in v1.13.0 

func (c *Client) CreateMessageTemplateAttachment(ctx context.Context, params *CreateMessageTemplateAttachmentInput, optFns ...func(*Options)) (*CreateMessageTemplateAttachmentOutput, error)

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

func (*Client) CreateMessageTemplateVersion added in v1.13.0 

func (c *Client) CreateMessageTemplateVersion(ctx context.Context, params *CreateMessageTemplateVersionInput, optFns ...func(*Options)) (*CreateMessageTemplateVersionOutput, error)

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

func (*Client) CreateQuickResponse 

func (c *Client) CreateQuickResponse(ctx context.Context, params *CreateQuickResponseInput, optFns ...func(*Options)) (*CreateQuickResponseOutput, error)

Creates an Amazon Q in Connect quick response.

func (*Client) CreateSession 

func (c *Client) CreateSession(ctx context.Context, params *CreateSessionInput, optFns ...func(*Options)) (*CreateSessionOutput, error)

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

func (*Client) DeactivateMessageTemplate added in v1.13.0 

func (c *Client) DeactivateMessageTemplate(ctx context.Context, params *DeactivateMessageTemplateInput, optFns ...func(*Options)) (*DeactivateMessageTemplateOutput, error)

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.

func (*Client) DeleteAIAgent added in v1.12.0 

func (c *Client) DeleteAIAgent(ctx context.Context, params *DeleteAIAgentInput, optFns ...func(*Options)) (*DeleteAIAgentOutput, error)

Deletes an Amazon Q in Connect AI Agent.

func (*Client) DeleteAIAgentVersion added in v1.12.0 

func (c *Client) DeleteAIAgentVersion(ctx context.Context, params *DeleteAIAgentVersionInput, optFns ...func(*Options)) (*DeleteAIAgentVersionOutput, error)

Deletes an Amazon Q in Connect AI Agent Version.

func (*Client) DeleteAIGuardrail added in v1.14.0 

func (c *Client) DeleteAIGuardrail(ctx context.Context, params *DeleteAIGuardrailInput, optFns ...func(*Options)) (*DeleteAIGuardrailOutput, error)

Deletes an Amazon Q in Connect AI Guardrail.

func (*Client) DeleteAIGuardrailVersion added in v1.14.0 

func (c *Client) DeleteAIGuardrailVersion(ctx context.Context, params *DeleteAIGuardrailVersionInput, optFns ...func(*Options)) (*DeleteAIGuardrailVersionOutput, error)

Delete and Amazon Q in Connect AI Guardrail version.

func (*Client) DeleteAIPrompt added in v1.12.0 

func (c *Client) DeleteAIPrompt(ctx context.Context, params *DeleteAIPromptInput, optFns ...func(*Options)) (*DeleteAIPromptOutput, error)

Deletes an Amazon Q in Connect AI Prompt.

func (*Client) DeleteAIPromptVersion added in v1.12.0 

func (c *Client) DeleteAIPromptVersion(ctx context.Context, params *DeleteAIPromptVersionInput, optFns ...func(*Options)) (*DeleteAIPromptVersionOutput, error)

Delete and Amazon Q in Connect AI Prompt version.

func (*Client) DeleteAssistant 

func (c *Client) DeleteAssistant(ctx context.Context, params *DeleteAssistantInput, optFns ...func(*Options)) (*DeleteAssistantOutput, error)

Deletes an assistant.

func (*Client) DeleteAssistantAssociation 

func (c *Client) DeleteAssistantAssociation(ctx context.Context, params *DeleteAssistantAssociationInput, optFns ...func(*Options)) (*DeleteAssistantAssociationOutput, error)

Deletes an assistant association.

func (*Client) DeleteContent 

func (c *Client) DeleteContent(ctx context.Context, params *DeleteContentInput, optFns ...func(*Options)) (*DeleteContentOutput, error)

Deletes the content.

func (*Client) DeleteContentAssociation added in v1.9.0 

func (c *Client) DeleteContentAssociation(ctx context.Context, params *DeleteContentAssociationInput, optFns ...func(*Options)) (*DeleteContentAssociationOutput, error)

Deletes the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guidesin the Amazon Connect Administrator Guide.

func (*Client) DeleteImportJob 

func (c *Client) DeleteImportJob(ctx context.Context, params *DeleteImportJobInput, optFns ...func(*Options)) (*DeleteImportJobOutput, error)

Deletes the quick response import job.

func (*Client) DeleteKnowledgeBase 

func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error)

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrationsDataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegrationand CreateDataIntegration in the Amazon AppIntegrations API Reference.

func (*Client) DeleteMessageTemplate added in v1.13.0 

func (c *Client) DeleteMessageTemplate(ctx context.Context, params *DeleteMessageTemplateInput, optFns ...func(*Options)) (*DeleteMessageTemplateOutput, error)

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

func (*Client) DeleteMessageTemplateAttachment added in v1.13.0 

func (c *Client) DeleteMessageTemplateAttachment(ctx context.Context, params *DeleteMessageTemplateAttachmentInput, optFns ...func(*Options)) (*DeleteMessageTemplateAttachmentOutput, error)

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.

func (*Client) DeleteQuickResponse 

func (c *Client) DeleteQuickResponse(ctx context.Context, params *DeleteQuickResponseInput, optFns ...func(*Options)) (*DeleteQuickResponseOutput, error)

Deletes a quick response.

func (*Client) GetAIAgent added in v1.12.0 

func (c *Client) GetAIAgent(ctx context.Context, params *GetAIAgentInput, optFns ...func(*Options)) (*GetAIAgentOutput, error)

Gets an Amazon Q in Connect AI Agent.

func (*Client) GetAIGuardrail added in v1.14.0 

func (c *Client) GetAIGuardrail(ctx context.Context, params *GetAIGuardrailInput, optFns ...func(*Options)) (*GetAIGuardrailOutput, error)

Gets the Amazon Q in Connect AI Guardrail.

func (*Client) GetAIPrompt added in v1.12.0 

func (c *Client) GetAIPrompt(ctx context.Context, params *GetAIPromptInput, optFns ...func(*Options)) (*GetAIPromptOutput, error)

Gets and Amazon Q in Connect AI Prompt.

func (*Client) GetAssistant 

func (c *Client) GetAssistant(ctx context.Context, params *GetAssistantInput, optFns ...func(*Options)) (*GetAssistantOutput, error)

Retrieves information about an assistant.

func (*Client) GetAssistantAssociation 

func (c *Client) GetAssistantAssociation(ctx context.Context, params *GetAssistantAssociationInput, optFns ...func(*Options)) (*GetAssistantAssociationOutput, error)

Retrieves information about an assistant association.

func (*Client) GetContent 

func (c *Client) GetContent(ctx context.Context, params *GetContentInput, optFns ...func(*Options)) (*GetContentOutput, error)

Retrieves content, including a pre-signed URL to download the content.

func (*Client) GetContentAssociation added in v1.9.0 

func (c *Client) GetContentAssociation(ctx context.Context, params *GetContentAssociationInput, optFns ...func(*Options)) (*GetContentAssociationOutput, error)

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guidesin the Amazon Connect Administrator Guide.

func (*Client) GetContentSummary 

func (c *Client) GetContentSummary(ctx context.Context, params *GetContentSummaryInput, optFns ...func(*Options)) (*GetContentSummaryOutput, error)

Retrieves summary information about the content.

func (*Client) GetImportJob 

func (c *Client) GetImportJob(ctx context.Context, params *GetImportJobInput, optFns ...func(*Options)) (*GetImportJobOutput, error)

Retrieves the started import job.

func (*Client) GetKnowledgeBase 

func (c *Client) GetKnowledgeBase(ctx context.Context, params *GetKnowledgeBaseInput, optFns ...func(*Options)) (*GetKnowledgeBaseOutput, error)

Retrieves information about the knowledge base.

func (*Client) GetMessageTemplate added in v1.13.0 

func (c *Client) GetMessageTemplate(ctx context.Context, params *GetMessageTemplateInput, optFns ...func(*Options)) (*GetMessageTemplateOutput, error)

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier> , which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST . If it is not supplied, then $LATEST is assumed implicitly.

func (*Client) GetNextMessage added in v1.14.0 

func (c *Client) GetNextMessage(ctx context.Context, params *GetNextMessageInput, optFns ...func(*Options)) (*GetNextMessageOutput, error)

Retrieves next message on an Amazon Q in Connect session.

func (*Client) GetQuickResponse 

func (c *Client) GetQuickResponse(ctx context.Context, params *GetQuickResponseInput, optFns ...func(*Options)) (*GetQuickResponseOutput, error)

Retrieves the quick response.

func (*Client) GetRecommendations deprecated 

func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error)

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Deprecated: GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

func (*Client) GetSession 

func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error)

Retrieves information for a specified session.

func (*Client) ListAIAgentVersions added in v1.12.0 

func (c *Client) ListAIAgentVersions(ctx context.Context, params *ListAIAgentVersionsInput, optFns ...func(*Options)) (*ListAIAgentVersionsOutput, error)

List AI Agent versions.

func (*Client) ListAIAgents added in v1.12.0 

func (c *Client) ListAIAgents(ctx context.Context, params *ListAIAgentsInput, optFns ...func(*Options)) (*ListAIAgentsOutput, error)

Lists AI Agents.

func (*Client) ListAIGuardrailVersions added in v1.14.0 

func (c *Client) ListAIGuardrailVersions(ctx context.Context, params *ListAIGuardrailVersionsInput, optFns ...func(*Options)) (*ListAIGuardrailVersionsOutput, error)

Lists AI Guardrail versions.

func (*Client) ListAIGuardrails added in v1.14.0 

func (c *Client) ListAIGuardrails(ctx context.Context, params *ListAIGuardrailsInput, optFns ...func(*Options)) (*ListAIGuardrailsOutput, error)

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

func (*Client) ListAIPromptVersions added in v1.12.0 

func (c *Client) ListAIPromptVersions(ctx context.Context, params *ListAIPromptVersionsInput, optFns ...func(*Options)) (*ListAIPromptVersionsOutput, error)

Lists AI Prompt versions.

func (*Client) ListAIPrompts added in v1.12.0 

func (c *Client) ListAIPrompts(ctx context.Context, params *ListAIPromptsInput, optFns ...func(*Options)) (*ListAIPromptsOutput, error)

Lists the AI Prompts available on the Amazon Q in Connect assistant.

func (*Client) ListAssistantAssociations 

func (c *Client) ListAssistantAssociations(ctx context.Context, params *ListAssistantAssociationsInput, optFns ...func(*Options)) (*ListAssistantAssociationsOutput, error)

Lists information about assistant associations.

func (*Client) ListAssistants 

func (c *Client) ListAssistants(ctx context.Context, params *ListAssistantsInput, optFns ...func(*Options)) (*ListAssistantsOutput, error)

Lists information about assistants.

func (*Client) ListContentAssociations added in v1.9.0 

func (c *Client) ListContentAssociations(ctx context.Context, params *ListContentAssociationsInput, optFns ...func(*Options)) (*ListContentAssociationsOutput, error)

Lists the content associations.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guidesin the Amazon Connect Administrator Guide.

func (*Client) ListContents 

func (c *Client) ListContents(ctx context.Context, params *ListContentsInput, optFns ...func(*Options)) (*ListContentsOutput, error)

Lists the content.

func (*Client) ListImportJobs 

func (c *Client) ListImportJobs(ctx context.Context, params *ListImportJobsInput, optFns ...func(*Options)) (*ListImportJobsOutput, error)

Lists information about import jobs.

func (*Client) ListKnowledgeBases 

func (c *Client) ListKnowledgeBases(ctx context.Context, params *ListKnowledgeBasesInput, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)

Lists the knowledge bases.

func (*Client) ListMessageTemplateVersions added in v1.13.0 

func (c *Client) ListMessageTemplateVersions(ctx context.Context, params *ListMessageTemplateVersionsInput, optFns ...func(*Options)) (*ListMessageTemplateVersionsOutput, error)

Lists all the available versions for the specified Amazon Q in Connect message template.

func (*Client) ListMessageTemplates added in v1.13.0 

func (c *Client) ListMessageTemplates(ctx context.Context, params *ListMessageTemplatesInput, optFns ...func(*Options)) (*ListMessageTemplatesOutput, error)

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

func (*Client) ListMessages added in v1.14.0 

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

Lists messages on an Amazon Q in Connect session.

func (*Client) ListQuickResponses 

func (c *Client) ListQuickResponses(ctx context.Context, params *ListQuickResponsesInput, optFns ...func(*Options)) (*ListQuickResponsesOutput, error)

Lists information about quick response.

func (*Client) ListTagsForResource 

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

Lists the tags for the specified resource.

func (*Client) NotifyRecommendationsReceived 

func (c *Client) NotifyRecommendationsReceived(ctx context.Context, params *NotifyRecommendationsReceivedInput, optFns ...func(*Options)) (*NotifyRecommendationsReceivedOutput, error)

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendationsand a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

func (*Client) Options added in v1.1.0 

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 added in v1.2.0 

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

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

func (*Client) QueryAssistant deprecated 

func (c *Client) QueryAssistant(ctx context.Context, params *QueryAssistantInput, optFns ...func(*Options)) (*QueryAssistantOutput, error)

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

Deprecated: QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

func (*Client) RemoveAssistantAIAgent added in v1.12.0 

func (c *Client) RemoveAssistantAIAgent(ctx context.Context, params *RemoveAssistantAIAgentInput, optFns ...func(*Options)) (*RemoveAssistantAIAgentOutput, error)

Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

func (*Client) RemoveKnowledgeBaseTemplateUri 

func (c *Client) RemoveKnowledgeBaseTemplateUri(ctx context.Context, params *RemoveKnowledgeBaseTemplateUriInput, optFns ...func(*Options)) (*RemoveKnowledgeBaseTemplateUriOutput, error)

Removes a URI template from a knowledge base.

func (*Client) RenderMessageTemplate added in v1.13.0 

func (c *Client) RenderMessageTemplate(ctx context.Context, params *RenderMessageTemplateInput, optFns ...func(*Options)) (*RenderMessageTemplateOutput, error)

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

func (*Client) SearchContent 

func (c *Client) SearchContent(ctx context.Context, params *SearchContentInput, optFns ...func(*Options)) (*SearchContentOutput, error)

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

func (*Client) SearchMessageTemplates added in v1.13.0 

func (c *Client) SearchMessageTemplates(ctx context.Context, params *SearchMessageTemplatesInput, optFns ...func(*Options)) (*SearchMessageTemplatesOutput, error)

Searches for Amazon Q in Connect message templates in the specified knowledge base.

func (*Client) SearchQuickResponses 

func (c *Client) SearchQuickResponses(ctx context.Context, params *SearchQuickResponsesInput, optFns ...func(*Options)) (*SearchQuickResponsesOutput, error)

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

func (*Client) SearchSessions 

func (c *Client) SearchSessions(ctx context.Context, params *SearchSessionsInput, optFns ...func(*Options)) (*SearchSessionsOutput, error)

Searches for sessions.

func (*Client) SendMessage added in v1.14.0 

func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error)

Submits a message to the Amazon Q in Connect session.

func (*Client) StartContentUpload 

func (c *Client) StartContentUpload(ctx context.Context, params *StartContentUploadInput, optFns ...func(*Options)) (*StartContentUploadOutput, error)

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContentto finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

func (*Client) StartImportJob 

func (c *Client) StartImportJob(ctx context.Context, params *StartImportJobInput, optFns ...func(*Options)) (*StartImportJobOutput, error)

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUploadto upload an asset that contains the resource data.

  • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

func (*Client) TagResource 

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

Adds the specified tags to the specified resource.

func (*Client) UntagResource 

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

Removes the specified tags from the specified resource.

func (*Client) UpdateAIAgent added in v1.12.0 

func (c *Client) UpdateAIAgent(ctx context.Context, params *UpdateAIAgentInput, optFns ...func(*Options)) (*UpdateAIAgentOutput, error)

Updates an AI Agent.

func (*Client) UpdateAIGuardrail added in v1.14.0 

func (c *Client) UpdateAIGuardrail(ctx context.Context, params *UpdateAIGuardrailInput, optFns ...func(*Options)) (*UpdateAIGuardrailOutput, error)

Updates an AI Guardrail.

func (*Client) UpdateAIPrompt added in v1.12.0 

func (c *Client) UpdateAIPrompt(ctx context.Context, params *UpdateAIPromptInput, optFns ...func(*Options)) (*UpdateAIPromptOutput, error)

Updates an AI Prompt.

func (*Client) UpdateAssistantAIAgent added in v1.12.0 

func (c *Client) UpdateAssistantAIAgent(ctx context.Context, params *UpdateAssistantAIAgentInput, optFns ...func(*Options)) (*UpdateAssistantAIAgentOutput, error)

Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

func (*Client) UpdateContent 

func (c *Client) UpdateContent(ctx context.Context, params *UpdateContentInput, optFns ...func(*Options)) (*UpdateContentOutput, error)

Updates information about the content.

func (*Client) UpdateKnowledgeBaseTemplateUri 

func (c *Client) UpdateKnowledgeBaseTemplateUri(ctx context.Context, params *UpdateKnowledgeBaseTemplateUriInput, optFns ...func(*Options)) (*UpdateKnowledgeBaseTemplateUriOutput, error)

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view .

func (*Client) UpdateMessageTemplate added in v1.13.0 

func (c *Client) UpdateMessageTemplate(ctx context.Context, params *UpdateMessageTemplateInput, optFns ...func(*Options)) (*UpdateMessageTemplateOutput, error)

Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.

func (*Client) UpdateMessageTemplateMetadata added in v1.13.0 

func (c *Client) UpdateMessageTemplateMetadata(ctx context.Context, params *UpdateMessageTemplateMetadataInput, optFns ...func(*Options)) (*UpdateMessageTemplateMetadataOutput, error)

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

func (*Client) UpdateQuickResponse 

func (c *Client) UpdateQuickResponse(ctx context.Context, params *UpdateQuickResponseInput, optFns ...func(*Options)) (*UpdateQuickResponseOutput, error)

Updates an existing Amazon Q in Connect quick response.

func (*Client) UpdateSession added in v1.6.0 

func (c *Client) UpdateSession(ctx context.Context, params *UpdateSessionInput, optFns ...func(*Options)) (*UpdateSessionOutput, error)

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

func (*Client) UpdateSessionData added in v1.12.0 

func (c *Client) UpdateSessionData(ctx context.Context, params *UpdateSessionDataInput, optFns ...func(*Options)) (*UpdateSessionDataOutput, error)

Updates the data stored on an Amazon Q in Connect Session.

type CreateAIAgentInput added in v1.12.0 

type CreateAIAgentInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The configuration of the AI Agent.
	//
	// This member is required.
	Configuration types.AIAgentConfiguration

	// The name of the AI Agent.
	//
	// This member is required.
	Name *string

	// The type of the AI Agent.
	//
	// This member is required.
	Type types.AIAgentType

	// The visibility status of the AI Agent.
	//
	// This member is required.
	VisibilityStatus types.VisibilityStatus

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The description of the AI Agent.
	Description *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAIAgentOutput added in v1.12.0 

type CreateAIAgentOutput struct {

	// The data of the created AI Agent.
	AiAgent *types.AIAgentData

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

type CreateAIAgentVersionInput added in v1.12.0 

type CreateAIAgentVersionInput struct {

	// The identifier of the Amazon Q in Connect AI Agent.
	//
	// This member is required.
	AiAgentId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The modification time of the AI Agent should be tracked for version creation.
	// This field should be specified to avoid version creation when simultaneous
	// update to the underlying AI Agent are possible. The value should be the
	// modifiedTime returned from the request to create or update an AI Agent so that
	// version creation can fail if an update to the AI Agent post the specified
	// modification time has been made.
	ModifiedTime *time.Time
	// contains filtered or unexported fields
}

type CreateAIAgentVersionOutput added in v1.12.0 

type CreateAIAgentVersionOutput struct {

	// The data of the AI Agent version.
	AiAgent *types.AIAgentData

	// The version number of the AI Agent version.
	VersionNumber *int64

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

type CreateAIGuardrailInput added in v1.14.0 

type CreateAIGuardrailInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The message to return when the AI Guardrail blocks a prompt.
	//
	// This member is required.
	BlockedInputMessaging *string

	// The message to return when the AI Guardrail blocks a model response.
	//
	// This member is required.
	BlockedOutputsMessaging *string

	// The name of the AI Guardrail.
	//
	// This member is required.
	Name *string

	// The visibility status of the AI Guardrail.
	//
	// This member is required.
	VisibilityStatus types.VisibilityStatus

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The content filter policies to configure for the AI Guardrail.
	ContentPolicyConfig *types.AIGuardrailContentPolicyConfig

	// The contextual grounding policy configuration used to create an AI Guardrail.
	ContextualGroundingPolicyConfig *types.AIGuardrailContextualGroundingPolicyConfig

	// A description of the AI Guardrail.
	Description *string

	// The sensitive information policy to configure for the AI Guardrail.
	SensitiveInformationPolicyConfig *types.AIGuardrailSensitiveInformationPolicyConfig

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// The topic policies to configure for the AI Guardrail.
	TopicPolicyConfig *types.AIGuardrailTopicPolicyConfig

	// The word policy you configure for the AI Guardrail.
	WordPolicyConfig *types.AIGuardrailWordPolicyConfig
	// contains filtered or unexported fields
}

type CreateAIGuardrailOutput added in v1.14.0 

type CreateAIGuardrailOutput struct {

	// The data of the AI Guardrail.
	AiGuardrail *types.AIGuardrailData

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

type CreateAIGuardrailVersionInput added in v1.14.0 

type CreateAIGuardrailVersionInput struct {

	// The identifier of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	AiGuardrailId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The time the AI Guardrail was last modified.
	ModifiedTime *time.Time
	// contains filtered or unexported fields
}

type CreateAIGuardrailVersionOutput added in v1.14.0 

type CreateAIGuardrailVersionOutput struct {

	// The data of the AI Guardrail version.
	AiGuardrail *types.AIGuardrailData

	// The version number of the AI Guardrail version.
	VersionNumber *int64

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

type CreateAIPromptInput added in v1.12.0 

type CreateAIPromptInput struct {

	// The API Format of the AI Prompt.
	//
	// This member is required.
	ApiFormat types.AIPromptAPIFormat

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the model used for this AI Prompt. Model Ids supported are:
	// CLAUDE_3_HAIKU_20240307_V1
	//
	// This member is required.
	ModelId *string

	// The name of the AI Prompt.
	//
	// This member is required.
	Name *string

	// The configuration of the prompt template for this AI Prompt.
	//
	// This member is required.
	TemplateConfiguration types.AIPromptTemplateConfiguration

	// The type of the prompt template for this AI Prompt.
	//
	// This member is required.
	TemplateType types.AIPromptTemplateType

	// The type of this AI Prompt.
	//
	// This member is required.
	Type types.AIPromptType

	// The visibility status of the AI Prompt.
	//
	// This member is required.
	VisibilityStatus types.VisibilityStatus

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The description of the AI Prompt.
	Description *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAIPromptOutput added in v1.12.0 

type CreateAIPromptOutput struct {

	// The data of the AI Prompt.
	AiPrompt *types.AIPromptData

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

type CreateAIPromptVersionInput added in v1.12.0 

type CreateAIPromptVersionInput struct {

	// The identifier of the Amazon Q in Connect AI prompt.
	//
	// This member is required.
	AiPromptId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The time the AI Prompt was last modified.
	ModifiedTime *time.Time
	// contains filtered or unexported fields
}

type CreateAIPromptVersionOutput added in v1.12.0 

type CreateAIPromptVersionOutput struct {

	// The data of the AI Prompt version.
	AiPrompt *types.AIPromptData

	// The version number of the AI Prompt version.
	VersionNumber *int64

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

type CreateAssistantAssociationInput 

type CreateAssistantAssociationInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the associated resource.
	//
	// This member is required.
	Association types.AssistantAssociationInputData

	// The type of association.
	//
	// This member is required.
	AssociationType types.AssociationType

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAssistantAssociationOutput 

type CreateAssistantAssociationOutput struct {

	// The assistant association.
	AssistantAssociation *types.AssistantAssociationData

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

type CreateAssistantInput 

type CreateAssistantInput struct {

	// The name of the assistant.
	//
	// This member is required.
	Name *string

	// The type of assistant.
	//
	// This member is required.
	Type types.AssistantType

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The description of the assistant.
	Description *string

	// The configuration information for the customer managed key used for encryption.
	//
	// The customer managed key must have a policy that allows kms:CreateGrant ,
	// kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM
	// identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect
	// with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* ,
	// and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
	//
	// For more information about setting up a customer managed key for Amazon Q in
	// Connect, see [Enable Amazon Q in Connect for your instance].
	//
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAssistantOutput 

type CreateAssistantOutput struct {

	// Information about the assistant.
	Assistant *types.AssistantData

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

type CreateContentAssociationInput added in v1.9.0 

type CreateContentAssociationInput struct {

	// The identifier of the associated resource.
	//
	// This member is required.
	Association types.ContentAssociationContents

	// The type of association.
	//
	// This member is required.
	AssociationType types.ContentAssociationType

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateContentAssociationOutput added in v1.9.0 

type CreateContentAssociationOutput struct {

	// The association between Amazon Q in Connect content and another resource.
	ContentAssociation *types.ContentAssociationData

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

type CreateContentInput 

type CreateContentInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the content. Each piece of content in a knowledge base must have a
	// unique name. You can retrieve a piece of content using only its knowledge base
	// and its name with the [SearchContent]API.
	//
	// [SearchContent]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html
	//
	// This member is required.
	Name *string

	// A pointer to the uploaded asset. This value is returned by [StartContentUpload].
	//
	// [StartContentUpload]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html
	//
	// This member is required.
	UploadId *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// A key/value map to store attributes without affecting tagging or
	// recommendations. For example, when synchronizing data between an external system
	// and Amazon Q in Connect, you can store an external version identifier as
	// metadata to utilize for determining drift.
	Metadata map[string]string

	// The URI you want to use for the article. If the knowledge base has a
	// templateUri, setting this argument overrides it for this piece of content.
	OverrideLinkOutUri *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// The title of the content. If not set, the title is equal to the name.
	Title *string
	// contains filtered or unexported fields
}

type CreateContentOutput 

type CreateContentOutput struct {

	// The content.
	Content *types.ContentData

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

type CreateKnowledgeBaseInput 

type CreateKnowledgeBaseInput struct {

	// The type of knowledge base. Only CUSTOM knowledge bases allow you to upload
	// your own content. EXTERNAL knowledge bases support integrations with third-party
	// systems whose content is synchronized automatically.
	//
	// This member is required.
	KnowledgeBaseType types.KnowledgeBaseType

	// The name of the knowledge base.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The description.
	Description *string

	// Information about how to render the content.
	RenderingConfiguration *types.RenderingConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using
	// the key to invoke Amazon Q in Connect.
	//
	// For more information about setting up a customer managed key for Amazon Q in
	// Connect, see [Enable Amazon Q in Connect for your instance].
	//
	// [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

	// The source of the knowledge base content. Only set this argument for EXTERNAL
	// or Managed knowledge bases.
	SourceConfiguration types.SourceConfiguration

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

	// Contains details about how to ingest the documents in a data source.
	VectorIngestionConfiguration *types.VectorIngestionConfiguration
	// contains filtered or unexported fields
}

type CreateKnowledgeBaseOutput 

type CreateKnowledgeBaseOutput struct {

	// The knowledge base.
	KnowledgeBase *types.KnowledgeBaseData

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

type CreateMessageTemplateAttachmentInput added in v1.13.0 

type CreateMessageTemplateAttachmentInput struct {

	// The body of the attachment file being uploaded. It should be encoded using
	// base64 encoding.
	//
	// This member is required.
	Body *string

	// The presentation information for the attachment file.
	//
	// This member is required.
	ContentDisposition types.ContentDisposition

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The name of the attachment file being uploaded. The name should include the
	// file extension.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateMessageTemplateAttachmentOutput added in v1.13.0 

type CreateMessageTemplateAttachmentOutput struct {

	// The message template attachment.
	Attachment *types.MessageTemplateAttachment

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

type CreateMessageTemplateInput added in v1.13.0 

type CreateMessageTemplateInput struct {

	// The channel subtype this message template applies to.
	//
	// This member is required.
	ChannelSubtype types.ChannelSubtype

	// The content of the message template.
	//
	// This member is required.
	Content types.MessageTemplateContentProvider

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the message template.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// An object that specifies the default values to use for variables in the message
	// template. This object contains different categories of key-value pairs. Each key
	// defines a variable or placeholder in the message template. The corresponding
	// value defines the default value for that variable.
	DefaultAttributes *types.MessageTemplateAttributes

	// The description of the message template.
	Description *string

	// The configuration information of the grouping of Amazon Q in Connect users.
	GroupingConfiguration *types.GroupingConfiguration

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateMessageTemplateOutput added in v1.13.0 

type CreateMessageTemplateOutput struct {

	// The message template.
	MessageTemplate *types.MessageTemplateData

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

type CreateMessageTemplateVersionInput added in v1.13.0 

type CreateMessageTemplateVersionInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The checksum value of the message template content that is referenced by the
	// $LATEST qualifier. It can be returned in MessageTemplateData or
	// ExtendedMessageTemplateData . It’s calculated by content, language,
	// defaultAttributes and Attachments of the message template. If not supplied, the
	// message template version will be created based on the message template content
	// that is referenced by the $LATEST qualifier by default.
	MessageTemplateContentSha256 *string
	// contains filtered or unexported fields
}

type CreateMessageTemplateVersionOutput added in v1.13.0 

type CreateMessageTemplateVersionOutput struct {

	// The message template.
	MessageTemplate *types.ExtendedMessageTemplateData

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

type CreateQuickResponseInput 

type CreateQuickResponseInput struct {

	// The content of the quick response.
	//
	// This member is required.
	Content types.QuickResponseDataProvider

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the quick response.
	//
	// This member is required.
	Name *string

	// The Amazon Connect channels this quick response applies to.
	Channels []string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The media type of the quick response content.
	//
	//   - Use application/x.quickresponse;format=plain for a quick response written in
	//   plain text.
	//
	//   - Use application/x.quickresponse;format=markdown for a quick response written
	//   in richtext.
	ContentType *string

	// The description of the quick response.
	Description *string

	// The configuration information of the user groups that the quick response is
	// accessible to.
	GroupingConfiguration *types.GroupingConfiguration

	// Whether the quick response is active.
	IsActive *bool

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The shortcut key of the quick response. The value should be unique across the
	// knowledge base.
	ShortcutKey *string

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateQuickResponseOutput 

type CreateQuickResponseOutput struct {

	// The quick response.
	QuickResponse *types.QuickResponseData

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

type CreateSessionInput 

type CreateSessionInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The name of the session.
	//
	// This member is required.
	Name *string

	// The configuration of the AI Agents (mapped by AI Agent Type to AI Agent
	// version) that should be used by Amazon Q in Connect for this Session.
	AiAgentConfiguration map[string]types.AIAgentConfigurationData

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs].
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The description.
	Description *string

	// An object that can be used to specify Tag conditions.
	TagFilter types.TagFilter

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSessionOutput 

type CreateSessionOutput struct {

	// The session.
	Session *types.SessionData

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

type DeactivateMessageTemplateInput added in v1.13.0 

type DeactivateMessageTemplateInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The version number of the message template version to deactivate.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeactivateMessageTemplateOutput added in v1.13.0 

type DeactivateMessageTemplateOutput struct {

	// The Amazon Resource Name (ARN) of the message template.
	//
	// This member is required.
	MessageTemplateArn *string

	// The identifier of the message template.
	//
	// This member is required.
	MessageTemplateId *string

	// The version number of the message template version that has been deactivated.
	//
	// This member is required.
	VersionNumber *int64

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

type DeleteAIAgentInput added in v1.12.0 

type DeleteAIAgentInput struct {

	// The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the
	// ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AiAgentId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type DeleteAIAgentOutput added in v1.12.0 

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

type DeleteAIAgentVersionInput added in v1.12.0 

type DeleteAIAgentVersionInput struct {

	// The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the
	// ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AiAgentId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The version number of the AI Agent version.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeleteAIAgentVersionOutput added in v1.12.0 

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

type DeleteAIGuardrailInput added in v1.14.0 

type DeleteAIGuardrailInput struct {

	// The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AiGuardrailId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type DeleteAIGuardrailOutput added in v1.14.0 

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

type DeleteAIGuardrailVersionInput added in v1.14.0 

type DeleteAIGuardrailVersionInput struct {

	// The identifier of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	AiGuardrailId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The version number of the AI Guardrail version to be deleted.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeleteAIGuardrailVersionOutput added in v1.14.0 

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

type DeleteAIPromptInput added in v1.12.0 

type DeleteAIPromptInput struct {

	// The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AiPromptId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type DeleteAIPromptOutput added in v1.12.0 

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

type DeleteAIPromptVersionInput added in v1.12.0 

type DeleteAIPromptVersionInput struct {

	// The identifier of the Amazon Q in Connect AI prompt.
	//
	// This member is required.
	AiPromptId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The version number of the AI Prompt version to be deleted.
	//
	// This member is required.
	VersionNumber *int64
	// contains filtered or unexported fields
}

type DeleteAIPromptVersionOutput added in v1.12.0 

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

type DeleteAssistantAssociationInput 

type DeleteAssistantAssociationInput struct {

	// The identifier of the assistant association. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type DeleteAssistantAssociationOutput 

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

type DeleteAssistantInput 

type DeleteAssistantInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type DeleteAssistantOutput 

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

type DeleteContentAssociationInput added in v1.9.0 

type DeleteContentAssociationInput struct {

	// The identifier of the content association. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	ContentAssociationId *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DeleteContentAssociationOutput added in v1.9.0 

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

type DeleteContentInput 

type DeleteContentInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DeleteContentOutput 

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

type DeleteImportJobInput 

type DeleteImportJobInput struct {

	// The identifier of the import job to be deleted.
	//
	// This member is required.
	ImportJobId *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DeleteImportJobOutput 

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

type DeleteKnowledgeBaseInput 

type DeleteKnowledgeBaseInput struct {

	// The knowledge base to delete content from. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DeleteKnowledgeBaseOutput 

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

type DeleteMessageTemplateAttachmentInput added in v1.13.0 

type DeleteMessageTemplateAttachmentInput struct {

	// The identifier of the attachment file.
	//
	// This member is required.
	AttachmentId *string

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string
	// contains filtered or unexported fields
}

type DeleteMessageTemplateAttachmentOutput added in v1.13.0 

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

type DeleteMessageTemplateInput added in v1.13.0 

type DeleteMessageTemplateInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN.
	//
	// This member is required.
	MessageTemplateId *string
	// contains filtered or unexported fields
}

type DeleteMessageTemplateOutput added in v1.13.0 

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

type DeleteQuickResponseInput 

type DeleteQuickResponseInput struct {

	// The knowledge base from which the quick response is deleted. The identifier of
	// the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the quick response to delete.
	//
	// This member is required.
	QuickResponseId *string
	// contains filtered or unexported fields
}

type DeleteQuickResponseOutput 

type DeleteQuickResponseOutput 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, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// 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 GetAIAgentInput added in v1.12.0 

type GetAIAgentInput struct {

	// The identifier of the Amazon Q in Connect AI Agent (with or without a version
	// qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AiAgentId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type GetAIAgentOutput added in v1.12.0 

type GetAIAgentOutput struct {

	// The data of the AI Agent.
	AiAgent *types.AIAgentData

	// The version number of the AI Agent version (returned if an AI Agent version was
	// specified via use of a qualifier for the aiAgentId on the request).
	VersionNumber *int64

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

type GetAIGuardrailInput added in v1.14.0 

type GetAIGuardrailInput struct {

	// The identifier of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	AiGuardrailId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type GetAIGuardrailOutput added in v1.14.0 

type GetAIGuardrailOutput struct {

	// The data of the AI Guardrail.
	AiGuardrail *types.AIGuardrailData

	// The version number of the AI Guardrail version (returned if an AI Guardrail
	// version was specified via use of a qualifier for the aiGuardrailId on the
	// request).
	VersionNumber *int64

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

type GetAIPromptInput added in v1.12.0 

type GetAIPromptInput struct {

	// The identifier of the Amazon Q in Connect AI prompt.
	//
	// This member is required.
	AiPromptId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type GetAIPromptOutput added in v1.12.0 

type GetAIPromptOutput struct {

	// The data of the AI Prompt.
	AiPrompt *types.AIPromptData

	// The version number of the AI Prompt version (returned if an AI Prompt version
	// was specified via use of a qualifier for the aiPromptId on the request).
	VersionNumber *int64

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

type GetAssistantAssociationInput 

type GetAssistantAssociationInput struct {

	// The identifier of the assistant association. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type GetAssistantAssociationOutput 

type GetAssistantAssociationOutput struct {

	// The assistant association.
	AssistantAssociation *types.AssistantAssociationData

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

type GetAssistantInput 

type GetAssistantInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type GetAssistantOutput 

type GetAssistantOutput struct {

	// Information about the assistant.
	Assistant *types.AssistantData

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

type GetContentAssociationInput added in v1.9.0 

type GetContentAssociationInput struct {

	// The identifier of the content association. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// This member is required.
	ContentAssociationId *string

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetContentAssociationOutput added in v1.9.0 

type GetContentAssociationOutput struct {

	// The association between Amazon Q in Connect content and another resource.
	ContentAssociation *types.ContentAssociationData

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

type GetContentInput 

type GetContentInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetContentOutput 

type GetContentOutput struct {

	// The content.
	Content *types.ContentData

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

type GetContentSummaryInput 

type GetContentSummaryInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetContentSummaryOutput 

type GetContentSummaryOutput struct {

	// The content summary.
	ContentSummary *types.ContentSummary

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

type GetImportJobInput 

type GetImportJobInput struct {

	// The identifier of the import job to retrieve.
	//
	// This member is required.
	ImportJobId *string

	// The identifier of the knowledge base that the import job belongs to.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetImportJobOutput 

type GetImportJobOutput struct {

	// The import job.
	ImportJob *types.ImportJobData

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

type GetKnowledgeBaseInput 

type GetKnowledgeBaseInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetKnowledgeBaseOutput 

type GetKnowledgeBaseOutput struct {

	// The knowledge base.
	KnowledgeBase *types.KnowledgeBaseData

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

type GetMessageTemplateInput added in v1.13.0 

type GetMessageTemplateInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN.
	//
	// This member is required.
	MessageTemplateId *string
	// contains filtered or unexported fields
}

type GetMessageTemplateOutput added in v1.13.0 

type GetMessageTemplateOutput struct {

	// The message template.
	MessageTemplate *types.ExtendedMessageTemplateData

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

type GetNextMessageInput added in v1.14.0 

type GetNextMessageInput struct {

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The token for the next message. Use the value returned in the SendMessage or
	// previous response in the next request to retrieve the next message.
	//
	// This member is required.
	NextMessageToken *string

	// The identifier of the Amazon Q in Connect session.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetNextMessageOutput added in v1.14.0 

type GetNextMessageOutput struct {

	// The state of current conversation.
	//
	// This member is required.
	ConversationState *types.ConversationState

	// The identifier of the submitted message.
	//
	// This member is required.
	RequestMessageId *string

	// The message response to the requested message.
	//
	// This member is required.
	Response *types.MessageOutput

	// The type of message response.
	//
	// This member is required.
	Type types.MessageType

	// The conversation data stored on an Amazon Q in Connect Session.
	ConversationSessionData []types.RuntimeSessionData

	// The token for the next message.
	NextMessageToken *string

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

type GetQuickResponseInput 

type GetQuickResponseInput struct {

	// The identifier of the knowledge base. This should be a QUICK_RESPONSES type
	// knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the quick response.
	//
	// This member is required.
	QuickResponseId *string
	// contains filtered or unexported fields
}

type GetQuickResponseOutput 

type GetQuickResponseOutput struct {

	// The quick response.
	QuickResponse *types.QuickResponseData

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

type GetRecommendationsInput 

type GetRecommendationsInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	SessionId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The duration (in seconds) for which the call waits for a recommendation to be
	// made available before returning. If a recommendation is available, the call
	// returns sooner than WaitTimeSeconds . If no messages are available and the wait
	// time expires, the call returns successfully with an empty list.
	WaitTimeSeconds int32
	// contains filtered or unexported fields
}

type GetRecommendationsOutput 

type GetRecommendationsOutput struct {

	// The recommendations.
	//
	// This member is required.
	Recommendations []types.RecommendationData

	// The triggers corresponding to recommendations.
	Triggers []types.RecommendationTrigger

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

type GetSessionInput 

type GetSessionInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetSessionOutput 

type GetSessionOutput struct {

	// The session.
	Session *types.SessionData

	// 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 ListAIAgentVersionsAPIClient added in v1.12.0 

type ListAIAgentVersionsAPIClient interface {
	ListAIAgentVersions(context.Context, *ListAIAgentVersionsInput, ...func(*Options)) (*ListAIAgentVersionsOutput, error)
}

ListAIAgentVersionsAPIClient is a client that implements the ListAIAgentVersions operation.

type ListAIAgentVersionsInput added in v1.12.0 

type ListAIAgentVersionsInput struct {

	// The identifier of the Amazon Q in Connect AI Agent for which versions are to be
	// listed.
	//
	// This member is required.
	AiAgentId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The origin of the AI Agent versions to be listed. SYSTEM for a default AI Agent
	// created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent
	// creation APIs.
	Origin types.Origin
	// contains filtered or unexported fields
}

type ListAIAgentVersionsOutput added in v1.12.0 

type ListAIAgentVersionsOutput struct {

	// The summaries of AI Agent versions.
	//
	// This member is required.
	AiAgentVersionSummaries []types.AIAgentVersionSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListAIAgentVersionsPaginator added in v1.12.0 

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

ListAIAgentVersionsPaginator is a paginator for ListAIAgentVersions

func NewListAIAgentVersionsPaginator added in v1.12.0 

func NewListAIAgentVersionsPaginator(client ListAIAgentVersionsAPIClient, params *ListAIAgentVersionsInput, optFns ...func(*ListAIAgentVersionsPaginatorOptions)) *ListAIAgentVersionsPaginator

NewListAIAgentVersionsPaginator returns a new ListAIAgentVersionsPaginator

func (*ListAIAgentVersionsPaginator) HasMorePages added in v1.12.0 

func (p *ListAIAgentVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAIAgentVersionsPaginator) NextPage added in v1.12.0 

func (p *ListAIAgentVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAIAgentVersionsOutput, error)

NextPage retrieves the next ListAIAgentVersions page.

type ListAIAgentVersionsPaginatorOptions added in v1.12.0 

type ListAIAgentVersionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAIAgentVersionsPaginatorOptions is the paginator options for ListAIAgentVersions

type ListAIAgentsAPIClient added in v1.12.0 

type ListAIAgentsAPIClient interface {
	ListAIAgents(context.Context, *ListAIAgentsInput, ...func(*Options)) (*ListAIAgentsOutput, error)
}

ListAIAgentsAPIClient is a client that implements the ListAIAgents operation.

type ListAIAgentsInput added in v1.12.0 

type ListAIAgentsInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The origin of the AI Agents to be listed. SYSTEM for a default AI Agent created
	// by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent
	// creation APIs.
	Origin types.Origin
	// contains filtered or unexported fields
}

type ListAIAgentsOutput added in v1.12.0 

type ListAIAgentsOutput struct {

	// The summaries of AI Agents.
	//
	// This member is required.
	AiAgentSummaries []types.AIAgentSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListAIAgentsPaginator added in v1.12.0 

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

ListAIAgentsPaginator is a paginator for ListAIAgents

func NewListAIAgentsPaginator added in v1.12.0 

func NewListAIAgentsPaginator(client ListAIAgentsAPIClient, params *ListAIAgentsInput, optFns ...func(*ListAIAgentsPaginatorOptions)) *ListAIAgentsPaginator

NewListAIAgentsPaginator returns a new ListAIAgentsPaginator

func (*ListAIAgentsPaginator) HasMorePages added in v1.12.0 

func (p *ListAIAgentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAIAgentsPaginator) NextPage added in v1.12.0 

func (p *ListAIAgentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAIAgentsOutput, error)

NextPage retrieves the next ListAIAgents page.

type ListAIAgentsPaginatorOptions added in v1.12.0 

type ListAIAgentsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAIAgentsPaginatorOptions is the paginator options for ListAIAgents

type ListAIGuardrailVersionsAPIClient added in v1.14.0 

type ListAIGuardrailVersionsAPIClient interface {
	ListAIGuardrailVersions(context.Context, *ListAIGuardrailVersionsInput, ...func(*Options)) (*ListAIGuardrailVersionsOutput, error)
}

ListAIGuardrailVersionsAPIClient is a client that implements the ListAIGuardrailVersions operation.

type ListAIGuardrailVersionsInput added in v1.14.0 

type ListAIGuardrailVersionsInput struct {

	// The identifier of the Amazon Q in Connect AI Guardrail for which versions are
	// to be listed.
	//
	// This member is required.
	AiGuardrailId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAIGuardrailVersionsOutput added in v1.14.0 

type ListAIGuardrailVersionsOutput struct {

	// The summaries of the AI Guardrail versions.
	//
	// This member is required.
	AiGuardrailVersionSummaries []types.AIGuardrailVersionSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListAIGuardrailVersionsPaginator added in v1.14.0 

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

ListAIGuardrailVersionsPaginator is a paginator for ListAIGuardrailVersions

func NewListAIGuardrailVersionsPaginator added in v1.14.0 

func NewListAIGuardrailVersionsPaginator(client ListAIGuardrailVersionsAPIClient, params *ListAIGuardrailVersionsInput, optFns ...func(*ListAIGuardrailVersionsPaginatorOptions)) *ListAIGuardrailVersionsPaginator

NewListAIGuardrailVersionsPaginator returns a new ListAIGuardrailVersionsPaginator

func (*ListAIGuardrailVersionsPaginator) HasMorePages added in v1.14.0 

func (p *ListAIGuardrailVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAIGuardrailVersionsPaginator) NextPage added in v1.14.0 

func (p *ListAIGuardrailVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAIGuardrailVersionsOutput, error)

NextPage retrieves the next ListAIGuardrailVersions page.

type ListAIGuardrailVersionsPaginatorOptions added in v1.14.0 

type ListAIGuardrailVersionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAIGuardrailVersionsPaginatorOptions is the paginator options for ListAIGuardrailVersions

type ListAIGuardrailsAPIClient added in v1.14.0 

type ListAIGuardrailsAPIClient interface {
	ListAIGuardrails(context.Context, *ListAIGuardrailsInput, ...func(*Options)) (*ListAIGuardrailsOutput, error)
}

ListAIGuardrailsAPIClient is a client that implements the ListAIGuardrails operation.

type ListAIGuardrailsInput added in v1.14.0 

type ListAIGuardrailsInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAIGuardrailsOutput added in v1.14.0 

type ListAIGuardrailsOutput struct {

	// The summaries of the AI Guardrails.
	//
	// This member is required.
	AiGuardrailSummaries []types.AIGuardrailSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListAIGuardrailsPaginator added in v1.14.0 

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

ListAIGuardrailsPaginator is a paginator for ListAIGuardrails

func NewListAIGuardrailsPaginator added in v1.14.0 

func NewListAIGuardrailsPaginator(client ListAIGuardrailsAPIClient, params *ListAIGuardrailsInput, optFns ...func(*ListAIGuardrailsPaginatorOptions)) *ListAIGuardrailsPaginator

NewListAIGuardrailsPaginator returns a new ListAIGuardrailsPaginator

func (*ListAIGuardrailsPaginator) HasMorePages added in v1.14.0 

func (p *ListAIGuardrailsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAIGuardrailsPaginator) NextPage added in v1.14.0 

func (p *ListAIGuardrailsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAIGuardrailsOutput, error)

NextPage retrieves the next ListAIGuardrails page.

type ListAIGuardrailsPaginatorOptions added in v1.14.0 

type ListAIGuardrailsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAIGuardrailsPaginatorOptions is the paginator options for ListAIGuardrails

type ListAIPromptVersionsAPIClient added in v1.12.0 

type ListAIPromptVersionsAPIClient interface {
	ListAIPromptVersions(context.Context, *ListAIPromptVersionsInput, ...func(*Options)) (*ListAIPromptVersionsOutput, error)
}

ListAIPromptVersionsAPIClient is a client that implements the ListAIPromptVersions operation.

type ListAIPromptVersionsInput added in v1.12.0 

type ListAIPromptVersionsInput struct {

	// The identifier of the Amazon Q in Connect AI prompt for which versions are to
	// be listed.
	//
	// This member is required.
	AiPromptId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The origin of the AI Prompt versions to be listed. SYSTEM for a default AI
	// Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI
	// Agent creation APIs.
	Origin types.Origin
	// contains filtered or unexported fields
}

type ListAIPromptVersionsOutput added in v1.12.0 

type ListAIPromptVersionsOutput struct {

	// The summaries of the AI Prompt versions.
	//
	// This member is required.
	AiPromptVersionSummaries []types.AIPromptVersionSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListAIPromptVersionsPaginator added in v1.12.0 

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

ListAIPromptVersionsPaginator is a paginator for ListAIPromptVersions

func NewListAIPromptVersionsPaginator added in v1.12.0 

func NewListAIPromptVersionsPaginator(client ListAIPromptVersionsAPIClient, params *ListAIPromptVersionsInput, optFns ...func(*ListAIPromptVersionsPaginatorOptions)) *ListAIPromptVersionsPaginator

NewListAIPromptVersionsPaginator returns a new ListAIPromptVersionsPaginator

func (*ListAIPromptVersionsPaginator) HasMorePages added in v1.12.0 

func (p *ListAIPromptVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAIPromptVersionsPaginator) NextPage added in v1.12.0 

func (p *ListAIPromptVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAIPromptVersionsOutput, error)

NextPage retrieves the next ListAIPromptVersions page.

type ListAIPromptVersionsPaginatorOptions added in v1.12.0 

type ListAIPromptVersionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAIPromptVersionsPaginatorOptions is the paginator options for ListAIPromptVersions

type ListAIPromptsAPIClient added in v1.12.0 

type ListAIPromptsAPIClient interface {
	ListAIPrompts(context.Context, *ListAIPromptsInput, ...func(*Options)) (*ListAIPromptsOutput, error)
}

ListAIPromptsAPIClient is a client that implements the ListAIPrompts operation.

type ListAIPromptsInput added in v1.12.0 

type ListAIPromptsInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent
	// created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent
	// creation APIs.
	Origin types.Origin
	// contains filtered or unexported fields
}

type ListAIPromptsOutput added in v1.12.0 

type ListAIPromptsOutput struct {

	// The summaries of the AI Prompts.
	//
	// This member is required.
	AiPromptSummaries []types.AIPromptSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListAIPromptsPaginator added in v1.12.0 

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

ListAIPromptsPaginator is a paginator for ListAIPrompts

func NewListAIPromptsPaginator added in v1.12.0 

func NewListAIPromptsPaginator(client ListAIPromptsAPIClient, params *ListAIPromptsInput, optFns ...func(*ListAIPromptsPaginatorOptions)) *ListAIPromptsPaginator

NewListAIPromptsPaginator returns a new ListAIPromptsPaginator

func (*ListAIPromptsPaginator) HasMorePages added in v1.12.0 

func (p *ListAIPromptsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAIPromptsPaginator) NextPage added in v1.12.0 

func (p *ListAIPromptsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAIPromptsOutput, error)

NextPage retrieves the next ListAIPrompts page.

type ListAIPromptsPaginatorOptions added in v1.12.0 

type ListAIPromptsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAIPromptsPaginatorOptions is the paginator options for ListAIPrompts

type ListAssistantAssociationsAPIClient 

type ListAssistantAssociationsAPIClient interface {
	ListAssistantAssociations(context.Context, *ListAssistantAssociationsInput, ...func(*Options)) (*ListAssistantAssociationsOutput, error)
}

ListAssistantAssociationsAPIClient is a client that implements the ListAssistantAssociations operation.

type ListAssistantAssociationsInput 

type ListAssistantAssociationsInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssistantAssociationsOutput 

type ListAssistantAssociationsOutput struct {

	// Summary information about assistant associations.
	//
	// This member is required.
	AssistantAssociationSummaries []types.AssistantAssociationSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListAssistantAssociationsPaginator 

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

ListAssistantAssociationsPaginator is a paginator for ListAssistantAssociations

func NewListAssistantAssociationsPaginator 

func NewListAssistantAssociationsPaginator(client ListAssistantAssociationsAPIClient, params *ListAssistantAssociationsInput, optFns ...func(*ListAssistantAssociationsPaginatorOptions)) *ListAssistantAssociationsPaginator

NewListAssistantAssociationsPaginator returns a new ListAssistantAssociationsPaginator

func (*ListAssistantAssociationsPaginator) HasMorePages 

func (p *ListAssistantAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssistantAssociationsPaginator) NextPage 

func (p *ListAssistantAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssistantAssociationsOutput, error)

NextPage retrieves the next ListAssistantAssociations page.

type ListAssistantAssociationsPaginatorOptions 

type ListAssistantAssociationsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAssistantAssociationsPaginatorOptions is the paginator options for ListAssistantAssociations

type ListAssistantsAPIClient 

type ListAssistantsAPIClient interface {
	ListAssistants(context.Context, *ListAssistantsInput, ...func(*Options)) (*ListAssistantsOutput, error)
}

ListAssistantsAPIClient is a client that implements the ListAssistants operation.

type ListAssistantsInput 

type ListAssistantsInput struct {

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssistantsOutput 

type ListAssistantsOutput struct {

	// Information about the assistants.
	//
	// This member is required.
	AssistantSummaries []types.AssistantSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListAssistantsPaginator 

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

ListAssistantsPaginator is a paginator for ListAssistants

func NewListAssistantsPaginator 

func NewListAssistantsPaginator(client ListAssistantsAPIClient, params *ListAssistantsInput, optFns ...func(*ListAssistantsPaginatorOptions)) *ListAssistantsPaginator

NewListAssistantsPaginator returns a new ListAssistantsPaginator

func (*ListAssistantsPaginator) HasMorePages 

func (p *ListAssistantsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssistantsPaginator) NextPage 

func (p *ListAssistantsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssistantsOutput, error)

NextPage retrieves the next ListAssistants page.

type ListAssistantsPaginatorOptions 

type ListAssistantsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListAssistantsPaginatorOptions is the paginator options for ListAssistants

type ListContentAssociationsAPIClient added in v1.9.0 

type ListContentAssociationsAPIClient interface {
	ListContentAssociations(context.Context, *ListContentAssociationsInput, ...func(*Options)) (*ListContentAssociationsOutput, error)
}

ListContentAssociationsAPIClient is a client that implements the ListContentAssociations operation.

type ListContentAssociationsInput added in v1.9.0 

type ListContentAssociationsInput struct {

	// The identifier of the content.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContentAssociationsOutput added in v1.9.0 

type ListContentAssociationsOutput struct {

	// Summary information about content associations.
	//
	// This member is required.
	ContentAssociationSummaries []types.ContentAssociationSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListContentAssociationsPaginator added in v1.9.0 

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

ListContentAssociationsPaginator is a paginator for ListContentAssociations

func NewListContentAssociationsPaginator added in v1.9.0 

func NewListContentAssociationsPaginator(client ListContentAssociationsAPIClient, params *ListContentAssociationsInput, optFns ...func(*ListContentAssociationsPaginatorOptions)) *ListContentAssociationsPaginator

NewListContentAssociationsPaginator returns a new ListContentAssociationsPaginator

func (*ListContentAssociationsPaginator) HasMorePages added in v1.9.0 

func (p *ListContentAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContentAssociationsPaginator) NextPage added in v1.9.0 

func (p *ListContentAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContentAssociationsOutput, error)

NextPage retrieves the next ListContentAssociations page.

type ListContentAssociationsPaginatorOptions added in v1.9.0 

type ListContentAssociationsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListContentAssociationsPaginatorOptions is the paginator options for ListContentAssociations

type ListContentsAPIClient 

type ListContentsAPIClient interface {
	ListContents(context.Context, *ListContentsInput, ...func(*Options)) (*ListContentsOutput, error)
}

ListContentsAPIClient is a client that implements the ListContents operation.

type ListContentsInput 

type ListContentsInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListContentsOutput 

type ListContentsOutput struct {

	// Information about the content.
	//
	// This member is required.
	ContentSummaries []types.ContentSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListContentsPaginator 

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

ListContentsPaginator is a paginator for ListContents

func NewListContentsPaginator 

func NewListContentsPaginator(client ListContentsAPIClient, params *ListContentsInput, optFns ...func(*ListContentsPaginatorOptions)) *ListContentsPaginator

NewListContentsPaginator returns a new ListContentsPaginator

func (*ListContentsPaginator) HasMorePages 

func (p *ListContentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContentsPaginator) NextPage 

func (p *ListContentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContentsOutput, error)

NextPage retrieves the next ListContents page.

type ListContentsPaginatorOptions 

type ListContentsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListContentsPaginatorOptions is the paginator options for ListContents

type ListImportJobsAPIClient 

type ListImportJobsAPIClient interface {
	ListImportJobs(context.Context, *ListImportJobsInput, ...func(*Options)) (*ListImportJobsOutput, error)
}

ListImportJobsAPIClient is a client that implements the ListImportJobs operation.

type ListImportJobsInput 

type ListImportJobsInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImportJobsOutput 

type ListImportJobsOutput struct {

	// Summary information about the import jobs.
	//
	// This member is required.
	ImportJobSummaries []types.ImportJobSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListImportJobsPaginator 

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

ListImportJobsPaginator is a paginator for ListImportJobs

func NewListImportJobsPaginator 

func NewListImportJobsPaginator(client ListImportJobsAPIClient, params *ListImportJobsInput, optFns ...func(*ListImportJobsPaginatorOptions)) *ListImportJobsPaginator

NewListImportJobsPaginator returns a new ListImportJobsPaginator

func (*ListImportJobsPaginator) HasMorePages 

func (p *ListImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImportJobsPaginator) NextPage 

func (p *ListImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportJobsOutput, error)

NextPage retrieves the next ListImportJobs page.

type ListImportJobsPaginatorOptions 

type ListImportJobsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListImportJobsPaginatorOptions is the paginator options for ListImportJobs

type ListKnowledgeBasesAPIClient 

type ListKnowledgeBasesAPIClient interface {
	ListKnowledgeBases(context.Context, *ListKnowledgeBasesInput, ...func(*Options)) (*ListKnowledgeBasesOutput, error)
}

ListKnowledgeBasesAPIClient is a client that implements the ListKnowledgeBases operation.

type ListKnowledgeBasesInput 

type ListKnowledgeBasesInput struct {

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKnowledgeBasesOutput 

type ListKnowledgeBasesOutput struct {

	// Information about the knowledge bases.
	//
	// This member is required.
	KnowledgeBaseSummaries []types.KnowledgeBaseSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListKnowledgeBasesPaginator 

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

ListKnowledgeBasesPaginator is a paginator for ListKnowledgeBases

func NewListKnowledgeBasesPaginator 

func NewListKnowledgeBasesPaginator(client ListKnowledgeBasesAPIClient, params *ListKnowledgeBasesInput, optFns ...func(*ListKnowledgeBasesPaginatorOptions)) *ListKnowledgeBasesPaginator

NewListKnowledgeBasesPaginator returns a new ListKnowledgeBasesPaginator

func (*ListKnowledgeBasesPaginator) HasMorePages 

func (p *ListKnowledgeBasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKnowledgeBasesPaginator) NextPage 

func (p *ListKnowledgeBasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)

NextPage retrieves the next ListKnowledgeBases page.

type ListKnowledgeBasesPaginatorOptions 

type ListKnowledgeBasesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListKnowledgeBasesPaginatorOptions is the paginator options for ListKnowledgeBases

type ListMessageTemplateVersionsAPIClient added in v1.13.0 

type ListMessageTemplateVersionsAPIClient interface {
	ListMessageTemplateVersions(context.Context, *ListMessageTemplateVersionsInput, ...func(*Options)) (*ListMessageTemplateVersionsOutput, error)
}

ListMessageTemplateVersionsAPIClient is a client that implements the ListMessageTemplateVersions operation.

type ListMessageTemplateVersionsInput added in v1.13.0 

type ListMessageTemplateVersionsInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMessageTemplateVersionsOutput added in v1.13.0 

type ListMessageTemplateVersionsOutput struct {

	// Summary information about the versions of a message template.
	//
	// This member is required.
	MessageTemplateVersionSummaries []types.MessageTemplateVersionSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListMessageTemplateVersionsPaginator added in v1.13.0 

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

ListMessageTemplateVersionsPaginator is a paginator for ListMessageTemplateVersions

func NewListMessageTemplateVersionsPaginator added in v1.13.0 

func NewListMessageTemplateVersionsPaginator(client ListMessageTemplateVersionsAPIClient, params *ListMessageTemplateVersionsInput, optFns ...func(*ListMessageTemplateVersionsPaginatorOptions)) *ListMessageTemplateVersionsPaginator

NewListMessageTemplateVersionsPaginator returns a new ListMessageTemplateVersionsPaginator

func (*ListMessageTemplateVersionsPaginator) HasMorePages added in v1.13.0 

func (p *ListMessageTemplateVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMessageTemplateVersionsPaginator) NextPage added in v1.13.0 

func (p *ListMessageTemplateVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMessageTemplateVersionsOutput, error)

NextPage retrieves the next ListMessageTemplateVersions page.

type ListMessageTemplateVersionsPaginatorOptions added in v1.13.0 

type ListMessageTemplateVersionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListMessageTemplateVersionsPaginatorOptions is the paginator options for ListMessageTemplateVersions

type ListMessageTemplatesAPIClient added in v1.13.0 

type ListMessageTemplatesAPIClient interface {
	ListMessageTemplates(context.Context, *ListMessageTemplatesInput, ...func(*Options)) (*ListMessageTemplatesOutput, error)
}

ListMessageTemplatesAPIClient is a client that implements the ListMessageTemplates operation.

type ListMessageTemplatesInput added in v1.13.0 

type ListMessageTemplatesInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMessageTemplatesOutput added in v1.13.0 

type ListMessageTemplatesOutput struct {

	// Summary information about the message template.
	//
	// This member is required.
	MessageTemplateSummaries []types.MessageTemplateSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type ListMessageTemplatesPaginator added in v1.13.0 

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

ListMessageTemplatesPaginator is a paginator for ListMessageTemplates

func NewListMessageTemplatesPaginator added in v1.13.0 

func NewListMessageTemplatesPaginator(client ListMessageTemplatesAPIClient, params *ListMessageTemplatesInput, optFns ...func(*ListMessageTemplatesPaginatorOptions)) *ListMessageTemplatesPaginator

NewListMessageTemplatesPaginator returns a new ListMessageTemplatesPaginator

func (*ListMessageTemplatesPaginator) HasMorePages added in v1.13.0 

func (p *ListMessageTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMessageTemplatesPaginator) NextPage added in v1.13.0 

func (p *ListMessageTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMessageTemplatesOutput, error)

NextPage retrieves the next ListMessageTemplates page.

type ListMessageTemplatesPaginatorOptions added in v1.13.0 

type ListMessageTemplatesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListMessageTemplatesPaginatorOptions is the paginator options for ListMessageTemplates

type ListMessagesAPIClient added in v1.14.0 

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

ListMessagesAPIClient is a client that implements the ListMessages operation.

type ListMessagesInput added in v1.14.0 

type ListMessagesInput struct {

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the Amazon Q in Connect session.
	//
	// This member is required.
	SessionId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMessagesOutput added in v1.14.0 

type ListMessagesOutput struct {

	// The message information.
	//
	// This member is required.
	Messages []types.MessageOutput

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListMessagesPaginator added in v1.14.0 

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

ListMessagesPaginator is a paginator for ListMessages

func NewListMessagesPaginator added in v1.14.0 

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

NewListMessagesPaginator returns a new ListMessagesPaginator

func (*ListMessagesPaginator) HasMorePages added in v1.14.0 

func (p *ListMessagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMessagesPaginator) NextPage added in v1.14.0 

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

NextPage retrieves the next ListMessages page.

type ListMessagesPaginatorOptions added in v1.14.0 

type ListMessagesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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 ListQuickResponsesAPIClient 

type ListQuickResponsesAPIClient interface {
	ListQuickResponses(context.Context, *ListQuickResponsesInput, ...func(*Options)) (*ListQuickResponsesOutput, error)
}

ListQuickResponsesAPIClient is a client that implements the ListQuickResponses operation.

type ListQuickResponsesInput 

type ListQuickResponsesInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListQuickResponsesOutput 

type ListQuickResponsesOutput struct {

	// Summary information about the quick responses.
	//
	// This member is required.
	QuickResponseSummaries []types.QuickResponseSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListQuickResponsesPaginator 

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

ListQuickResponsesPaginator is a paginator for ListQuickResponses

func NewListQuickResponsesPaginator 

func NewListQuickResponsesPaginator(client ListQuickResponsesAPIClient, params *ListQuickResponsesInput, optFns ...func(*ListQuickResponsesPaginatorOptions)) *ListQuickResponsesPaginator

NewListQuickResponsesPaginator returns a new ListQuickResponsesPaginator

func (*ListQuickResponsesPaginator) HasMorePages 

func (p *ListQuickResponsesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQuickResponsesPaginator) NextPage 

func (p *ListQuickResponsesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQuickResponsesOutput, error)

NextPage retrieves the next ListQuickResponses page.

type ListQuickResponsesPaginatorOptions 

type ListQuickResponsesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListQuickResponsesPaginatorOptions is the paginator options for ListQuickResponses

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]string

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

type NotifyRecommendationsReceivedInput 

type NotifyRecommendationsReceivedInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifiers of the recommendations.
	//
	// This member is required.
	RecommendationIds []string

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type NotifyRecommendationsReceivedOutput 

type NotifyRecommendationsReceivedOutput struct {

	// The identifiers of recommendations that are causing errors.
	Errors []types.NotifyRecommendationsReceivedError

	// The identifiers of the recommendations.
	RecommendationIds []string

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

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 client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

	// 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 added in v1.2.0 

type PutFeedbackInput struct {

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// Information about the feedback provided.
	//
	// This member is required.
	ContentFeedback types.ContentFeedbackData

	// The identifier of the feedback target.
	//
	// This member is required.
	TargetId *string

	// The type of the feedback target.
	//
	// This member is required.
	TargetType types.TargetType
	// contains filtered or unexported fields
}

type PutFeedbackOutput added in v1.2.0 

type PutFeedbackOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantArn *string

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// Information about the feedback provided.
	//
	// This member is required.
	ContentFeedback types.ContentFeedbackData

	// The identifier of the feedback target.
	//
	// This member is required.
	TargetId *string

	// The type of the feedback target.
	//
	// This member is required.
	TargetType types.TargetType

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

type QueryAssistantAPIClient 

type QueryAssistantAPIClient interface {
	QueryAssistant(context.Context, *QueryAssistantInput, ...func(*Options)) (*QueryAssistantOutput, error)
}

QueryAssistantAPIClient is a client that implements the QueryAssistant operation.

type QueryAssistantInput 

type QueryAssistantInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The search type to be used against the Knowledge Base for this request. The
	// values can be SEMANTIC which uses vector embeddings or HYBRID which use vector
	// embeddings and raw text.
	OverrideKnowledgeBaseSearchType types.KnowledgeBaseSearchType

	// Information about how to query content.
	QueryCondition []types.QueryCondition

	// Information about the query.
	QueryInputData types.QueryInputData

	// The text to search for.
	QueryText *string

	// The identifier of the Amazon Q in Connect session. Can be either the ID or the
	// ARN. URLs cannot contain the ARN.
	SessionId *string
	// contains filtered or unexported fields
}

type QueryAssistantOutput 

type QueryAssistantOutput struct {

	// The results of the query.
	//
	// This member is required.
	Results []types.ResultData

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type QueryAssistantPaginator 

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

QueryAssistantPaginator is a paginator for QueryAssistant

func NewQueryAssistantPaginator 

func NewQueryAssistantPaginator(client QueryAssistantAPIClient, params *QueryAssistantInput, optFns ...func(*QueryAssistantPaginatorOptions)) *QueryAssistantPaginator

NewQueryAssistantPaginator returns a new QueryAssistantPaginator

func (*QueryAssistantPaginator) HasMorePages 

func (p *QueryAssistantPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*QueryAssistantPaginator) NextPage 

func (p *QueryAssistantPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*QueryAssistantOutput, error)

NextPage retrieves the next QueryAssistant page.

type QueryAssistantPaginatorOptions 

type QueryAssistantPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

QueryAssistantPaginatorOptions is the paginator options for QueryAssistant

type RemoveAssistantAIAgentInput added in v1.12.0 

type RemoveAssistantAIAgentInput struct {

	// The type of the AI Agent being removed for use by default from the Amazon Q in
	// Connect Assistant.
	//
	// This member is required.
	AiAgentType types.AIAgentType

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string
	// contains filtered or unexported fields
}

type RemoveAssistantAIAgentOutput added in v1.12.0 

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

type RemoveKnowledgeBaseTemplateUriInput 

type RemoveKnowledgeBaseTemplateUriInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type RemoveKnowledgeBaseTemplateUriOutput 

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

type RenderMessageTemplateInput added in v1.13.0 

type RenderMessageTemplateInput struct {

	// An object that specifies the values to use for variables in the message
	// template. This object contains different categories of key-value pairs. Each key
	// defines a variable or placeholder in the message template. The corresponding
	// value defines the value for that variable.
	//
	// This member is required.
	Attributes *types.MessageTemplateAttributes

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN.
	//
	// This member is required.
	MessageTemplateId *string
	// contains filtered or unexported fields
}

type RenderMessageTemplateOutput added in v1.13.0 

type RenderMessageTemplateOutput struct {

	// The content of the message template.
	//
	// This member is required.
	Content types.MessageTemplateContentProvider

	// The message template attachments.
	Attachments []types.MessageTemplateAttachment

	// The attribute keys that are not resolved.
	AttributesNotInterpolated []string

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

type SearchContentAPIClient interface {
	SearchContent(context.Context, *SearchContentInput, ...func(*Options)) (*SearchContentOutput, error)
}

SearchContentAPIClient is a client that implements the SearchContent operation.

type SearchContentInput 

type SearchContentInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The search expression to filter results.
	//
	// This member is required.
	SearchExpression *types.SearchExpression

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchContentOutput 

type SearchContentOutput struct {

	// Summary information about the content.
	//
	// This member is required.
	ContentSummaries []types.ContentSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type SearchContentPaginator 

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

SearchContentPaginator is a paginator for SearchContent

func NewSearchContentPaginator 

func NewSearchContentPaginator(client SearchContentAPIClient, params *SearchContentInput, optFns ...func(*SearchContentPaginatorOptions)) *SearchContentPaginator

NewSearchContentPaginator returns a new SearchContentPaginator

func (*SearchContentPaginator) HasMorePages 

func (p *SearchContentPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchContentPaginator) NextPage 

func (p *SearchContentPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchContentOutput, error)

NextPage retrieves the next SearchContent page.

type SearchContentPaginatorOptions 

type SearchContentPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

SearchContentPaginatorOptions is the paginator options for SearchContent

type SearchMessageTemplatesAPIClient added in v1.13.0 

type SearchMessageTemplatesAPIClient interface {
	SearchMessageTemplates(context.Context, *SearchMessageTemplatesInput, ...func(*Options)) (*SearchMessageTemplatesOutput, error)
}

SearchMessageTemplatesAPIClient is a client that implements the SearchMessageTemplates operation.

type SearchMessageTemplatesInput added in v1.13.0 

type SearchMessageTemplatesInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The search expression for querying the message template.
	//
	// This member is required.
	SearchExpression *types.MessageTemplateSearchExpression

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchMessageTemplatesOutput added in v1.13.0 

type SearchMessageTemplatesOutput struct {

	// The results of the message template search.
	//
	// This member is required.
	Results []types.MessageTemplateSearchResultData

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type SearchMessageTemplatesPaginator added in v1.13.0 

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

SearchMessageTemplatesPaginator is a paginator for SearchMessageTemplates

func NewSearchMessageTemplatesPaginator added in v1.13.0 

func NewSearchMessageTemplatesPaginator(client SearchMessageTemplatesAPIClient, params *SearchMessageTemplatesInput, optFns ...func(*SearchMessageTemplatesPaginatorOptions)) *SearchMessageTemplatesPaginator

NewSearchMessageTemplatesPaginator returns a new SearchMessageTemplatesPaginator

func (*SearchMessageTemplatesPaginator) HasMorePages added in v1.13.0 

func (p *SearchMessageTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchMessageTemplatesPaginator) NextPage added in v1.13.0 

func (p *SearchMessageTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchMessageTemplatesOutput, error)

NextPage retrieves the next SearchMessageTemplates page.

type SearchMessageTemplatesPaginatorOptions added in v1.13.0 

type SearchMessageTemplatesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

SearchMessageTemplatesPaginatorOptions is the paginator options for SearchMessageTemplates

type SearchQuickResponsesAPIClient 

type SearchQuickResponsesAPIClient interface {
	SearchQuickResponses(context.Context, *SearchQuickResponsesInput, ...func(*Options)) (*SearchQuickResponsesOutput, error)
}

SearchQuickResponsesAPIClient is a client that implements the SearchQuickResponses operation.

type SearchQuickResponsesInput 

type SearchQuickResponsesInput struct {

	// The identifier of the knowledge base. This should be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The search expression for querying the quick response.
	//
	// This member is required.
	SearchExpression *types.QuickResponseSearchExpression

	// The [user-defined Amazon Connect contact attributes] to be resolved when search results are returned.
	//
	// [user-defined Amazon Connect contact attributes]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes
	Attributes map[string]string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchQuickResponsesOutput 

type SearchQuickResponsesOutput struct {

	// The results of the quick response search.
	//
	// This member is required.
	Results []types.QuickResponseSearchResultData

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type SearchQuickResponsesPaginator 

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

SearchQuickResponsesPaginator is a paginator for SearchQuickResponses

func NewSearchQuickResponsesPaginator 

func NewSearchQuickResponsesPaginator(client SearchQuickResponsesAPIClient, params *SearchQuickResponsesInput, optFns ...func(*SearchQuickResponsesPaginatorOptions)) *SearchQuickResponsesPaginator

NewSearchQuickResponsesPaginator returns a new SearchQuickResponsesPaginator

func (*SearchQuickResponsesPaginator) HasMorePages 

func (p *SearchQuickResponsesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchQuickResponsesPaginator) NextPage 

func (p *SearchQuickResponsesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchQuickResponsesOutput, error)

NextPage retrieves the next SearchQuickResponses page.

type SearchQuickResponsesPaginatorOptions 

type SearchQuickResponsesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

SearchQuickResponsesPaginatorOptions is the paginator options for SearchQuickResponses

type SearchSessionsAPIClient 

type SearchSessionsAPIClient interface {
	SearchSessions(context.Context, *SearchSessionsInput, ...func(*Options)) (*SearchSessionsOutput, error)
}

SearchSessionsAPIClient is a client that implements the SearchSessions operation.

type SearchSessionsInput 

type SearchSessionsInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The search expression to filter results.
	//
	// This member is required.
	SearchExpression *types.SearchExpression

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type SearchSessionsOutput 

type SearchSessionsOutput struct {

	// Summary information about the sessions.
	//
	// This member is required.
	SessionSummaries []types.SessionSummary

	// If there are additional results, this is the token for the next set of results.
	NextToken *string

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

type SearchSessionsPaginator 

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

SearchSessionsPaginator is a paginator for SearchSessions

func NewSearchSessionsPaginator 

func NewSearchSessionsPaginator(client SearchSessionsAPIClient, params *SearchSessionsInput, optFns ...func(*SearchSessionsPaginatorOptions)) *SearchSessionsPaginator

NewSearchSessionsPaginator returns a new SearchSessionsPaginator

func (*SearchSessionsPaginator) HasMorePages 

func (p *SearchSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchSessionsPaginator) NextPage 

func (p *SearchSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchSessionsOutput, error)

NextPage retrieves the next SearchSessions page.

type SearchSessionsPaginatorOptions 

type SearchSessionsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

SearchSessionsPaginatorOptions is the paginator options for SearchSessions

type SendMessageInput added in v1.14.0 

type SendMessageInput struct {

	// The identifier of the Amazon Q in Connect assistant.
	//
	// This member is required.
	AssistantId *string

	// The message data to submit to the Amazon Q in Connect session.
	//
	// This member is required.
	Message *types.MessageInput

	// The identifier of the Amazon Q in Connect session.
	//
	// This member is required.
	SessionId *string

	// The message type.
	//
	// This member is required.
	Type types.MessageType

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the AWS SDK populates this field.For more
	// information about idempotency, see Making retries safe with idempotent APIs.
	ClientToken *string

	// The conversation context before the Amazon Q in Connect session.
	ConversationContext *types.ConversationContext
	// contains filtered or unexported fields
}

type SendMessageOutput added in v1.14.0 

type SendMessageOutput struct {

	// The token for the next message, used by GetNextMessage.
	//
	// This member is required.
	NextMessageToken *string

	// The identifier of the submitted message.
	//
	// This member is required.
	RequestMessageId *string

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

type StartContentUploadInput 

type StartContentUploadInput struct {

	// The type of content to upload.
	//
	// This member is required.
	ContentType *string

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The expected expiration time of the generated presigned URL, specified in
	// minutes.
	PresignedUrlTimeToLive *int32
	// contains filtered or unexported fields
}

type StartContentUploadOutput 

type StartContentUploadOutput struct {

	// The headers to include in the upload.
	//
	// This member is required.
	HeadersToInclude map[string]string

	// The identifier of the upload.
	//
	// This member is required.
	UploadId *string

	// The URL of the upload.
	//
	// This member is required.
	Url *string

	// The expiration time of the URL as an epoch timestamp.
	//
	// This member is required.
	UrlExpiry *time.Time

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

type StartImportJobInput 

type StartImportJobInput struct {

	// The type of the import job.
	//
	//   - For importing quick response resource, set the value to QUICK_RESPONSES .
	//
	// This member is required.
	ImportJobType types.ImportJobType

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	//   - For importing Amazon Q in Connect quick responses, this should be a
	//   QUICK_RESPONSES type knowledge base.
	//
	// This member is required.
	KnowledgeBaseId *string

	// A pointer to the uploaded asset. This value is returned by [StartContentUpload].
	//
	// [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
	//
	// This member is required.
	UploadId *string

	// The tags used to organize, track, or control access for this resource.
	ClientToken *string

	// The configuration information of the external source that the resource data are
	// imported from.
	ExternalSourceConfiguration *types.ExternalSourceConfiguration

	// The metadata fields of the imported Amazon Q in Connect resources.
	Metadata map[string]string
	// contains filtered or unexported fields
}

type StartImportJobOutput 

type StartImportJobOutput struct {

	// The import job.
	ImportJob *types.ImportJobData

	// 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 resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags used to organize, track, or control access for this resource.
	//
	// This member is required.
	Tags map[string]string
	// 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 UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys.
	//
	// 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 UpdateAIAgentInput added in v1.12.0 

type UpdateAIAgentInput struct {

	// The identifier of the Amazon Q in Connect AI Agent.
	//
	// This member is required.
	AiAgentId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The visbility status of the Amazon Q in Connect AI Agent.
	//
	// This member is required.
	VisibilityStatus types.VisibilityStatus

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The configuration of the Amazon Q in Connect AI Agent.
	Configuration types.AIAgentConfiguration

	// The description of the Amazon Q in Connect AI Agent.
	Description *string
	// contains filtered or unexported fields
}

type UpdateAIAgentOutput added in v1.12.0 

type UpdateAIAgentOutput struct {

	// The data of the updated Amazon Q in Connect AI Agent.
	AiAgent *types.AIAgentData

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

type UpdateAIGuardrailInput added in v1.14.0 

type UpdateAIGuardrailInput struct {

	// The identifier of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	AiGuardrailId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The message to return when the AI Guardrail blocks a prompt.
	//
	// This member is required.
	BlockedInputMessaging *string

	// The message to return when the AI Guardrail blocks a model response.
	//
	// This member is required.
	BlockedOutputsMessaging *string

	// The visibility status of the Amazon Q in Connect AI Guardrail.
	//
	// This member is required.
	VisibilityStatus types.VisibilityStatus

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The content filter policies to configure for the AI Guardrail.
	ContentPolicyConfig *types.AIGuardrailContentPolicyConfig

	// The contextual grounding policy configuration used to create an AI Guardrail.
	ContextualGroundingPolicyConfig *types.AIGuardrailContextualGroundingPolicyConfig

	// A description of the AI Guardrail.
	Description *string

	// The sensitive information policy to configure for the AI Guardrail.
	SensitiveInformationPolicyConfig *types.AIGuardrailSensitiveInformationPolicyConfig

	// The topic policies to configure for the AI Guardrail.
	TopicPolicyConfig *types.AIGuardrailTopicPolicyConfig

	// The word policy you configure for the AI Guardrail.
	WordPolicyConfig *types.AIGuardrailWordPolicyConfig
	// contains filtered or unexported fields
}

type UpdateAIGuardrailOutput added in v1.14.0 

type UpdateAIGuardrailOutput struct {

	// The data of the updated Amazon Q in Connect AI Guardrail.
	AiGuardrail *types.AIGuardrailData

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

type UpdateAIPromptInput added in v1.12.0 

type UpdateAIPromptInput struct {

	// The identifier of the Amazon Q in Connect AI Prompt.
	//
	// This member is required.
	AiPromptId *string

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The visibility status of the Amazon Q in Connect AI prompt.
	//
	// This member is required.
	VisibilityStatus types.VisibilityStatus

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see [Making retries safe with idempotent APIs]..
	//
	// [Making retries safe with idempotent APIs]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
	ClientToken *string

	// The description of the Amazon Q in Connect AI Prompt.
	Description *string

	// The configuration of the prompt template for this AI Prompt.
	TemplateConfiguration types.AIPromptTemplateConfiguration
	// contains filtered or unexported fields
}

type UpdateAIPromptOutput added in v1.12.0 

type UpdateAIPromptOutput struct {

	// The data of the updated Amazon Q in Connect AI Prompt.
	AiPrompt *types.AIPromptData

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

type UpdateAssistantAIAgentInput added in v1.12.0 

type UpdateAssistantAIAgentInput struct {

	// The type of the AI Agent being updated for use by default on the Amazon Q in
	// Connect Assistant.
	//
	// This member is required.
	AiAgentType types.AIAgentType

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The configuration of the AI Agent being updated for use by default on the
	// Amazon Q in Connect Assistant.
	//
	// This member is required.
	Configuration *types.AIAgentConfigurationData
	// contains filtered or unexported fields
}

type UpdateAssistantAIAgentOutput added in v1.12.0 

type UpdateAssistantAIAgentOutput struct {

	// The assistant data.
	Assistant *types.AssistantData

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

type UpdateContentInput 

type UpdateContentInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	ContentId *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN
	//
	// This member is required.
	KnowledgeBaseId *string

	// A key/value map to store attributes without affecting tagging or
	// recommendations. For example, when synchronizing data between an external system
	// and Amazon Q in Connect, you can store an external version identifier as
	// metadata to utilize for determining drift.
	Metadata map[string]string

	// The URI for the article. If the knowledge base has a templateUri, setting this
	// argument overrides it for this piece of content. To remove an existing
	// overrideLinkOurUri , exclude this argument and set removeOverrideLinkOutUri to
	// true.
	OverrideLinkOutUri *string

	// Unset the existing overrideLinkOutUri if it exists.
	RemoveOverrideLinkOutUri *bool

	// The revisionId of the content resource to update, taken from an earlier call to
	// GetContent , GetContentSummary , SearchContent , or ListContents . If included,
	// this argument acts as an optimistic lock to ensure content was not modified
	// since it was last read. If it has been modified, this API throws a
	// PreconditionFailedException .
	RevisionId *string

	// The title of the content.
	Title *string

	// A pointer to the uploaded asset. This value is returned by [StartContentUpload].
	//
	// [StartContentUpload]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html
	UploadId *string
	// contains filtered or unexported fields
}

type UpdateContentOutput 

type UpdateContentOutput struct {

	// The content.
	Content *types.ContentData

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

type UpdateKnowledgeBaseTemplateUriInput 

type UpdateKnowledgeBaseTemplateUriInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The template URI to update.
	//
	// This member is required.
	TemplateUri *string
	// contains filtered or unexported fields
}

type UpdateKnowledgeBaseTemplateUriOutput 

type UpdateKnowledgeBaseTemplateUriOutput struct {

	// The knowledge base to update.
	KnowledgeBase *types.KnowledgeBaseData

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

type UpdateMessageTemplateInput added in v1.13.0 

type UpdateMessageTemplateInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The content of the message template.
	Content types.MessageTemplateContentProvider

	// An object that specifies the default values to use for variables in the message
	// template. This object contains different categories of key-value pairs. Each key
	// defines a variable or placeholder in the message template. The corresponding
	// value defines the default value for that variable.
	DefaultAttributes *types.MessageTemplateAttributes

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string
	// contains filtered or unexported fields
}

type UpdateMessageTemplateMetadataInput added in v1.13.0 

type UpdateMessageTemplateMetadataInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the message template. Can be either the ID or the ARN. It
	// cannot contain any qualifier.
	//
	// This member is required.
	MessageTemplateId *string

	// The description of the message template.
	Description *string

	// The configuration information of the grouping of Amazon Q in Connect users.
	GroupingConfiguration *types.GroupingConfiguration

	// The name of the message template.
	Name *string
	// contains filtered or unexported fields
}

type UpdateMessageTemplateMetadataOutput added in v1.13.0 

type UpdateMessageTemplateMetadataOutput struct {

	// The message template.
	MessageTemplate *types.MessageTemplateData

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

type UpdateMessageTemplateOutput added in v1.13.0 

type UpdateMessageTemplateOutput struct {

	// The message template.
	MessageTemplate *types.MessageTemplateData

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

type UpdateQuickResponseInput 

type UpdateQuickResponseInput struct {

	// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
	// cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The identifier of the quick response.
	//
	// This member is required.
	QuickResponseId *string

	// The Amazon Connect contact channels this quick response applies to. The
	// supported contact channel types include Chat .
	Channels []string

	// The updated content of the quick response.
	Content types.QuickResponseDataProvider

	// The media type of the quick response content.
	//
	//   - Use application/x.quickresponse;format=plain for quick response written in
	//   plain text.
	//
	//   - Use application/x.quickresponse;format=markdown for quick response written
	//   in richtext.
	ContentType *string

	// The updated description of the quick response.
	Description *string

	// The updated grouping configuration of the quick response.
	GroupingConfiguration *types.GroupingConfiguration

	// Whether the quick response is active.
	IsActive *bool

	// The language code value for the language in which the quick response is
	// written. The supported language codes include de_DE , en_US , es_ES , fr_FR ,
	// id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
	Language *string

	// The name of the quick response.
	Name *string

	// Whether to remove the description from the quick response.
	RemoveDescription *bool

	// Whether to remove the grouping configuration of the quick response.
	RemoveGroupingConfiguration *bool

	// Whether to remove the shortcut key of the quick response.
	RemoveShortcutKey *bool

	// The shortcut key of the quick response. The value should be unique across the
	// knowledge base.
	ShortcutKey *string
	// contains filtered or unexported fields
}

type UpdateQuickResponseOutput 

type UpdateQuickResponseOutput struct {

	// The quick response.
	QuickResponse *types.QuickResponseData

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

type UpdateSessionDataInput added in v1.12.0 

type UpdateSessionDataInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The data stored on the Amazon Q in Connect Session.
	//
	// This member is required.
	Data []types.RuntimeSessionData

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	SessionId *string

	// The namespace into which the session data is stored. Supported namespaces are:
	// Custom
	Namespace types.SessionDataNamespace
	// contains filtered or unexported fields
}

type UpdateSessionDataOutput added in v1.12.0 

type UpdateSessionDataOutput struct {

	// Data stored in the session.
	//
	// This member is required.
	Data []types.RuntimeSessionData

	// The namespace into which the session data is stored. Supported namespaces are:
	// Custom
	//
	// This member is required.
	Namespace types.SessionDataNamespace

	// The Amazon Resource Name (ARN) of the session.
	//
	// This member is required.
	SessionArn *string

	// The identifier of the session.
	//
	// This member is required.
	SessionId *string

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

type UpdateSessionInput added in v1.6.0 

type UpdateSessionInput struct {

	// The identifier of the Amazon Q in Connect assistant. Can be either the ID or
	// the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	AssistantId *string

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// This member is required.
	SessionId *string

	// The configuration of the AI Agents (mapped by AI Agent Type to AI Agent
	// version) that should be used by Amazon Q in Connect for this Session.
	AiAgentConfiguration map[string]types.AIAgentConfigurationData

	// The description.
	Description *string

	// An object that can be used to specify Tag conditions.
	TagFilter types.TagFilter
	// contains filtered or unexported fields
}

type UpdateSessionOutput added in v1.6.0 

type UpdateSessionOutput struct {

	// Information about the session.
	Session *types.SessionData

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

Source Files

View all Source files

Directories

Path Synopsis
internal
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.