qconnect

package
v1.50.26 Latest Latest
Warning

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

Go to latest
Published: Feb 26, 2024 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package qconnect provides the client and types for making API requests to Amazon Q Connect.

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection (https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html). 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 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 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 (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html) in the Amazon Connect Administrator Guide.

See https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19 for more information on this service.

See qconnect package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/qconnect/

Using the Client

To contact Amazon Q Connect with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Q Connect client QConnect for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/qconnect/#New

Index

Constants

View Source
const (
	// AssistantCapabilityTypeV1 is a AssistantCapabilityType enum value
	AssistantCapabilityTypeV1 = "V1"

	// AssistantCapabilityTypeV2 is a AssistantCapabilityType enum value
	AssistantCapabilityTypeV2 = "V2"
)
View Source
const (
	// AssistantStatusCreateInProgress is a AssistantStatus enum value
	AssistantStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// AssistantStatusCreateFailed is a AssistantStatus enum value
	AssistantStatusCreateFailed = "CREATE_FAILED"

	// AssistantStatusActive is a AssistantStatus enum value
	AssistantStatusActive = "ACTIVE"

	// AssistantStatusDeleteInProgress is a AssistantStatus enum value
	AssistantStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// AssistantStatusDeleteFailed is a AssistantStatus enum value
	AssistantStatusDeleteFailed = "DELETE_FAILED"

	// AssistantStatusDeleted is a AssistantStatus enum value
	AssistantStatusDeleted = "DELETED"
)
View Source
const (
	// ContentStatusCreateInProgress is a ContentStatus enum value
	ContentStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// ContentStatusCreateFailed is a ContentStatus enum value
	ContentStatusCreateFailed = "CREATE_FAILED"

	// ContentStatusActive is a ContentStatus enum value
	ContentStatusActive = "ACTIVE"

	// ContentStatusDeleteInProgress is a ContentStatus enum value
	ContentStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// ContentStatusDeleteFailed is a ContentStatus enum value
	ContentStatusDeleteFailed = "DELETE_FAILED"

	// ContentStatusDeleted is a ContentStatus enum value
	ContentStatusDeleted = "DELETED"

	// ContentStatusUpdateFailed is a ContentStatus enum value
	ContentStatusUpdateFailed = "UPDATE_FAILED"
)
View Source
const (
	// ImportJobStatusStartInProgress is a ImportJobStatus enum value
	ImportJobStatusStartInProgress = "START_IN_PROGRESS"

	// ImportJobStatusFailed is a ImportJobStatus enum value
	ImportJobStatusFailed = "FAILED"

	// ImportJobStatusComplete is a ImportJobStatus enum value
	ImportJobStatusComplete = "COMPLETE"

	// ImportJobStatusDeleteInProgress is a ImportJobStatus enum value
	ImportJobStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// ImportJobStatusDeleteFailed is a ImportJobStatus enum value
	ImportJobStatusDeleteFailed = "DELETE_FAILED"

	// ImportJobStatusDeleted is a ImportJobStatus enum value
	ImportJobStatusDeleted = "DELETED"
)
View Source
const (
	// KnowledgeBaseStatusCreateInProgress is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// KnowledgeBaseStatusCreateFailed is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusCreateFailed = "CREATE_FAILED"

	// KnowledgeBaseStatusActive is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusActive = "ACTIVE"

	// KnowledgeBaseStatusDeleteInProgress is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// KnowledgeBaseStatusDeleteFailed is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusDeleteFailed = "DELETE_FAILED"

	// KnowledgeBaseStatusDeleted is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusDeleted = "DELETED"
)
View Source
const (
	// KnowledgeBaseTypeExternal is a KnowledgeBaseType enum value
	KnowledgeBaseTypeExternal = "EXTERNAL"

	// KnowledgeBaseTypeCustom is a KnowledgeBaseType enum value
	KnowledgeBaseTypeCustom = "CUSTOM"

	// KnowledgeBaseTypeQuickResponses is a KnowledgeBaseType enum value
	KnowledgeBaseTypeQuickResponses = "QUICK_RESPONSES"
)
View Source
const (
	// OrderAsc is a Order enum value
	OrderAsc = "ASC"

	// OrderDesc is a Order enum value
	OrderDesc = "DESC"
)
View Source
const (
	// PriorityHigh is a Priority enum value
	PriorityHigh = "HIGH"

	// PriorityMedium is a Priority enum value
	PriorityMedium = "MEDIUM"

	// PriorityLow is a Priority enum value
	PriorityLow = "LOW"
)
View Source
const (
	// QueryResultTypeKnowledgeContent is a QueryResultType enum value
	QueryResultTypeKnowledgeContent = "KNOWLEDGE_CONTENT"

	// QueryResultTypeGenerativeAnswer is a QueryResultType enum value
	QueryResultTypeGenerativeAnswer = "GENERATIVE_ANSWER"
)
View Source
const (
	// QuickResponseFilterOperatorEquals is a QuickResponseFilterOperator enum value
	QuickResponseFilterOperatorEquals = "EQUALS"

	// QuickResponseFilterOperatorPrefix is a QuickResponseFilterOperator enum value
	QuickResponseFilterOperatorPrefix = "PREFIX"
)
View Source
const (
	// QuickResponseQueryOperatorContains is a QuickResponseQueryOperator enum value
	QuickResponseQueryOperatorContains = "CONTAINS"

	// QuickResponseQueryOperatorContainsAndPrefix is a QuickResponseQueryOperator enum value
	QuickResponseQueryOperatorContainsAndPrefix = "CONTAINS_AND_PREFIX"
)
View Source
const (
	// QuickResponseStatusCreateInProgress is a QuickResponseStatus enum value
	QuickResponseStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// QuickResponseStatusCreateFailed is a QuickResponseStatus enum value
	QuickResponseStatusCreateFailed = "CREATE_FAILED"

	// QuickResponseStatusCreated is a QuickResponseStatus enum value
	QuickResponseStatusCreated = "CREATED"

	// QuickResponseStatusDeleteInProgress is a QuickResponseStatus enum value
	QuickResponseStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// QuickResponseStatusDeleteFailed is a QuickResponseStatus enum value
	QuickResponseStatusDeleteFailed = "DELETE_FAILED"

	// QuickResponseStatusDeleted is a QuickResponseStatus enum value
	QuickResponseStatusDeleted = "DELETED"

	// QuickResponseStatusUpdateInProgress is a QuickResponseStatus enum value
	QuickResponseStatusUpdateInProgress = "UPDATE_IN_PROGRESS"

	// QuickResponseStatusUpdateFailed is a QuickResponseStatus enum value
	QuickResponseStatusUpdateFailed = "UPDATE_FAILED"
)
View Source
const (
	// RecommendationSourceTypeIssueDetection is a RecommendationSourceType enum value
	RecommendationSourceTypeIssueDetection = "ISSUE_DETECTION"

	// RecommendationSourceTypeRuleEvaluation is a RecommendationSourceType enum value
	RecommendationSourceTypeRuleEvaluation = "RULE_EVALUATION"

	// RecommendationSourceTypeOther is a RecommendationSourceType enum value
	RecommendationSourceTypeOther = "OTHER"
)
View Source
const (
	// RecommendationTriggerTypeQuery is a RecommendationTriggerType enum value
	RecommendationTriggerTypeQuery = "QUERY"

	// RecommendationTriggerTypeGenerative is a RecommendationTriggerType enum value
	RecommendationTriggerTypeGenerative = "GENERATIVE"
)
View Source
const (
	// RecommendationTypeKnowledgeContent is a RecommendationType enum value
	RecommendationTypeKnowledgeContent = "KNOWLEDGE_CONTENT"

	// RecommendationTypeGenerativeResponse is a RecommendationType enum value
	RecommendationTypeGenerativeResponse = "GENERATIVE_RESPONSE"

	// RecommendationTypeGenerativeAnswer is a RecommendationType enum value
	RecommendationTypeGenerativeAnswer = "GENERATIVE_ANSWER"
)
View Source
const (
	// RelevanceHelpful is a Relevance enum value
	RelevanceHelpful = "HELPFUL"

	// RelevanceNotHelpful is a Relevance enum value
	RelevanceNotHelpful = "NOT_HELPFUL"
)
View Source
const (
	// RelevanceLevelHigh is a RelevanceLevel enum value
	RelevanceLevelHigh = "HIGH"

	// RelevanceLevelMedium is a RelevanceLevel enum value
	RelevanceLevelMedium = "MEDIUM"

	// RelevanceLevelLow is a RelevanceLevel enum value
	RelevanceLevelLow = "LOW"
)
View Source
const (
	// TargetTypeRecommendation is a TargetType enum value
	TargetTypeRecommendation = "RECOMMENDATION"

	// TargetTypeResult is a TargetType enum value
	TargetTypeResult = "RESULT"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// 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.
	ErrCodeConflictException = "ConflictException"

	// ErrCodePreconditionFailedException for service response error code
	// "PreconditionFailedException".
	//
	// The provided revisionId does not match, indicating the content has been modified
	// since it was last read.
	ErrCodePreconditionFailedException = "PreconditionFailedException"

	// ErrCodeRequestTimeoutException for service response error code
	// "RequestTimeoutException".
	//
	// 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.
	ErrCodeRequestTimeoutException = "RequestTimeoutException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// 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.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// Amazon Q in Connect throws this exception if you have too many tags in your
	// tag set.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by a service.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "QConnect" // Name of service.
	EndpointsID = "wisdom"   // ID to lookup a service endpoint with.
	ServiceID   = "QConnect" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// AssistantTypeAgent is a AssistantType enum value
	AssistantTypeAgent = "AGENT"
)
View Source
const (
	// AssociationTypeKnowledgeBase is a AssociationType enum value
	AssociationTypeKnowledgeBase = "KNOWLEDGE_BASE"
)
View Source
const (
	// ExternalSourceAmazonConnect is a ExternalSource enum value
	ExternalSourceAmazonConnect = "AMAZON_CONNECT"
)
View Source
const (
	// FilterFieldName is a FilterField enum value
	FilterFieldName = "NAME"
)
View Source
const (
	// FilterOperatorEquals is a FilterOperator enum value
	FilterOperatorEquals = "EQUALS"
)
View Source
const (
	// ImportJobTypeQuickResponses is a ImportJobType enum value
	ImportJobTypeQuickResponses = "QUICK_RESPONSES"
)
View Source
const (
	// QueryConditionComparisonOperatorEquals is a QueryConditionComparisonOperator enum value
	QueryConditionComparisonOperatorEquals = "EQUALS"
)
View Source
const (
	// QueryConditionFieldNameResultType is a QueryConditionFieldName enum value
	QueryConditionFieldNameResultType = "RESULT_TYPE"
)
View Source
const (
	// SourceContentTypeKnowledgeContent is a SourceContentType enum value
	SourceContentTypeKnowledgeContent = "KNOWLEDGE_CONTENT"
)

Variables

This section is empty.

Functions

func AssistantCapabilityType_Values

func AssistantCapabilityType_Values() []string

AssistantCapabilityType_Values returns all elements of the AssistantCapabilityType enum

func AssistantStatus_Values

func AssistantStatus_Values() []string

AssistantStatus_Values returns all elements of the AssistantStatus enum

func AssistantType_Values

func AssistantType_Values() []string

AssistantType_Values returns all elements of the AssistantType enum

func AssociationType_Values

func AssociationType_Values() []string

AssociationType_Values returns all elements of the AssociationType enum

func ContentStatus_Values

func ContentStatus_Values() []string

ContentStatus_Values returns all elements of the ContentStatus enum

func ExternalSource_Values

func ExternalSource_Values() []string

ExternalSource_Values returns all elements of the ExternalSource enum

func FilterField_Values

func FilterField_Values() []string

FilterField_Values returns all elements of the FilterField enum

func FilterOperator_Values

func FilterOperator_Values() []string

FilterOperator_Values returns all elements of the FilterOperator enum

func ImportJobStatus_Values

func ImportJobStatus_Values() []string

ImportJobStatus_Values returns all elements of the ImportJobStatus enum

func ImportJobType_Values

func ImportJobType_Values() []string

ImportJobType_Values returns all elements of the ImportJobType enum

func KnowledgeBaseStatus_Values

func KnowledgeBaseStatus_Values() []string

KnowledgeBaseStatus_Values returns all elements of the KnowledgeBaseStatus enum

func KnowledgeBaseType_Values

func KnowledgeBaseType_Values() []string

KnowledgeBaseType_Values returns all elements of the KnowledgeBaseType enum

func Order_Values

func Order_Values() []string

Order_Values returns all elements of the Order enum

func Priority_Values

func Priority_Values() []string

Priority_Values returns all elements of the Priority enum

func QueryConditionComparisonOperator_Values

func QueryConditionComparisonOperator_Values() []string

QueryConditionComparisonOperator_Values returns all elements of the QueryConditionComparisonOperator enum

func QueryConditionFieldName_Values

func QueryConditionFieldName_Values() []string

QueryConditionFieldName_Values returns all elements of the QueryConditionFieldName enum

func QueryResultType_Values

func QueryResultType_Values() []string

QueryResultType_Values returns all elements of the QueryResultType enum

func QuickResponseFilterOperator_Values

func QuickResponseFilterOperator_Values() []string

QuickResponseFilterOperator_Values returns all elements of the QuickResponseFilterOperator enum

func QuickResponseQueryOperator_Values

func QuickResponseQueryOperator_Values() []string

QuickResponseQueryOperator_Values returns all elements of the QuickResponseQueryOperator enum

func QuickResponseStatus_Values

func QuickResponseStatus_Values() []string

QuickResponseStatus_Values returns all elements of the QuickResponseStatus enum

func RecommendationSourceType_Values

func RecommendationSourceType_Values() []string

RecommendationSourceType_Values returns all elements of the RecommendationSourceType enum

func RecommendationTriggerType_Values

func RecommendationTriggerType_Values() []string

RecommendationTriggerType_Values returns all elements of the RecommendationTriggerType enum

func RecommendationType_Values

func RecommendationType_Values() []string

RecommendationType_Values returns all elements of the RecommendationType enum

func RelevanceLevel_Values

func RelevanceLevel_Values() []string

RelevanceLevel_Values returns all elements of the RelevanceLevel enum

func Relevance_Values added in v1.48.11

func Relevance_Values() []string

Relevance_Values returns all elements of the Relevance enum

func SourceContentType_Values

func SourceContentType_Values() []string

SourceContentType_Values returns all elements of the SourceContentType enum

func TargetType_Values added in v1.48.11

func TargetType_Values() []string

TargetType_Values returns all elements of the TargetType enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppIntegrationsConfiguration

type AppIntegrationsConfiguration struct {

	// The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to
	// use for ingesting content.
	//
	//    * For Salesforce (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm),
	//    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 (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api),
	//    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 (https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/),
	//    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 (https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index),
	//    your AppIntegrations DataIntegration must have a FileConfiguration, including
	//    only file extensions that are among docx, pdf, html, htm, and txt.
	//
	//    * For Amazon S3 (https://aws.amazon.com/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.
	//
	// AppIntegrationArn is a required field
	AppIntegrationArn *string `locationName:"appIntegrationArn" min:"1" type:"string" required:"true"`

	// The fields from the source that are made available to your agents in Amazon
	// Q. Optional if ObjectConfiguration is included in the provided DataIntegration.
	//
	//    * For Salesforce (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm),
	//    you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus,
	//    and IsDeleted.
	//
	//    * For ServiceNow (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api),
	//    you must include at least number, short_description, sys_mod_count, workflow_state,
	//    and active.
	//
	//    * For Zendesk (https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/),
	//    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.
	ObjectFields []*string `locationName:"objectFields" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Configuration information for Amazon AppIntegrations to automatically ingest content.

func (AppIntegrationsConfiguration) GoString

func (s AppIntegrationsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppIntegrationsConfiguration) SetAppIntegrationArn

SetAppIntegrationArn sets the AppIntegrationArn field's value.

func (*AppIntegrationsConfiguration) SetObjectFields

SetObjectFields sets the ObjectFields field's value.

func (AppIntegrationsConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppIntegrationsConfiguration) Validate

func (s *AppIntegrationsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssistantAssociationData

type AssistantAssociationData struct {

	// The Amazon Resource Name (ARN) of the Amazon Q assistant.
	//
	// AssistantArn is a required field
	AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// AssistantAssociationArn is a required field
	AssistantAssociationArn *string `locationName:"assistantAssociationArn" type:"string" required:"true"`

	// The identifier of the assistant association.
	//
	// AssistantAssociationId is a required field
	AssistantAssociationId *string `locationName:"assistantAssociationId" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `locationName:"assistantId" type:"string" required:"true"`

	// A union type that currently has a single argument, the knowledge base ID.
	//
	// AssociationData is a required field
	AssociationData *AssistantAssociationOutputData `locationName:"associationData" type:"structure" required:"true"`

	// The type of association.
	//
	// AssociationType is a required field
	AssociationType *string `locationName:"associationType" type:"string" required:"true" enum:"AssociationType"`

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

Information about the assistant association.

func (AssistantAssociationData) GoString

func (s AssistantAssociationData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantAssociationData) SetAssistantArn

SetAssistantArn sets the AssistantArn field's value.

func (*AssistantAssociationData) SetAssistantAssociationArn

func (s *AssistantAssociationData) SetAssistantAssociationArn(v string) *AssistantAssociationData

SetAssistantAssociationArn sets the AssistantAssociationArn field's value.

func (*AssistantAssociationData) SetAssistantAssociationId

func (s *AssistantAssociationData) SetAssistantAssociationId(v string) *AssistantAssociationData

SetAssistantAssociationId sets the AssistantAssociationId field's value.

func (*AssistantAssociationData) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (*AssistantAssociationData) SetAssociationData

SetAssociationData sets the AssociationData field's value.

func (*AssistantAssociationData) SetAssociationType

func (s *AssistantAssociationData) SetAssociationType(v string) *AssistantAssociationData

SetAssociationType sets the AssociationType field's value.

func (*AssistantAssociationData) SetTags

SetTags sets the Tags field's value.

func (AssistantAssociationData) String

func (s AssistantAssociationData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantAssociationInputData

type AssistantAssociationInputData struct {

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

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

func (AssistantAssociationInputData) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantAssociationInputData) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (AssistantAssociationInputData) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantAssociationOutputData

type AssistantAssociationOutputData struct {

	// The knowledge base where output data is sent.
	KnowledgeBaseAssociation *KnowledgeBaseAssociationData `locationName:"knowledgeBaseAssociation" type:"structure"`
	// contains filtered or unexported fields
}

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

func (AssistantAssociationOutputData) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantAssociationOutputData) SetKnowledgeBaseAssociation

SetKnowledgeBaseAssociation sets the KnowledgeBaseAssociation field's value.

func (AssistantAssociationOutputData) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantAssociationSummary

type AssistantAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the Amazon Q assistant.
	//
	// AssistantArn is a required field
	AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the assistant association.
	//
	// AssistantAssociationArn is a required field
	AssistantAssociationArn *string `locationName:"assistantAssociationArn" type:"string" required:"true"`

	// The identifier of the assistant association.
	//
	// AssistantAssociationId is a required field
	AssistantAssociationId *string `locationName:"assistantAssociationId" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `locationName:"assistantId" type:"string" required:"true"`

	// The association data.
	//
	// AssociationData is a required field
	AssociationData *AssistantAssociationOutputData `locationName:"associationData" type:"structure" required:"true"`

	// The type of association.
	//
	// AssociationType is a required field
	AssociationType *string `locationName:"associationType" type:"string" required:"true" enum:"AssociationType"`

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

Summary information about the assistant association.

func (AssistantAssociationSummary) GoString

func (s AssistantAssociationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantAssociationSummary) SetAssistantArn

SetAssistantArn sets the AssistantArn field's value.

func (*AssistantAssociationSummary) SetAssistantAssociationArn

func (s *AssistantAssociationSummary) SetAssistantAssociationArn(v string) *AssistantAssociationSummary

SetAssistantAssociationArn sets the AssistantAssociationArn field's value.

func (*AssistantAssociationSummary) SetAssistantAssociationId

func (s *AssistantAssociationSummary) SetAssistantAssociationId(v string) *AssistantAssociationSummary

SetAssistantAssociationId sets the AssistantAssociationId field's value.

func (*AssistantAssociationSummary) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (*AssistantAssociationSummary) SetAssociationData

SetAssociationData sets the AssociationData field's value.

func (*AssistantAssociationSummary) SetAssociationType

SetAssociationType sets the AssociationType field's value.

func (*AssistantAssociationSummary) SetTags

SetTags sets the Tags field's value.

func (AssistantAssociationSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantCapabilityConfiguration

type AssistantCapabilityConfiguration struct {

	// The type of Amazon Q assistant capability.
	Type *string `locationName:"type" type:"string" enum:"AssistantCapabilityType"`
	// contains filtered or unexported fields
}

The capability configuration for an Amazon Q assistant.

func (AssistantCapabilityConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantCapabilityConfiguration) SetType

SetType sets the Type field's value.

func (AssistantCapabilityConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantData

type AssistantData struct {

	// The Amazon Resource Name (ARN) of the Amazon Q assistant.
	//
	// AssistantArn is a required field
	AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `locationName:"assistantId" type:"string" required:"true"`

	// The configuration information for the Amazon Q assistant capability.
	CapabilityConfiguration *AssistantCapabilityConfiguration `locationName:"capabilityConfiguration" type:"structure"`

	// The description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The configuration information for the Amazon Q assistant integration.
	IntegrationConfiguration *AssistantIntegrationConfiguration `locationName:"integrationConfiguration" type:"structure"`

	// The name.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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. To use Amazon Q 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,
	// see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// The status of the assistant.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AssistantStatus"`

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The type of assistant.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AssistantType"`
	// contains filtered or unexported fields
}

The assistant data.

func (AssistantData) GoString

func (s AssistantData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantData) SetAssistantArn

func (s *AssistantData) SetAssistantArn(v string) *AssistantData

SetAssistantArn sets the AssistantArn field's value.

func (*AssistantData) SetAssistantId

func (s *AssistantData) SetAssistantId(v string) *AssistantData

SetAssistantId sets the AssistantId field's value.

func (*AssistantData) SetCapabilityConfiguration

func (s *AssistantData) SetCapabilityConfiguration(v *AssistantCapabilityConfiguration) *AssistantData

SetCapabilityConfiguration sets the CapabilityConfiguration field's value.

func (*AssistantData) SetDescription

func (s *AssistantData) SetDescription(v string) *AssistantData

SetDescription sets the Description field's value.

func (*AssistantData) SetIntegrationConfiguration

func (s *AssistantData) SetIntegrationConfiguration(v *AssistantIntegrationConfiguration) *AssistantData

SetIntegrationConfiguration sets the IntegrationConfiguration field's value.

func (*AssistantData) SetName

func (s *AssistantData) SetName(v string) *AssistantData

SetName sets the Name field's value.

func (*AssistantData) SetServerSideEncryptionConfiguration

func (s *AssistantData) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *AssistantData

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*AssistantData) SetStatus

func (s *AssistantData) SetStatus(v string) *AssistantData

SetStatus sets the Status field's value.

func (*AssistantData) SetTags

func (s *AssistantData) SetTags(v map[string]*string) *AssistantData

SetTags sets the Tags field's value.

func (*AssistantData) SetType

func (s *AssistantData) SetType(v string) *AssistantData

SetType sets the Type field's value.

func (AssistantData) String

func (s AssistantData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantIntegrationConfiguration

type AssistantIntegrationConfiguration struct {

	// The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for
	// streaming chat messages.
	TopicIntegrationArn *string `locationName:"topicIntegrationArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The configuration information for the Amazon Q assistant integration.

func (AssistantIntegrationConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantIntegrationConfiguration) SetTopicIntegrationArn

SetTopicIntegrationArn sets the TopicIntegrationArn field's value.

func (AssistantIntegrationConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssistantSummary

type AssistantSummary struct {

	// The Amazon Resource Name (ARN) of the Amazon Q assistant.
	//
	// AssistantArn is a required field
	AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `locationName:"assistantId" type:"string" required:"true"`

	// The configuration information for the Amazon Q assistant capability.
	CapabilityConfiguration *AssistantCapabilityConfiguration `locationName:"capabilityConfiguration" type:"structure"`

	// The description of the assistant.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The configuration information for the Amazon Q assistant integration.
	IntegrationConfiguration *AssistantIntegrationConfiguration `locationName:"integrationConfiguration" type:"structure"`

	// The name of the assistant.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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. To use Amazon Q 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,
	// see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// The status of the assistant.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AssistantStatus"`

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The type of the assistant.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AssistantType"`
	// contains filtered or unexported fields
}

Summary information about the assistant.

func (AssistantSummary) GoString

func (s AssistantSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssistantSummary) SetAssistantArn

func (s *AssistantSummary) SetAssistantArn(v string) *AssistantSummary

SetAssistantArn sets the AssistantArn field's value.

func (*AssistantSummary) SetAssistantId

func (s *AssistantSummary) SetAssistantId(v string) *AssistantSummary

SetAssistantId sets the AssistantId field's value.

func (*AssistantSummary) SetCapabilityConfiguration

func (s *AssistantSummary) SetCapabilityConfiguration(v *AssistantCapabilityConfiguration) *AssistantSummary

SetCapabilityConfiguration sets the CapabilityConfiguration field's value.

func (*AssistantSummary) SetDescription

func (s *AssistantSummary) SetDescription(v string) *AssistantSummary

SetDescription sets the Description field's value.

func (*AssistantSummary) SetIntegrationConfiguration

func (s *AssistantSummary) SetIntegrationConfiguration(v *AssistantIntegrationConfiguration) *AssistantSummary

SetIntegrationConfiguration sets the IntegrationConfiguration field's value.

func (*AssistantSummary) SetName

func (s *AssistantSummary) SetName(v string) *AssistantSummary

SetName sets the Name field's value.

func (*AssistantSummary) SetServerSideEncryptionConfiguration

func (s *AssistantSummary) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *AssistantSummary

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*AssistantSummary) SetStatus

