types

package
v1.23.8 Latest Latest
Warning

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

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

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AppIntegrationsConfiguration 

type AppIntegrationsConfiguration struct {

	// The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use
	// for ingesting content.
	//
	//   - For [Salesforce], your AppIntegrations DataIntegration must have an ObjectConfiguration
	//   if objectFields is not provided, including at least Id , ArticleNumber ,
	//   VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
	//
	//   - For [ServiceNow], your AppIntegrations DataIntegration must have an ObjectConfiguration
	//   if objectFields is not provided, including at least number , short_description
	//   , sys_mod_count , workflow_state , and active as source fields.
	//
	//   - For [Zendesk], your AppIntegrations DataIntegration must have an ObjectConfiguration
	//   if objectFields is not provided, including at least id , title , updated_at ,
	//   and draft as source fields.
	//
	//   - For [SharePoint], your AppIntegrations DataIntegration must have a FileConfiguration,
	//   including only file extensions that are among docx , pdf , html , htm , and
	//   txt .
	//
	//   - For [Amazon S3], the ObjectConfiguration and FileConfiguration of your AppIntegrations
	//   DataIntegration must be null. The SourceURI of your DataIntegration must use
	//   the following format: s3://your_s3_bucket_name .
	//
	// The bucket policy of the corresponding S3 bucket must allow the Amazon Web
	//   Services principal app-integrations.amazonaws.com to perform s3:ListBucket ,
	//   s3:GetObject , and s3:GetBucketLocation against the bucket.
	//
	// [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
	// [Amazon S3]: https://aws.amazon.com/s3/
	// [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
	// [SharePoint]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index
	// [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
	//
	// This member is required.
	AppIntegrationArn *string

	// The fields from the source that are made available to your agents in Wisdom.
	// Optional if ObjectConfiguration is included in the provided DataIntegration.
	//
	//   - For [Salesforce], you must include at least Id , ArticleNumber , VersionNumber , Title ,
	//   PublishStatus , and IsDeleted .
	//
	//   - For [ServiceNow], you must include at least number , short_description , sys_mod_count ,
	//   workflow_state , and active .
	//
	//   - For [Zendesk], you must include at least id , title , updated_at , and draft .
	//
	// Make sure to include additional fields. These fields are indexed and used to
	// source recommendations.
	//
	// [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
	// [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
	// [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
	ObjectFields []string
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

type AssistantAssociationData 

type AssistantAssociationData struct {

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

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// This member is required.
	AssistantAssociationArn *string

	// The identifier of the assistant association.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// A union type that currently has a single argument, the knowledge base ID.
	//
	// This member is required.
	AssociationData AssistantAssociationOutputData

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

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

Information about the assistant association.

type AssistantAssociationInputData 

type AssistantAssociationInputData interface {
	// contains filtered or unexported methods
}

The data that is input into Wisdom as a result of the assistant association.

The following types satisfy this interface: 

AssistantAssociationInputDataMemberKnowledgeBaseId
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.AssistantAssociationInputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssistantAssociationInputDataMemberKnowledgeBaseId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssistantAssociationInputDataMemberKnowledgeBaseId 

type AssistantAssociationInputDataMemberKnowledgeBaseId struct {
	Value string
	// contains filtered or unexported fields
}

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.

type AssistantAssociationOutputData 

type AssistantAssociationOutputData interface {
	// contains filtered or unexported methods
}

The data that is output as a result of the assistant association.

The following types satisfy this interface: 

AssistantAssociationOutputDataMemberKnowledgeBaseAssociation
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.AssistantAssociationOutputData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssistantAssociationOutputDataMemberKnowledgeBaseAssociation:
		_ = v.Value // Value is types.KnowledgeBaseAssociationData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type AssistantAssociationOutputDataMemberKnowledgeBaseAssociation 

type AssistantAssociationOutputDataMemberKnowledgeBaseAssociation struct {
	Value KnowledgeBaseAssociationData
	// contains filtered or unexported fields
}

The knowledge base where output data is sent.

type AssistantAssociationSummary 

type AssistantAssociationSummary struct {

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

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// This member is required.
	AssistantAssociationArn *string

	// The identifier of the assistant association.
	//
	// This member is required.
	AssistantAssociationId *string

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// The association data.
	//
	// This member is required.
	AssociationData AssistantAssociationOutputData

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

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

Summary information about the assistant association.

type AssistantData 

type AssistantData struct {

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

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// The name.
	//
	// This member is required.
	Name *string

	// The status of the assistant.
	//
	// This member is required.
	Status AssistantStatus

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

	// The description.
	Description *string

	// The configuration information for the Wisdom assistant integration.
	IntegrationConfiguration *AssistantIntegrationConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the
	// key to invoke Wisdom. To use Wisdom 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 Wisdom, see [Enable Amazon Connect Wisdom for your instance].
	//
	// [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

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

The assistant data.

type AssistantIntegrationConfiguration added in v1.14.0 

type AssistantIntegrationConfiguration struct {

	// The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for
	// streaming chat messages.
	TopicIntegrationArn *string
	// contains filtered or unexported fields
}

The configuration information for the Wisdom assistant integration.

type AssistantStatus 

type AssistantStatus string
const (
	AssistantStatusCreateInProgress AssistantStatus = "CREATE_IN_PROGRESS"
	AssistantStatusCreateFailed     AssistantStatus = "CREATE_FAILED"
	AssistantStatusActive           AssistantStatus = "ACTIVE"
	AssistantStatusDeleteInProgress AssistantStatus = "DELETE_IN_PROGRESS"
	AssistantStatusDeleteFailed     AssistantStatus = "DELETE_FAILED"
	AssistantStatusDeleted          AssistantStatus = "DELETED"
)

Enum values for AssistantStatus

func (AssistantStatus) Values 

func (AssistantStatus) Values() []AssistantStatus

Values returns all known values for AssistantStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssistantSummary 

type AssistantSummary struct {

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

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

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

	// The status of the assistant.
	//
	// This member is required.
	Status AssistantStatus

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

	// The description of the assistant.
	Description *string

	// The configuration information for the Wisdom assistant integration.
	IntegrationConfiguration *AssistantIntegrationConfiguration

	// The configuration information for the customer managed key used for encryption.
	//
	// This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey ,
	// and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the
	// key to invoke Wisdom. To use Wisdom 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 Wisdom, see [Enable Amazon Connect Wisdom for your instance].
	//
	// [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

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

Summary information about the assistant.

type AssistantType 

type AssistantType string
const (
	AssistantTypeAgent AssistantType = "AGENT"
)

Enum values for AssistantType

func (AssistantType) Values 

func (AssistantType) Values() []AssistantType

Values returns all known values for AssistantType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationType 

type AssociationType string
const (
	AssociationTypeKnowledgeBase AssociationType = "KNOWLEDGE_BASE"
)

Enum values for AssociationType

func (AssociationType) Values 

func (AssociationType) Values() []AssociationType

Values returns all known values for AssociationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Configuration added in v1.19.0 

type Configuration interface {
	// contains filtered or unexported methods
}

The configuration information of the external data source.

The following types satisfy this interface: 

ConfigurationMemberConnectConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.Configuration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfigurationMemberConnectConfiguration:
		_ = v.Value // Value is types.ConnectConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ConfigurationMemberConnectConfiguration added in v1.19.0 

type ConfigurationMemberConnectConfiguration struct {
	Value ConnectConfiguration
	// contains filtered or unexported fields
}

The configuration information of the Amazon Connect data source.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant ) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConnectConfiguration added in v1.19.0 

type ConnectConfiguration struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId in
	// the ARN of the instance.
	InstanceId *string
	// contains filtered or unexported fields
}

The configuration information of the Amazon Connect data source.

type ContentData 

type ContentData struct {

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

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

	// The media type of the content.
	//
	// This member is required.
	ContentType *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// 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 Wisdom, you can store an external version identifier as metadata to utilize
	// for determining drift.
	//
	// This member is required.
	Metadata map[string]string

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

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

	// The status of the content.
	//
	// This member is required.
	Status ContentStatus

	// The title of the content.
	//
	// This member is required.
	Title *string

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

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

	// The URI of the content.
	LinkOutUri *string

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

Information about the content.

type ContentReference 

type ContentReference struct {

	// The Amazon Resource Name (ARN) of the content.
	ContentArn *string

	// The identifier of the content.
	ContentId *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

Reference information about the content.

type ContentStatus 

type ContentStatus string
const (
	ContentStatusCreateInProgress ContentStatus = "CREATE_IN_PROGRESS"
	ContentStatusCreateFailed     ContentStatus = "CREATE_FAILED"
	ContentStatusActive           ContentStatus = "ACTIVE"
	ContentStatusDeleteInProgress ContentStatus = "DELETE_IN_PROGRESS"
	ContentStatusDeleteFailed     ContentStatus = "DELETE_FAILED"
	ContentStatusDeleted          ContentStatus = "DELETED"
	ContentStatusUpdateFailed     ContentStatus = "UPDATE_FAILED"
)

Enum values for ContentStatus

func (ContentStatus) Values 

func (ContentStatus) Values() []ContentStatus

Values returns all known values for ContentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentSummary 

type ContentSummary struct {

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

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

	// The media type of the content.
	//
	// This member is required.
	ContentType *string

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// 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 Wisdom, you can store an external version identifier as metadata to utilize
	// for determining drift.
	//
	// This member is required.
	Metadata map[string]string

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

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

	// The status of the content.
	//
	// This member is required.
	Status ContentStatus

	// The title of the content.
	//
	// This member is required.
	Title *string

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

Summary information about the content.

type Document 

type Document struct {

	// A reference to the content resource.
	//
	// This member is required.
	ContentReference *ContentReference

	// The excerpt from the document.
	Excerpt *DocumentText

	// The title of the document.
	Title *DocumentText
	// contains filtered or unexported fields
}

The document.

type DocumentText 

type DocumentText struct {

	// Highlights in the document text.
	Highlights []Highlight

	// Text in the document.
	Text *string
	// contains filtered or unexported fields
}

The text of the document.

type ExternalSource added in v1.19.0 

type ExternalSource string
const (
	ExternalSourceAmazonConnect ExternalSource = "AMAZON_CONNECT"
)

Enum values for ExternalSource

func (ExternalSource) Values added in v1.19.0 

func (ExternalSource) Values() []ExternalSource

Values returns all known values for ExternalSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExternalSourceConfiguration added in v1.19.0 

type ExternalSourceConfiguration struct {

	// The configuration information of the external data source.
	//
	// This member is required.
	Configuration Configuration

	// The type of the external data source.
	//
	// This member is required.
	Source ExternalSource
	// contains filtered or unexported fields
}

The configuration information of the external data source.

type Filter 

type Filter struct {

	// The field on which to filter.
	//
	// This member is required.
	Field FilterField

	// The operator to use for comparing the field’s value with the provided value.
	//
	// This member is required.
	Operator FilterOperator

	// The desired field value on which to filter.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A search filter.

type FilterField 

type FilterField string
const (
	FilterFieldName FilterField = "NAME"
)

Enum values for FilterField

func (FilterField) Values 

func (FilterField) Values() []FilterField

Values returns all known values for FilterField. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FilterOperator 

type FilterOperator string
const (
	FilterOperatorEquals FilterOperator = "EQUALS"
)

Enum values for FilterOperator

func (FilterOperator) Values 

func (FilterOperator) Values() []FilterOperator

Values returns all known values for FilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GroupingConfiguration added in v1.19.0 

type GroupingConfiguration struct {

	// The criteria used for grouping Wisdom users.
	//
	// The following is the list of supported criteria values.
	//
	//   - RoutingProfileArn : Grouping the users by their [Amazon Connect routing profile ARN]. User should have [SearchRoutingProfile]and [DescribeRoutingProfile]
	//   permissions when setting criteria to this value.
	//
	// [Amazon Connect routing profile ARN]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
	// [SearchRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html
	// [DescribeRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html
	Criteria *string

	// The list of values that define different groups of Wisdom users.
	//
	//   - When setting criteria to RoutingProfileArn , you need to provide a list of
	//   ARNs of [Amazon Connect routing profiles]as values of this parameter.
	//
	// [Amazon Connect routing profiles]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
	Values []string
	// contains filtered or unexported fields
}

The configuration information of the grouping of Wisdom users.

type Highlight 

type Highlight struct {

	// The offset for the start of the highlight.
	BeginOffsetInclusive int32

	// The offset for the end of the highlight.
	EndOffsetExclusive int32
	// contains filtered or unexported fields
}

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

type ImportJobData added in v1.19.0 

type ImportJobData struct {

	// The timestamp when the import job was created.
	//
	// This member is required.
	CreatedTime *time.Time

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

	// The type of the import job.
	//
	// This member is required.
	ImportJobType ImportJobType

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the import job data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The status of the import job.
	//
	// This member is required.
	Status ImportJobStatus

	// 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 download link to the resource file that is uploaded to the import job.
	//
	// This member is required.
	Url *string

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

	// The configuration information of the external data source.
	ExternalSourceConfiguration *ExternalSourceConfiguration

	// The link to donwload the information of resource data that failed to be
	// imported.
	FailedRecordReport *string

	// The metadata fields of the imported Wisdom resources.
	Metadata map[string]string
	// contains filtered or unexported fields
}

Summary information about the import job.

type ImportJobStatus added in v1.19.0 

type ImportJobStatus string
const (
	ImportJobStatusStartInProgress  ImportJobStatus = "START_IN_PROGRESS"
	ImportJobStatusFailed           ImportJobStatus = "FAILED"
	ImportJobStatusComplete         ImportJobStatus = "COMPLETE"
	ImportJobStatusDeleteInProgress ImportJobStatus = "DELETE_IN_PROGRESS"
	ImportJobStatusDeleteFailed     ImportJobStatus = "DELETE_FAILED"
	ImportJobStatusDeleted          ImportJobStatus = "DELETED"
)

Enum values for ImportJobStatus

func (ImportJobStatus) Values added in v1.19.0 

func (ImportJobStatus) Values() []ImportJobStatus

Values returns all known values for ImportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImportJobSummary added in v1.19.0 

type ImportJobSummary struct {

	// The timestamp when the import job was created.
	//
	// This member is required.
	CreatedTime *time.Time

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

	// The type of import job.
	//
	// This member is required.
	ImportJobType ImportJobType

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the import job was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The status of the import job.
	//
	// This member is required.
	Status ImportJobStatus

	// 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 configuration information of the external source that the resource data are
	// imported from.
	ExternalSourceConfiguration *ExternalSourceConfiguration

	// The metadata fields of the imported Wisdom resources.
	Metadata map[string]string
	// contains filtered or unexported fields
}

Summary information about the import job.

type ImportJobType added in v1.19.0 

type ImportJobType string
const (
	ImportJobTypeQuickResponses ImportJobType = "QUICK_RESPONSES"
)

Enum values for ImportJobType

func (ImportJobType) Values added in v1.19.0 

func (ImportJobType) Values() []ImportJobType

Values returns all known values for ImportJobType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseAssociationData 

type KnowledgeBaseAssociationData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

Association information about the knowledge base.

type KnowledgeBaseData 

type KnowledgeBaseData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The type of knowledge base.
	//
	// This member is required.
	KnowledgeBaseType KnowledgeBaseType

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

	// The status of the knowledge base.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The description.
	Description *string

	// An epoch timestamp indicating the most recent content modification inside the
	// knowledge base. If no content exists in a knowledge base, this value is unset.
	LastContentModificationTime *time.Time

	// Information about how to render the content.
	RenderingConfiguration *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 ,
	// and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the
	// key to invoke Wisdom.
	//
	// For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance].
	//
	// [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Source configuration information about the knowledge base.
	SourceConfiguration SourceConfiguration

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

Information about the knowledge base.

type KnowledgeBaseStatus 

type KnowledgeBaseStatus string
const (
	KnowledgeBaseStatusCreateInProgress KnowledgeBaseStatus = "CREATE_IN_PROGRESS"
	KnowledgeBaseStatusCreateFailed     KnowledgeBaseStatus = "CREATE_FAILED"
	KnowledgeBaseStatusActive           KnowledgeBaseStatus = "ACTIVE"
	KnowledgeBaseStatusDeleteInProgress KnowledgeBaseStatus = "DELETE_IN_PROGRESS"
	KnowledgeBaseStatusDeleteFailed     KnowledgeBaseStatus = "DELETE_FAILED"
	KnowledgeBaseStatusDeleted          KnowledgeBaseStatus = "DELETED"
)

Enum values for KnowledgeBaseStatus

func (KnowledgeBaseStatus) Values 

func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus

Values returns all known values for KnowledgeBaseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KnowledgeBaseSummary 

type KnowledgeBaseSummary struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The type of knowledge base.
	//
	// This member is required.
	KnowledgeBaseType KnowledgeBaseType

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

	// The status of the knowledge base summary.
	//
	// This member is required.
	Status KnowledgeBaseStatus

	// The description of the knowledge base.
	Description *string

	// Information about how to render the content.
	RenderingConfiguration *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/kms:GenerateDataKey permissions to the IAM identity using the key to
	// invoke Wisdom.
	//
	// For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance].
	//
	// [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// Configuration information about the external data source.
	SourceConfiguration SourceConfiguration

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

Summary information about the knowledge base.

type KnowledgeBaseType 

type KnowledgeBaseType string
const (
	KnowledgeBaseTypeExternal       KnowledgeBaseType = "EXTERNAL"
	KnowledgeBaseTypeCustom         KnowledgeBaseType = "CUSTOM"
	KnowledgeBaseTypeQuickResponses KnowledgeBaseType = "QUICK_RESPONSES"
)

Enum values for KnowledgeBaseType

func (KnowledgeBaseType) Values 

func (KnowledgeBaseType) Values() []KnowledgeBaseType

Values returns all known values for KnowledgeBaseType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NotifyRecommendationsReceivedError 

type NotifyRecommendationsReceivedError struct {

	// A recommendation is causing an error.
	Message *string

	// The identifier of the recommendation that is in error.
	RecommendationId *string
	// contains filtered or unexported fields
}

An error occurred when creating a recommendation.

type Order added in v1.19.0 

type Order string
const (
	OrderAsc  Order = "ASC"
	OrderDesc Order = "DESC"
)

Enum values for Order

func (Order) Values added in v1.19.0 

func (Order) Values() []Order

Values returns all known values for Order. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PreconditionFailedException 

type PreconditionFailedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The provided revisionId does not match, indicating the content has been modified since it was last read.

func (*PreconditionFailedException) Error 

func (e *PreconditionFailedException) Error() string

func (*PreconditionFailedException) ErrorCode 

func (e *PreconditionFailedException) ErrorCode() string

func (*PreconditionFailedException) ErrorFault 

func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault

func (*PreconditionFailedException) ErrorMessage 

func (e *PreconditionFailedException) ErrorMessage() string

type Priority added in v1.19.0 

type Priority string
const (
	PriorityHigh   Priority = "HIGH"
	PriorityMedium Priority = "MEDIUM"
	PriorityLow    Priority = "LOW"
)

Enum values for Priority

func (Priority) Values added in v1.19.0 

func (Priority) Values() []Priority

Values returns all known values for Priority. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryRecommendationTriggerData added in v1.8.0 

type QueryRecommendationTriggerData struct {

	// The text associated with the recommendation trigger.
	Text *string
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

type QuickResponseContentProvider added in v1.19.0 

type QuickResponseContentProvider interface {
	// contains filtered or unexported methods
}

The container quick response content.

The following types satisfy this interface: 

QuickResponseContentProviderMemberContent
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.QuickResponseContentProvider
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QuickResponseContentProviderMemberContent:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type QuickResponseContentProviderMemberContent added in v1.19.0 

type QuickResponseContentProviderMemberContent struct {
	Value string
	// contains filtered or unexported fields
}

The content of the quick response.

type QuickResponseContents added in v1.19.0 

type QuickResponseContents struct {

	// The container quick response content.
	Markdown QuickResponseContentProvider

	// The container quick response content.
	PlainText QuickResponseContentProvider
	// contains filtered or unexported fields
}

The content of the quick response stored in different media types.

type QuickResponseData added in v1.19.0 

type QuickResponseData struct {

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

	// The timestamp when the quick response was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it. Can be either
	// the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the quick response data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

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

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// This member is required.
	QuickResponseArn *string

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

	// The status of the quick response data.
	//
	// This member is required.
	Status QuickResponseStatus

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

	// The contents of the quick response.
	Contents *QuickResponseContents

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

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

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

	// The language code value for the language in which the quick response is written.
	Language *string

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// data.
	LastModifiedBy *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
}

Information about the quick response.

type QuickResponseDataProvider added in v1.19.0 

type QuickResponseDataProvider interface {
	// contains filtered or unexported methods
}

The container of quick response data.

The following types satisfy this interface: 

QuickResponseDataProviderMemberContent
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.QuickResponseDataProvider
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QuickResponseDataProviderMemberContent:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type QuickResponseDataProviderMemberContent added in v1.19.0 

type QuickResponseDataProviderMemberContent struct {
	Value string
	// contains filtered or unexported fields
}

The content of the quick response.

type QuickResponseFilterField added in v1.19.0 

type QuickResponseFilterField struct {

	// The name of the attribute field to filter the quick responses by.
	//
	// This member is required.
	Name *string

	// The operator to use for filtering.
	//
	// This member is required.
	Operator QuickResponseFilterOperator

	// Whether to treat null value as a match for the attribute field.
	IncludeNoExistence *bool

	// The values of attribute field to filter the quick response by.
	Values []string
	// contains filtered or unexported fields
}

The quick response fields to filter the quick response query results by.

The following is the list of supported field names.

  • name

  • description

  • shortcutKey

  • isActive

  • channels

  • language

  • contentType

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

type QuickResponseFilterOperator added in v1.19.0 

type QuickResponseFilterOperator string
const (
	QuickResponseFilterOperatorEquals QuickResponseFilterOperator = "EQUALS"
	QuickResponseFilterOperatorPrefix QuickResponseFilterOperator = "PREFIX"
)

Enum values for QuickResponseFilterOperator

func (QuickResponseFilterOperator) Values added in v1.19.0 

func (QuickResponseFilterOperator) Values() []QuickResponseFilterOperator

Values returns all known values for QuickResponseFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuickResponseOrderField added in v1.19.0 

type QuickResponseOrderField struct {

	// The name of the attribute to order the quick response query results by.
	//
	// This member is required.
	Name *string

	// The order at which the quick responses are sorted by.
	Order Order
	// contains filtered or unexported fields
}

The quick response fields to order the quick response query results by.

The following is the list of supported field names.

  • name

  • description

  • shortcutKey

  • isActive

  • channels

  • language

  • contentType

  • createdTime

  • lastModifiedTime

  • lastModifiedBy

  • groupingConfiguration.criteria

  • groupingConfiguration.values

type QuickResponseQueryField added in v1.19.0 

type QuickResponseQueryField struct {

	// The name of the attribute to query the quick responses by.
	//
	// This member is required.
	Name *string

	// The operator to use for matching attribute field values in the query.
	//
	// This member is required.
	Operator QuickResponseQueryOperator

	// The values of the attribute to query the quick responses by.
	//
	// This member is required.
	Values []string

	// Whether the query expects only exact matches on the attribute field values. The
	// results of the query will only include exact matches if this parameter is set to
	// false.
	AllowFuzziness *bool

	// The importance of the attribute field when calculating query result relevancy
	// scores. The value set for this parameter affects the ordering of search results.
	Priority Priority
	// contains filtered or unexported fields
}

The quick response fields to query quick responses by.

The following is the list of supported field names.

  • content

  • name

  • description

  • shortcutKey

type QuickResponseQueryOperator added in v1.19.0 

type QuickResponseQueryOperator string
const (
	QuickResponseQueryOperatorContains          QuickResponseQueryOperator = "CONTAINS"
	QuickResponseQueryOperatorContainsAndPrefix QuickResponseQueryOperator = "CONTAINS_AND_PREFIX"
)

Enum values for QuickResponseQueryOperator

func (QuickResponseQueryOperator) Values added in v1.19.0 

func (QuickResponseQueryOperator) Values() []QuickResponseQueryOperator

Values returns all known values for QuickResponseQueryOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuickResponseSearchExpression added in v1.19.0 

type QuickResponseSearchExpression struct {

	// The configuration of filtering rules applied to quick response query results.
	Filters []QuickResponseFilterField

	// The quick response attribute fields on which the query results are ordered.
	OrderOnField *QuickResponseOrderField

	// The quick response query expressions.
	Queries []QuickResponseQueryField
	// contains filtered or unexported fields
}

Information about the import job.

type QuickResponseSearchResultData added in v1.19.0 

type QuickResponseSearchResultData struct {

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

	// The contents of the quick response.
	//
	// This member is required.
	Contents *QuickResponseContents

	// The timestamp when the quick response was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// Whether the quick response is active.
	//
	// This member is required.
	IsActive *bool

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it. Can be either
	// the ID or the ARN. URLs cannot contain the ARN.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the quick response search result data was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

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

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// This member is required.
	QuickResponseArn *string

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

	// The resource status of the quick response.
	//
	// This member is required.
	Status QuickResponseStatus

	// The user defined contact attributes that are resolved when the search result is
	// returned.
	AttributesInterpolated []string

	// The user defined contact attributes that are not resolved when the search
	// result is returned.
	AttributesNotInterpolated []string

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

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

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

	// The language code value for the language in which the quick response is written.
	Language *string

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// search result data.
	LastModifiedBy *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
}

The result of quick response search.

type QuickResponseStatus added in v1.19.0 

type QuickResponseStatus string
const (
	QuickResponseStatusCreateInProgress QuickResponseStatus = "CREATE_IN_PROGRESS"
	QuickResponseStatusCreateFailed     QuickResponseStatus = "CREATE_FAILED"
	QuickResponseStatusCreated          QuickResponseStatus = "CREATED"
	QuickResponseStatusDeleteInProgress QuickResponseStatus = "DELETE_IN_PROGRESS"
	QuickResponseStatusDeleteFailed     QuickResponseStatus = "DELETE_FAILED"
	QuickResponseStatusDeleted          QuickResponseStatus = "DELETED"
	QuickResponseStatusUpdateInProgress QuickResponseStatus = "UPDATE_IN_PROGRESS"
	QuickResponseStatusUpdateFailed     QuickResponseStatus = "UPDATE_FAILED"
)

Enum values for QuickResponseStatus

func (QuickResponseStatus) Values added in v1.19.0 

func (QuickResponseStatus) Values() []QuickResponseStatus

Values returns all known values for QuickResponseStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuickResponseSummary added in v1.19.0 

type QuickResponseSummary struct {

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

	// The timestamp when the quick response was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// This member is required.
	KnowledgeBaseArn *string

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES type
	// knowledge base if you're storing Wisdom Content resource to it.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The timestamp when the quick response summary was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

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

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// This member is required.
	QuickResponseArn *string

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

	// The resource status of the quick response.
	//
	// This member is required.
	Status QuickResponseStatus

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

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

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

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// data.
	LastModifiedBy *string

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

The summary information about the quick response.

type RecommendationData 

type RecommendationData struct {

	// The recommended document.
	//
	// This member is required.
	Document *Document

	// The identifier of the recommendation.
	//
	// This member is required.
	RecommendationId *string

	// The relevance level of the recommendation.
	RelevanceLevel RelevanceLevel

	// The relevance score of the recommendation.
	RelevanceScore float64

	// The type of recommendation.
	Type RecommendationType
	// contains filtered or unexported fields
}

Information about the recommendation.

type RecommendationSourceType added in v1.8.0 

type RecommendationSourceType string
const (
	RecommendationSourceTypeIssueDetection RecommendationSourceType = "ISSUE_DETECTION"
	RecommendationSourceTypeRuleEvaluation RecommendationSourceType = "RULE_EVALUATION"
	RecommendationSourceTypeOther          RecommendationSourceType = "OTHER"
)

Enum values for RecommendationSourceType

func (RecommendationSourceType) Values added in v1.8.0 

func (RecommendationSourceType) Values() []RecommendationSourceType

Values returns all known values for RecommendationSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationTrigger added in v1.8.0 

type RecommendationTrigger struct {

	// A union type containing information related to the trigger.
	//
	// This member is required.
	Data RecommendationTriggerData

	// The identifier of the recommendation trigger.
	//
	// This member is required.
	Id *string

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

	// The source of the recommendation trigger.
	//
	//   - ISSUE_DETECTION: The corresponding recommendations were triggered by a
	//   Contact Lens issue.
	//
	//   - RULE_EVALUATION: The corresponding recommendations were triggered by a
	//   Contact Lens rule.
	//
	// This member is required.
	Source RecommendationSourceType

	// The type of recommendation trigger.
	//
	// This member is required.
	Type RecommendationTriggerType
	// contains filtered or unexported fields
}

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

type RecommendationTriggerData added in v1.8.0 

type RecommendationTriggerData interface {
	// contains filtered or unexported methods
}

A union type containing information related to the trigger.

The following types satisfy this interface: 

RecommendationTriggerDataMemberQuery
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.RecommendationTriggerData
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.RecommendationTriggerDataMemberQuery:
		_ = v.Value // Value is types.QueryRecommendationTriggerData

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type RecommendationTriggerDataMemberQuery added in v1.8.0 

type RecommendationTriggerDataMemberQuery struct {
	Value QueryRecommendationTriggerData
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

type RecommendationTriggerType added in v1.8.0 

type RecommendationTriggerType string
const (
	RecommendationTriggerTypeQuery RecommendationTriggerType = "QUERY"
)

Enum values for RecommendationTriggerType

func (RecommendationTriggerType) Values added in v1.8.0 

func (RecommendationTriggerType) Values() []RecommendationTriggerType

Values returns all known values for RecommendationTriggerType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationType added in v1.8.0 

type RecommendationType string
const (
	RecommendationTypeKnowledgeContent RecommendationType = "KNOWLEDGE_CONTENT"
)

Enum values for RecommendationType

func (RecommendationType) Values added in v1.8.0 

func (RecommendationType) Values() []RecommendationType

Values returns all known values for RecommendationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RelevanceLevel 

type RelevanceLevel string
const (
	RelevanceLevelHigh   RelevanceLevel = "HIGH"
	RelevanceLevelMedium RelevanceLevel = "MEDIUM"
	RelevanceLevelLow    RelevanceLevel = "LOW"
)

Enum values for RelevanceLevel

func (RelevanceLevel) Values 

func (RelevanceLevel) Values() []RelevanceLevel

Values returns all known values for RelevanceLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenderingConfiguration 

type RenderingConfiguration struct {

	// A URI template containing exactly one variable in ${variableName} format. This
	// can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and
	// Zendesk, the variable must be one of the following:
	//
	//   - Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or
	//   IsDeleted
	//
	//   - ServiceNow: number , short_description , sys_mod_count , workflow_state , or
	//   active
	//
	//   - Zendesk: id , title , updated_at , or draft
	//
	// The variable is replaced with the actual value for a piece of content when
	// calling [GetContent].
	//
	// [GetContent]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html
	TemplateUri *string
	// contains filtered or unexported fields
}

Information about how to render the content.

type RequestTimeoutException added in v1.19.0 

type RequestTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

func (*RequestTimeoutException) Error added in v1.19.0 

func (e *RequestTimeoutException) Error() string

func (*RequestTimeoutException) ErrorCode added in v1.19.0 

func (e *RequestTimeoutException) ErrorCode() string

func (*RequestTimeoutException) ErrorFault added in v1.19.0 

func (e *RequestTimeoutException) ErrorFault() smithy.ErrorFault

func (*RequestTimeoutException) ErrorMessage added in v1.19.0 

func (e *RequestTimeoutException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResultData 

type ResultData struct {

	// The document.
	//
	// This member is required.
	Document *Document

	// The identifier of the result data.
	//
	// This member is required.
	ResultId *string

	// The relevance score of the results.
	RelevanceScore float64
	// contains filtered or unexported fields
}

Information about the result.

type SearchExpression 

type SearchExpression struct {

	// The search expression filters.
	//
	// This member is required.
	Filters []Filter
	// contains filtered or unexported fields
}

The search expression.

type ServerSideEncryptionConfiguration 

type ServerSideEncryptionConfiguration struct {

	// The customer managed key used for encryption. For more information about
	// setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. For information about valid
	// ID values, see [Key identifiers (KeyId)].
	//
	// [Key identifiers (KeyId)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
	// [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
	KmsKeyId *string
	// contains filtered or unexported fields
}

The configuration information for the customer managed key used for encryption.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SessionData 

type SessionData struct {

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

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

	// The description of the session.
	Description *string

	// The configuration information for the session integration.
	IntegrationConfiguration *SessionIntegrationConfiguration

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

Information about the session.

type SessionIntegrationConfiguration added in v1.14.0 

type SessionIntegrationConfiguration struct {

	// The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for
	// streaming chat messages.
	TopicIntegrationArn *string
	// contains filtered or unexported fields
}

The configuration information for the session integration.

type SessionSummary 

type SessionSummary struct {

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

	// The identifier of the Wisdom assistant.
	//
	// This member is required.
	AssistantId *string

	// 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
	// contains filtered or unexported fields
}

Summary information about the session.

type SourceConfiguration 

type SourceConfiguration interface {
	// contains filtered or unexported methods
}

Configuration information about the external data source.

The following types satisfy this interface: 

SourceConfigurationMemberAppIntegrations
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/wisdom/types"
)

func main() {
	var union types.SourceConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SourceConfigurationMemberAppIntegrations:
		_ = v.Value // Value is types.AppIntegrationsConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type SourceConfigurationMemberAppIntegrations 

type SourceConfigurationMemberAppIntegrations struct {
	Value AppIntegrationsConfiguration
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by a service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

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.