func (s *AssistantSummary) SetStatus(v string) *AssistantSummary

SetStatus sets the Status field's value.

func (*AssistantSummary) SetTags

func (s *AssistantSummary) SetTags(v map[string]*string) *AssistantSummary

SetTags sets the Tags field's value.

func (*AssistantSummary) SetType

func (s *AssistantSummary) SetType(v string) *AssistantSummary

SetType sets the Type field's value.

func (AssistantSummary) String

func (s AssistantSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Configuration

type Configuration struct {

	// The configuration information of the Amazon Connect data source.
	ConnectConfiguration *ConnectConfiguration `locationName:"connectConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The configuration information of the external data source.

func (Configuration) GoString

func (s Configuration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Configuration) SetConnectConfiguration

func (s *Configuration) SetConnectConfiguration(v *ConnectConfiguration) *Configuration

SetConnectConfiguration sets the ConnectConfiguration field's value.

func (Configuration) String

func (s Configuration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Configuration) Validate

func (s *Configuration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectConfiguration

type ConnectConfiguration struct {

	// The identifier of the Amazon Connect instance. You can find the instanceId
	// in the ARN of the instance.
	InstanceId *string `locationName:"instanceId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The configuration information of the Amazon Connect data source.

func (ConnectConfiguration) GoString

func (s ConnectConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectConfiguration) SetInstanceId

func (s *ConnectConfiguration) SetInstanceId(v string) *ConnectConfiguration

SetInstanceId sets the InstanceId field's value.

func (ConnectConfiguration) String

func (s ConnectConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectConfiguration) Validate

func (s *ConnectConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContentData

type ContentData struct {

	// The Amazon Resource Name (ARN) of the content.
	//
	// ContentArn is a required field
	ContentArn *string `locationName:"contentArn" type:"string" required:"true"`

	// The identifier of the content.
	//
	// ContentId is a required field
	ContentId *string `locationName:"contentId" type:"string" required:"true"`

	// The media type of the content.
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The URI of the content.
	LinkOutUri *string `locationName:"linkOutUri" min:"1" type:"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, you can store an external version identifier as metadata to utilize for
	// determining drift.
	//
	// Metadata is a required field
	Metadata map[string]*string `locationName:"metadata" type:"map" required:"true"`

	// The name of the content.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The identifier of the content revision.
	//
	// RevisionId is a required field
	RevisionId *string `locationName:"revisionId" min:"1" type:"string" required:"true"`

	// The status of the content.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ContentStatus"`

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The title of the content.
	//
	// Title is a required field
	Title *string `locationName:"title" min:"1" type:"string" required:"true"`

	// The URL of the content.
	//
	// Url is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ContentData's
	// String and GoString methods.
	//
	// Url is a required field
	Url *string `locationName:"url" min:"1" type:"string" required:"true" sensitive:"true"`

	// The expiration time of the URL as an epoch timestamp.
	//
	// UrlExpiry is a required field
	UrlExpiry *time.Time `locationName:"urlExpiry" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`
	// contains filtered or unexported fields
}

Information about the content.

func (ContentData) GoString

func (s ContentData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentData) SetContentArn

func (s *ContentData) SetContentArn(v string) *ContentData

SetContentArn sets the ContentArn field's value.

func (*ContentData) SetContentId

func (s *ContentData) SetContentId(v string) *ContentData

SetContentId sets the ContentId field's value.

func (*ContentData) SetContentType

func (s *ContentData) SetContentType(v string) *ContentData

SetContentType sets the ContentType field's value.

func (*ContentData) SetKnowledgeBaseArn

func (s *ContentData) SetKnowledgeBaseArn(v string) *ContentData

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*ContentData) SetKnowledgeBaseId

func (s *ContentData) SetKnowledgeBaseId(v string) *ContentData

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ContentData) SetLinkOutUri

func (s *ContentData) SetLinkOutUri(v string) *ContentData

SetLinkOutUri sets the LinkOutUri field's value.

func (*ContentData) SetMetadata

func (s *ContentData) SetMetadata(v map[string]*string) *ContentData

SetMetadata sets the Metadata field's value.

func (*ContentData) SetName

func (s *ContentData) SetName(v string) *ContentData

SetName sets the Name field's value.

func (*ContentData) SetRevisionId

func (s *ContentData) SetRevisionId(v string) *ContentData

SetRevisionId sets the RevisionId field's value.

func (*ContentData) SetStatus

func (s *ContentData) SetStatus(v string) *ContentData

SetStatus sets the Status field's value.

func (*ContentData) SetTags

func (s *ContentData) SetTags(v map[string]*string) *ContentData

SetTags sets the Tags field's value.

func (*ContentData) SetTitle

func (s *ContentData) SetTitle(v string) *ContentData

SetTitle sets the Title field's value.

func (*ContentData) SetUrl

func (s *ContentData) SetUrl(v string) *ContentData

SetUrl sets the Url field's value.

func (*ContentData) SetUrlExpiry

func (s *ContentData) SetUrlExpiry(v time.Time) *ContentData

SetUrlExpiry sets the UrlExpiry field's value.

func (ContentData) String

func (s ContentData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContentDataDetails

type ContentDataDetails struct {

	// Details about the content ranking data.
	//
	// RankingData is a required field
	RankingData *RankingData `locationName:"rankingData" type:"structure" required:"true"`

	// Details about the content text data.
	//
	// TextData is a required field
	TextData *TextData `locationName:"textData" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Details about the content data.

func (ContentDataDetails) GoString

func (s ContentDataDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentDataDetails) SetRankingData

func (s *ContentDataDetails) SetRankingData(v *RankingData) *ContentDataDetails

SetRankingData sets the RankingData field's value.

func (*ContentDataDetails) SetTextData

func (s *ContentDataDetails) SetTextData(v *TextData) *ContentDataDetails

SetTextData sets the TextData field's value.

func (ContentDataDetails) String

func (s ContentDataDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContentFeedbackData added in v1.48.11

type ContentFeedbackData struct {

	// Information about the feedback for a generative target type.
	GenerativeContentFeedbackData *GenerativeContentFeedbackData `locationName:"generativeContentFeedbackData" type:"structure"`
	// contains filtered or unexported fields
}

Information about the feedback.

func (ContentFeedbackData) GoString added in v1.48.11

func (s ContentFeedbackData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentFeedbackData) SetGenerativeContentFeedbackData added in v1.48.11

func (s *ContentFeedbackData) SetGenerativeContentFeedbackData(v *GenerativeContentFeedbackData) *ContentFeedbackData

SetGenerativeContentFeedbackData sets the GenerativeContentFeedbackData field's value.

func (ContentFeedbackData) String added in v1.48.11

func (s ContentFeedbackData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentFeedbackData) Validate added in v1.48.11

func (s *ContentFeedbackData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContentReference

type ContentReference struct {

	// The Amazon Resource Name (ARN) of the content.
	ContentArn *string `locationName:"contentArn" type:"string"`

	// The identifier of the content.
	ContentId *string `locationName:"contentId" type:"string"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string"`

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

Reference information about the content.

func (ContentReference) GoString

func (s ContentReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentReference) SetContentArn

func (s *ContentReference) SetContentArn(v string) *ContentReference

SetContentArn sets the ContentArn field's value.

func (*ContentReference) SetContentId

func (s *ContentReference) SetContentId(v string) *ContentReference

SetContentId sets the ContentId field's value.

func (*ContentReference) SetKnowledgeBaseArn

func (s *ContentReference) SetKnowledgeBaseArn(v string) *ContentReference

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*ContentReference) SetKnowledgeBaseId

func (s *ContentReference) SetKnowledgeBaseId(v string) *ContentReference

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (ContentReference) String

func (s ContentReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContentSummary

type ContentSummary struct {

	// The Amazon Resource Name (ARN) of the content.
	//
	// ContentArn is a required field
	ContentArn *string `locationName:"contentArn" type:"string" required:"true"`

	// The identifier of the content.
	//
	// ContentId is a required field
	ContentId *string `locationName:"contentId" type:"string" required:"true"`

	// The media type of the content.
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// A key/value map to store attributes without affecting tagging or recommendations.
	// For example, when synchronizing data between an external system and Amazon
	// Q, you can store an external version identifier as metadata to utilize for
	// determining drift.
	//
	// Metadata is a required field
	Metadata map[string]*string `locationName:"metadata" type:"map" required:"true"`

	// The name of the content.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The identifier of the revision of the content.
	//
	// RevisionId is a required field
	RevisionId *string `locationName:"revisionId" min:"1" type:"string" required:"true"`

	// The status of the content.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ContentStatus"`

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The title of the content.
	//
	// Title is a required field
	Title *string `locationName:"title" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Summary information about the content.

func (ContentSummary) GoString

func (s ContentSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentSummary) SetContentArn

func (s *ContentSummary) SetContentArn(v string) *ContentSummary

SetContentArn sets the ContentArn field's value.

func (*ContentSummary) SetContentId

func (s *ContentSummary) SetContentId(v string) *ContentSummary

SetContentId sets the ContentId field's value.

func (*ContentSummary) SetContentType

func (s *ContentSummary) SetContentType(v string) *ContentSummary

SetContentType sets the ContentType field's value.

func (*ContentSummary) SetKnowledgeBaseArn

func (s *ContentSummary) SetKnowledgeBaseArn(v string) *ContentSummary

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*ContentSummary) SetKnowledgeBaseId

func (s *ContentSummary) SetKnowledgeBaseId(v string) *ContentSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ContentSummary) SetMetadata

func (s *ContentSummary) SetMetadata(v map[string]*string) *ContentSummary

SetMetadata sets the Metadata field's value.

func (*ContentSummary) SetName

func (s *ContentSummary) SetName(v string) *ContentSummary

SetName sets the Name field's value.

func (*ContentSummary) SetRevisionId

func (s *ContentSummary) SetRevisionId(v string) *ContentSummary

SetRevisionId sets the RevisionId field's value.

func (*ContentSummary) SetStatus

func (s *ContentSummary) SetStatus(v string) *ContentSummary

SetStatus sets the Status field's value.

func (*ContentSummary) SetTags

func (s *ContentSummary) SetTags(v map[string]*string) *ContentSummary

SetTags sets the Tags field's value.

func (*ContentSummary) SetTitle

func (s *ContentSummary) SetTitle(v string) *ContentSummary

SetTitle sets the Title field's value.

func (ContentSummary) String

func (s ContentSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAssistantAssociationInput

type CreateAssistantAssociationInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The identifier of the associated resource.
	//
	// Association is a required field
	Association *AssistantAssociationInputData `locationName:"association" type:"structure" required:"true"`

	// The type of association.
	//
	// AssociationType is a required field
	AssociationType *string `locationName:"associationType" type:"string" required:"true" enum:"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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

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

func (CreateAssistantAssociationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssistantAssociationInput) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (*CreateAssistantAssociationInput) SetAssociation

SetAssociation sets the Association field's value.

func (*CreateAssistantAssociationInput) SetAssociationType

SetAssociationType sets the AssociationType field's value.

func (*CreateAssistantAssociationInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateAssistantAssociationInput) SetTags

SetTags sets the Tags field's value.

func (CreateAssistantAssociationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssistantAssociationInput) Validate

func (s *CreateAssistantAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAssistantAssociationOutput

type CreateAssistantAssociationOutput struct {

	// The assistant association.
	AssistantAssociation *AssistantAssociationData `locationName:"assistantAssociation" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAssistantAssociationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssistantAssociationOutput) SetAssistantAssociation

SetAssistantAssociation sets the AssistantAssociation field's value.

func (CreateAssistantAssociationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAssistantInput

type CreateAssistantInput struct {

	// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The description of the assistant.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The name of the assistant.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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. To use Amazon Q 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,
	// see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The type of assistant.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AssistantType"`
	// contains filtered or unexported fields
}

func (CreateAssistantInput) GoString

func (s CreateAssistantInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssistantInput) SetClientToken

func (s *CreateAssistantInput) SetClientToken(v string) *CreateAssistantInput

SetClientToken sets the ClientToken field's value.

func (*CreateAssistantInput) SetDescription

func (s *CreateAssistantInput) SetDescription(v string) *CreateAssistantInput

SetDescription sets the Description field's value.

func (*CreateAssistantInput) SetName

SetName sets the Name field's value.

func (*CreateAssistantInput) SetServerSideEncryptionConfiguration

func (s *CreateAssistantInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateAssistantInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateAssistantInput) SetTags

SetTags sets the Tags field's value.

func (*CreateAssistantInput) SetType

SetType sets the Type field's value.

func (CreateAssistantInput) String

func (s CreateAssistantInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssistantInput) Validate

func (s *CreateAssistantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAssistantOutput

type CreateAssistantOutput struct {

	// Information about the assistant.
	Assistant *AssistantData `locationName:"assistant" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAssistantOutput) GoString

func (s CreateAssistantOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssistantOutput) SetAssistant

SetAssistant sets the Assistant field's value.

func (CreateAssistantOutput) String

func (s CreateAssistantOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContentInput

type CreateContentInput struct {

	// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

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

	// 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 (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html)
	// API.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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 `locationName:"overrideLinkOutUri" min:"1" type:"string"`

	// The tags used to organize, track, or control access for this resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The title of the content. If not set, the title is equal to the name.
	Title *string `locationName:"title" min:"1" type:"string"`

	// A pointer to the uploaded asset. This value is returned by StartContentUpload
	// (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html).
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateContentInput) GoString

func (s CreateContentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContentInput) SetClientToken

func (s *CreateContentInput) SetClientToken(v string) *CreateContentInput

SetClientToken sets the ClientToken field's value.

func (*CreateContentInput) SetKnowledgeBaseId

func (s *CreateContentInput) SetKnowledgeBaseId(v string) *CreateContentInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*CreateContentInput) SetMetadata

func (s *CreateContentInput) SetMetadata(v map[string]*string) *CreateContentInput

SetMetadata sets the Metadata field's value.

func (*CreateContentInput) SetName

SetName sets the Name field's value.

func (*CreateContentInput) SetOverrideLinkOutUri

func (s *CreateContentInput) SetOverrideLinkOutUri(v string) *CreateContentInput

SetOverrideLinkOutUri sets the OverrideLinkOutUri field's value.

func (*CreateContentInput) SetTags

func (s *CreateContentInput) SetTags(v map[string]*string) *CreateContentInput

SetTags sets the Tags field's value.

func (*CreateContentInput) SetTitle

SetTitle sets the Title field's value.

func (*CreateContentInput) SetUploadId

func (s *CreateContentInput) SetUploadId(v string) *CreateContentInput

SetUploadId sets the UploadId field's value.

func (CreateContentInput) String

func (s CreateContentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContentInput) Validate

func (s *CreateContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateContentOutput

type CreateContentOutput struct {

	// The content.
	Content *ContentData `locationName:"content" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateContentOutput) GoString

func (s CreateContentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContentOutput) SetContent

SetContent sets the Content field's value.

func (CreateContentOutput) String

func (s CreateContentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateKnowledgeBaseInput

type CreateKnowledgeBaseInput struct {

	// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// 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.
	//
	// KnowledgeBaseType is a required field
	KnowledgeBaseType *string `locationName:"knowledgeBaseType" type:"string" required:"true" enum:"KnowledgeBaseType"`

	// The name of the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration `locationName:"renderingConfiguration" type:"structure"`

	// 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.
	//
	// For more information about setting up a customer managed key for Amazon Q,
	// see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// The source of the knowledge base content. Only set this argument for EXTERNAL
	// knowledge bases.
	SourceConfiguration *SourceConfiguration `locationName:"sourceConfiguration" type:"structure"`

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

func (CreateKnowledgeBaseInput) GoString

func (s CreateKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKnowledgeBaseInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateKnowledgeBaseInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateKnowledgeBaseInput) SetKnowledgeBaseType

func (s *CreateKnowledgeBaseInput) SetKnowledgeBaseType(v string) *CreateKnowledgeBaseInput

SetKnowledgeBaseType sets the KnowledgeBaseType field's value.

func (*CreateKnowledgeBaseInput) SetName

SetName sets the Name field's value.

func (*CreateKnowledgeBaseInput) SetRenderingConfiguration

SetRenderingConfiguration sets the RenderingConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetServerSideEncryptionConfiguration

func (s *CreateKnowledgeBaseInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateKnowledgeBaseInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetSourceConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetTags

SetTags sets the Tags field's value.

func (CreateKnowledgeBaseInput) String

func (s CreateKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKnowledgeBaseInput) Validate

func (s *CreateKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKnowledgeBaseOutput

type CreateKnowledgeBaseOutput struct {

	// The knowledge base.
	KnowledgeBase *KnowledgeBaseData `locationName:"knowledgeBase" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateKnowledgeBaseOutput) GoString

func (s CreateKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKnowledgeBaseOutput) SetKnowledgeBase

SetKnowledgeBase sets the KnowledgeBase field's value.

func (CreateKnowledgeBaseOutput) String

func (s CreateKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateQuickResponseInput

type CreateQuickResponseInput struct {

	// The Amazon Connect channels this quick response applies to.
	Channels []*string `locationName:"channels" type:"list"`

	// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The content of the quick response.
	//
	// Content is a required field
	Content *QuickResponseDataProvider `locationName:"content" type:"structure" required:"true"`

	// 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 `locationName:"contentType" type:"string"`

	// The description of the quick response.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The configuration information of the user groups that the quick response
	// is accessible to.
	GroupingConfiguration *GroupingConfiguration `locationName:"groupingConfiguration" type:"structure"`

	// Whether the quick response is active.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 `locationName:"language" min:"2" type:"string"`

	// The name of the quick response.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The shortcut key of the quick response. The value should be unique across
	// the knowledge base.
	ShortcutKey *string `locationName:"shortcutKey" min:"1" type:"string"`

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

func (CreateQuickResponseInput) GoString

func (s CreateQuickResponseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuickResponseInput) SetChannels

SetChannels sets the Channels field's value.

func (*CreateQuickResponseInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateQuickResponseInput) SetContent

SetContent sets the Content field's value.

func (*CreateQuickResponseInput) SetContentType

SetContentType sets the ContentType field's value.

func (*CreateQuickResponseInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateQuickResponseInput) SetGroupingConfiguration

SetGroupingConfiguration sets the GroupingConfiguration field's value.

func (*CreateQuickResponseInput) SetIsActive

SetIsActive sets the IsActive field's value.

func (*CreateQuickResponseInput) SetKnowledgeBaseId

func (s *CreateQuickResponseInput) SetKnowledgeBaseId(v string) *CreateQuickResponseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*CreateQuickResponseInput) SetLanguage

SetLanguage sets the Language field's value.

func (*CreateQuickResponseInput) SetName

SetName sets the Name field's value.

func (*CreateQuickResponseInput) SetShortcutKey

SetShortcutKey sets the ShortcutKey field's value.

func (*CreateQuickResponseInput) SetTags

SetTags sets the Tags field's value.

func (CreateQuickResponseInput) String

func (s CreateQuickResponseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuickResponseInput) Validate

func (s *CreateQuickResponseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateQuickResponseOutput

type CreateQuickResponseOutput struct {

	// The quick response.
	QuickResponse *QuickResponseData `locationName:"quickResponse" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateQuickResponseOutput) GoString

func (s CreateQuickResponseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuickResponseOutput) SetQuickResponse

SetQuickResponse sets the QuickResponse field's value.

func (CreateQuickResponseOutput) String

func (s CreateQuickResponseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSessionInput

type CreateSessionInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The name of the session.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

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

func (CreateSessionInput) GoString

func (s CreateSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSessionInput) SetAssistantId

func (s *CreateSessionInput) SetAssistantId(v string) *CreateSessionInput

SetAssistantId sets the AssistantId field's value.

func (*CreateSessionInput) SetClientToken

func (s *CreateSessionInput) SetClientToken(v string) *CreateSessionInput

SetClientToken sets the ClientToken field's value.

func (*CreateSessionInput) SetDescription

func (s *CreateSessionInput) SetDescription(v string) *CreateSessionInput

SetDescription sets the Description field's value.

func (*CreateSessionInput) SetName

SetName sets the Name field's value.

func (*CreateSessionInput) SetTags

func (s *CreateSessionInput) SetTags(v map[string]*string) *CreateSessionInput

SetTags sets the Tags field's value.

func (CreateSessionInput) String

func (s CreateSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSessionInput) Validate

func (s *CreateSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSessionOutput

type CreateSessionOutput struct {

	// The session.
	Session *SessionData `locationName:"session" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSessionOutput) GoString

func (s CreateSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSessionOutput) SetSession

SetSession sets the Session field's value.

func (CreateSessionOutput) String

func (s CreateSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataDetails

type DataDetails struct {

	// Details about the content data.
	ContentData *ContentDataDetails `locationName:"contentData" type:"structure"`

	// Details about the generative data.
	GenerativeData *GenerativeDataDetails `locationName:"generativeData" type:"structure"`

	// Details about the content data.
	SourceContentData *SourceContentDataDetails `locationName:"sourceContentData" type:"structure"`
	// contains filtered or unexported fields
}

Details about the data.

func (DataDetails) GoString

func (s DataDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataDetails) SetContentData

func (s *DataDetails) SetContentData(v *ContentDataDetails) *DataDetails

SetContentData sets the ContentData field's value.

func (*DataDetails) SetGenerativeData

func (s *DataDetails) SetGenerativeData(v *GenerativeDataDetails) *DataDetails

SetGenerativeData sets the GenerativeData field's value.

func (*DataDetails) SetSourceContentData

func (s *DataDetails) SetSourceContentData(v *SourceContentDataDetails) *DataDetails

SetSourceContentData sets the SourceContentData field's value.

func (DataDetails) String

func (s DataDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataReference

type DataReference struct {

	// Reference information about the content.
	ContentReference *ContentReference `locationName:"contentReference" type:"structure"`

	// Reference information about the generative content.
	GenerativeReference *GenerativeReference `locationName:"generativeReference" type:"structure"`
	// contains filtered or unexported fields
}

Reference data.

func (DataReference) GoString

func (s DataReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataReference) SetContentReference

func (s *DataReference) SetContentReference(v *ContentReference) *DataReference

SetContentReference sets the ContentReference field's value.

func (*DataReference) SetGenerativeReference

func (s *DataReference) SetGenerativeReference(v *GenerativeReference) *DataReference

SetGenerativeReference sets the GenerativeReference field's value.

func (DataReference) String

func (s DataReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSummary

type DataSummary struct {

	// Details about the data.
	//
	// Details is a required field
	Details *DataDetails `locationName:"details" type:"structure" required:"true"`

	// Reference information about the content.
	//
	// Reference is a required field
	Reference *DataReference `locationName:"reference" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Summary of the data.

func (DataSummary) GoString

func (s DataSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSummary) SetDetails

func (s *DataSummary) SetDetails(v *DataDetails) *DataSummary

SetDetails sets the Details field's value.

func (*DataSummary) SetReference

func (s *DataSummary) SetReference(v *DataReference) *DataSummary

SetReference sets the Reference field's value.

func (DataSummary) String

func (s DataSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAssistantAssociationInput

type DeleteAssistantAssociationInput struct {

	// The identifier of the assistant association. Can be either the ID or the
	// ARN. URLs cannot contain the ARN.
	//
	// AssistantAssociationId is a required field
	AssistantAssociationId *string `location:"uri" locationName:"assistantAssociationId" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssistantAssociationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssistantAssociationInput) SetAssistantAssociationId

SetAssistantAssociationId sets the AssistantAssociationId field's value.

func (*DeleteAssistantAssociationInput) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (DeleteAssistantAssociationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssistantAssociationInput) Validate

func (s *DeleteAssistantAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAssistantAssociationOutput

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

func (DeleteAssistantAssociationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAssistantAssociationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAssistantInput

type DeleteAssistantInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssistantInput) GoString

func (s DeleteAssistantInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssistantInput) SetAssistantId

func (s *DeleteAssistantInput) SetAssistantId(v string) *DeleteAssistantInput

SetAssistantId sets the AssistantId field's value.

func (DeleteAssistantInput) String

func (s DeleteAssistantInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssistantInput) Validate

func (s *DeleteAssistantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAssistantOutput

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

func (DeleteAssistantOutput) GoString

func (s DeleteAssistantOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAssistantOutput) String

func (s DeleteAssistantOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContentInput

type DeleteContentInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// ContentId is a required field
	ContentId *string `location:"uri" locationName:"contentId" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteContentInput) GoString

func (s DeleteContentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContentInput) SetContentId

func (s *DeleteContentInput) SetContentId(v string) *DeleteContentInput

SetContentId sets the ContentId field's value.

func (*DeleteContentInput) SetKnowledgeBaseId

func (s *DeleteContentInput) SetKnowledgeBaseId(v string) *DeleteContentInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DeleteContentInput) String

func (s DeleteContentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContentInput) Validate

func (s *DeleteContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteContentOutput

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

func (DeleteContentOutput) GoString

func (s DeleteContentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteContentOutput) String

func (s DeleteContentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteImportJobInput

type DeleteImportJobInput struct {

	// The identifier of the import job to be deleted.
	//
	// ImportJobId is a required field
	ImportJobId *string `location:"uri" locationName:"importJobId" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteImportJobInput) GoString

func (s DeleteImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteImportJobInput) SetImportJobId

func (s *DeleteImportJobInput) SetImportJobId(v string) *DeleteImportJobInput

SetImportJobId sets the ImportJobId field's value.

func (*DeleteImportJobInput) SetKnowledgeBaseId

func (s *DeleteImportJobInput) SetKnowledgeBaseId(v string) *DeleteImportJobInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DeleteImportJobInput) String

func (s DeleteImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteImportJobInput) Validate

func (s *DeleteImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteImportJobOutput

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

func (DeleteImportJobOutput) GoString

func (s DeleteImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteImportJobOutput) String

func (s DeleteImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKnowledgeBaseInput) GoString

func (s DeleteKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnowledgeBaseInput) SetKnowledgeBaseId

func (s *DeleteKnowledgeBaseInput) SetKnowledgeBaseId(v string) *DeleteKnowledgeBaseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DeleteKnowledgeBaseInput) String

func (s DeleteKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnowledgeBaseInput) Validate

func (s *DeleteKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKnowledgeBaseOutput

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

func (DeleteKnowledgeBaseOutput) GoString

func (s DeleteKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteKnowledgeBaseOutput) String

func (s DeleteKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteQuickResponseInput

type DeleteQuickResponseInput struct {

	// The knowledge base from which the quick response is deleted. The identifier
	// of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
	// base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The identifier of the quick response to delete.
	//
	// QuickResponseId is a required field
	QuickResponseId *string `location:"uri" locationName:"quickResponseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteQuickResponseInput) GoString

func (s DeleteQuickResponseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQuickResponseInput) SetKnowledgeBaseId

func (s *DeleteQuickResponseInput) SetKnowledgeBaseId(v string) *DeleteQuickResponseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*DeleteQuickResponseInput) SetQuickResponseId

func (s *DeleteQuickResponseInput) SetQuickResponseId(v string) *DeleteQuickResponseInput

SetQuickResponseId sets the QuickResponseId field's value.

func (DeleteQuickResponseInput) String

func (s DeleteQuickResponseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQuickResponseInput) Validate

func (s *DeleteQuickResponseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteQuickResponseOutput

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

func (DeleteQuickResponseOutput) GoString

func (s DeleteQuickResponseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteQuickResponseOutput) String

func (s DeleteQuickResponseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Document

type Document struct {

	// A reference to the content resource.
	//
	// ContentReference is a required field
	ContentReference *ContentReference `locationName:"contentReference" type:"structure" required:"true"`

	// The excerpt from the document.
	Excerpt *DocumentText `locationName:"excerpt" type:"structure"`

	// The title of the document.
	Title *DocumentText `locationName:"title" type:"structure"`
	// contains filtered or unexported fields
}

The document.

func (Document) GoString

func (s Document) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) SetContentReference

func (s *Document) SetContentReference(v *ContentReference) *Document

SetContentReference sets the ContentReference field's value.

func (*Document) SetExcerpt

func (s *Document) SetExcerpt(v *DocumentText) *Document

SetExcerpt sets the Excerpt field's value.

func (*Document) SetTitle

func (s *Document) SetTitle(v *DocumentText) *Document

SetTitle sets the Title field's value.

func (Document) String

func (s Document) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentText

type DocumentText struct {

	// Highlights in the document text.
	Highlights []*Highlight `locationName:"highlights" type:"list"`

	// Text in the document.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DocumentText's
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The text of the document.

func (DocumentText) GoString

func (s DocumentText) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentText) SetHighlights

func (s *DocumentText) SetHighlights(v []*Highlight) *DocumentText

SetHighlights sets the Highlights field's value.

func (*DocumentText) SetText

func (s *DocumentText) SetText(v string) *DocumentText

SetText sets the Text field's value.

func (DocumentText) String

func (s DocumentText) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExternalSourceConfiguration

type ExternalSourceConfiguration struct {

	// The configuration information of the external data source.
	//
	// Configuration is a required field
	Configuration *Configuration `locationName:"configuration" type:"structure" required:"true"`

	// The type of the external data source.
	//
	// Source is a required field
	Source *string `locationName:"source" type:"string" required:"true" enum:"ExternalSource"`
	// contains filtered or unexported fields
}

The configuration information of the external data source.

func (ExternalSourceConfiguration) GoString

func (s ExternalSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSourceConfiguration) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*ExternalSourceConfiguration) SetSource

SetSource sets the Source field's value.

func (ExternalSourceConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalSourceConfiguration) Validate

func (s *ExternalSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Filter

type Filter struct {

	// The field on which to filter.
	//
	// Field is a required field
	Field *string `locationName:"field" type:"string" required:"true" enum:"FilterField"`

	// The operator to use for comparing the field’s value with the provided value.
	//
	// Operator is a required field
	Operator *string `locationName:"operator" type:"string" required:"true" enum:"FilterOperator"`

	// The desired field value on which to filter.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A search filter.

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetField

func (s *Filter) SetField(v string) *Filter

SetField sets the Field field's value.

func (*Filter) SetOperator

func (s *Filter) SetOperator(v string) *Filter

SetOperator sets the Operator field's value.

func (*Filter) SetValue

func (s *Filter) SetValue(v string) *Filter

SetValue sets the Value field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerativeContentFeedbackData added in v1.48.11

type GenerativeContentFeedbackData struct {

	// The relevance of the feedback.
	//
	// Relevance is a required field
	Relevance *string `locationName:"relevance" type:"string" required:"true" enum:"Relevance"`
	// contains filtered or unexported fields
}

The feedback information for a generative target type.

func (GenerativeContentFeedbackData) GoString added in v1.48.11

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerativeContentFeedbackData) SetRelevance added in v1.48.11

SetRelevance sets the Relevance field's value.

func (GenerativeContentFeedbackData) String added in v1.48.11

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerativeContentFeedbackData) Validate added in v1.48.11

func (s *GenerativeContentFeedbackData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerativeDataDetails

type GenerativeDataDetails struct {

	// The LLM response.
	//
	// Completion is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GenerativeDataDetails's
	// String and GoString methods.
	//
	// Completion is a required field
	Completion *string `locationName:"completion" type:"string" required:"true" sensitive:"true"`

	// Details about the generative content ranking data.
	//
	// RankingData is a required field
	RankingData *RankingData `locationName:"rankingData" type:"structure" required:"true"`

	// The references used to generative the LLM response.
	//
	// References is a required field
	References []*DataSummary `locationName:"references" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Details about generative data.

func (GenerativeDataDetails) GoString

func (s GenerativeDataDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerativeDataDetails) SetCompletion

func (s *GenerativeDataDetails) SetCompletion(v string) *GenerativeDataDetails

SetCompletion sets the Completion field's value.

func (*GenerativeDataDetails) SetRankingData

SetRankingData sets the RankingData field's value.

func (*GenerativeDataDetails) SetReferences

SetReferences sets the References field's value.

func (GenerativeDataDetails) String

func (s GenerativeDataDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GenerativeReference

type GenerativeReference struct {

	// The identifier of the LLM model.
	GenerationId *string `locationName:"generationId" type:"string"`

	// The identifier of the LLM model.
	ModelId *string `locationName:"modelId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Reference information about generative content.

func (GenerativeReference) GoString

func (s GenerativeReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GenerativeReference) SetGenerationId

func (s *GenerativeReference) SetGenerationId(v string) *GenerativeReference

SetGenerationId sets the GenerationId field's value.

func (*GenerativeReference) SetModelId

SetModelId sets the ModelId field's value.

func (GenerativeReference) String

func (s GenerativeReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAssistantAssociationInput

type GetAssistantAssociationInput struct {

	// The identifier of the assistant association. Can be either the ID or the
	// ARN. URLs cannot contain the ARN.
	//
	// AssistantAssociationId is a required field
	AssistantAssociationId *string `location:"uri" locationName:"assistantAssociationId" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAssistantAssociationInput) GoString

func (s GetAssistantAssociationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssistantAssociationInput) SetAssistantAssociationId

func (s *GetAssistantAssociationInput) SetAssistantAssociationId(v string) *GetAssistantAssociationInput

SetAssistantAssociationId sets the AssistantAssociationId field's value.

func (*GetAssistantAssociationInput) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (GetAssistantAssociationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssistantAssociationInput) Validate

func (s *GetAssistantAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAssistantAssociationOutput

type GetAssistantAssociationOutput struct {

	// The assistant association.
	AssistantAssociation *AssistantAssociationData `locationName:"assistantAssociation" type:"structure"`
	// contains filtered or unexported fields
}

func (GetAssistantAssociationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssistantAssociationOutput) SetAssistantAssociation

SetAssistantAssociation sets the AssistantAssociation field's value.

func (GetAssistantAssociationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAssistantInput

type GetAssistantInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAssistantInput) GoString

func (s GetAssistantInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssistantInput) SetAssistantId

func (s *GetAssistantInput) SetAssistantId(v string) *GetAssistantInput

SetAssistantId sets the AssistantId field's value.

func (GetAssistantInput) String

func (s GetAssistantInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssistantInput) Validate

func (s *GetAssistantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAssistantOutput

type GetAssistantOutput struct {

	// Information about the assistant.
	Assistant *AssistantData `locationName:"assistant" type:"structure"`
	// contains filtered or unexported fields
}

func (GetAssistantOutput) GoString

func (s GetAssistantOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssistantOutput) SetAssistant

SetAssistant sets the Assistant field's value.

func (GetAssistantOutput) String

func (s GetAssistantOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContentInput

type GetContentInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// ContentId is a required field
	ContentId *string `location:"uri" locationName:"contentId" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetContentInput) GoString

func (s GetContentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContentInput) SetContentId

func (s *GetContentInput) SetContentId(v string) *GetContentInput

SetContentId sets the ContentId field's value.

func (*GetContentInput) SetKnowledgeBaseId

func (s *GetContentInput) SetKnowledgeBaseId(v string) *GetContentInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetContentInput) String

func (s GetContentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContentInput) Validate

func (s *GetContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContentOutput

type GetContentOutput struct {

	// The content.
	Content *ContentData `locationName:"content" type:"structure"`
	// contains filtered or unexported fields
}

func (GetContentOutput) GoString

func (s GetContentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContentOutput) SetContent

func (s *GetContentOutput) SetContent(v *ContentData) *GetContentOutput

SetContent sets the Content field's value.

func (GetContentOutput) String

func (s GetContentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContentSummaryInput

type GetContentSummaryInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// ContentId is a required field
	ContentId *string `location:"uri" locationName:"contentId" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetContentSummaryInput) GoString

func (s GetContentSummaryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContentSummaryInput) SetContentId

SetContentId sets the ContentId field's value.

func (*GetContentSummaryInput) SetKnowledgeBaseId

func (s *GetContentSummaryInput) SetKnowledgeBaseId(v string) *GetContentSummaryInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetContentSummaryInput) String

func (s GetContentSummaryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContentSummaryInput) Validate

func (s *GetContentSummaryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetContentSummaryOutput

type GetContentSummaryOutput struct {

	// The content summary.
	ContentSummary *ContentSummary `locationName:"contentSummary" type:"structure"`
	// contains filtered or unexported fields
}

func (GetContentSummaryOutput) GoString

func (s GetContentSummaryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContentSummaryOutput) SetContentSummary

SetContentSummary sets the ContentSummary field's value.

func (GetContentSummaryOutput) String

func (s GetContentSummaryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetImportJobInput

type GetImportJobInput struct {

	// The identifier of the import job to retrieve.
	//
	// ImportJobId is a required field
	ImportJobId *string `location:"uri" locationName:"importJobId" type:"string" required:"true"`

	// The identifier of the knowledge base that the import job belongs to.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetImportJobInput) GoString

func (s GetImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetImportJobInput) SetImportJobId

func (s *GetImportJobInput) SetImportJobId(v string) *GetImportJobInput

SetImportJobId sets the ImportJobId field's value.

func (*GetImportJobInput) SetKnowledgeBaseId

func (s *GetImportJobInput) SetKnowledgeBaseId(v string) *GetImportJobInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetImportJobInput) String

func (s GetImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetImportJobInput) Validate

func (s *GetImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetImportJobOutput

type GetImportJobOutput struct {

	// The import job.
	ImportJob *ImportJobData `locationName:"importJob" type:"structure"`
	// contains filtered or unexported fields
}

func (GetImportJobOutput) GoString

func (s GetImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetImportJobOutput) SetImportJob

SetImportJob sets the ImportJob field's value.

func (GetImportJobOutput) String

func (s GetImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetKnowledgeBaseInput

type GetKnowledgeBaseInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetKnowledgeBaseInput) GoString

func (s GetKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKnowledgeBaseInput) SetKnowledgeBaseId

func (s *GetKnowledgeBaseInput) SetKnowledgeBaseId(v string) *GetKnowledgeBaseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetKnowledgeBaseInput) String

func (s GetKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKnowledgeBaseInput) Validate

func (s *GetKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKnowledgeBaseOutput

type GetKnowledgeBaseOutput struct {

	// The knowledge base.
	KnowledgeBase *KnowledgeBaseData `locationName:"knowledgeBase" type:"structure"`
	// contains filtered or unexported fields
}

func (GetKnowledgeBaseOutput) GoString

func (s GetKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKnowledgeBaseOutput) SetKnowledgeBase

SetKnowledgeBase sets the KnowledgeBase field's value.

func (GetKnowledgeBaseOutput) String

func (s GetKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetQuickResponseInput

type GetQuickResponseInput struct {

	// The identifier of the knowledge base. This should be a QUICK_RESPONSES type
	// knowledge base.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The identifier of the quick response.
	//
	// QuickResponseId is a required field
	QuickResponseId *string `location:"uri" locationName:"quickResponseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQuickResponseInput) GoString

func (s GetQuickResponseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuickResponseInput) SetKnowledgeBaseId

func (s *GetQuickResponseInput) SetKnowledgeBaseId(v string) *GetQuickResponseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*GetQuickResponseInput) SetQuickResponseId

func (s *GetQuickResponseInput) SetQuickResponseId(v string) *GetQuickResponseInput

SetQuickResponseId sets the QuickResponseId field's value.

func (GetQuickResponseInput) String

func (s GetQuickResponseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuickResponseInput) Validate

func (s *GetQuickResponseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQuickResponseOutput

type GetQuickResponseOutput struct {

	// The quick response.
	QuickResponse *QuickResponseData `locationName:"quickResponse" type:"structure"`
	// contains filtered or unexported fields
}

func (GetQuickResponseOutput) GoString

func (s GetQuickResponseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuickResponseOutput) SetQuickResponse

SetQuickResponse sets the QuickResponse field's value.

func (GetQuickResponseOutput) String

func (s GetQuickResponseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRecommendationsInput

type GetRecommendationsInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" type:"string" required:"true"`

	// 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 *int64 `location:"querystring" locationName:"waitTimeSeconds" type:"integer"`
	// contains filtered or unexported fields
}

func (GetRecommendationsInput) GoString

func (s GetRecommendationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommendationsInput) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (*GetRecommendationsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*GetRecommendationsInput) SetSessionId

SetSessionId sets the SessionId field's value.

func (*GetRecommendationsInput) SetWaitTimeSeconds

func (s *GetRecommendationsInput) SetWaitTimeSeconds(v int64) *GetRecommendationsInput

SetWaitTimeSeconds sets the WaitTimeSeconds field's value.

func (GetRecommendationsInput) String

func (s GetRecommendationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommendationsInput) Validate

func (s *GetRecommendationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRecommendationsOutput

type GetRecommendationsOutput struct {

	// The recommendations.
	//
	// Recommendations is a required field
	Recommendations []*RecommendationData `locationName:"recommendations" type:"list" required:"true"`

	// The triggers corresponding to recommendations.
	Triggers []*RecommendationTrigger `locationName:"triggers" type:"list"`
	// contains filtered or unexported fields
}

func (GetRecommendationsOutput) GoString

func (s GetRecommendationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecommendationsOutput) SetRecommendations

SetRecommendations sets the Recommendations field's value.

func (*GetRecommendationsOutput) SetTriggers

SetTriggers sets the Triggers field's value.

func (GetRecommendationsOutput) String

func (s GetRecommendationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSessionInput

type GetSessionInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSessionInput) GoString

func (s GetSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionInput) SetAssistantId

func (s *GetSessionInput) SetAssistantId(v string) *GetSessionInput

SetAssistantId sets the AssistantId field's value.

func (*GetSessionInput) SetSessionId

func (s *GetSessionInput) SetSessionId(v string) *GetSessionInput

SetSessionId sets the SessionId field's value.

func (GetSessionInput) String

func (s GetSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionInput) Validate

func (s *GetSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSessionOutput

type GetSessionOutput struct {

	// The session.
	Session *SessionData `locationName:"session" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSessionOutput) GoString

func (s GetSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionOutput) SetSession

func (s *GetSessionOutput) SetSession(v *SessionData) *GetSessionOutput

SetSession sets the Session field's value.

func (GetSessionOutput) String

func (s GetSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GroupingConfiguration

type GroupingConfiguration struct {

	// The criteria used for grouping Amazon Q users.
	//
	// The following is the list of supported criteria values.
	//
	//    * RoutingProfileArn: Grouping the users by their Amazon Connect routing
	//    profile ARN (https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html).
	//    User should have SearchRoutingProfile (https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html)
	//    and DescribeRoutingProfile (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html)
	//    permissions when setting criteria to this value.
	//
	// Criteria is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GroupingConfiguration's
	// String and GoString methods.
	Criteria *string `locationName:"criteria" min:"1" type:"string" sensitive:"true"`

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

The configuration information of the grouping of Amazon Q users.

func (GroupingConfiguration) GoString

func (s GroupingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupingConfiguration) SetCriteria

SetCriteria sets the Criteria field's value.

func (*GroupingConfiguration) SetValues

SetValues sets the Values field's value.

func (GroupingConfiguration) String

func (s GroupingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupingConfiguration) Validate

func (s *GroupingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Highlight

type Highlight struct {

	// The offset for the start of the highlight.
	BeginOffsetInclusive *int64 `locationName:"beginOffsetInclusive" type:"integer"`

	// The offset for the end of the highlight.
	EndOffsetExclusive *int64 `locationName:"endOffsetExclusive" type:"integer"`
	// contains filtered or unexported fields
}

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

func (Highlight) GoString

func (s Highlight) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Highlight) SetBeginOffsetInclusive

func (s *Highlight) SetBeginOffsetInclusive(v int64) *Highlight

SetBeginOffsetInclusive sets the BeginOffsetInclusive field's value.

func (*Highlight) SetEndOffsetExclusive

func (s *Highlight) SetEndOffsetExclusive(v int64) *Highlight

SetEndOffsetExclusive sets the EndOffsetExclusive field's value.

func (Highlight) String

func (s Highlight) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportJobData

type ImportJobData struct {

	// The timestamp when the import job was created.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `locationName:"createdTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The configuration information of the external data source.
	ExternalSourceConfiguration *ExternalSourceConfiguration `locationName:"externalSourceConfiguration" type:"structure"`

	// The link to donwload the information of resource data that failed to be imported.
	//
	// FailedRecordReport is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ImportJobData's
	// String and GoString methods.
	FailedRecordReport *string `locationName:"failedRecordReport" min:"1" type:"string" sensitive:"true"`

	// The identifier of the import job.
	//
	// ImportJobId is a required field
	ImportJobId *string `locationName:"importJobId" type:"string" required:"true"`

	// The type of the import job.
	//
	// ImportJobType is a required field
	ImportJobType *string `locationName:"importJobType" type:"string" required:"true" enum:"ImportJobType"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The timestamp when the import job data was last modified.
	//
	// LastModifiedTime is a required field
	LastModifiedTime *time.Time `locationName:"lastModifiedTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The metadata fields of the imported Amazon Q resources.
	Metadata map[string]*string `locationName:"metadata" type:"map"`

	// The status of the import job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ImportJobStatus"`

	// A pointer to the uploaded asset. This value is returned by StartContentUpload
	// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html).
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`

	// The download link to the resource file that is uploaded to the import job.
	//
	// Url is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ImportJobData's
	// String and GoString methods.
	//
	// Url is a required field
	Url *string `locationName:"url" min:"1" type:"string" required:"true" sensitive:"true"`

	// The expiration time of the URL as an epoch timestamp.
	//
	// UrlExpiry is a required field
	UrlExpiry *time.Time `locationName:"urlExpiry" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`
	// contains filtered or unexported fields
}

Summary information about the import job.

func (ImportJobData) GoString

func (s ImportJobData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportJobData) SetCreatedTime

func (s *ImportJobData) SetCreatedTime(v time.Time) *ImportJobData

SetCreatedTime sets the CreatedTime field's value.

func (*ImportJobData) SetExternalSourceConfiguration

func (s *ImportJobData) SetExternalSourceConfiguration(v *ExternalSourceConfiguration) *ImportJobData

SetExternalSourceConfiguration sets the ExternalSourceConfiguration field's value.

func (*ImportJobData) SetFailedRecordReport

func (s *ImportJobData) SetFailedRecordReport(v string) *ImportJobData

SetFailedRecordReport sets the FailedRecordReport field's value.

func (*ImportJobData) SetImportJobId

func (s *ImportJobData) SetImportJobId(v string) *ImportJobData

SetImportJobId sets the ImportJobId field's value.

func (*ImportJobData) SetImportJobType

func (s *ImportJobData) SetImportJobType(v string) *ImportJobData

SetImportJobType sets the ImportJobType field's value.

func (*ImportJobData) SetKnowledgeBaseArn

func (s *ImportJobData) SetKnowledgeBaseArn(v string) *ImportJobData

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*ImportJobData) SetKnowledgeBaseId

func (s *ImportJobData) SetKnowledgeBaseId(v string) *ImportJobData

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ImportJobData) SetLastModifiedTime

func (s *ImportJobData) SetLastModifiedTime(v time.Time) *ImportJobData

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*ImportJobData) SetMetadata

func (s *ImportJobData) SetMetadata(v map[string]*string) *ImportJobData

SetMetadata sets the Metadata field's value.

func (*ImportJobData) SetStatus

func (s *ImportJobData) SetStatus(v string) *ImportJobData

SetStatus sets the Status field's value.

func (*ImportJobData) SetUploadId

func (s *ImportJobData) SetUploadId(v string) *ImportJobData

SetUploadId sets the UploadId field's value.

func (*ImportJobData) SetUrl

func (s *ImportJobData) SetUrl(v string) *ImportJobData

SetUrl sets the Url field's value.

func (*ImportJobData) SetUrlExpiry

func (s *ImportJobData) SetUrlExpiry(v time.Time) *ImportJobData

SetUrlExpiry sets the UrlExpiry field's value.

func (ImportJobData) String

func (s ImportJobData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportJobSummary

type ImportJobSummary struct {

	// The timestamp when the import job was created.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `locationName:"createdTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The configuration information of the external source that the resource data
	// are imported from.
	ExternalSourceConfiguration *ExternalSourceConfiguration `locationName:"externalSourceConfiguration" type:"structure"`

	// The identifier of the import job.
	//
	// ImportJobId is a required field
	ImportJobId *string `locationName:"importJobId" type:"string" required:"true"`

	// The type of import job.
	//
	// ImportJobType is a required field
	ImportJobType *string `locationName:"importJobType" type:"string" required:"true" enum:"ImportJobType"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The timestamp when the import job was last modified.
	//
	// LastModifiedTime is a required field
	LastModifiedTime *time.Time `locationName:"lastModifiedTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The metadata fields of the imported Amazon Q resources.
	Metadata map[string]*string `locationName:"metadata" type:"map"`

	// The status of the import job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ImportJobStatus"`

	// A pointer to the uploaded asset. This value is returned by StartContentUpload
	// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html).
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Summary information about the import job.

func (ImportJobSummary) GoString

func (s ImportJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportJobSummary) SetCreatedTime

func (s *ImportJobSummary) SetCreatedTime(v time.Time) *ImportJobSummary

SetCreatedTime sets the CreatedTime field's value.

func (*ImportJobSummary) SetExternalSourceConfiguration

func (s *ImportJobSummary) SetExternalSourceConfiguration(v *ExternalSourceConfiguration) *ImportJobSummary

SetExternalSourceConfiguration sets the ExternalSourceConfiguration field's value.

func (*ImportJobSummary) SetImportJobId

func (s *ImportJobSummary) SetImportJobId(v string) *ImportJobSummary

SetImportJobId sets the ImportJobId field's value.

func (*ImportJobSummary) SetImportJobType

func (s *ImportJobSummary) SetImportJobType(v string) *ImportJobSummary

SetImportJobType sets the ImportJobType field's value.

func (*ImportJobSummary) SetKnowledgeBaseArn

func (s *ImportJobSummary) SetKnowledgeBaseArn(v string) *ImportJobSummary

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*ImportJobSummary) SetKnowledgeBaseId

func (s *ImportJobSummary) SetKnowledgeBaseId(v string) *ImportJobSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ImportJobSummary) SetLastModifiedTime

func (s *ImportJobSummary) SetLastModifiedTime(v time.Time) *ImportJobSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*ImportJobSummary) SetMetadata

func (s *ImportJobSummary) SetMetadata(v map[string]*string) *ImportJobSummary

SetMetadata sets the Metadata field's value.

func (*ImportJobSummary) SetStatus

func (s *ImportJobSummary) SetStatus(v string) *ImportJobSummary

SetStatus sets the Status field's value.

func (*ImportJobSummary) SetUploadId

func (s *ImportJobSummary) SetUploadId(v string) *ImportJobSummary

SetUploadId sets the UploadId field's value.

func (ImportJobSummary) String

func (s ImportJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseAssociationData

type KnowledgeBaseAssociationData struct {

	// The Amazon Resource Name (ARN) of the knowledge base.
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string"`

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

Association information about the knowledge base.

func (KnowledgeBaseAssociationData) GoString

func (s KnowledgeBaseAssociationData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseAssociationData) SetKnowledgeBaseArn

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*KnowledgeBaseAssociationData) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (KnowledgeBaseAssociationData) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseData

type KnowledgeBaseData struct {

	// The description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The type of knowledge base.
	//
	// KnowledgeBaseType is a required field
	KnowledgeBaseType *string `locationName:"knowledgeBaseType" type:"string" required:"true" enum:"KnowledgeBaseType"`

	// 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 `locationName:"lastContentModificationTime" type:"timestamp" timestampFormat:"unixTimestamp"`

	// The name of the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration `locationName:"renderingConfiguration" type:"structure"`

	// 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.
	//
	// For more information about setting up a customer managed key for Amazon Q,
	// see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// Source configuration information about the knowledge base.
	SourceConfiguration *SourceConfiguration `locationName:"sourceConfiguration" type:"structure"`

	// The status of the knowledge base.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"`

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

Information about the knowledge base.

func (KnowledgeBaseData) GoString

func (s KnowledgeBaseData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseData) SetDescription

func (s *KnowledgeBaseData) SetDescription(v string) *KnowledgeBaseData

SetDescription sets the Description field's value.

func (*KnowledgeBaseData) SetKnowledgeBaseArn

func (s *KnowledgeBaseData) SetKnowledgeBaseArn(v string) *KnowledgeBaseData

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*KnowledgeBaseData) SetKnowledgeBaseId

func (s *KnowledgeBaseData) SetKnowledgeBaseId(v string) *KnowledgeBaseData

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBaseData) SetKnowledgeBaseType

func (s *KnowledgeBaseData) SetKnowledgeBaseType(v string) *KnowledgeBaseData

SetKnowledgeBaseType sets the KnowledgeBaseType field's value.

func (*KnowledgeBaseData) SetLastContentModificationTime

func (s *KnowledgeBaseData) SetLastContentModificationTime(v time.Time) *KnowledgeBaseData

SetLastContentModificationTime sets the LastContentModificationTime field's value.

func (*KnowledgeBaseData) SetName

SetName sets the Name field's value.

func (*KnowledgeBaseData) SetRenderingConfiguration

func (s *KnowledgeBaseData) SetRenderingConfiguration(v *RenderingConfiguration) *KnowledgeBaseData

SetRenderingConfiguration sets the RenderingConfiguration field's value.

func (*KnowledgeBaseData) SetServerSideEncryptionConfiguration

func (s *KnowledgeBaseData) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *KnowledgeBaseData

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*KnowledgeBaseData) SetSourceConfiguration

func (s *KnowledgeBaseData) SetSourceConfiguration(v *SourceConfiguration) *KnowledgeBaseData

SetSourceConfiguration sets the SourceConfiguration field's value.

func (*KnowledgeBaseData) SetStatus

func (s *KnowledgeBaseData) SetStatus(v string) *KnowledgeBaseData

SetStatus sets the Status field's value.

func (*KnowledgeBaseData) SetTags

func (s *KnowledgeBaseData) SetTags(v map[string]*string) *KnowledgeBaseData

SetTags sets the Tags field's value.

func (KnowledgeBaseData) String

func (s KnowledgeBaseData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseSummary

type KnowledgeBaseSummary struct {

	// The description of the knowledge base.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The type of knowledge base.
	//
	// KnowledgeBaseType is a required field
	KnowledgeBaseType *string `locationName:"knowledgeBaseType" type:"string" required:"true" enum:"KnowledgeBaseType"`

	// The name of the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Information about how to render the content.
	RenderingConfiguration *RenderingConfiguration `locationName:"renderingConfiguration" type:"structure"`

	// 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.
	//
	// For more information about setting up a customer managed key for Amazon Q,
	// see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// Configuration information about the external data source.
	SourceConfiguration *SourceConfiguration `locationName:"sourceConfiguration" type:"structure"`

	// The status of the knowledge base summary.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"`

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

Summary information about the knowledge base.

func (KnowledgeBaseSummary) GoString

func (s KnowledgeBaseSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseSummary) SetDescription

func (s *KnowledgeBaseSummary) SetDescription(v string) *KnowledgeBaseSummary

SetDescription sets the Description field's value.

func (*KnowledgeBaseSummary) SetKnowledgeBaseArn

func (s *KnowledgeBaseSummary) SetKnowledgeBaseArn(v string) *KnowledgeBaseSummary

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*KnowledgeBaseSummary) SetKnowledgeBaseId

func (s *KnowledgeBaseSummary) SetKnowledgeBaseId(v string) *KnowledgeBaseSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBaseSummary) SetKnowledgeBaseType

func (s *KnowledgeBaseSummary) SetKnowledgeBaseType(v string) *KnowledgeBaseSummary

SetKnowledgeBaseType sets the KnowledgeBaseType field's value.

func (*KnowledgeBaseSummary) SetName

SetName sets the Name field's value.

func (*KnowledgeBaseSummary) SetRenderingConfiguration

func (s *KnowledgeBaseSummary) SetRenderingConfiguration(v *RenderingConfiguration) *KnowledgeBaseSummary

SetRenderingConfiguration sets the RenderingConfiguration field's value.

func (*KnowledgeBaseSummary) SetServerSideEncryptionConfiguration

func (s *KnowledgeBaseSummary) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *KnowledgeBaseSummary

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*KnowledgeBaseSummary) SetSourceConfiguration

func (s *KnowledgeBaseSummary) SetSourceConfiguration(v *SourceConfiguration) *KnowledgeBaseSummary

SetSourceConfiguration sets the SourceConfiguration field's value.

func (*KnowledgeBaseSummary) SetStatus

SetStatus sets the Status field's value.

func (*KnowledgeBaseSummary) SetTags

SetTags sets the Tags field's value.

func (KnowledgeBaseSummary) String

func (s KnowledgeBaseSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssistantAssociationsInput

type ListAssistantAssociationsInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssistantAssociationsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssistantAssociationsInput) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (*ListAssistantAssociationsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAssistantAssociationsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAssistantAssociationsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssistantAssociationsInput) Validate

func (s *ListAssistantAssociationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssistantAssociationsOutput

type ListAssistantAssociationsOutput struct {

	// Summary information about assistant associations.
	//
	// AssistantAssociationSummaries is a required field
	AssistantAssociationSummaries []*AssistantAssociationSummary `locationName:"assistantAssociationSummaries" type:"list" required:"true"`

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssistantAssociationsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssistantAssociationsOutput) SetAssistantAssociationSummaries

SetAssistantAssociationSummaries sets the AssistantAssociationSummaries field's value.

func (*ListAssistantAssociationsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAssistantAssociationsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssistantsInput

type ListAssistantsInput struct {

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssistantsInput) GoString

func (s ListAssistantsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssistantsInput) SetMaxResults

func (s *ListAssistantsInput) SetMaxResults(v int64) *ListAssistantsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssistantsInput) SetNextToken

func (s *ListAssistantsInput) SetNextToken(v string) *ListAssistantsInput

SetNextToken sets the NextToken field's value.

func (ListAssistantsInput) String

func (s ListAssistantsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssistantsInput) Validate

func (s *ListAssistantsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssistantsOutput

type ListAssistantsOutput struct {

	// Information about the assistants.
	//
	// AssistantSummaries is a required field
	AssistantSummaries []*AssistantSummary `locationName:"assistantSummaries" type:"list" required:"true"`

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssistantsOutput) GoString

func (s ListAssistantsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssistantsOutput) SetAssistantSummaries

func (s *ListAssistantsOutput) SetAssistantSummaries(v []*AssistantSummary) *ListAssistantsOutput

SetAssistantSummaries sets the AssistantSummaries field's value.

func (*ListAssistantsOutput) SetNextToken

func (s *ListAssistantsOutput) SetNextToken(v string) *ListAssistantsOutput

SetNextToken sets the NextToken field's value.

func (ListAssistantsOutput) String

func (s ListAssistantsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListContentsInput

type ListContentsInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListContentsInput) GoString

func (s ListContentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContentsInput) SetKnowledgeBaseId

func (s *ListContentsInput) SetKnowledgeBaseId(v string) *ListContentsInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ListContentsInput) SetMaxResults

func (s *ListContentsInput) SetMaxResults(v int64) *ListContentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListContentsInput) SetNextToken

func (s *ListContentsInput) SetNextToken(v string) *ListContentsInput

SetNextToken sets the NextToken field's value.

func (ListContentsInput) String

func (s ListContentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContentsInput) Validate

func (s *ListContentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListContentsOutput

type ListContentsOutput struct {

	// Information about the content.
	//
	// ContentSummaries is a required field
	ContentSummaries []*ContentSummary `locationName:"contentSummaries" type:"list" required:"true"`

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListContentsOutput) GoString

func (s ListContentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListContentsOutput) SetContentSummaries

func (s *ListContentsOutput) SetContentSummaries(v []*ContentSummary) *ListContentsOutput

SetContentSummaries sets the ContentSummaries field's value.

func (*ListContentsOutput) SetNextToken

func (s *ListContentsOutput) SetNextToken(v string) *ListContentsOutput

SetNextToken sets the NextToken field's value.

func (ListContentsOutput) String

func (s ListContentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListImportJobsInput

type ListImportJobsInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListImportJobsInput) GoString

func (s ListImportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListImportJobsInput) SetKnowledgeBaseId

func (s *ListImportJobsInput) SetKnowledgeBaseId(v string) *ListImportJobsInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ListImportJobsInput) SetMaxResults

func (s *ListImportJobsInput) SetMaxResults(v int64) *ListImportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListImportJobsInput) SetNextToken

func (s *ListImportJobsInput) SetNextToken(v string) *ListImportJobsInput

SetNextToken sets the NextToken field's value.

func (ListImportJobsInput) String

func (s ListImportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListImportJobsInput) Validate

func (s *ListImportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListImportJobsOutput

type ListImportJobsOutput struct {

	// Summary information about the import jobs.
	//
	// ImportJobSummaries is a required field
	ImportJobSummaries []*ImportJobSummary `locationName:"importJobSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListImportJobsOutput) GoString

func (s ListImportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListImportJobsOutput) SetImportJobSummaries

func (s *ListImportJobsOutput) SetImportJobSummaries(v []*ImportJobSummary) *ListImportJobsOutput

SetImportJobSummaries sets the ImportJobSummaries field's value.

func (*ListImportJobsOutput) SetNextToken

func (s *ListImportJobsOutput) SetNextToken(v string) *ListImportJobsOutput

SetNextToken sets the NextToken field's value.

func (ListImportJobsOutput) String

func (s ListImportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListKnowledgeBasesInput

type ListKnowledgeBasesInput struct {

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKnowledgeBasesInput) GoString

func (s ListKnowledgeBasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKnowledgeBasesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListKnowledgeBasesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListKnowledgeBasesInput) String

func (s ListKnowledgeBasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKnowledgeBasesInput) Validate

func (s *ListKnowledgeBasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKnowledgeBasesOutput

type ListKnowledgeBasesOutput struct {

	// Information about the knowledge bases.
	//
	// KnowledgeBaseSummaries is a required field
	KnowledgeBaseSummaries []*KnowledgeBaseSummary `locationName:"knowledgeBaseSummaries" type:"list" required:"true"`

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKnowledgeBasesOutput) GoString

func (s ListKnowledgeBasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKnowledgeBasesOutput) SetKnowledgeBaseSummaries

func (s *ListKnowledgeBasesOutput) SetKnowledgeBaseSummaries(v []*KnowledgeBaseSummary) *ListKnowledgeBasesOutput

SetKnowledgeBaseSummaries sets the KnowledgeBaseSummaries field's value.

func (*ListKnowledgeBasesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListKnowledgeBasesOutput) String

func (s ListKnowledgeBasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListQuickResponsesInput

type ListQuickResponsesInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListQuickResponsesInput) GoString

func (s ListQuickResponsesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuickResponsesInput) SetKnowledgeBaseId

func (s *ListQuickResponsesInput) SetKnowledgeBaseId(v string) *ListQuickResponsesInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ListQuickResponsesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListQuickResponsesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListQuickResponsesInput) String

func (s ListQuickResponsesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuickResponsesInput) Validate

func (s *ListQuickResponsesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListQuickResponsesOutput

type ListQuickResponsesOutput struct {

	// 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 `locationName:"nextToken" min:"1" type:"string"`

	// Summary information about the quick responses.
	//
	// QuickResponseSummaries is a required field
	QuickResponseSummaries []*QuickResponseSummary `locationName:"quickResponseSummaries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListQuickResponsesOutput) GoString

func (s ListQuickResponsesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuickResponsesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListQuickResponsesOutput) SetQuickResponseSummaries

func (s *ListQuickResponsesOutput) SetQuickResponseSummaries(v []*QuickResponseSummary) *ListQuickResponsesOutput

SetQuickResponseSummaries sets the QuickResponseSummaries field's value.

func (ListQuickResponsesOutput) String

func (s ListQuickResponsesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

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

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotifyRecommendationsReceivedError

type NotifyRecommendationsReceivedError struct {

	// A recommendation is causing an error.
	Message *string `locationName:"message" type:"string"`

	// The identifier of the recommendation that is in error.
	RecommendationId *string `locationName:"recommendationId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An error occurred when creating a recommendation.

func (NotifyRecommendationsReceivedError) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotifyRecommendationsReceivedError) SetMessage

SetMessage sets the Message field's value.

func (*NotifyRecommendationsReceivedError) SetRecommendationId

SetRecommendationId sets the RecommendationId field's value.

func (NotifyRecommendationsReceivedError) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotifyRecommendationsReceivedInput

type NotifyRecommendationsReceivedInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The identifiers of the recommendations.
	//
	// RecommendationIds is a required field
	RecommendationIds []*string `locationName:"recommendationIds" type:"list" required:"true"`

	// The identifier of the session. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// SessionId is a required field
	SessionId *string `location:"uri" locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (NotifyRecommendationsReceivedInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotifyRecommendationsReceivedInput) SetAssistantId

SetAssistantId sets the AssistantId field's value.

func (*NotifyRecommendationsReceivedInput) SetRecommendationIds

SetRecommendationIds sets the RecommendationIds field's value.

func (*NotifyRecommendationsReceivedInput) SetSessionId

SetSessionId sets the SessionId field's value.

func (NotifyRecommendationsReceivedInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotifyRecommendationsReceivedInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type NotifyRecommendationsReceivedOutput

type NotifyRecommendationsReceivedOutput struct {

	// The identifiers of recommendations that are causing errors.
	Errors []*NotifyRecommendationsReceivedError `locationName:"errors" type:"list"`

	// The identifiers of the recommendations.
	RecommendationIds []*string `locationName:"recommendationIds" type:"list"`
	// contains filtered or unexported fields
}

func (NotifyRecommendationsReceivedOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotifyRecommendationsReceivedOutput) SetErrors

SetErrors sets the Errors field's value.

func (*NotifyRecommendationsReceivedOutput) SetRecommendationIds

SetRecommendationIds sets the RecommendationIds field's value.

func (NotifyRecommendationsReceivedOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PreconditionFailedException

type PreconditionFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code

Code returns the exception type name.

func (*PreconditionFailedException) Error

func (PreconditionFailedException) GoString

func (s PreconditionFailedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreconditionFailedException) Message

func (s *PreconditionFailedException) Message() string

Message returns the exception's message.

func (*PreconditionFailedException) OrigErr

func (s *PreconditionFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PreconditionFailedException) RequestID

func (s *PreconditionFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PreconditionFailedException) StatusCode

func (s *PreconditionFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PreconditionFailedException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutFeedbackInput added in v1.48.11

type PutFeedbackInput struct {

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// Information about the feedback provided.
	//
	// ContentFeedback is a required field
	ContentFeedback *ContentFeedbackData `locationName:"contentFeedback" type:"structure" required:"true"`

	// The identifier of the feedback target.
	//
	// TargetId is a required field
	TargetId *string `locationName:"targetId" type:"string" required:"true"`

	// The type of the feedback target.
	//
	// TargetType is a required field
	TargetType *string `locationName:"targetType" type:"string" required:"true" enum:"TargetType"`
	// contains filtered or unexported fields
}

func (PutFeedbackInput) GoString added in v1.48.11

func (s PutFeedbackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutFeedbackInput) SetAssistantId added in v1.48.11

func (s *PutFeedbackInput) SetAssistantId(v string) *PutFeedbackInput

SetAssistantId sets the AssistantId field's value.

func (*PutFeedbackInput) SetContentFeedback added in v1.48.11

func (s *PutFeedbackInput) SetContentFeedback(v *ContentFeedbackData) *PutFeedbackInput

SetContentFeedback sets the ContentFeedback field's value.

func (*PutFeedbackInput) SetTargetId added in v1.48.11

func (s *PutFeedbackInput) SetTargetId(v string) *PutFeedbackInput

SetTargetId sets the TargetId field's value.

func (*PutFeedbackInput) SetTargetType added in v1.48.11

func (s *PutFeedbackInput) SetTargetType(v string) *PutFeedbackInput

SetTargetType sets the TargetType field's value.

func (PutFeedbackInput) String added in v1.48.11

func (s PutFeedbackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutFeedbackInput) Validate added in v1.48.11

func (s *PutFeedbackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutFeedbackOutput added in v1.48.11

type PutFeedbackOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q assistant.
	//
	// AssistantArn is a required field
	AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `locationName:"assistantId" type:"string" required:"true"`

	// Information about the feedback provided.
	//
	// ContentFeedback is a required field
	ContentFeedback *ContentFeedbackData `locationName:"contentFeedback" type:"structure" required:"true"`

	// The identifier of the feedback target.
	//
	// TargetId is a required field
	TargetId *string `locationName:"targetId" type:"string" required:"true"`

	// The type of the feedback target.
	//
	// TargetType is a required field
	TargetType *string `locationName:"targetType" type:"string" required:"true" enum:"TargetType"`
	// contains filtered or unexported fields
}

func (PutFeedbackOutput) GoString added in v1.48.11

func (s PutFeedbackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutFeedbackOutput) SetAssistantArn added in v1.48.11

func (s *PutFeedbackOutput) SetAssistantArn(v string) *PutFeedbackOutput

SetAssistantArn sets the AssistantArn field's value.

func (*PutFeedbackOutput) SetAssistantId added in v1.48.11

func (s *PutFeedbackOutput) SetAssistantId(v string) *PutFeedbackOutput

SetAssistantId sets the AssistantId field's value.

func (*PutFeedbackOutput) SetContentFeedback added in v1.48.11

func (s *PutFeedbackOutput) SetContentFeedback(v *ContentFeedbackData) *PutFeedbackOutput

SetContentFeedback sets the ContentFeedback field's value.

func (*PutFeedbackOutput) SetTargetId added in v1.48.11

func (s *PutFeedbackOutput) SetTargetId(v string) *PutFeedbackOutput

SetTargetId sets the TargetId field's value.

func (*PutFeedbackOutput) SetTargetType added in v1.48.11

func (s *PutFeedbackOutput) SetTargetType(v string) *PutFeedbackOutput

SetTargetType sets the TargetType field's value.

func (PutFeedbackOutput) String added in v1.48.11

func (s PutFeedbackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QConnect

type QConnect struct {
	*client.Client
}

QConnect provides the API operation methods for making requests to Amazon Q Connect. See this package's package overview docs for details on the service.

QConnect methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *QConnect

New creates a new instance of the QConnect client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a QConnect client from just a session.
svc := qconnect.New(mySession)

// Create a QConnect client with additional configuration
svc := qconnect.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*QConnect) CreateAssistant

func (c *QConnect) CreateAssistant(input *CreateAssistantInput) (*CreateAssistantOutput, error)

CreateAssistant API operation for Amazon Q Connect.

Creates an Amazon Q in Connect assistant.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation CreateAssistant for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ServiceQuotaExceededException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistant

func (*QConnect) CreateAssistantAssociation

func (c *QConnect) CreateAssistantAssociation(input *CreateAssistantAssociationInput) (*CreateAssistantAssociationOutput, error)

CreateAssistantAssociation API operation for Amazon Q Connect.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation CreateAssistantAssociation for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ServiceQuotaExceededException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantAssociation

func (*QConnect) CreateAssistantAssociationRequest

func (c *QConnect) CreateAssistantAssociationRequest(input *CreateAssistantAssociationInput) (req *request.Request, output *CreateAssistantAssociationOutput)

CreateAssistantAssociationRequest generates a "aws/request.Request" representing the client's request for the CreateAssistantAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAssistantAssociation for more information on using the CreateAssistantAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAssistantAssociationRequest method.
req, resp := client.CreateAssistantAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantAssociation

func (*QConnect) CreateAssistantAssociationWithContext

func (c *QConnect) CreateAssistantAssociationWithContext(ctx aws.Context, input *CreateAssistantAssociationInput, opts ...request.Option) (*CreateAssistantAssociationOutput, error)

CreateAssistantAssociationWithContext is the same as CreateAssistantAssociation with the addition of the ability to pass a context and additional request options.

See CreateAssistantAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) CreateAssistantRequest

func (c *QConnect) CreateAssistantRequest(input *CreateAssistantInput) (req *request.Request, output *CreateAssistantOutput)

CreateAssistantRequest generates a "aws/request.Request" representing the client's request for the CreateAssistant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAssistant for more information on using the CreateAssistant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAssistantRequest method.
req, resp := client.CreateAssistantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistant

func (*QConnect) CreateAssistantWithContext

func (c *QConnect) CreateAssistantWithContext(ctx aws.Context, input *CreateAssistantInput, opts ...request.Option) (*CreateAssistantOutput, error)

CreateAssistantWithContext is the same as CreateAssistant with the addition of the ability to pass a context and additional request options.

See CreateAssistant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) CreateContent

func (c *QConnect) CreateContent(input *CreateContentInput) (*CreateContentOutput, error)

CreateContent API operation for Amazon Q Connect.

Creates Amazon Q content. Before to calling this API, use StartContentUpload (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html) to upload an asset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation CreateContent for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ServiceQuotaExceededException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateContent

func (*QConnect) CreateContentRequest

func (c *QConnect) CreateContentRequest(input *CreateContentInput) (req *request.Request, output *CreateContentOutput)

CreateContentRequest generates a "aws/request.Request" representing the client's request for the CreateContent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateContent for more information on using the CreateContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateContentRequest method.
req, resp := client.CreateContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateContent

func (*QConnect) CreateContentWithContext

func (c *QConnect) CreateContentWithContext(ctx aws.Context, input *CreateContentInput, opts ...request.Option) (*CreateContentOutput, error)

CreateContentWithContext is the same as CreateContent with the addition of the ability to pass a context and additional request options.

See CreateContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) CreateKnowledgeBase

func (c *QConnect) CreateKnowledgeBase(input *CreateKnowledgeBaseInput) (*CreateKnowledgeBaseOutput, error)

CreateKnowledgeBase API operation for Amazon Q Connect.

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) 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:

Call DeleteKnowledgeBase (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html).

Call DeleteDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html).

Call CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) to recreate the DataIntegration or a create different one.

Call CreateKnowledgeBase.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation CreateKnowledgeBase for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ServiceQuotaExceededException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateKnowledgeBase

func (*QConnect) CreateKnowledgeBaseRequest

func (c *QConnect) CreateKnowledgeBaseRequest(input *CreateKnowledgeBaseInput) (req *request.Request, output *CreateKnowledgeBaseOutput)

CreateKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the CreateKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKnowledgeBase for more information on using the CreateKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateKnowledgeBaseRequest method.
req, resp := client.CreateKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateKnowledgeBase

func (*QConnect) CreateKnowledgeBaseWithContext

func (c *QConnect) CreateKnowledgeBaseWithContext(ctx aws.Context, input *CreateKnowledgeBaseInput, opts ...request.Option) (*CreateKnowledgeBaseOutput, error)

CreateKnowledgeBaseWithContext is the same as CreateKnowledgeBase with the addition of the ability to pass a context and additional request options.

See CreateKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) CreateQuickResponse

func (c *QConnect) CreateQuickResponse(input *CreateQuickResponseInput) (*CreateQuickResponseOutput, error)

CreateQuickResponse API operation for Amazon Q Connect.

Creates an Amazon Q quick response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation CreateQuickResponse for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ServiceQuotaExceededException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateQuickResponse

func (*QConnect) CreateQuickResponseRequest

func (c *QConnect) CreateQuickResponseRequest(input *CreateQuickResponseInput) (req *request.Request, output *CreateQuickResponseOutput)

CreateQuickResponseRequest generates a "aws/request.Request" representing the client's request for the CreateQuickResponse operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateQuickResponse for more information on using the CreateQuickResponse API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateQuickResponseRequest method.
req, resp := client.CreateQuickResponseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateQuickResponse

func (*QConnect) CreateQuickResponseWithContext

func (c *QConnect) CreateQuickResponseWithContext(ctx aws.Context, input *CreateQuickResponseInput, opts ...request.Option) (*CreateQuickResponseOutput, error)

CreateQuickResponseWithContext is the same as CreateQuickResponse with the addition of the ability to pass a context and additional request options.

See CreateQuickResponse for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) CreateSession

func (c *QConnect) CreateSession(input *CreateSessionInput) (*CreateSessionOutput, error)

CreateSession API operation for Amazon Q Connect.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation CreateSession for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSession

func (*QConnect) CreateSessionRequest

func (c *QConnect) CreateSessionRequest(input *CreateSessionInput) (req *request.Request, output *CreateSessionOutput)

CreateSessionRequest generates a "aws/request.Request" representing the client's request for the CreateSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSession for more information on using the CreateSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSessionRequest method.
req, resp := client.CreateSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSession

func (*QConnect) CreateSessionWithContext

func (c *QConnect) CreateSessionWithContext(ctx aws.Context, input *CreateSessionInput, opts ...request.Option) (*CreateSessionOutput, error)

CreateSessionWithContext is the same as CreateSession with the addition of the ability to pass a context and additional request options.

See CreateSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) DeleteAssistant

func (c *QConnect) DeleteAssistant(input *DeleteAssistantInput) (*DeleteAssistantOutput, error)

DeleteAssistant API operation for Amazon Q Connect.

Deletes an assistant.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation DeleteAssistant for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistant

func (*QConnect) DeleteAssistantAssociation

func (c *QConnect) DeleteAssistantAssociation(input *DeleteAssistantAssociationInput) (*DeleteAssistantAssociationOutput, error)

DeleteAssistantAssociation API operation for Amazon Q Connect.

Deletes an assistant association.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation DeleteAssistantAssociation for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistantAssociation

func (*QConnect) DeleteAssistantAssociationRequest

func (c *QConnect) DeleteAssistantAssociationRequest(input *DeleteAssistantAssociationInput) (req *request.Request, output *DeleteAssistantAssociationOutput)

DeleteAssistantAssociationRequest generates a "aws/request.Request" representing the client's request for the DeleteAssistantAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAssistantAssociation for more information on using the DeleteAssistantAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAssistantAssociationRequest method.
req, resp := client.DeleteAssistantAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistantAssociation

func (*QConnect) DeleteAssistantAssociationWithContext

func (c *QConnect) DeleteAssistantAssociationWithContext(ctx aws.Context, input *DeleteAssistantAssociationInput, opts ...request.Option) (*DeleteAssistantAssociationOutput, error)

DeleteAssistantAssociationWithContext is the same as DeleteAssistantAssociation with the addition of the ability to pass a context and additional request options.

See DeleteAssistantAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) DeleteAssistantRequest

func (c *QConnect) DeleteAssistantRequest(input *DeleteAssistantInput) (req *request.Request, output *DeleteAssistantOutput)

DeleteAssistantRequest generates a "aws/request.Request" representing the client's request for the DeleteAssistant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAssistant for more information on using the DeleteAssistant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAssistantRequest method.
req, resp := client.DeleteAssistantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistant

func (*QConnect) DeleteAssistantWithContext

func (c *QConnect) DeleteAssistantWithContext(ctx aws.Context, input *DeleteAssistantInput, opts ...request.Option) (*DeleteAssistantOutput, error)

DeleteAssistantWithContext is the same as DeleteAssistant with the addition of the ability to pass a context and additional request options.

See DeleteAssistant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) DeleteContent

func (c *QConnect) DeleteContent(input *DeleteContentInput) (*DeleteContentOutput, error)

DeleteContent API operation for Amazon Q Connect.

Deletes the content.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation DeleteContent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteContent

func (*QConnect) DeleteContentRequest

func (c *QConnect) DeleteContentRequest(input *DeleteContentInput) (req *request.Request, output *DeleteContentOutput)

DeleteContentRequest generates a "aws/request.Request" representing the client's request for the DeleteContent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteContent for more information on using the DeleteContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteContentRequest method.
req, resp := client.DeleteContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteContent

func (*QConnect) DeleteContentWithContext

func (c *QConnect) DeleteContentWithContext(ctx aws.Context, input *DeleteContentInput, opts ...request.Option) (*DeleteContentOutput, error)

DeleteContentWithContext is the same as DeleteContent with the addition of the ability to pass a context and additional request options.

See DeleteContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) DeleteImportJob

func (c *QConnect) DeleteImportJob(input *DeleteImportJobInput) (*DeleteImportJobOutput, error)

DeleteImportJob API operation for Amazon Q Connect.

Deletes the quick response import job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation DeleteImportJob for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteImportJob

func (*QConnect) DeleteImportJobRequest

func (c *QConnect) DeleteImportJobRequest(input *DeleteImportJobInput) (req *request.Request, output *DeleteImportJobOutput)

DeleteImportJobRequest generates a "aws/request.Request" representing the client's request for the DeleteImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteImportJob for more information on using the DeleteImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteImportJobRequest method.
req, resp := client.DeleteImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteImportJob

func (*QConnect) DeleteImportJobWithContext

func (c *QConnect) DeleteImportJobWithContext(ctx aws.Context, input *DeleteImportJobInput, opts ...request.Option) (*DeleteImportJobOutput, error)

DeleteImportJobWithContext is the same as DeleteImportJob with the addition of the ability to pass a context and additional request options.

See DeleteImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) DeleteKnowledgeBase

func (c *QConnect) DeleteKnowledgeBase(input *DeleteKnowledgeBaseInput) (*DeleteKnowledgeBaseOutput, error)

DeleteKnowledgeBase API operation for Amazon Q Connect.

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 AppIntegrations (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) DataIntegration. 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 DeleteDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html) and CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) in the Amazon AppIntegrations API Reference.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation DeleteKnowledgeBase for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteKnowledgeBase

func (*QConnect) DeleteKnowledgeBaseRequest

func (c *QConnect) DeleteKnowledgeBaseRequest(input *DeleteKnowledgeBaseInput) (req *request.Request, output *DeleteKnowledgeBaseOutput)

DeleteKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the DeleteKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKnowledgeBase for more information on using the DeleteKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteKnowledgeBaseRequest method.
req, resp := client.DeleteKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteKnowledgeBase

func (*QConnect) DeleteKnowledgeBaseWithContext

func (c *QConnect) DeleteKnowledgeBaseWithContext(ctx aws.Context, input *DeleteKnowledgeBaseInput, opts ...request.Option) (*DeleteKnowledgeBaseOutput, error)

DeleteKnowledgeBaseWithContext is the same as DeleteKnowledgeBase with the addition of the ability to pass a context and additional request options.

See DeleteKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) DeleteQuickResponse

func (c *QConnect) DeleteQuickResponse(input *DeleteQuickResponseInput) (*DeleteQuickResponseOutput, error)

DeleteQuickResponse API operation for Amazon Q Connect.

Deletes a quick response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation DeleteQuickResponse for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteQuickResponse

func (*QConnect) DeleteQuickResponseRequest

func (c *QConnect) DeleteQuickResponseRequest(input *DeleteQuickResponseInput) (req *request.Request, output *DeleteQuickResponseOutput)

DeleteQuickResponseRequest generates a "aws/request.Request" representing the client's request for the DeleteQuickResponse operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteQuickResponse for more information on using the DeleteQuickResponse API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteQuickResponseRequest method.
req, resp := client.DeleteQuickResponseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteQuickResponse

func (*QConnect) DeleteQuickResponseWithContext

func (c *QConnect) DeleteQuickResponseWithContext(ctx aws.Context, input *DeleteQuickResponseInput, opts ...request.Option) (*DeleteQuickResponseOutput, error)

DeleteQuickResponseWithContext is the same as DeleteQuickResponse with the addition of the ability to pass a context and additional request options.

See DeleteQuickResponse for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetAssistant

func (c *QConnect) GetAssistant(input *GetAssistantInput) (*GetAssistantOutput, error)

GetAssistant API operation for Amazon Q Connect.

Retrieves information about an assistant.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetAssistant for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistant

func (*QConnect) GetAssistantAssociation

func (c *QConnect) GetAssistantAssociation(input *GetAssistantAssociationInput) (*GetAssistantAssociationOutput, error)

GetAssistantAssociation API operation for Amazon Q Connect.

Retrieves information about an assistant association.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetAssistantAssociation for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistantAssociation

func (*QConnect) GetAssistantAssociationRequest

func (c *QConnect) GetAssistantAssociationRequest(input *GetAssistantAssociationInput) (req *request.Request, output *GetAssistantAssociationOutput)

GetAssistantAssociationRequest generates a "aws/request.Request" representing the client's request for the GetAssistantAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAssistantAssociation for more information on using the GetAssistantAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAssistantAssociationRequest method.
req, resp := client.GetAssistantAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistantAssociation

func (*QConnect) GetAssistantAssociationWithContext

func (c *QConnect) GetAssistantAssociationWithContext(ctx aws.Context, input *GetAssistantAssociationInput, opts ...request.Option) (*GetAssistantAssociationOutput, error)

GetAssistantAssociationWithContext is the same as GetAssistantAssociation with the addition of the ability to pass a context and additional request options.

See GetAssistantAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetAssistantRequest

func (c *QConnect) GetAssistantRequest(input *GetAssistantInput) (req *request.Request, output *GetAssistantOutput)

GetAssistantRequest generates a "aws/request.Request" representing the client's request for the GetAssistant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAssistant for more information on using the GetAssistant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAssistantRequest method.
req, resp := client.GetAssistantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistant

func (*QConnect) GetAssistantWithContext

func (c *QConnect) GetAssistantWithContext(ctx aws.Context, input *GetAssistantInput, opts ...request.Option) (*GetAssistantOutput, error)

GetAssistantWithContext is the same as GetAssistant with the addition of the ability to pass a context and additional request options.

See GetAssistant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetContent

func (c *QConnect) GetContent(input *GetContentInput) (*GetContentOutput, error)

GetContent API operation for Amazon Q Connect.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetContent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContent

func (*QConnect) GetContentRequest

func (c *QConnect) GetContentRequest(input *GetContentInput) (req *request.Request, output *GetContentOutput)

GetContentRequest generates a "aws/request.Request" representing the client's request for the GetContent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContent for more information on using the GetContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetContentRequest method.
req, resp := client.GetContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContent

func (*QConnect) GetContentSummary

func (c *QConnect) GetContentSummary(input *GetContentSummaryInput) (*GetContentSummaryOutput, error)

GetContentSummary API operation for Amazon Q Connect.

Retrieves summary information about the content.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetContentSummary for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContentSummary

func (*QConnect) GetContentSummaryRequest

func (c *QConnect) GetContentSummaryRequest(input *GetContentSummaryInput) (req *request.Request, output *GetContentSummaryOutput)

GetContentSummaryRequest generates a "aws/request.Request" representing the client's request for the GetContentSummary operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetContentSummary for more information on using the GetContentSummary API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetContentSummaryRequest method.
req, resp := client.GetContentSummaryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContentSummary

func (*QConnect) GetContentSummaryWithContext

func (c *QConnect) GetContentSummaryWithContext(ctx aws.Context, input *GetContentSummaryInput, opts ...request.Option) (*GetContentSummaryOutput, error)

GetContentSummaryWithContext is the same as GetContentSummary with the addition of the ability to pass a context and additional request options.

See GetContentSummary for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetContentWithContext

func (c *QConnect) GetContentWithContext(ctx aws.Context, input *GetContentInput, opts ...request.Option) (*GetContentOutput, error)

GetContentWithContext is the same as GetContent with the addition of the ability to pass a context and additional request options.

See GetContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetImportJob

func (c *QConnect) GetImportJob(input *GetImportJobInput) (*GetImportJobOutput, error)

GetImportJob API operation for Amazon Q Connect.

Retrieves the started import job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetImportJob for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetImportJob

func (*QConnect) GetImportJobRequest

func (c *QConnect) GetImportJobRequest(input *GetImportJobInput) (req *request.Request, output *GetImportJobOutput)

GetImportJobRequest generates a "aws/request.Request" representing the client's request for the GetImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetImportJob for more information on using the GetImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetImportJobRequest method.
req, resp := client.GetImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetImportJob

func (*QConnect) GetImportJobWithContext

func (c *QConnect) GetImportJobWithContext(ctx aws.Context, input *GetImportJobInput, opts ...request.Option) (*GetImportJobOutput, error)

GetImportJobWithContext is the same as GetImportJob with the addition of the ability to pass a context and additional request options.

See GetImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetKnowledgeBase

func (c *QConnect) GetKnowledgeBase(input *GetKnowledgeBaseInput) (*GetKnowledgeBaseOutput, error)

GetKnowledgeBase API operation for Amazon Q Connect.

Retrieves information about the knowledge base.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetKnowledgeBase for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBase

func (*QConnect) GetKnowledgeBaseRequest

func (c *QConnect) GetKnowledgeBaseRequest(input *GetKnowledgeBaseInput) (req *request.Request, output *GetKnowledgeBaseOutput)

GetKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the GetKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKnowledgeBase for more information on using the GetKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKnowledgeBaseRequest method.
req, resp := client.GetKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBase

func (*QConnect) GetKnowledgeBaseWithContext

func (c *QConnect) GetKnowledgeBaseWithContext(ctx aws.Context, input *GetKnowledgeBaseInput, opts ...request.Option) (*GetKnowledgeBaseOutput, error)

GetKnowledgeBaseWithContext is the same as GetKnowledgeBase with the addition of the ability to pass a context and additional request options.

See GetKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetQuickResponse

func (c *QConnect) GetQuickResponse(input *GetQuickResponseInput) (*GetQuickResponseOutput, error)

GetQuickResponse API operation for Amazon Q Connect.

Retrieves the quick response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetQuickResponse for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetQuickResponse

func (*QConnect) GetQuickResponseRequest

func (c *QConnect) GetQuickResponseRequest(input *GetQuickResponseInput) (req *request.Request, output *GetQuickResponseOutput)

GetQuickResponseRequest generates a "aws/request.Request" representing the client's request for the GetQuickResponse operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQuickResponse for more information on using the GetQuickResponse API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetQuickResponseRequest method.
req, resp := client.GetQuickResponseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetQuickResponse

func (*QConnect) GetQuickResponseWithContext

func (c *QConnect) GetQuickResponseWithContext(ctx aws.Context, input *GetQuickResponseInput, opts ...request.Option) (*GetQuickResponseOutput, error)

GetQuickResponseWithContext is the same as GetQuickResponse with the addition of the ability to pass a context and additional request options.

See GetQuickResponse for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) GetRecommendations deprecated

func (c *QConnect) GetRecommendations(input *GetRecommendationsInput) (*GetRecommendationsOutput, error)

GetRecommendations API operation for Amazon Q Connect.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html). 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 (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetRecommendations for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendations

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 (*QConnect) GetRecommendationsRequest deprecated

func (c *QConnect) GetRecommendationsRequest(input *GetRecommendationsInput) (req *request.Request, output *GetRecommendationsOutput)

GetRecommendationsRequest generates a "aws/request.Request" representing the client's request for the GetRecommendations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecommendations for more information on using the GetRecommendations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRecommendationsRequest method.
req, resp := client.GetRecommendationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendations

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 (*QConnect) GetRecommendationsWithContext deprecated

func (c *QConnect) GetRecommendationsWithContext(ctx aws.Context, input *GetRecommendationsInput, opts ...request.Option) (*GetRecommendationsOutput, error)

GetRecommendationsWithContext is the same as GetRecommendations with the addition of the ability to pass a context and additional request options.

See GetRecommendations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 (*QConnect) GetSession

func (c *QConnect) GetSession(input *GetSessionInput) (*GetSessionOutput, error)

GetSession API operation for Amazon Q Connect.

Retrieves information for a specified session.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation GetSession for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetSession

func (*QConnect) GetSessionRequest

func (c *QConnect) GetSessionRequest(input *GetSessionInput) (req *request.Request, output *GetSessionOutput)

GetSessionRequest generates a "aws/request.Request" representing the client's request for the GetSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSession for more information on using the GetSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSessionRequest method.
req, resp := client.GetSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetSession

func (*QConnect) GetSessionWithContext

func (c *QConnect) GetSessionWithContext(ctx aws.Context, input *GetSessionInput, opts ...request.Option) (*GetSessionOutput, error)

GetSessionWithContext is the same as GetSession with the addition of the ability to pass a context and additional request options.

See GetSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListAssistantAssociations

func (c *QConnect) ListAssistantAssociations(input *ListAssistantAssociationsInput) (*ListAssistantAssociationsOutput, error)

ListAssistantAssociations API operation for Amazon Q Connect.

Lists information about assistant associations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListAssistantAssociations for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantAssociations

func (*QConnect) ListAssistantAssociationsPages

func (c *QConnect) ListAssistantAssociationsPages(input *ListAssistantAssociationsInput, fn func(*ListAssistantAssociationsOutput, bool) bool) error

ListAssistantAssociationsPages iterates over the pages of a ListAssistantAssociations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssistantAssociations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAssistantAssociations operation.
pageNum := 0
err := client.ListAssistantAssociationsPages(params,
    func(page *qconnect.ListAssistantAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) ListAssistantAssociationsPagesWithContext

func (c *QConnect) ListAssistantAssociationsPagesWithContext(ctx aws.Context, input *ListAssistantAssociationsInput, fn func(*ListAssistantAssociationsOutput, bool) bool, opts ...request.Option) error

ListAssistantAssociationsPagesWithContext same as ListAssistantAssociationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListAssistantAssociationsRequest

func (c *QConnect) ListAssistantAssociationsRequest(input *ListAssistantAssociationsInput) (req *request.Request, output *ListAssistantAssociationsOutput)

ListAssistantAssociationsRequest generates a "aws/request.Request" representing the client's request for the ListAssistantAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssistantAssociations for more information on using the ListAssistantAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAssistantAssociationsRequest method.
req, resp := client.ListAssistantAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantAssociations

func (*QConnect) ListAssistantAssociationsWithContext

func (c *QConnect) ListAssistantAssociationsWithContext(ctx aws.Context, input *ListAssistantAssociationsInput, opts ...request.Option) (*ListAssistantAssociationsOutput, error)

ListAssistantAssociationsWithContext is the same as ListAssistantAssociations with the addition of the ability to pass a context and additional request options.

See ListAssistantAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListAssistants

func (c *QConnect) ListAssistants(input *ListAssistantsInput) (*ListAssistantsOutput, error)

ListAssistants API operation for Amazon Q Connect.

Lists information about assistants.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListAssistants for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistants

func (*QConnect) ListAssistantsPages

func (c *QConnect) ListAssistantsPages(input *ListAssistantsInput, fn func(*ListAssistantsOutput, bool) bool) error

ListAssistantsPages iterates over the pages of a ListAssistants operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssistants method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAssistants operation.
pageNum := 0
err := client.ListAssistantsPages(params,
    func(page *qconnect.ListAssistantsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) ListAssistantsPagesWithContext

func (c *QConnect) ListAssistantsPagesWithContext(ctx aws.Context, input *ListAssistantsInput, fn func(*ListAssistantsOutput, bool) bool, opts ...request.Option) error

ListAssistantsPagesWithContext same as ListAssistantsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListAssistantsRequest

func (c *QConnect) ListAssistantsRequest(input *ListAssistantsInput) (req *request.Request, output *ListAssistantsOutput)

ListAssistantsRequest generates a "aws/request.Request" representing the client's request for the ListAssistants operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssistants for more information on using the ListAssistants API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAssistantsRequest method.
req, resp := client.ListAssistantsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistants

func (*QConnect) ListAssistantsWithContext

func (c *QConnect) ListAssistantsWithContext(ctx aws.Context, input *ListAssistantsInput, opts ...request.Option) (*ListAssistantsOutput, error)

ListAssistantsWithContext is the same as ListAssistants with the addition of the ability to pass a context and additional request options.

See ListAssistants for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListContents

func (c *QConnect) ListContents(input *ListContentsInput) (*ListContentsOutput, error)

ListContents API operation for Amazon Q Connect.

Lists the content.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListContents for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListContents

func (*QConnect) ListContentsPages

func (c *QConnect) ListContentsPages(input *ListContentsInput, fn func(*ListContentsOutput, bool) bool) error

ListContentsPages iterates over the pages of a ListContents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListContents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListContents operation.
pageNum := 0
err := client.ListContentsPages(params,
    func(page *qconnect.ListContentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) ListContentsPagesWithContext

func (c *QConnect) ListContentsPagesWithContext(ctx aws.Context, input *ListContentsInput, fn func(*ListContentsOutput, bool) bool, opts ...request.Option) error

ListContentsPagesWithContext same as ListContentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListContentsRequest

func (c *QConnect) ListContentsRequest(input *ListContentsInput) (req *request.Request, output *ListContentsOutput)

ListContentsRequest generates a "aws/request.Request" representing the client's request for the ListContents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListContents for more information on using the ListContents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListContentsRequest method.
req, resp := client.ListContentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListContents

func (*QConnect) ListContentsWithContext

func (c *QConnect) ListContentsWithContext(ctx aws.Context, input *ListContentsInput, opts ...request.Option) (*ListContentsOutput, error)

ListContentsWithContext is the same as ListContents with the addition of the ability to pass a context and additional request options.

See ListContents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListImportJobs

func (c *QConnect) ListImportJobs(input *ListImportJobsInput) (*ListImportJobsOutput, error)

ListImportJobs API operation for Amazon Q Connect.

Lists information about import jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListImportJobs for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListImportJobs

func (*QConnect) ListImportJobsPages

func (c *QConnect) ListImportJobsPages(input *ListImportJobsInput, fn func(*ListImportJobsOutput, bool) bool) error

ListImportJobsPages iterates over the pages of a ListImportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListImportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListImportJobs operation.
pageNum := 0
err := client.ListImportJobsPages(params,
    func(page *qconnect.ListImportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) ListImportJobsPagesWithContext

func (c *QConnect) ListImportJobsPagesWithContext(ctx aws.Context, input *ListImportJobsInput, fn func(*ListImportJobsOutput, bool) bool, opts ...request.Option) error

ListImportJobsPagesWithContext same as ListImportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListImportJobsRequest

func (c *QConnect) ListImportJobsRequest(input *ListImportJobsInput) (req *request.Request, output *ListImportJobsOutput)

ListImportJobsRequest generates a "aws/request.Request" representing the client's request for the ListImportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListImportJobs for more information on using the ListImportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListImportJobsRequest method.
req, resp := client.ListImportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListImportJobs

func (*QConnect) ListImportJobsWithContext

func (c *QConnect) ListImportJobsWithContext(ctx aws.Context, input *ListImportJobsInput, opts ...request.Option) (*ListImportJobsOutput, error)

ListImportJobsWithContext is the same as ListImportJobs with the addition of the ability to pass a context and additional request options.

See ListImportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListKnowledgeBases

func (c *QConnect) ListKnowledgeBases(input *ListKnowledgeBasesInput) (*ListKnowledgeBasesOutput, error)

ListKnowledgeBases API operation for Amazon Q Connect.

Lists the knowledge bases.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListKnowledgeBases for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBases

func (*QConnect) ListKnowledgeBasesPages

func (c *QConnect) ListKnowledgeBasesPages(input *ListKnowledgeBasesInput, fn func(*ListKnowledgeBasesOutput, bool) bool) error

ListKnowledgeBasesPages iterates over the pages of a ListKnowledgeBases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKnowledgeBases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListKnowledgeBases operation.
pageNum := 0
err := client.ListKnowledgeBasesPages(params,
    func(page *qconnect.ListKnowledgeBasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) ListKnowledgeBasesPagesWithContext

func (c *QConnect) ListKnowledgeBasesPagesWithContext(ctx aws.Context, input *ListKnowledgeBasesInput, fn func(*ListKnowledgeBasesOutput, bool) bool, opts ...request.Option) error

ListKnowledgeBasesPagesWithContext same as ListKnowledgeBasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListKnowledgeBasesRequest

func (c *QConnect) ListKnowledgeBasesRequest(input *ListKnowledgeBasesInput) (req *request.Request, output *ListKnowledgeBasesOutput)

ListKnowledgeBasesRequest generates a "aws/request.Request" representing the client's request for the ListKnowledgeBases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKnowledgeBases for more information on using the ListKnowledgeBases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListKnowledgeBasesRequest method.
req, resp := client.ListKnowledgeBasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBases

func (*QConnect) ListKnowledgeBasesWithContext

func (c *QConnect) ListKnowledgeBasesWithContext(ctx aws.Context, input *ListKnowledgeBasesInput, opts ...request.Option) (*ListKnowledgeBasesOutput, error)

ListKnowledgeBasesWithContext is the same as ListKnowledgeBases with the addition of the ability to pass a context and additional request options.

See ListKnowledgeBases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListQuickResponses

func (c *QConnect) ListQuickResponses(input *ListQuickResponsesInput) (*ListQuickResponsesOutput, error)

ListQuickResponses API operation for Amazon Q Connect.

Lists information about quick response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListQuickResponses for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponses

func (*QConnect) ListQuickResponsesPages

func (c *QConnect) ListQuickResponsesPages(input *ListQuickResponsesInput, fn func(*ListQuickResponsesOutput, bool) bool) error

ListQuickResponsesPages iterates over the pages of a ListQuickResponses operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListQuickResponses method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListQuickResponses operation.
pageNum := 0
err := client.ListQuickResponsesPages(params,
    func(page *qconnect.ListQuickResponsesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) ListQuickResponsesPagesWithContext

func (c *QConnect) ListQuickResponsesPagesWithContext(ctx aws.Context, input *ListQuickResponsesInput, fn func(*ListQuickResponsesOutput, bool) bool, opts ...request.Option) error

ListQuickResponsesPagesWithContext same as ListQuickResponsesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListQuickResponsesRequest

func (c *QConnect) ListQuickResponsesRequest(input *ListQuickResponsesInput) (req *request.Request, output *ListQuickResponsesOutput)

ListQuickResponsesRequest generates a "aws/request.Request" representing the client's request for the ListQuickResponses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListQuickResponses for more information on using the ListQuickResponses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListQuickResponsesRequest method.
req, resp := client.ListQuickResponsesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponses

func (*QConnect) ListQuickResponsesWithContext

func (c *QConnect) ListQuickResponsesWithContext(ctx aws.Context, input *ListQuickResponsesInput, opts ...request.Option) (*ListQuickResponsesOutput, error)

ListQuickResponsesWithContext is the same as ListQuickResponses with the addition of the ability to pass a context and additional request options.

See ListQuickResponses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) ListTagsForResource

func (c *QConnect) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Q Connect.

Lists the tags for the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResource

func (*QConnect) ListTagsForResourceRequest

func (c *QConnect) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResource

func (*QConnect) ListTagsForResourceWithContext

func (c *QConnect) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) NotifyRecommendationsReceived

func (c *QConnect) NotifyRecommendationsReceived(input *NotifyRecommendationsReceivedInput) (*NotifyRecommendationsReceivedOutput, error)

NotifyRecommendationsReceived API operation for Amazon Q Connect.

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html) and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation NotifyRecommendationsReceived for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotifyRecommendationsReceived

func (*QConnect) NotifyRecommendationsReceivedRequest

func (c *QConnect) NotifyRecommendationsReceivedRequest(input *NotifyRecommendationsReceivedInput) (req *request.Request, output *NotifyRecommendationsReceivedOutput)

NotifyRecommendationsReceivedRequest generates a "aws/request.Request" representing the client's request for the NotifyRecommendationsReceived operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See NotifyRecommendationsReceived for more information on using the NotifyRecommendationsReceived API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the NotifyRecommendationsReceivedRequest method.
req, resp := client.NotifyRecommendationsReceivedRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotifyRecommendationsReceived

func (*QConnect) NotifyRecommendationsReceivedWithContext

func (c *QConnect) NotifyRecommendationsReceivedWithContext(ctx aws.Context, input *NotifyRecommendationsReceivedInput, opts ...request.Option) (*NotifyRecommendationsReceivedOutput, error)

NotifyRecommendationsReceivedWithContext is the same as NotifyRecommendationsReceived with the addition of the ability to pass a context and additional request options.

See NotifyRecommendationsReceived for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) PutFeedback added in v1.48.11

func (c *QConnect) PutFeedback(input *PutFeedbackInput) (*PutFeedbackOutput, error)

PutFeedback API operation for Amazon Q Connect.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation PutFeedback for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedback

func (*QConnect) PutFeedbackRequest added in v1.48.11

func (c *QConnect) PutFeedbackRequest(input *PutFeedbackInput) (req *request.Request, output *PutFeedbackOutput)

PutFeedbackRequest generates a "aws/request.Request" representing the client's request for the PutFeedback operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutFeedback for more information on using the PutFeedback API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutFeedbackRequest method.
req, resp := client.PutFeedbackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedback

func (*QConnect) PutFeedbackWithContext added in v1.48.11

func (c *QConnect) PutFeedbackWithContext(ctx aws.Context, input *PutFeedbackInput, opts ...request.Option) (*PutFeedbackOutput, error)

PutFeedbackWithContext is the same as PutFeedback with the addition of the ability to pass a context and additional request options.

See PutFeedback for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) QueryAssistant deprecated

func (c *QConnect) QueryAssistant(input *QueryAssistantInput) (*QueryAssistantOutput, error)

QueryAssistant API operation for Amazon Q Connect.

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation QueryAssistant for usage and error information.

Returned Error Types:

  • RequestTimeoutException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryAssistant

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 (*QConnect) QueryAssistantPages deprecated

func (c *QConnect) QueryAssistantPages(input *QueryAssistantInput, fn func(*QueryAssistantOutput, bool) bool) error

QueryAssistantPages iterates over the pages of a QueryAssistant operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See QueryAssistant method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a QueryAssistant operation.
pageNum := 0
err := client.QueryAssistantPages(params,
    func(page *qconnect.QueryAssistantOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 (*QConnect) QueryAssistantPagesWithContext deprecated

func (c *QConnect) QueryAssistantPagesWithContext(ctx aws.Context, input *QueryAssistantInput, fn func(*QueryAssistantOutput, bool) bool, opts ...request.Option) error

QueryAssistantPagesWithContext same as QueryAssistantPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 (*QConnect) QueryAssistantRequest deprecated

func (c *QConnect) QueryAssistantRequest(input *QueryAssistantInput) (req *request.Request, output *QueryAssistantOutput)

QueryAssistantRequest generates a "aws/request.Request" representing the client's request for the QueryAssistant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See QueryAssistant for more information on using the QueryAssistant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the QueryAssistantRequest method.
req, resp := client.QueryAssistantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryAssistant

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 (*QConnect) QueryAssistantWithContext deprecated

func (c *QConnect) QueryAssistantWithContext(ctx aws.Context, input *QueryAssistantInput, opts ...request.Option) (*QueryAssistantOutput, error)

QueryAssistantWithContext is the same as QueryAssistant with the addition of the ability to pass a context and additional request options.

See QueryAssistant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 (*QConnect) RemoveKnowledgeBaseTemplateUri

func (c *QConnect) RemoveKnowledgeBaseTemplateUri(input *RemoveKnowledgeBaseTemplateUriInput) (*RemoveKnowledgeBaseTemplateUriOutput, error)

RemoveKnowledgeBaseTemplateUri API operation for Amazon Q Connect.

Removes a URI template from a knowledge base.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation RemoveKnowledgeBaseTemplateUri for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri

func (*QConnect) RemoveKnowledgeBaseTemplateUriRequest

func (c *QConnect) RemoveKnowledgeBaseTemplateUriRequest(input *RemoveKnowledgeBaseTemplateUriInput) (req *request.Request, output *RemoveKnowledgeBaseTemplateUriOutput)

RemoveKnowledgeBaseTemplateUriRequest generates a "aws/request.Request" representing the client's request for the RemoveKnowledgeBaseTemplateUri operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveKnowledgeBaseTemplateUri for more information on using the RemoveKnowledgeBaseTemplateUri API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveKnowledgeBaseTemplateUriRequest method.
req, resp := client.RemoveKnowledgeBaseTemplateUriRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri

func (*QConnect) RemoveKnowledgeBaseTemplateUriWithContext

func (c *QConnect) RemoveKnowledgeBaseTemplateUriWithContext(ctx aws.Context, input *RemoveKnowledgeBaseTemplateUriInput, opts ...request.Option) (*RemoveKnowledgeBaseTemplateUriOutput, error)

RemoveKnowledgeBaseTemplateUriWithContext is the same as RemoveKnowledgeBaseTemplateUri with the addition of the ability to pass a context and additional request options.

See RemoveKnowledgeBaseTemplateUri for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) SearchContent

func (c *QConnect) SearchContent(input *SearchContentInput) (*SearchContentOutput, error)

SearchContent API operation for Amazon Q Connect.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation SearchContent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchContent

func (*QConnect) SearchContentPages

func (c *QConnect) SearchContentPages(input *SearchContentInput, fn func(*SearchContentOutput, bool) bool) error

SearchContentPages iterates over the pages of a SearchContent operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchContent method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a SearchContent operation.
pageNum := 0
err := client.SearchContentPages(params,
    func(page *qconnect.SearchContentOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) SearchContentPagesWithContext

func (c *QConnect) SearchContentPagesWithContext(ctx aws.Context, input *SearchContentInput, fn func(*SearchContentOutput, bool) bool, opts ...request.Option) error

SearchContentPagesWithContext same as SearchContentPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) SearchContentRequest

func (c *QConnect) SearchContentRequest(input *SearchContentInput) (req *request.Request, output *SearchContentOutput)

SearchContentRequest generates a "aws/request.Request" representing the client's request for the SearchContent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchContent for more information on using the SearchContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SearchContentRequest method.
req, resp := client.SearchContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchContent

func (*QConnect) SearchContentWithContext

func (c *QConnect) SearchContentWithContext(ctx aws.Context, input *SearchContentInput, opts ...request.Option) (*SearchContentOutput, error)

SearchContentWithContext is the same as SearchContent with the addition of the ability to pass a context and additional request options.

See SearchContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) SearchQuickResponses

func (c *QConnect) SearchQuickResponses(input *SearchQuickResponsesInput) (*SearchQuickResponsesOutput, error)

SearchQuickResponses API operation for Amazon Q Connect.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation SearchQuickResponses for usage and error information.

Returned Error Types:

  • RequestTimeoutException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchQuickResponses

func (*QConnect) SearchQuickResponsesPages

func (c *QConnect) SearchQuickResponsesPages(input *SearchQuickResponsesInput, fn func(*SearchQuickResponsesOutput, bool) bool) error

SearchQuickResponsesPages iterates over the pages of a SearchQuickResponses operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchQuickResponses method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a SearchQuickResponses operation.
pageNum := 0
err := client.SearchQuickResponsesPages(params,
    func(page *qconnect.SearchQuickResponsesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) SearchQuickResponsesPagesWithContext

func (c *QConnect) SearchQuickResponsesPagesWithContext(ctx aws.Context, input *SearchQuickResponsesInput, fn func(*SearchQuickResponsesOutput, bool) bool, opts ...request.Option) error

SearchQuickResponsesPagesWithContext same as SearchQuickResponsesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) SearchQuickResponsesRequest

func (c *QConnect) SearchQuickResponsesRequest(input *SearchQuickResponsesInput) (req *request.Request, output *SearchQuickResponsesOutput)

SearchQuickResponsesRequest generates a "aws/request.Request" representing the client's request for the SearchQuickResponses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchQuickResponses for more information on using the SearchQuickResponses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SearchQuickResponsesRequest method.
req, resp := client.SearchQuickResponsesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchQuickResponses

func (*QConnect) SearchQuickResponsesWithContext

func (c *QConnect) SearchQuickResponsesWithContext(ctx aws.Context, input *SearchQuickResponsesInput, opts ...request.Option) (*SearchQuickResponsesOutput, error)

SearchQuickResponsesWithContext is the same as SearchQuickResponses with the addition of the ability to pass a context and additional request options.

See SearchQuickResponses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) SearchSessions

func (c *QConnect) SearchSessions(input *SearchSessionsInput) (*SearchSessionsOutput, error)

SearchSessions API operation for Amazon Q Connect.

Searches for sessions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation SearchSessions for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchSessions

func (*QConnect) SearchSessionsPages

func (c *QConnect) SearchSessionsPages(input *SearchSessionsInput, fn func(*SearchSessionsOutput, bool) bool) error

SearchSessionsPages iterates over the pages of a SearchSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchSessions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a SearchSessions operation.
pageNum := 0
err := client.SearchSessionsPages(params,
    func(page *qconnect.SearchSessionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QConnect) SearchSessionsPagesWithContext

func (c *QConnect) SearchSessionsPagesWithContext(ctx aws.Context, input *SearchSessionsInput, fn func(*SearchSessionsOutput, bool) bool, opts ...request.Option) error

SearchSessionsPagesWithContext same as SearchSessionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) SearchSessionsRequest

func (c *QConnect) SearchSessionsRequest(input *SearchSessionsInput) (req *request.Request, output *SearchSessionsOutput)

SearchSessionsRequest generates a "aws/request.Request" representing the client's request for the SearchSessions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchSessions for more information on using the SearchSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SearchSessionsRequest method.
req, resp := client.SearchSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchSessions

func (*QConnect) SearchSessionsWithContext

func (c *QConnect) SearchSessionsWithContext(ctx aws.Context, input *SearchSessionsInput, opts ...request.Option) (*SearchSessionsOutput, error)

SearchSessionsWithContext is the same as SearchSessions with the addition of the ability to pass a context and additional request options.

See SearchSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) StartContentUpload

func (c *QConnect) StartContentUpload(input *StartContentUploadInput) (*StartContentUploadOutput, error)

StartContentUpload API operation for Amazon Q Connect.

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 CreateContent (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_CreateContent.html) to finalize the content creation process or UpdateContent (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html) to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation StartContentUpload for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartContentUpload

func (*QConnect) StartContentUploadRequest

func (c *QConnect) StartContentUploadRequest(input *StartContentUploadInput) (req *request.Request, output *StartContentUploadOutput)

StartContentUploadRequest generates a "aws/request.Request" representing the client's request for the StartContentUpload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartContentUpload for more information on using the StartContentUpload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartContentUploadRequest method.
req, resp := client.StartContentUploadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartContentUpload

func (*QConnect) StartContentUploadWithContext

func (c *QConnect) StartContentUploadWithContext(ctx aws.Context, input *StartContentUploadInput, opts ...request.Option) (*StartContentUploadOutput, error)

StartContentUploadWithContext is the same as StartContentUpload with the addition of the ability to pass a context and additional request options.

See StartContentUpload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) StartImportJob

func (c *QConnect) StartImportJob(input *StartImportJobInput) (*StartImportJobOutput, error)

StartImportJob API operation for Amazon Q Connect.

Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) to upload an asset that contains the resource data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation StartImportJob for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • ServiceQuotaExceededException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartImportJob

func (*QConnect) StartImportJobRequest

func (c *QConnect) StartImportJobRequest(input *StartImportJobInput) (req *request.Request, output *StartImportJobOutput)

StartImportJobRequest generates a "aws/request.Request" representing the client's request for the StartImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartImportJob for more information on using the StartImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartImportJobRequest method.
req, resp := client.StartImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartImportJob

func (*QConnect) StartImportJobWithContext

func (c *QConnect) StartImportJobWithContext(ctx aws.Context, input *StartImportJobInput, opts ...request.Option) (*StartImportJobOutput, error)

StartImportJobWithContext is the same as StartImportJob with the addition of the ability to pass a context and additional request options.

See StartImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) TagResource

func (c *QConnect) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Q Connect.

Adds the specified tags to the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation TagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TagResource

func (*QConnect) TagResourceRequest

func (c *QConnect) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TagResource

func (*QConnect) TagResourceWithContext

func (c *QConnect) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) UntagResource

func (c *QConnect) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Q Connect.

Removes the specified tags from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UntagResource

func (*QConnect) UntagResourceRequest

func (c *QConnect) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UntagResource

func (*QConnect) UntagResourceWithContext

func (c *QConnect) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) UpdateContent

func (c *QConnect) UpdateContent(input *UpdateContentInput) (*UpdateContentOutput, error)

UpdateContent API operation for Amazon Q Connect.

Updates information about the content.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation UpdateContent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateContent

func (*QConnect) UpdateContentRequest

func (c *QConnect) UpdateContentRequest(input *UpdateContentInput) (req *request.Request, output *UpdateContentOutput)

UpdateContentRequest generates a "aws/request.Request" representing the client's request for the UpdateContent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateContent for more information on using the UpdateContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateContentRequest method.
req, resp := client.UpdateContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateContent

func (*QConnect) UpdateContentWithContext

func (c *QConnect) UpdateContentWithContext(ctx aws.Context, input *UpdateContentInput, opts ...request.Option) (*UpdateContentOutput, error)

UpdateContentWithContext is the same as UpdateContent with the addition of the ability to pass a context and additional request options.

See UpdateContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) UpdateKnowledgeBaseTemplateUri

func (c *QConnect) UpdateKnowledgeBaseTemplateUri(input *UpdateKnowledgeBaseTemplateUriInput) (*UpdateKnowledgeBaseTemplateUriOutput, error)

UpdateKnowledgeBaseTemplateUri API operation for Amazon Q Connect.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation UpdateKnowledgeBaseTemplateUri for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri

func (*QConnect) UpdateKnowledgeBaseTemplateUriRequest

func (c *QConnect) UpdateKnowledgeBaseTemplateUriRequest(input *UpdateKnowledgeBaseTemplateUriInput) (req *request.Request, output *UpdateKnowledgeBaseTemplateUriOutput)

UpdateKnowledgeBaseTemplateUriRequest generates a "aws/request.Request" representing the client's request for the UpdateKnowledgeBaseTemplateUri operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateKnowledgeBaseTemplateUri for more information on using the UpdateKnowledgeBaseTemplateUri API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateKnowledgeBaseTemplateUriRequest method.
req, resp := client.UpdateKnowledgeBaseTemplateUriRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri

func (*QConnect) UpdateKnowledgeBaseTemplateUriWithContext

func (c *QConnect) UpdateKnowledgeBaseTemplateUriWithContext(ctx aws.Context, input *UpdateKnowledgeBaseTemplateUriInput, opts ...request.Option) (*UpdateKnowledgeBaseTemplateUriOutput, error)

UpdateKnowledgeBaseTemplateUriWithContext is the same as UpdateKnowledgeBaseTemplateUri with the addition of the ability to pass a context and additional request options.

See UpdateKnowledgeBaseTemplateUri for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QConnect) UpdateQuickResponse

func (c *QConnect) UpdateQuickResponse(input *UpdateQuickResponseInput) (*UpdateQuickResponseOutput, error)

UpdateQuickResponse API operation for Amazon Q Connect.

Updates an existing Amazon Q quick response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Q Connect's API operation UpdateQuickResponse for usage and error information.

Returned Error Types:

  • ConflictException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

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

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateQuickResponse

func (*QConnect) UpdateQuickResponseRequest

func (c *QConnect) UpdateQuickResponseRequest(input *UpdateQuickResponseInput) (req *request.Request, output *UpdateQuickResponseOutput)

UpdateQuickResponseRequest generates a "aws/request.Request" representing the client's request for the UpdateQuickResponse operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateQuickResponse for more information on using the UpdateQuickResponse API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateQuickResponseRequest method.
req, resp := client.UpdateQuickResponseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateQuickResponse

func (*QConnect) UpdateQuickResponseWithContext

func (c *QConnect) UpdateQuickResponseWithContext(ctx aws.Context, input *UpdateQuickResponseInput, opts ...request.Option) (*UpdateQuickResponseOutput, error)

UpdateQuickResponseWithContext is the same as UpdateQuickResponse with the addition of the ability to pass a context and additional request options.

See UpdateQuickResponse for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type QueryAssistantInput

type QueryAssistantInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`

	// Information about how to query content.
	QueryCondition []*QueryCondition `locationName:"queryCondition" type:"list"`

	// The text to search for.
	//
	// QueryText is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QueryAssistantInput's
	// String and GoString methods.
	//
	// QueryText is a required field
	QueryText *string `locationName:"queryText" type:"string" required:"true" sensitive:"true"`

	// The identifier of the Amazon Q session. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	SessionId *string `locationName:"sessionId" type:"string"`
	// contains filtered or unexported fields
}

func (QueryAssistantInput) GoString

func (s QueryAssistantInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryAssistantInput) SetAssistantId

func (s *QueryAssistantInput) SetAssistantId(v string) *QueryAssistantInput

SetAssistantId sets the AssistantId field's value.

func (*QueryAssistantInput) SetMaxResults

func (s *QueryAssistantInput) SetMaxResults(v int64) *QueryAssistantInput

SetMaxResults sets the MaxResults field's value.

func (*QueryAssistantInput) SetNextToken

func (s *QueryAssistantInput) SetNextToken(v string) *QueryAssistantInput

SetNextToken sets the NextToken field's value.

func (*QueryAssistantInput) SetQueryCondition

func (s *QueryAssistantInput) SetQueryCondition(v []*QueryCondition) *QueryAssistantInput

SetQueryCondition sets the QueryCondition field's value.

func (*QueryAssistantInput) SetQueryText

func (s *QueryAssistantInput) SetQueryText(v string) *QueryAssistantInput

SetQueryText sets the QueryText field's value.

func (*QueryAssistantInput) SetSessionId

func (s *QueryAssistantInput) SetSessionId(v string) *QueryAssistantInput

SetSessionId sets the SessionId field's value.

func (QueryAssistantInput) String

func (s QueryAssistantInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryAssistantInput) Validate

func (s *QueryAssistantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryAssistantOutput

type QueryAssistantOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The results of the query.
	//
	// Results is a required field
	Results []*ResultData `locationName:"results" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (QueryAssistantOutput) GoString

func (s QueryAssistantOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryAssistantOutput) SetNextToken

func (s *QueryAssistantOutput) SetNextToken(v string) *QueryAssistantOutput

SetNextToken sets the NextToken field's value.

func (*QueryAssistantOutput) SetResults

SetResults sets the Results field's value.

func (QueryAssistantOutput) String

func (s QueryAssistantOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryCondition

type QueryCondition struct {

	// The condition for the query.
	Single *QueryConditionItem `locationName:"single" type:"structure"`
	// contains filtered or unexported fields
}

Information about how to query content.

func (QueryCondition) GoString

func (s QueryCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryCondition) SetSingle

SetSingle sets the Single field's value.

func (QueryCondition) String

func (s QueryCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryCondition) Validate

func (s *QueryCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryConditionItem

type QueryConditionItem struct {

	// The comparison operator for query condition to query on.
	//
	// Comparator is a required field
	Comparator *string `locationName:"comparator" type:"string" required:"true" enum:"QueryConditionComparisonOperator"`

	// The name of the field for query condition to query on.
	//
	// Field is a required field
	Field *string `locationName:"field" type:"string" required:"true" enum:"QueryConditionFieldName"`

	// The value for the query condition to query on.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The condition for the query.

func (QueryConditionItem) GoString

func (s QueryConditionItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryConditionItem) SetComparator

func (s *QueryConditionItem) SetComparator(v string) *QueryConditionItem

SetComparator sets the Comparator field's value.

func (*QueryConditionItem) SetField

SetField sets the Field field's value.

func (*QueryConditionItem) SetValue

SetValue sets the Value field's value.

func (QueryConditionItem) String

func (s QueryConditionItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryConditionItem) Validate

func (s *QueryConditionItem) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryRecommendationTriggerData

type QueryRecommendationTriggerData struct {

	// The text associated with the recommendation trigger.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QueryRecommendationTriggerData's
	// String and GoString methods.
	Text *string `locationName:"text" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Data associated with the QUERY RecommendationTriggerType.

func (QueryRecommendationTriggerData) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryRecommendationTriggerData) SetText

SetText sets the Text field's value.

func (QueryRecommendationTriggerData) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuickResponseContentProvider

type QuickResponseContentProvider struct {

	// The content of the quick response.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QuickResponseContentProvider's
	// String and GoString methods.
	Content *string `locationName:"content" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The container quick response content.

func (QuickResponseContentProvider) GoString

func (s QuickResponseContentProvider) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseContentProvider) SetContent

SetContent sets the Content field's value.

func (QuickResponseContentProvider) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuickResponseContents

type QuickResponseContents struct {

	// The container quick response content.
	Markdown *QuickResponseContentProvider `locationName:"markdown" type:"structure"`

	// The container quick response content.
	PlainText *QuickResponseContentProvider `locationName:"plainText" type:"structure"`
	// contains filtered or unexported fields
}

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

func (QuickResponseContents) GoString

func (s QuickResponseContents) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseContents) SetMarkdown

SetMarkdown sets the Markdown field's value.

func (*QuickResponseContents) SetPlainText

SetPlainText sets the PlainText field's value.

func (QuickResponseContents) String

func (s QuickResponseContents) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuickResponseData

type QuickResponseData struct {

	// The Amazon Connect contact channels this quick response applies to. The supported
	// contact channel types include Chat.
	Channels []*string `locationName:"channels" type:"list"`

	// 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 is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The contents of the quick response.
	Contents *QuickResponseContents `locationName:"contents" type:"structure"`

	// The timestamp when the quick response was created.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `locationName:"createdTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The description of the quick response.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The configuration information of the user groups that the quick response
	// is accessible to.
	GroupingConfiguration *GroupingConfiguration `locationName:"groupingConfiguration" type:"structure"`

	// Whether the quick response is active.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The language code value for the language in which the quick response is written.
	Language *string `locationName:"language" min:"2" type:"string"`

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// data.
	LastModifiedBy *string `locationName:"lastModifiedBy" min:"1" type:"string"`

	// The timestamp when the quick response data was last modified.
	//
	// LastModifiedTime is a required field
	LastModifiedTime *time.Time `locationName:"lastModifiedTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The name of the quick response.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// QuickResponseArn is a required field
	QuickResponseArn *string `locationName:"quickResponseArn" type:"string" required:"true"`

	// The identifier of the quick response.
	//
	// QuickResponseId is a required field
	QuickResponseId *string `locationName:"quickResponseId" type:"string" required:"true"`

	// The shortcut key of the quick response. The value should be unique across
	// the knowledge base.
	ShortcutKey *string `locationName:"shortcutKey" min:"1" type:"string"`

	// The status of the quick response data.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"QuickResponseStatus"`

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

Information about the quick response.

func (QuickResponseData) GoString

func (s QuickResponseData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseData) SetChannels

func (s *QuickResponseData) SetChannels(v []*string) *QuickResponseData

SetChannels sets the Channels field's value.

func (*QuickResponseData) SetContentType

func (s *QuickResponseData) SetContentType(v string) *QuickResponseData

SetContentType sets the ContentType field's value.

func (*QuickResponseData) SetContents

SetContents sets the Contents field's value.

func (*QuickResponseData) SetCreatedTime

func (s *QuickResponseData) SetCreatedTime(v time.Time) *QuickResponseData

SetCreatedTime sets the CreatedTime field's value.

func (*QuickResponseData) SetDescription

func (s *QuickResponseData) SetDescription(v string) *QuickResponseData

SetDescription sets the Description field's value.

func (*QuickResponseData) SetGroupingConfiguration

func (s *QuickResponseData) SetGroupingConfiguration(v *GroupingConfiguration) *QuickResponseData

SetGroupingConfiguration sets the GroupingConfiguration field's value.

func (*QuickResponseData) SetIsActive

func (s *QuickResponseData) SetIsActive(v bool) *QuickResponseData

SetIsActive sets the IsActive field's value.

func (*QuickResponseData) SetKnowledgeBaseArn

func (s *QuickResponseData) SetKnowledgeBaseArn(v string) *QuickResponseData

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*QuickResponseData) SetKnowledgeBaseId

func (s *QuickResponseData) SetKnowledgeBaseId(v string) *QuickResponseData

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*QuickResponseData) SetLanguage

func (s *QuickResponseData) SetLanguage(v string) *QuickResponseData

SetLanguage sets the Language field's value.

func (*QuickResponseData) SetLastModifiedBy

func (s *QuickResponseData) SetLastModifiedBy(v string) *QuickResponseData

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*QuickResponseData) SetLastModifiedTime

func (s *QuickResponseData) SetLastModifiedTime(v time.Time) *QuickResponseData

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*QuickResponseData) SetName

SetName sets the Name field's value.

func (*QuickResponseData) SetQuickResponseArn

func (s *QuickResponseData) SetQuickResponseArn(v string) *QuickResponseData

SetQuickResponseArn sets the QuickResponseArn field's value.

func (*QuickResponseData) SetQuickResponseId

func (s *QuickResponseData) SetQuickResponseId(v string) *QuickResponseData

SetQuickResponseId sets the QuickResponseId field's value.

func (*QuickResponseData) SetShortcutKey

func (s *QuickResponseData) SetShortcutKey(v string) *QuickResponseData

SetShortcutKey sets the ShortcutKey field's value.

func (*QuickResponseData) SetStatus

func (s *QuickResponseData) SetStatus(v string) *QuickResponseData

SetStatus sets the Status field's value.

func (*QuickResponseData) SetTags

func (s *QuickResponseData) SetTags(v map[string]*string) *QuickResponseData

SetTags sets the Tags field's value.

func (QuickResponseData) String

func (s QuickResponseData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuickResponseDataProvider

type QuickResponseDataProvider struct {

	// The content of the quick response.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QuickResponseDataProvider's
	// String and GoString methods.
	Content *string `locationName:"content" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The container of quick response data.

func (QuickResponseDataProvider) GoString

func (s QuickResponseDataProvider) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseDataProvider) SetContent

SetContent sets the Content field's value.

func (QuickResponseDataProvider) String

func (s QuickResponseDataProvider) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseDataProvider) Validate

func (s *QuickResponseDataProvider) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QuickResponseFilterField

type QuickResponseFilterField struct {

	// Whether to treat null value as a match for the attribute field.
	IncludeNoExistence *bool `locationName:"includeNoExistence" type:"boolean"`

	// The name of the attribute field to filter the quick responses by.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The operator to use for filtering.
	//
	// Operator is a required field
	Operator *string `locationName:"operator" type:"string" required:"true" enum:"QuickResponseFilterOperator"`

	// The values of attribute field to filter the quick response by.
	Values []*string `locationName:"values" min:"1" type:"list"`
	// 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

func (QuickResponseFilterField) GoString

func (s QuickResponseFilterField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseFilterField) SetIncludeNoExistence

func (s *QuickResponseFilterField) SetIncludeNoExistence(v bool) *QuickResponseFilterField

SetIncludeNoExistence sets the IncludeNoExistence field's value.

func (*QuickResponseFilterField) SetName

SetName sets the Name field's value.

func (*QuickResponseFilterField) SetOperator

SetOperator sets the Operator field's value.

func (*QuickResponseFilterField) SetValues

SetValues sets the Values field's value.

func (QuickResponseFilterField) String

func (s QuickResponseFilterField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseFilterField) Validate

func (s *QuickResponseFilterField) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QuickResponseOrderField

type QuickResponseOrderField struct {

	// The name of the attribute to order the quick response query results by.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The order at which the quick responses are sorted by.
	Order *string `locationName:"order" type:"string" enum:"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

func (QuickResponseOrderField) GoString

func (s QuickResponseOrderField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseOrderField) SetName

SetName sets the Name field's value.

func (*QuickResponseOrderField) SetOrder

SetOrder sets the Order field's value.

func (QuickResponseOrderField) String

func (s QuickResponseOrderField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseOrderField) Validate

func (s *QuickResponseOrderField) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QuickResponseQueryField

type QuickResponseQueryField struct {

	// 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 `locationName:"allowFuzziness" type:"boolean"`

	// The name of the attribute to query the quick responses by.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The operator to use for matching attribute field values in the query.
	//
	// Operator is a required field
	Operator *string `locationName:"operator" type:"string" required:"true" enum:"QuickResponseQueryOperator"`

	// 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 *string `locationName:"priority" type:"string" enum:"Priority"`

	// The values of the attribute to query the quick responses by.
	//
	// Values is a required field
	Values []*string `locationName:"values" min:"1" type:"list" required:"true"`
	// 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

func (QuickResponseQueryField) GoString

func (s QuickResponseQueryField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseQueryField) SetAllowFuzziness

func (s *QuickResponseQueryField) SetAllowFuzziness(v bool) *QuickResponseQueryField

SetAllowFuzziness sets the AllowFuzziness field's value.

func (*QuickResponseQueryField) SetName

SetName sets the Name field's value.

func (*QuickResponseQueryField) SetOperator

SetOperator sets the Operator field's value.

func (*QuickResponseQueryField) SetPriority

SetPriority sets the Priority field's value.

func (*QuickResponseQueryField) SetValues

SetValues sets the Values field's value.

func (QuickResponseQueryField) String

func (s QuickResponseQueryField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseQueryField) Validate

func (s *QuickResponseQueryField) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QuickResponseSearchExpression

type QuickResponseSearchExpression struct {

	// The configuration of filtering rules applied to quick response query results.
	Filters []*QuickResponseFilterField `locationName:"filters" type:"list"`

	// The quick response attribute fields on which the query results are ordered.
	OrderOnField *QuickResponseOrderField `locationName:"orderOnField" type:"structure"`

	// The quick response query expressions.
	Queries []*QuickResponseQueryField `locationName:"queries" type:"list"`
	// contains filtered or unexported fields
}

Information about the import job.

func (QuickResponseSearchExpression) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseSearchExpression) SetFilters

SetFilters sets the Filters field's value.

func (*QuickResponseSearchExpression) SetOrderOnField

SetOrderOnField sets the OrderOnField field's value.

func (*QuickResponseSearchExpression) SetQueries

SetQueries sets the Queries field's value.

func (QuickResponseSearchExpression) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseSearchExpression) Validate

func (s *QuickResponseSearchExpression) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QuickResponseSearchResultData

type QuickResponseSearchResultData struct {

	// The user defined contact attributes that are resolved when the search result
	// is returned.
	//
	// AttributesInterpolated is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QuickResponseSearchResultData's
	// String and GoString methods.
	AttributesInterpolated []*string `locationName:"attributesInterpolated" type:"list" sensitive:"true"`

	// The user defined contact attributes that are not resolved when the search
	// result is returned.
	//
	// AttributesNotInterpolated is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by QuickResponseSearchResultData's
	// String and GoString methods.
	AttributesNotInterpolated []*string `locationName:"attributesNotInterpolated" type:"list" sensitive:"true"`

	// The Amazon Connect contact channels this quick response applies to. The supported
	// contact channel types include Chat.
	Channels []*string `locationName:"channels" type:"list"`

	// 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 is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The contents of the quick response.
	//
	// Contents is a required field
	Contents *QuickResponseContents `locationName:"contents" type:"structure" required:"true"`

	// The timestamp when the quick response was created.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `locationName:"createdTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The description of the quick response.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The configuration information of the user groups that the quick response
	// is accessible to.
	GroupingConfiguration *GroupingConfiguration `locationName:"groupingConfiguration" type:"structure"`

	// Whether the quick response is active.
	//
	// IsActive is a required field
	IsActive *bool `locationName:"isActive" type:"boolean" required:"true"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The language code value for the language in which the quick response is written.
	Language *string `locationName:"language" min:"2" type:"string"`

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// search result data.
	LastModifiedBy *string `locationName:"lastModifiedBy" min:"1" type:"string"`

	// The timestamp when the quick response search result data was last modified.
	//
	// LastModifiedTime is a required field
	LastModifiedTime *time.Time `locationName:"lastModifiedTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The name of the quick response.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// QuickResponseArn is a required field
	QuickResponseArn *string `locationName:"quickResponseArn" type:"string" required:"true"`

	// The identifier of the quick response.
	//
	// QuickResponseId is a required field
	QuickResponseId *string `locationName:"quickResponseId" type:"string" required:"true"`

	// The shortcut key of the quick response. The value should be unique across
	// the knowledge base.
	ShortcutKey *string `locationName:"shortcutKey" min:"1" type:"string"`

	// The resource status of the quick response.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"QuickResponseStatus"`

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

The result of quick response search.

func (QuickResponseSearchResultData) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseSearchResultData) SetAttributesInterpolated

func (s *QuickResponseSearchResultData) SetAttributesInterpolated(v []*string) *QuickResponseSearchResultData

SetAttributesInterpolated sets the AttributesInterpolated field's value.

func (*QuickResponseSearchResultData) SetAttributesNotInterpolated

func (s *QuickResponseSearchResultData) SetAttributesNotInterpolated(v []*string) *QuickResponseSearchResultData

SetAttributesNotInterpolated sets the AttributesNotInterpolated field's value.

func (*QuickResponseSearchResultData) SetChannels

SetChannels sets the Channels field's value.

func (*QuickResponseSearchResultData) SetContentType

SetContentType sets the ContentType field's value.

func (*QuickResponseSearchResultData) SetContents

SetContents sets the Contents field's value.

func (*QuickResponseSearchResultData) SetCreatedTime

SetCreatedTime sets the CreatedTime field's value.

func (*QuickResponseSearchResultData) SetDescription

SetDescription sets the Description field's value.

func (*QuickResponseSearchResultData) SetGroupingConfiguration

SetGroupingConfiguration sets the GroupingConfiguration field's value.

func (*QuickResponseSearchResultData) SetIsActive

SetIsActive sets the IsActive field's value.

func (*QuickResponseSearchResultData) SetKnowledgeBaseArn

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*QuickResponseSearchResultData) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*QuickResponseSearchResultData) SetLanguage

SetLanguage sets the Language field's value.

func (*QuickResponseSearchResultData) SetLastModifiedBy

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*QuickResponseSearchResultData) SetLastModifiedTime

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*QuickResponseSearchResultData) SetName

SetName sets the Name field's value.

func (*QuickResponseSearchResultData) SetQuickResponseArn

SetQuickResponseArn sets the QuickResponseArn field's value.

func (*QuickResponseSearchResultData) SetQuickResponseId

SetQuickResponseId sets the QuickResponseId field's value.

func (*QuickResponseSearchResultData) SetShortcutKey

SetShortcutKey sets the ShortcutKey field's value.

func (*QuickResponseSearchResultData) SetStatus

SetStatus sets the Status field's value.

func (*QuickResponseSearchResultData) SetTags

SetTags sets the Tags field's value.

func (QuickResponseSearchResultData) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuickResponseSummary

type QuickResponseSummary struct {

	// The Amazon Connect contact channels this quick response applies to. The supported
	// contact channel types include Chat.
	Channels []*string `locationName:"channels" type:"list"`

	// 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 is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The timestamp when the quick response was created.
	//
	// CreatedTime is a required field
	CreatedTime *time.Time `locationName:"createdTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The description of the quick response.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Whether the quick response is active.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the user who last updated the quick response
	// data.
	LastModifiedBy *string `locationName:"lastModifiedBy" min:"1" type:"string"`

	// The timestamp when the quick response summary was last modified.
	//
	// LastModifiedTime is a required field
	LastModifiedTime *time.Time `locationName:"lastModifiedTime" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`

	// The name of the quick response.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the quick response.
	//
	// QuickResponseArn is a required field
	QuickResponseArn *string `locationName:"quickResponseArn" type:"string" required:"true"`

	// The identifier of the quick response.
	//
	// QuickResponseId is a required field
	QuickResponseId *string `locationName:"quickResponseId" type:"string" required:"true"`

	// The resource status of the quick response.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"QuickResponseStatus"`

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

The summary information about the quick response.

func (QuickResponseSummary) GoString

func (s QuickResponseSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuickResponseSummary) SetChannels

func (s *QuickResponseSummary) SetChannels(v []*string) *QuickResponseSummary

SetChannels sets the Channels field's value.

func (*QuickResponseSummary) SetContentType

func (s *QuickResponseSummary) SetContentType(v string) *QuickResponseSummary

SetContentType sets the ContentType field's value.

func (*QuickResponseSummary) SetCreatedTime

func (s *QuickResponseSummary) SetCreatedTime(v time.Time) *QuickResponseSummary

SetCreatedTime sets the CreatedTime field's value.

func (*QuickResponseSummary) SetDescription

func (s *QuickResponseSummary) SetDescription(v string) *QuickResponseSummary

SetDescription sets the Description field's value.

func (*QuickResponseSummary) SetIsActive

func (s *QuickResponseSummary) SetIsActive(v bool) *QuickResponseSummary

SetIsActive sets the IsActive field's value.

func (*QuickResponseSummary) SetKnowledgeBaseArn

func (s *QuickResponseSummary) SetKnowledgeBaseArn(v string) *QuickResponseSummary

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*QuickResponseSummary) SetKnowledgeBaseId

func (s *QuickResponseSummary) SetKnowledgeBaseId(v string) *QuickResponseSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*QuickResponseSummary) SetLastModifiedBy

func (s *QuickResponseSummary) SetLastModifiedBy(v string) *QuickResponseSummary

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*QuickResponseSummary) SetLastModifiedTime

func (s *QuickResponseSummary) SetLastModifiedTime(v time.Time) *QuickResponseSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*QuickResponseSummary) SetName

SetName sets the Name field's value.

func (*QuickResponseSummary) SetQuickResponseArn

func (s *QuickResponseSummary) SetQuickResponseArn(v string) *QuickResponseSummary

SetQuickResponseArn sets the QuickResponseArn field's value.

func (*QuickResponseSummary) SetQuickResponseId

func (s *QuickResponseSummary) SetQuickResponseId(v string) *QuickResponseSummary

SetQuickResponseId sets the QuickResponseId field's value.

func (*QuickResponseSummary) SetStatus

SetStatus sets the Status field's value.

func (*QuickResponseSummary) SetTags

SetTags sets the Tags field's value.

func (QuickResponseSummary) String

func (s QuickResponseSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RankingData

type RankingData struct {

	// The relevance score of the content.
	RelevanceLevel *string `locationName:"relevanceLevel" type:"string" enum:"RelevanceLevel"`

	// The relevance level of the recommendation.
	RelevanceScore *float64 `locationName:"relevanceScore" type:"double"`
	// contains filtered or unexported fields
}

Details about the source content ranking data.

func (RankingData) GoString

func (s RankingData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RankingData) SetRelevanceLevel

func (s *RankingData) SetRelevanceLevel(v string) *RankingData

SetRelevanceLevel sets the RelevanceLevel field's value.

func (*RankingData) SetRelevanceScore

func (s *RankingData) SetRelevanceScore(v float64) *RankingData

SetRelevanceScore sets the RelevanceScore field's value.

func (RankingData) String

func (s RankingData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecommendationData

type RecommendationData struct {

	// Summary of the recommended content.
	Data *DataSummary `locationName:"data" type:"structure"`

	// The recommended document.
	Document *Document `locationName:"document" type:"structure"`

	// The identifier of the recommendation.
	//
	// RecommendationId is a required field
	RecommendationId *string `locationName:"recommendationId" min:"1" type:"string" required:"true"`

	// The relevance level of the recommendation.
	RelevanceLevel *string `locationName:"relevanceLevel" type:"string" enum:"RelevanceLevel"`

	// The relevance score of the recommendation.
	RelevanceScore *float64 `locationName:"relevanceScore" type:"double"`

	// The type of recommendation.
	Type *string `locationName:"type" type:"string" enum:"RecommendationType"`
	// contains filtered or unexported fields
}

Information about the recommendation.

func (RecommendationData) GoString

func (s RecommendationData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecommendationData) SetData

SetData sets the Data field's value.

func (*RecommendationData) SetDocument

func (s *RecommendationData) SetDocument(v *Document) *RecommendationData

SetDocument sets the Document field's value.

func (*RecommendationData) SetRecommendationId

func (s *RecommendationData) SetRecommendationId(v string) *RecommendationData

SetRecommendationId sets the RecommendationId field's value.

func (*RecommendationData) SetRelevanceLevel

func (s *RecommendationData) SetRelevanceLevel(v string) *RecommendationData

SetRelevanceLevel sets the RelevanceLevel field's value.

func (*RecommendationData) SetRelevanceScore

func (s *RecommendationData) SetRelevanceScore(v float64) *RecommendationData

SetRelevanceScore sets the RelevanceScore field's value.

func (*RecommendationData) SetType

SetType sets the Type field's value.

func (RecommendationData) String

func (s RecommendationData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecommendationTrigger

type RecommendationTrigger struct {

	// A union type containing information related to the trigger.
	//
	// Data is a required field
	Data *RecommendationTriggerData `locationName:"data" type:"structure" required:"true"`

	// The identifier of the recommendation trigger.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The identifiers of the recommendations.
	//
	// RecommendationIds is a required field
	RecommendationIds []*string `locationName:"recommendationIds" type:"list" required:"true"`

	// 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.
	//
	// Source is a required field
	Source *string `locationName:"source" type:"string" required:"true" enum:"RecommendationSourceType"`

	// The type of recommendation trigger.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"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.

func (RecommendationTrigger) GoString

func (s RecommendationTrigger) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecommendationTrigger) SetData

SetData sets the Data field's value.

func (*RecommendationTrigger) SetId

SetId sets the Id field's value.

func (*RecommendationTrigger) SetRecommendationIds

func (s *RecommendationTrigger) SetRecommendationIds(v []*string) *RecommendationTrigger

SetRecommendationIds sets the RecommendationIds field's value.

func (*RecommendationTrigger) SetSource

SetSource sets the Source field's value.

func (*RecommendationTrigger) SetType

SetType sets the Type field's value.

func (RecommendationTrigger) String

func (s RecommendationTrigger) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecommendationTriggerData

type RecommendationTriggerData struct {

	// Data associated with the QUERY RecommendationTriggerType.
	Query *QueryRecommendationTriggerData `locationName:"query" type:"structure"`
	// contains filtered or unexported fields
}

A union type containing information related to the trigger.

func (RecommendationTriggerData) GoString

func (s RecommendationTriggerData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecommendationTriggerData) SetQuery

SetQuery sets the Query field's value.

func (RecommendationTriggerData) String

func (s RecommendationTriggerData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveKnowledgeBaseTemplateUriInput

type RemoveKnowledgeBaseTemplateUriInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveKnowledgeBaseTemplateUriInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveKnowledgeBaseTemplateUriInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (RemoveKnowledgeBaseTemplateUriInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveKnowledgeBaseTemplateUriInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type RemoveKnowledgeBaseTemplateUriOutput

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

func (RemoveKnowledgeBaseTemplateUriOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveKnowledgeBaseTemplateUriOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html).
	TemplateUri *string `locationName:"templateUri" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about how to render the content.

func (RenderingConfiguration) GoString

func (s RenderingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RenderingConfiguration) SetTemplateUri

SetTemplateUri sets the TemplateUri field's value.

func (RenderingConfiguration) String

func (s RenderingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RenderingConfiguration) Validate

func (s *RenderingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RequestTimeoutException

type RequestTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code

func (s *RequestTimeoutException) Code() string

Code returns the exception type name.

func (*RequestTimeoutException) Error

func (s *RequestTimeoutException) Error() string

func (RequestTimeoutException) GoString

func (s RequestTimeoutException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestTimeoutException) Message

func (s *RequestTimeoutException) Message() string

Message returns the exception's message.

func (*RequestTimeoutException) OrigErr

func (s *RequestTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestTimeoutException) RequestID

func (s *RequestTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestTimeoutException) StatusCode

func (s *RequestTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestTimeoutException) String

func (s RequestTimeoutException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The specified resource name.
	ResourceName *string `locationName:"resourceName" type:"string"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResultData

type ResultData struct {

	// Summary of the recommended content.
	Data *DataSummary `locationName:"data" type:"structure"`

	// The document.
	Document *Document `locationName:"document" type:"structure"`

	// The relevance score of the results.
	RelevanceScore *float64 `locationName:"relevanceScore" type:"double"`

	// The identifier of the result data.
	//
	// ResultId is a required field
	ResultId *string `locationName:"resultId" type:"string" required:"true"`

	// The type of the query result.
	Type *string `locationName:"type" type:"string" enum:"QueryResultType"`
	// contains filtered or unexported fields
}

Information about the result.

func (ResultData) GoString

func (s ResultData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultData) SetData

func (s *ResultData) SetData(v *DataSummary) *ResultData

SetData sets the Data field's value.

func (*ResultData) SetDocument

func (s *ResultData) SetDocument(v *Document) *ResultData

SetDocument sets the Document field's value.

func (*ResultData) SetRelevanceScore

func (s *ResultData) SetRelevanceScore(v float64) *ResultData

SetRelevanceScore sets the RelevanceScore field's value.

func (*ResultData) SetResultId

func (s *ResultData) SetResultId(v string) *ResultData

SetResultId sets the ResultId field's value.

func (*ResultData) SetType

func (s *ResultData) SetType(v string) *ResultData

SetType sets the Type field's value.

func (ResultData) String

func (s ResultData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchContentInput

type SearchContentInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The search expression to filter results.
	//
	// SearchExpression is a required field
	SearchExpression *SearchExpression `locationName:"searchExpression" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchContentInput) GoString

func (s SearchContentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchContentInput) SetKnowledgeBaseId

func (s *SearchContentInput) SetKnowledgeBaseId(v string) *SearchContentInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*SearchContentInput) SetMaxResults

func (s *SearchContentInput) SetMaxResults(v int64) *SearchContentInput

SetMaxResults sets the MaxResults field's value.

func (*SearchContentInput) SetNextToken

func (s *SearchContentInput) SetNextToken(v string) *SearchContentInput

SetNextToken sets the NextToken field's value.

func (*SearchContentInput) SetSearchExpression

func (s *SearchContentInput) SetSearchExpression(v *SearchExpression) *SearchContentInput

SetSearchExpression sets the SearchExpression field's value.

func (SearchContentInput) String

func (s SearchContentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchContentInput) Validate

func (s *SearchContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchContentOutput

type SearchContentOutput struct {

	// Summary information about the content.
	//
	// ContentSummaries is a required field
	ContentSummaries []*ContentSummary `locationName:"contentSummaries" type:"list" required:"true"`

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SearchContentOutput) GoString

func (s SearchContentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchContentOutput) SetContentSummaries

func (s *SearchContentOutput) SetContentSummaries(v []*ContentSummary) *SearchContentOutput

SetContentSummaries sets the ContentSummaries field's value.

func (*SearchContentOutput) SetNextToken

func (s *SearchContentOutput) SetNextToken(v string) *SearchContentOutput

SetNextToken sets the NextToken field's value.

func (SearchContentOutput) String

func (s SearchContentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchExpression

type SearchExpression struct {

	// The search expression filters.
	//
	// Filters is a required field
	Filters []*Filter `locationName:"filters" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The search expression.

func (SearchExpression) GoString

func (s SearchExpression) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchExpression) SetFilters

func (s *SearchExpression) SetFilters(v []*Filter) *SearchExpression

SetFilters sets the Filters field's value.

func (SearchExpression) String

func (s SearchExpression) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchExpression) Validate

func (s *SearchExpression) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchQuickResponsesInput

type SearchQuickResponsesInput struct {

	// The user-defined Amazon Connect contact attributes (https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes)
	// to be resolved when search results are returned.
	//
	// Attributes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SearchQuickResponsesInput's
	// String and GoString methods.
	Attributes map[string]*string `locationName:"attributes" type:"map" sensitive:"true"`

	// 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.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The search expression for querying the quick response.
	//
	// SearchExpression is a required field
	SearchExpression *QuickResponseSearchExpression `locationName:"searchExpression" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchQuickResponsesInput) GoString

func (s SearchQuickResponsesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchQuickResponsesInput) SetAttributes

SetAttributes sets the Attributes field's value.

func (*SearchQuickResponsesInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*SearchQuickResponsesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*SearchQuickResponsesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*SearchQuickResponsesInput) SetSearchExpression

SetSearchExpression sets the SearchExpression field's value.

func (SearchQuickResponsesInput) String

func (s SearchQuickResponsesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchQuickResponsesInput) Validate

func (s *SearchQuickResponsesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchQuickResponsesOutput

type SearchQuickResponsesOutput struct {

	// 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 `locationName:"nextToken" min:"1" type:"string"`

	// The results of the quick response search.
	//
	// Results is a required field
	Results []*QuickResponseSearchResultData `locationName:"results" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (SearchQuickResponsesOutput) GoString

func (s SearchQuickResponsesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchQuickResponsesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*SearchQuickResponsesOutput) SetResults

SetResults sets the Results field's value.

func (SearchQuickResponsesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchSessionsInput

type SearchSessionsInput struct {

	// The identifier of the Amazon Q assistant. Can be either the ID or the ARN.
	// URLs cannot contain the ARN.
	//
	// AssistantId is a required field
	AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"`

	// The maximum number of results to return per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The search expression to filter results.
	//
	// SearchExpression is a required field
	SearchExpression *SearchExpression `locationName:"searchExpression" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SearchSessionsInput) GoString

func (s SearchSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSessionsInput) SetAssistantId

func (s *SearchSessionsInput) SetAssistantId(v string) *SearchSessionsInput

SetAssistantId sets the AssistantId field's value.

func (*SearchSessionsInput) SetMaxResults

func (s *SearchSessionsInput) SetMaxResults(v int64) *SearchSessionsInput

SetMaxResults sets the MaxResults field's value.

func (*SearchSessionsInput) SetNextToken

func (s *SearchSessionsInput) SetNextToken(v string) *SearchSessionsInput

SetNextToken sets the NextToken field's value.

func (*SearchSessionsInput) SetSearchExpression

func (s *SearchSessionsInput) SetSearchExpression(v *SearchExpression) *SearchSessionsInput

SetSearchExpression sets the SearchExpression field's value.

func (SearchSessionsInput) String

func (s SearchSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSessionsInput) Validate

func (s *SearchSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchSessionsOutput

type SearchSessionsOutput struct {

	// If there are additional results, this is the token for the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Summary information about the sessions.
	//
	// SessionSummaries is a required field
	SessionSummaries []*SessionSummary `locationName:"sessionSummaries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (SearchSessionsOutput) GoString

func (s SearchSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSessionsOutput) SetNextToken

func (s *SearchSessionsOutput) SetNextToken(v string) *SearchSessionsOutput

SetNextToken sets the NextToken field's value.

func (*SearchSessionsOutput) SetSessionSummaries

func (s *SearchSessionsOutput) SetSessionSummaries(v []*SessionSummary) *SearchSessionsOutput

SetSessionSummaries sets the SessionSummaries field's value.

func (SearchSessionsOutput) String

func (s SearchSessionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServerSideEncryptionConfiguration

type ServerSideEncryptionConfiguration struct {

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

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

func (ServerSideEncryptionConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (ServerSideEncryptionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionData

type SessionData struct {

	// The description of the session.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The configuration information for the session integration.
	IntegrationConfiguration *SessionIntegrationConfiguration `locationName:"integrationConfiguration" type:"structure"`

	// The name of the session.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the session.
	//
	// SessionArn is a required field
	SessionArn *string `locationName:"sessionArn" type:"string" required:"true"`

	// The identifier of the session.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`

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

Information about the session.

func (SessionData) GoString

func (s SessionData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionData) SetDescription

func (s *SessionData) SetDescription(v string) *SessionData

SetDescription sets the Description field's value.

func (*SessionData) SetIntegrationConfiguration

func (s *SessionData) SetIntegrationConfiguration(v *SessionIntegrationConfiguration) *SessionData

SetIntegrationConfiguration sets the IntegrationConfiguration field's value.

func (*SessionData) SetName

func (s *SessionData) SetName(v string) *SessionData

SetName sets the Name field's value.

func (*SessionData) SetSessionArn

func (s *SessionData) SetSessionArn(v string) *SessionData

SetSessionArn sets the SessionArn field's value.

func (*SessionData) SetSessionId

func (s *SessionData) SetSessionId(v string) *SessionData

SetSessionId sets the SessionId field's value.

func (*SessionData) SetTags

func (s *SessionData) SetTags(v map[string]*string) *SessionData

SetTags sets the Tags field's value.

func (SessionData) String

func (s SessionData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionIntegrationConfiguration

type SessionIntegrationConfiguration struct {

	// The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for
	// streaming chat messages.
	TopicIntegrationArn *string `locationName:"topicIntegrationArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The configuration information for the session integration.

func (SessionIntegrationConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionIntegrationConfiguration) SetTopicIntegrationArn

SetTopicIntegrationArn sets the TopicIntegrationArn field's value.

func (SessionIntegrationConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionSummary

type SessionSummary struct {

	// The Amazon Resource Name (ARN) of the Amazon Q assistant.
	//
	// AssistantArn is a required field
	AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"`

	// The identifier of the Amazon Q assistant.
	//
	// AssistantId is a required field
	AssistantId *string `locationName:"assistantId" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the session.
	//
	// SessionArn is a required field
	SessionArn *string `locationName:"sessionArn" type:"string" required:"true"`

	// The identifier of the session.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Summary information about the session.

func (SessionSummary) GoString

func (s SessionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionSummary) SetAssistantArn

func (s *SessionSummary) SetAssistantArn(v string) *SessionSummary

SetAssistantArn sets the AssistantArn field's value.

func (*SessionSummary) SetAssistantId

func (s *SessionSummary) SetAssistantId(v string) *SessionSummary

SetAssistantId sets the AssistantId field's value.

func (*SessionSummary) SetSessionArn

func (s *SessionSummary) SetSessionArn(v string) *SessionSummary

SetSessionArn sets the SessionArn field's value.

func (*SessionSummary) SetSessionId

func (s *SessionSummary) SetSessionId(v string) *SessionSummary

SetSessionId sets the SessionId field's value.

func (SessionSummary) String

func (s SessionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SourceConfiguration

type SourceConfiguration struct {

	// Configuration information for Amazon AppIntegrations to automatically ingest
	// content.
	AppIntegrations *AppIntegrationsConfiguration `locationName:"appIntegrations" type:"structure"`
	// contains filtered or unexported fields
}

Configuration information about the external data source.

func (SourceConfiguration) GoString

func (s SourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceConfiguration) SetAppIntegrations

SetAppIntegrations sets the AppIntegrations field's value.

func (SourceConfiguration) String

func (s SourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceConfiguration) Validate

func (s *SourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SourceContentDataDetails

type SourceContentDataDetails struct {

	// The identifier of the source content.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// Details about the source content ranking data.
	//
	// RankingData is a required field
	RankingData *RankingData `locationName:"rankingData" type:"structure" required:"true"`

	// Details about the source content text data.
	//
	// TextData is a required field
	TextData *TextData `locationName:"textData" type:"structure" required:"true"`

	// The type of the source content.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"SourceContentType"`
	// contains filtered or unexported fields
}

Details about the source content data.

func (SourceContentDataDetails) GoString

func (s SourceContentDataDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceContentDataDetails) SetId

SetId sets the Id field's value.

func (*SourceContentDataDetails) SetRankingData

SetRankingData sets the RankingData field's value.

func (*SourceContentDataDetails) SetTextData

SetTextData sets the TextData field's value.

func (*SourceContentDataDetails) SetType

SetType sets the Type field's value.

func (SourceContentDataDetails) String

func (s SourceContentDataDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartContentUploadInput

type StartContentUploadInput struct {

	// The type of content to upload.
	//
	// ContentType is a required field
	ContentType *string `locationName:"contentType" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The expected expiration time of the generated presigned URL, specified in
	// minutes.
	PresignedUrlTimeToLive *int64 `locationName:"presignedUrlTimeToLive" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (StartContentUploadInput) GoString

func (s StartContentUploadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartContentUploadInput) SetContentType

SetContentType sets the ContentType field's value.

func (*StartContentUploadInput) SetKnowledgeBaseId

func (s *StartContentUploadInput) SetKnowledgeBaseId(v string) *StartContentUploadInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*StartContentUploadInput) SetPresignedUrlTimeToLive

func (s *StartContentUploadInput) SetPresignedUrlTimeToLive(v int64) *StartContentUploadInput

SetPresignedUrlTimeToLive sets the PresignedUrlTimeToLive field's value.

func (StartContentUploadInput) String

func (s StartContentUploadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartContentUploadInput) Validate

func (s *StartContentUploadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartContentUploadOutput

type StartContentUploadOutput struct {

	// The headers to include in the upload.
	//
	// HeadersToInclude is a required field
	HeadersToInclude map[string]*string `locationName:"headersToInclude" type:"map" required:"true"`

	// The identifier of the upload.
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`

	// The URL of the upload.
	//
	// Url is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartContentUploadOutput's
	// String and GoString methods.
	//
	// Url is a required field
	Url *string `locationName:"url" min:"1" type:"string" required:"true" sensitive:"true"`

	// The expiration time of the URL as an epoch timestamp.
	//
	// UrlExpiry is a required field
	UrlExpiry *time.Time `locationName:"urlExpiry" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`
	// contains filtered or unexported fields
}

func (StartContentUploadOutput) GoString

func (s StartContentUploadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartContentUploadOutput) SetHeadersToInclude

func (s *StartContentUploadOutput) SetHeadersToInclude(v map[string]*string) *StartContentUploadOutput

SetHeadersToInclude sets the HeadersToInclude field's value.

func (*StartContentUploadOutput) SetUploadId

SetUploadId sets the UploadId field's value.

func (*StartContentUploadOutput) SetUrl

SetUrl sets the Url field's value.

func (*StartContentUploadOutput) SetUrlExpiry

SetUrlExpiry sets the UrlExpiry field's value.

func (StartContentUploadOutput) String

func (s StartContentUploadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartImportJobInput

type StartImportJobInput struct {

	// The tags used to organize, track, or control access for this resource.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The configuration information of the external source that the resource data
	// are imported from.
	ExternalSourceConfiguration *ExternalSourceConfiguration `locationName:"externalSourceConfiguration" type:"structure"`

	// The type of the import job.
	//
	//    * For importing quick response resource, set the value to QUICK_RESPONSES.
	//
	// ImportJobType is a required field
	ImportJobType *string `locationName:"importJobType" type:"string" required:"true" enum:"ImportJobType"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	//    * For importing Amazon Q quick responses, this should be a QUICK_RESPONSES
	//    type knowledge base.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The metadata fields of the imported Amazon Q resources.
	Metadata map[string]*string `locationName:"metadata" type:"map"`

	// A pointer to the uploaded asset. This value is returned by StartContentUpload
	// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html).
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartImportJobInput) GoString

func (s StartImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartImportJobInput) SetClientToken

func (s *StartImportJobInput) SetClientToken(v string) *StartImportJobInput

SetClientToken sets the ClientToken field's value.

func (*StartImportJobInput) SetExternalSourceConfiguration

func (s *StartImportJobInput) SetExternalSourceConfiguration(v *ExternalSourceConfiguration) *StartImportJobInput

SetExternalSourceConfiguration sets the ExternalSourceConfiguration field's value.

func (*StartImportJobInput) SetImportJobType

func (s *StartImportJobInput) SetImportJobType(v string) *StartImportJobInput

SetImportJobType sets the ImportJobType field's value.

func (*StartImportJobInput) SetKnowledgeBaseId

func (s *StartImportJobInput) SetKnowledgeBaseId(v string) *StartImportJobInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*StartImportJobInput) SetMetadata

func (s *StartImportJobInput) SetMetadata(v map[string]*string) *StartImportJobInput

SetMetadata sets the Metadata field's value.

func (*StartImportJobInput) SetUploadId

func (s *StartImportJobInput) SetUploadId(v string) *StartImportJobInput

SetUploadId sets the UploadId field's value.

func (StartImportJobInput) String

func (s StartImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartImportJobInput) Validate

func (s *StartImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartImportJobOutput

type StartImportJobOutput struct {

	// The import job.
	ImportJob *ImportJobData `locationName:"importJob" type:"structure"`
	// contains filtered or unexported fields
}

func (StartImportJobOutput) GoString

func (s StartImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartImportJobOutput) SetImportJob

SetImportJob sets the ImportJob field's value.

func (StartImportJobOutput) String

func (s StartImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tags used to organize, track, or control access for this resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextData

type TextData struct {

	// The text of the document.
	Excerpt *DocumentText `locationName:"excerpt" type:"structure"`

	// The text of the document.
	Title *DocumentText `locationName:"title" type:"structure"`
	// contains filtered or unexported fields
}

Details about the source content text data.

func (TextData) GoString

func (s TextData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextData) SetExcerpt

func (s *TextData) SetExcerpt(v *DocumentText) *TextData

SetExcerpt sets the Excerpt field's value.

func (*TextData) SetTitle

func (s *TextData) SetTitle(v *DocumentText) *TextData

SetTitle sets the Title field's value.

func (TextData) String

func (s TextData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTagsException

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The specified resource name.
	ResourceName *string `locationName:"resourceName" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TooManyTagsException) Code

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The tag keys.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateContentInput

type UpdateContentInput struct {

	// The identifier of the content. Can be either the ID or the ARN. URLs cannot
	// contain the ARN.
	//
	// ContentId is a required field
	ContentId *string `location:"uri" locationName:"contentId" type:"string" required:"true"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

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

	// 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 `locationName:"overrideLinkOutUri" min:"1" type:"string"`

	// Unset the existing overrideLinkOutUri if it exists.
	RemoveOverrideLinkOutUri *bool `locationName:"removeOverrideLinkOutUri" type:"boolean"`

	// 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 `locationName:"revisionId" min:"1" type:"string"`

	// The title of the content.
	Title *string `locationName:"title" min:"1" type:"string"`

	// A pointer to the uploaded asset. This value is returned by StartContentUpload
	// (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html).
	UploadId *string `locationName:"uploadId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateContentInput) GoString

func (s UpdateContentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContentInput) SetContentId

func (s *UpdateContentInput) SetContentId(v string) *UpdateContentInput

SetContentId sets the ContentId field's value.

func (*UpdateContentInput) SetKnowledgeBaseId

func (s *UpdateContentInput) SetKnowledgeBaseId(v string) *UpdateContentInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateContentInput) SetMetadata

func (s *UpdateContentInput) SetMetadata(v map[string]*string) *UpdateContentInput

SetMetadata sets the Metadata field's value.

func (*UpdateContentInput) SetOverrideLinkOutUri

func (s *UpdateContentInput) SetOverrideLinkOutUri(v string) *UpdateContentInput

SetOverrideLinkOutUri sets the OverrideLinkOutUri field's value.

func (*UpdateContentInput) SetRemoveOverrideLinkOutUri

func (s *UpdateContentInput) SetRemoveOverrideLinkOutUri(v bool) *UpdateContentInput

SetRemoveOverrideLinkOutUri sets the RemoveOverrideLinkOutUri field's value.

func (*UpdateContentInput) SetRevisionId

func (s *UpdateContentInput) SetRevisionId(v string) *UpdateContentInput

SetRevisionId sets the RevisionId field's value.

func (*UpdateContentInput) SetTitle

SetTitle sets the Title field's value.

func (*UpdateContentInput) SetUploadId

func (s *UpdateContentInput) SetUploadId(v string) *UpdateContentInput

SetUploadId sets the UploadId field's value.

func (UpdateContentInput) String

func (s UpdateContentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContentInput) Validate

func (s *UpdateContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContentOutput

type UpdateContentOutput struct {

	// The content.
	Content *ContentData `locationName:"content" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateContentOutput) GoString

func (s UpdateContentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContentOutput) SetContent

SetContent sets the Content field's value.

func (UpdateContentOutput) String

func (s UpdateContentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateKnowledgeBaseTemplateUriInput

type UpdateKnowledgeBaseTemplateUriInput struct {

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The template URI to update.
	//
	// TemplateUri is a required field
	TemplateUri *string `locationName:"templateUri" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateKnowledgeBaseTemplateUriInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKnowledgeBaseTemplateUriInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateKnowledgeBaseTemplateUriInput) SetTemplateUri

SetTemplateUri sets the TemplateUri field's value.

func (UpdateKnowledgeBaseTemplateUriInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKnowledgeBaseTemplateUriInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateKnowledgeBaseTemplateUriOutput

type UpdateKnowledgeBaseTemplateUriOutput struct {

	// The knowledge base to update.
	KnowledgeBase *KnowledgeBaseData `locationName:"knowledgeBase" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateKnowledgeBaseTemplateUriOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKnowledgeBaseTemplateUriOutput) SetKnowledgeBase

SetKnowledgeBase sets the KnowledgeBase field's value.

func (UpdateKnowledgeBaseTemplateUriOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateQuickResponseInput

type UpdateQuickResponseInput struct {

	// The Amazon Connect contact channels this quick response applies to. The supported
	// contact channel types include Chat.
	Channels []*string `locationName:"channels" type:"list"`

	// The updated content of the quick response.
	Content *QuickResponseDataProvider `locationName:"content" type:"structure"`

	// 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 `locationName:"contentType" type:"string"`

	// The updated description of the quick response.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The updated grouping configuration of the quick response.
	GroupingConfiguration *GroupingConfiguration `locationName:"groupingConfiguration" type:"structure"`

	// Whether the quick response is active.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// The identifier of the knowledge base. This should not be a QUICK_RESPONSES
	// type knowledge base if you're storing Amazon Q Content resource to it. Can
	// be either the ID or the ARN. URLs cannot contain the ARN.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 `locationName:"language" min:"2" type:"string"`

	// The name of the quick response.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The identifier of the quick response.
	//
	// QuickResponseId is a required field
	QuickResponseId *string `location:"uri" locationName:"quickResponseId" type:"string" required:"true"`

	// Whether to remove the description from the quick response.
	RemoveDescription *bool `locationName:"removeDescription" type:"boolean"`

	// Whether to remove the grouping configuration of the quick response.
	RemoveGroupingConfiguration *bool `locationName:"removeGroupingConfiguration" type:"boolean"`

	// Whether to remove the shortcut key of the quick response.
	RemoveShortcutKey *bool `locationName:"removeShortcutKey" type:"boolean"`

	// The shortcut key of the quick response. The value should be unique across
	// the knowledge base.
	ShortcutKey *string `locationName:"shortcutKey" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateQuickResponseInput) GoString

func (s UpdateQuickResponseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuickResponseInput) SetChannels

SetChannels sets the Channels field's value.

func (*UpdateQuickResponseInput) SetContent

SetContent sets the Content field's value.

func (*UpdateQuickResponseInput) SetContentType

SetContentType sets the ContentType field's value.

func (*UpdateQuickResponseInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateQuickResponseInput) SetGroupingConfiguration

SetGroupingConfiguration sets the GroupingConfiguration field's value.

func (*UpdateQuickResponseInput) SetIsActive

SetIsActive sets the IsActive field's value.

func (*UpdateQuickResponseInput) SetKnowledgeBaseId

func (s *UpdateQuickResponseInput) SetKnowledgeBaseId(v string) *UpdateQuickResponseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateQuickResponseInput) SetLanguage

SetLanguage sets the Language field's value.

func (*UpdateQuickResponseInput) SetName

SetName sets the Name field's value.

func (*UpdateQuickResponseInput) SetQuickResponseId

func (s *UpdateQuickResponseInput) SetQuickResponseId(v string) *UpdateQuickResponseInput

SetQuickResponseId sets the QuickResponseId field's value.

func (*UpdateQuickResponseInput) SetRemoveDescription

func (s *UpdateQuickResponseInput) SetRemoveDescription(v bool) *UpdateQuickResponseInput

SetRemoveDescription sets the RemoveDescription field's value.

func (*UpdateQuickResponseInput) SetRemoveGroupingConfiguration

func (s *UpdateQuickResponseInput) SetRemoveGroupingConfiguration(v bool) *UpdateQuickResponseInput

SetRemoveGroupingConfiguration sets the RemoveGroupingConfiguration field's value.

func (*UpdateQuickResponseInput) SetRemoveShortcutKey

func (s *UpdateQuickResponseInput) SetRemoveShortcutKey(v bool) *UpdateQuickResponseInput

SetRemoveShortcutKey sets the RemoveShortcutKey field's value.

func (*UpdateQuickResponseInput) SetShortcutKey

SetShortcutKey sets the ShortcutKey field's value.

func (UpdateQuickResponseInput) String

func (s UpdateQuickResponseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuickResponseInput) Validate

func (s *UpdateQuickResponseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateQuickResponseOutput

type UpdateQuickResponseOutput struct {

	// The quick response.
	QuickResponse *QuickResponseData `locationName:"quickResponse" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateQuickResponseOutput) GoString

func (s UpdateQuickResponseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuickResponseOutput) SetQuickResponse

SetQuickResponse sets the QuickResponse field's value.

func (UpdateQuickResponseOutput) String

func (s UpdateQuickResponseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package qconnectiface provides an interface to enable mocking the Amazon Q Connect service client for testing your code.
Package qconnectiface provides an interface to enable mocking the Amazon Q Connect service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL