qbusiness

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 17 Imported by: 3

Documentation

Overview

Package qbusiness provides the client and types for making API requests to QBusiness.

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

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview).

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html) in the Amazon Q Business User Guide.

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

See https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27 for more information on this service.

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

Using the Client

To contact QBusiness 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 QBusiness client QBusiness for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/qbusiness/#New

Index

Constants

View Source 
const (
	// ActionPayloadFieldTypeString is a ActionPayloadFieldType enum value
	ActionPayloadFieldTypeString = "STRING"

	// ActionPayloadFieldTypeNumber is a ActionPayloadFieldType enum value
	ActionPayloadFieldTypeNumber = "NUMBER"

	// ActionPayloadFieldTypeArray is a ActionPayloadFieldType enum value
	ActionPayloadFieldTypeArray = "ARRAY"

	// ActionPayloadFieldTypeBoolean is a ActionPayloadFieldType enum value
	ActionPayloadFieldTypeBoolean = "BOOLEAN"
)
View Source 
const (
	// ApplicationStatusCreating is a ApplicationStatus enum value
	ApplicationStatusCreating = "CREATING"

	// ApplicationStatusActive is a ApplicationStatus enum value
	ApplicationStatusActive = "ACTIVE"

	// ApplicationStatusDeleting is a ApplicationStatus enum value
	ApplicationStatusDeleting = "DELETING"

	// ApplicationStatusFailed is a ApplicationStatus enum value
	ApplicationStatusFailed = "FAILED"

	// ApplicationStatusUpdating is a ApplicationStatus enum value
	ApplicationStatusUpdating = "UPDATING"
)
View Source 
const (
	// AttachmentStatusFailed is a AttachmentStatus enum value
	AttachmentStatusFailed = "FAILED"

	// AttachmentStatusSucceeded is a AttachmentStatus enum value
	AttachmentStatusSucceeded = "SUCCEEDED"
)
View Source 
const (
	// AttachmentsControlModeEnabled is a AttachmentsControlMode enum value
	AttachmentsControlModeEnabled = "ENABLED"

	// AttachmentsControlModeDisabled is a AttachmentsControlMode enum value
	AttachmentsControlModeDisabled = "DISABLED"
)
View Source 
const (
	// AttributeTypeString is a AttributeType enum value
	AttributeTypeString = "STRING"

	// AttributeTypeStringList is a AttributeType enum value
	AttributeTypeStringList = "STRING_LIST"

	// AttributeTypeNumber is a AttributeType enum value
	AttributeTypeNumber = "NUMBER"

	// AttributeTypeDate is a AttributeType enum value
	AttributeTypeDate = "DATE"
)
View Source 
const (
	// ChatModeRetrievalMode is a ChatMode enum value
	ChatModeRetrievalMode = "RETRIEVAL_MODE"

	// ChatModeCreatorMode is a ChatMode enum value
	ChatModeCreatorMode = "CREATOR_MODE"

	// ChatModePluginMode is a ChatMode enum value
	ChatModePluginMode = "PLUGIN_MODE"
)
View Source 
const (
	// ContentTypePdf is a ContentType enum value
	ContentTypePdf = "PDF"

	// ContentTypeHtml is a ContentType enum value
	ContentTypeHtml = "HTML"

	// ContentTypeMsWord is a ContentType enum value
	ContentTypeMsWord = "MS_WORD"

	// ContentTypePlainText is a ContentType enum value
	ContentTypePlainText = "PLAIN_TEXT"

	// ContentTypePpt is a ContentType enum value
	ContentTypePpt = "PPT"

	// ContentTypeRtf is a ContentType enum value
	ContentTypeRtf = "RTF"

	// ContentTypeXml is a ContentType enum value
	ContentTypeXml = "XML"

	// ContentTypeXslt is a ContentType enum value
	ContentTypeXslt = "XSLT"

	// ContentTypeMsExcel is a ContentType enum value
	ContentTypeMsExcel = "MS_EXCEL"

	// ContentTypeCsv is a ContentType enum value
	ContentTypeCsv = "CSV"

	// ContentTypeJson is a ContentType enum value
	ContentTypeJson = "JSON"

	// ContentTypeMd is a ContentType enum value
	ContentTypeMd = "MD"
)
View Source 
const (
	// CreatorModeControlEnabled is a CreatorModeControl enum value
	CreatorModeControlEnabled = "ENABLED"

	// CreatorModeControlDisabled is a CreatorModeControl enum value
	CreatorModeControlDisabled = "DISABLED"
)
View Source 
const (
	// DataSourceStatusPendingCreation is a DataSourceStatus enum value
	DataSourceStatusPendingCreation = "PENDING_CREATION"

	// DataSourceStatusCreating is a DataSourceStatus enum value
	DataSourceStatusCreating = "CREATING"

	// DataSourceStatusActive is a DataSourceStatus enum value
	DataSourceStatusActive = "ACTIVE"

	// DataSourceStatusDeleting is a DataSourceStatus enum value
	DataSourceStatusDeleting = "DELETING"

	// DataSourceStatusFailed is a DataSourceStatus enum value
	DataSourceStatusFailed = "FAILED"

	// DataSourceStatusUpdating is a DataSourceStatus enum value
	DataSourceStatusUpdating = "UPDATING"
)
View Source 
const (
	// DataSourceSyncJobStatusFailed is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusFailed = "FAILED"

	// DataSourceSyncJobStatusSucceeded is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusSucceeded = "SUCCEEDED"

	// DataSourceSyncJobStatusSyncing is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusSyncing = "SYNCING"

	// DataSourceSyncJobStatusIncomplete is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusIncomplete = "INCOMPLETE"

	// DataSourceSyncJobStatusStopping is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusStopping = "STOPPING"

	// DataSourceSyncJobStatusAborted is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusAborted = "ABORTED"

	// DataSourceSyncJobStatusSyncingIndexing is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusSyncingIndexing = "SYNCING_INDEXING"
)
View Source 
const (
	// DocumentAttributeBoostingLevelNone is a DocumentAttributeBoostingLevel enum value
	DocumentAttributeBoostingLevelNone = "NONE"

	// DocumentAttributeBoostingLevelLow is a DocumentAttributeBoostingLevel enum value
	DocumentAttributeBoostingLevelLow = "LOW"

	// DocumentAttributeBoostingLevelMedium is a DocumentAttributeBoostingLevel enum value
	DocumentAttributeBoostingLevelMedium = "MEDIUM"

	// DocumentAttributeBoostingLevelHigh is a DocumentAttributeBoostingLevel enum value
	DocumentAttributeBoostingLevelHigh = "HIGH"

	// DocumentAttributeBoostingLevelVeryHigh is a DocumentAttributeBoostingLevel enum value
	DocumentAttributeBoostingLevelVeryHigh = "VERY_HIGH"
)
View Source 
const (
	// DocumentEnrichmentConditionOperatorGreaterThan is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorGreaterThan = "GREATER_THAN"

	// DocumentEnrichmentConditionOperatorGreaterThanOrEquals is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorGreaterThanOrEquals = "GREATER_THAN_OR_EQUALS"

	// DocumentEnrichmentConditionOperatorLessThan is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorLessThan = "LESS_THAN"

	// DocumentEnrichmentConditionOperatorLessThanOrEquals is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorLessThanOrEquals = "LESS_THAN_OR_EQUALS"

	// DocumentEnrichmentConditionOperatorEquals is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorEquals = "EQUALS"

	// DocumentEnrichmentConditionOperatorNotEquals is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorNotEquals = "NOT_EQUALS"

	// DocumentEnrichmentConditionOperatorContains is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorContains = "CONTAINS"

	// DocumentEnrichmentConditionOperatorNotContains is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorNotContains = "NOT_CONTAINS"

	// DocumentEnrichmentConditionOperatorExists is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorExists = "EXISTS"

	// DocumentEnrichmentConditionOperatorNotExists is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorNotExists = "NOT_EXISTS"

	// DocumentEnrichmentConditionOperatorBeginsWith is a DocumentEnrichmentConditionOperator enum value
	DocumentEnrichmentConditionOperatorBeginsWith = "BEGINS_WITH"
)
View Source 
const (
	// DocumentStatusReceived is a DocumentStatus enum value
	DocumentStatusReceived = "RECEIVED"

	// DocumentStatusProcessing is a DocumentStatus enum value
	DocumentStatusProcessing = "PROCESSING"

	// DocumentStatusIndexed is a DocumentStatus enum value
	DocumentStatusIndexed = "INDEXED"

	// DocumentStatusUpdated is a DocumentStatus enum value
	DocumentStatusUpdated = "UPDATED"

	// DocumentStatusFailed is a DocumentStatus enum value
	DocumentStatusFailed = "FAILED"

	// DocumentStatusDeleting is a DocumentStatus enum value
	DocumentStatusDeleting = "DELETING"

	// DocumentStatusDeleted is a DocumentStatus enum value
	DocumentStatusDeleted = "DELETED"

	// DocumentStatusDocumentFailedToIndex is a DocumentStatus enum value
	DocumentStatusDocumentFailedToIndex = "DOCUMENT_FAILED_TO_INDEX"
)
View Source 
const (
	// ErrorCodeInternalError is a ErrorCode enum value
	ErrorCodeInternalError = "InternalError"

	// ErrorCodeInvalidRequest is a ErrorCode enum value
	ErrorCodeInvalidRequest = "InvalidRequest"

	// ErrorCodeResourceInactive is a ErrorCode enum value
	ErrorCodeResourceInactive = "ResourceInactive"

	// ErrorCodeResourceNotFound is a ErrorCode enum value
	ErrorCodeResourceNotFound = "ResourceNotFound"
)
View Source 
const (
	// GroupStatusFailed is a GroupStatus enum value
	GroupStatusFailed = "FAILED"

	// GroupStatusSucceeded is a GroupStatus enum value
	GroupStatusSucceeded = "SUCCEEDED"

	// GroupStatusProcessing is a GroupStatus enum value
	GroupStatusProcessing = "PROCESSING"

	// GroupStatusDeleting is a GroupStatus enum value
	GroupStatusDeleting = "DELETING"

	// GroupStatusDeleted is a GroupStatus enum value
	GroupStatusDeleted = "DELETED"
)
View Source 
const (
	// IndexStatusCreating is a IndexStatus enum value
	IndexStatusCreating = "CREATING"

	// IndexStatusActive is a IndexStatus enum value
	IndexStatusActive = "ACTIVE"

	// IndexStatusDeleting is a IndexStatus enum value
	IndexStatusDeleting = "DELETING"

	// IndexStatusFailed is a IndexStatus enum value
	IndexStatusFailed = "FAILED"

	// IndexStatusUpdating is a IndexStatus enum value
	IndexStatusUpdating = "UPDATING"
)
View Source 
const (
	// IndexTypeEnterprise is a IndexType enum value
	IndexTypeEnterprise = "ENTERPRISE"

	// IndexTypeStarter is a IndexType enum value
	IndexTypeStarter = "STARTER"
)
View Source 
const (
	// MemberRelationAnd is a MemberRelation enum value
	MemberRelationAnd = "AND"

	// MemberRelationOr is a MemberRelation enum value
	MemberRelationOr = "OR"
)
View Source 
const (
	// MembershipTypeIndex is a MembershipType enum value
	MembershipTypeIndex = "INDEX"

	// MembershipTypeDatasource is a MembershipType enum value
	MembershipTypeDatasource = "DATASOURCE"
)
View Source 
const (
	// MessageTypeUser is a MessageType enum value
	MessageTypeUser = "USER"

	// MessageTypeSystem is a MessageType enum value
	MessageTypeSystem = "SYSTEM"
)
View Source 
const (
	// MessageUsefulnessUseful is a MessageUsefulness enum value
	MessageUsefulnessUseful = "USEFUL"

	// MessageUsefulnessNotUseful is a MessageUsefulness enum value
	MessageUsefulnessNotUseful = "NOT_USEFUL"
)
View Source 
const (
	// MessageUsefulnessReasonNotFactuallyCorrect is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonNotFactuallyCorrect = "NOT_FACTUALLY_CORRECT"

	// MessageUsefulnessReasonHarmfulOrUnsafe is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonHarmfulOrUnsafe = "HARMFUL_OR_UNSAFE"

	// MessageUsefulnessReasonIncorrectOrMissingSources is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonIncorrectOrMissingSources = "INCORRECT_OR_MISSING_SOURCES"

	// MessageUsefulnessReasonNotHelpful is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonNotHelpful = "NOT_HELPFUL"

	// MessageUsefulnessReasonFactuallyCorrect is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonFactuallyCorrect = "FACTUALLY_CORRECT"

	// MessageUsefulnessReasonComplete is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonComplete = "COMPLETE"

	// MessageUsefulnessReasonRelevantSources is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonRelevantSources = "RELEVANT_SOURCES"

	// MessageUsefulnessReasonHelpful is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonHelpful = "HELPFUL"

	// MessageUsefulnessReasonNotBasedOnDocuments is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonNotBasedOnDocuments = "NOT_BASED_ON_DOCUMENTS"

	// MessageUsefulnessReasonNotComplete is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonNotComplete = "NOT_COMPLETE"

	// MessageUsefulnessReasonNotConcise is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonNotConcise = "NOT_CONCISE"

	// MessageUsefulnessReasonOther is a MessageUsefulnessReason enum value
	MessageUsefulnessReasonOther = "OTHER"
)
View Source 
const (
	// NumberAttributeBoostingTypePrioritizeLargerValues is a NumberAttributeBoostingType enum value
	NumberAttributeBoostingTypePrioritizeLargerValues = "PRIORITIZE_LARGER_VALUES"

	// NumberAttributeBoostingTypePrioritizeSmallerValues is a NumberAttributeBoostingType enum value
	NumberAttributeBoostingTypePrioritizeSmallerValues = "PRIORITIZE_SMALLER_VALUES"
)
View Source 
const (
	// PersonalizationControlModeEnabled is a PersonalizationControlMode enum value
	PersonalizationControlModeEnabled = "ENABLED"

	// PersonalizationControlModeDisabled is a PersonalizationControlMode enum value
	PersonalizationControlModeDisabled = "DISABLED"
)
View Source 
const (
	// PluginBuildStatusReady is a PluginBuildStatus enum value
	PluginBuildStatusReady = "READY"

	// PluginBuildStatusCreateInProgress is a PluginBuildStatus enum value
	PluginBuildStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// PluginBuildStatusCreateFailed is a PluginBuildStatus enum value
	PluginBuildStatusCreateFailed = "CREATE_FAILED"

	// PluginBuildStatusUpdateInProgress is a PluginBuildStatus enum value
	PluginBuildStatusUpdateInProgress = "UPDATE_IN_PROGRESS"

	// PluginBuildStatusUpdateFailed is a PluginBuildStatus enum value
	PluginBuildStatusUpdateFailed = "UPDATE_FAILED"

	// PluginBuildStatusDeleteInProgress is a PluginBuildStatus enum value
	PluginBuildStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// PluginBuildStatusDeleteFailed is a PluginBuildStatus enum value
	PluginBuildStatusDeleteFailed = "DELETE_FAILED"
)
View Source 
const (
	// PluginStateEnabled is a PluginState enum value
	PluginStateEnabled = "ENABLED"

	// PluginStateDisabled is a PluginState enum value
	PluginStateDisabled = "DISABLED"
)
View Source 
const (
	// PluginTypeServiceNow is a PluginType enum value
	PluginTypeServiceNow = "SERVICE_NOW"

	// PluginTypeSalesforce is a PluginType enum value
	PluginTypeSalesforce = "SALESFORCE"

	// PluginTypeJira is a PluginType enum value
	PluginTypeJira = "JIRA"

	// PluginTypeZendesk is a PluginType enum value
	PluginTypeZendesk = "ZENDESK"

	// PluginTypeCustom is a PluginType enum value
	PluginTypeCustom = "CUSTOM"
)
View Source 
const (
	// QAppsControlModeEnabled is a QAppsControlMode enum value
	QAppsControlModeEnabled = "ENABLED"

	// QAppsControlModeDisabled is a QAppsControlMode enum value
	QAppsControlModeDisabled = "DISABLED"
)
View Source 
const (
	// ReadAccessTypeAllow is a ReadAccessType enum value
	ReadAccessTypeAllow = "ALLOW"

	// ReadAccessTypeDeny is a ReadAccessType enum value
	ReadAccessTypeDeny = "DENY"
)
View Source 
const (
	// ResponseScopeEnterpriseContentOnly is a ResponseScope enum value
	ResponseScopeEnterpriseContentOnly = "ENTERPRISE_CONTENT_ONLY"

	// ResponseScopeExtendedKnowledgeEnabled is a ResponseScope enum value
	ResponseScopeExtendedKnowledgeEnabled = "EXTENDED_KNOWLEDGE_ENABLED"
)
View Source 
const (
	// RetrieverStatusCreating is a RetrieverStatus enum value
	RetrieverStatusCreating = "CREATING"

	// RetrieverStatusActive is a RetrieverStatus enum value
	RetrieverStatusActive = "ACTIVE"

	// RetrieverStatusFailed is a RetrieverStatus enum value
	RetrieverStatusFailed = "FAILED"
)
View Source 
const (
	// RetrieverTypeNativeIndex is a RetrieverType enum value
	RetrieverTypeNativeIndex = "NATIVE_INDEX"

	// RetrieverTypeKendraIndex is a RetrieverType enum value
	RetrieverTypeKendraIndex = "KENDRA_INDEX"
)
View Source 
const (
	// RuleTypeContentBlockerRule is a RuleType enum value
	RuleTypeContentBlockerRule = "CONTENT_BLOCKER_RULE"

	// RuleTypeContentRetrievalRule is a RuleType enum value
	RuleTypeContentRetrievalRule = "CONTENT_RETRIEVAL_RULE"
)
View Source 
const (
	// StatusEnabled is a Status enum value
	StatusEnabled = "ENABLED"

	// StatusDisabled is a Status enum value
	StatusDisabled = "DISABLED"
)
View Source 
const (
	// StringAttributeValueBoostingLevelLow is a StringAttributeValueBoostingLevel enum value
	StringAttributeValueBoostingLevelLow = "LOW"

	// StringAttributeValueBoostingLevelMedium is a StringAttributeValueBoostingLevel enum value
	StringAttributeValueBoostingLevelMedium = "MEDIUM"

	// StringAttributeValueBoostingLevelHigh is a StringAttributeValueBoostingLevel enum value
	StringAttributeValueBoostingLevelHigh = "HIGH"

	// StringAttributeValueBoostingLevelVeryHigh is a StringAttributeValueBoostingLevel enum value
	StringAttributeValueBoostingLevelVeryHigh = "VERY_HIGH"
)
View Source 
const (
	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"
)
View Source 
const (
	// WebExperienceSamplePromptsControlModeEnabled is a WebExperienceSamplePromptsControlMode enum value
	WebExperienceSamplePromptsControlModeEnabled = "ENABLED"

	// WebExperienceSamplePromptsControlModeDisabled is a WebExperienceSamplePromptsControlMode enum value
	WebExperienceSamplePromptsControlModeDisabled = "DISABLED"
)
View Source 
const (
	// WebExperienceStatusCreating is a WebExperienceStatus enum value
	WebExperienceStatusCreating = "CREATING"

	// WebExperienceStatusActive is a WebExperienceStatus enum value
	WebExperienceStatusActive = "ACTIVE"

	// WebExperienceStatusDeleting is a WebExperienceStatus enum value
	WebExperienceStatusDeleting = "DELETING"

	// WebExperienceStatusFailed is a WebExperienceStatus enum value
	WebExperienceStatusFailed = "FAILED"

	// WebExperienceStatusPendingAuthConfig is a WebExperienceStatus enum value
	WebExperienceStatusPendingAuthConfig = "PENDING_AUTH_CONFIG"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have access to perform this action. Make sure you have the required
	// permission policies and user accounts and try again.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// You are trying to perform an action that conflicts with the current status
	// of your resource. Fix any inconsistences with your resources and try again.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An issue occurred with the internal server used for your Amazon Q Business
	// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/)
	// for help.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeLicenseNotFoundException for service response error code
	// "LicenseNotFoundException".
	//
	// You don't have permissions to perform the action because your license is
	// inactive. Ask your admin to activate your license and try again after your
	// licence is active.
	ErrCodeLicenseNotFoundException = "LicenseNotFoundException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource you want to use doesn’t exist. Make sure you have provided
	// the correct resource and try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded the set limits for your Amazon Q Business service.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to throttling. Reduce the number of requests and
	// try again.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input doesn't meet the constraints set by the Amazon Q Business service.
	// Provide the correct input and try again.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "QBusiness" // Name of service.
	EndpointsID = "qbusiness" // ID to lookup a service endpoint with.
	ServiceID   = "QBusiness" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// APISchemaTypeOpenApiV3 is a APISchemaType enum value
	APISchemaTypeOpenApiV3 = "OPEN_API_V3"
)
View Source 
const (
	// AttributeValueOperatorDelete is a AttributeValueOperator enum value
	AttributeValueOperatorDelete = "DELETE"
)
View Source 
const (
	// DocumentContentOperatorDelete is a DocumentContentOperator enum value
	DocumentContentOperatorDelete = "DELETE"
)

Variables

This section is empty.

Functions

func APISchemaType_Values added in v1.51.32 

func APISchemaType_Values() []string

APISchemaType_Values returns all elements of the APISchemaType enum

func ActionPayloadFieldType_Values 

func ActionPayloadFieldType_Values() []string

ActionPayloadFieldType_Values returns all elements of the ActionPayloadFieldType enum

func ApplicationStatus_Values 

func ApplicationStatus_Values() []string

ApplicationStatus_Values returns all elements of the ApplicationStatus enum

func AttachmentStatus_Values 

func AttachmentStatus_Values() []string

AttachmentStatus_Values returns all elements of the AttachmentStatus enum

func AttachmentsControlMode_Values 

func AttachmentsControlMode_Values() []string

AttachmentsControlMode_Values returns all elements of the AttachmentsControlMode enum

func AttributeType_Values 

func AttributeType_Values() []string

AttributeType_Values returns all elements of the AttributeType enum

func AttributeValueOperator_Values 

func AttributeValueOperator_Values() []string

AttributeValueOperator_Values returns all elements of the AttributeValueOperator enum

func ChatMode_Values added in v1.51.23 

func ChatMode_Values() []string

ChatMode_Values returns all elements of the ChatMode enum

func ContentType_Values 

func ContentType_Values() []string

ContentType_Values returns all elements of the ContentType enum

func CreatorModeControl_Values added in v1.51.23 

func CreatorModeControl_Values() []string

CreatorModeControl_Values returns all elements of the CreatorModeControl enum

func DataSourceStatus_Values 

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DataSourceSyncJobStatus_Values 

func DataSourceSyncJobStatus_Values() []string

DataSourceSyncJobStatus_Values returns all elements of the DataSourceSyncJobStatus enum

func DocumentAttributeBoostingLevel_Values added in v1.50.18 

func DocumentAttributeBoostingLevel_Values() []string

DocumentAttributeBoostingLevel_Values returns all elements of the DocumentAttributeBoostingLevel enum

func DocumentContentOperator_Values 

func DocumentContentOperator_Values() []string

DocumentContentOperator_Values returns all elements of the DocumentContentOperator enum

func DocumentEnrichmentConditionOperator_Values 

func DocumentEnrichmentConditionOperator_Values() []string

DocumentEnrichmentConditionOperator_Values returns all elements of the DocumentEnrichmentConditionOperator enum

func DocumentStatus_Values 

func DocumentStatus_Values() []string

DocumentStatus_Values returns all elements of the DocumentStatus enum

func ErrorCode_Values 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func GroupStatus_Values 

func GroupStatus_Values() []string

GroupStatus_Values returns all elements of the GroupStatus enum

func IndexStatus_Values 

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func IndexType_Values added in v1.51.32 

func IndexType_Values() []string

IndexType_Values returns all elements of the IndexType enum

func MemberRelation_Values 

func MemberRelation_Values() []string

MemberRelation_Values returns all elements of the MemberRelation enum

func MembershipType_Values 

func MembershipType_Values() []string

MembershipType_Values returns all elements of the MembershipType enum

func MessageType_Values 

func MessageType_Values() []string

MessageType_Values returns all elements of the MessageType enum

func MessageUsefulnessReason_Values 

func MessageUsefulnessReason_Values() []string

MessageUsefulnessReason_Values returns all elements of the MessageUsefulnessReason enum

func MessageUsefulness_Values 

func MessageUsefulness_Values() []string

MessageUsefulness_Values returns all elements of the MessageUsefulness enum

func NumberAttributeBoostingType_Values added in v1.50.18 

func NumberAttributeBoostingType_Values() []string

NumberAttributeBoostingType_Values returns all elements of the NumberAttributeBoostingType enum

func PersonalizationControlMode_Values added in v1.54.15 

func PersonalizationControlMode_Values() []string

PersonalizationControlMode_Values returns all elements of the PersonalizationControlMode enum

func PluginBuildStatus_Values added in v1.51.32 

func PluginBuildStatus_Values() []string

PluginBuildStatus_Values returns all elements of the PluginBuildStatus enum

func PluginState_Values 

func PluginState_Values() []string

PluginState_Values returns all elements of the PluginState enum

func PluginType_Values 

func PluginType_Values() []string

PluginType_Values returns all elements of the PluginType enum

func QAppsControlMode_Values added in v1.54.7 

func QAppsControlMode_Values() []string

QAppsControlMode_Values returns all elements of the QAppsControlMode enum

func ReadAccessType_Values 

func ReadAccessType_Values() []string

ReadAccessType_Values returns all elements of the ReadAccessType enum

func ResponseScope_Values 

func ResponseScope_Values() []string

ResponseScope_Values returns all elements of the ResponseScope enum

func RetrieverStatus_Values 

func RetrieverStatus_Values() []string

RetrieverStatus_Values returns all elements of the RetrieverStatus enum

func RetrieverType_Values 

func RetrieverType_Values() []string

RetrieverType_Values returns all elements of the RetrieverType enum

func RuleType_Values 

func RuleType_Values() []string

RuleType_Values returns all elements of the RuleType enum

func Status_Values 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func StringAttributeValueBoostingLevel_Values added in v1.50.18 

func StringAttributeValueBoostingLevel_Values() []string

StringAttributeValueBoostingLevel_Values returns all elements of the StringAttributeValueBoostingLevel enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func WebExperienceSamplePromptsControlMode_Values 

func WebExperienceSamplePromptsControlMode_Values() []string

WebExperienceSamplePromptsControlMode_Values returns all elements of the WebExperienceSamplePromptsControlMode enum

func WebExperienceStatus_Values 

func WebExperienceStatus_Values() []string

WebExperienceStatus_Values returns all elements of the WebExperienceStatus enum

Types

type APISchema added in v1.51.32 

type APISchema struct {

	// The JSON or YAML-formatted payload defining the OpenAPI schema for a custom
	// plugin.
	//
	// Payload is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by APISchema's
	// String and GoString methods.
	Payload *string `locationName:"payload" type:"string" sensitive:"true"`

	// Contains details about the S3 object containing the OpenAPI schema for a
	// custom plugin. The schema could be in either JSON or YAML format.
	S3 *S3 `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema). You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

func (APISchema) GoString added in v1.51.32 

func (s APISchema) 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 (*APISchema) SetPayload added in v1.51.32 

func (s *APISchema) SetPayload(v string) *APISchema

SetPayload sets the Payload field's value.

func (*APISchema) SetS3 added in v1.51.32 

func (s *APISchema) SetS3(v *S3) *APISchema

SetS3 sets the S3 field's value.

func (APISchema) String added in v1.51.32 

func (s APISchema) 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 (*APISchema) Validate added in v1.51.32 

func (s *APISchema) Validate() error

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

type AccessConfiguration 

type AccessConfiguration struct {

	// A list of AccessControlList objects.
	//
	// AccessControls is a required field
	AccessControls []*AccessControl `locationName:"accessControls" type:"list" required:"true"`

	// Describes the member relation within the AccessControlList object.
	MemberRelation *string `locationName:"memberRelation" type:"string" enum:"MemberRelation"`
	// contains filtered or unexported fields
}

Used to configure access permissions for a document.

func (AccessConfiguration) GoString 

func (s AccessConfiguration) 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 (*AccessConfiguration) SetAccessControls 

func (s *AccessConfiguration) SetAccessControls(v []*AccessControl) *AccessConfiguration

SetAccessControls sets the AccessControls field's value.

func (*AccessConfiguration) SetMemberRelation 

func (s *AccessConfiguration) SetMemberRelation(v string) *AccessConfiguration

SetMemberRelation sets the MemberRelation field's value.

func (AccessConfiguration) String 

func (s AccessConfiguration) 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 (*AccessConfiguration) Validate 

func (s *AccessConfiguration) Validate() error

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

type AccessControl 

type AccessControl struct {

	// Describes the member relation within a principal list.
	MemberRelation *string `locationName:"memberRelation" type:"string" enum:"MemberRelation"`

	// Contains a list of principals, where a principal can be either a USER or
	// a GROUP. Each principal can be have the following type of document access:
	// ALLOW or DENY.
	//
	// Principals is a required field
	Principals []*Principal `locationName:"principals" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.

func (AccessControl) GoString 

func (s AccessControl) 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 (*AccessControl) SetMemberRelation 

func (s *AccessControl) SetMemberRelation(v string) *AccessControl

SetMemberRelation sets the MemberRelation field's value.

func (*AccessControl) SetPrincipals 

func (s *AccessControl) SetPrincipals(v []*Principal) *AccessControl

SetPrincipals sets the Principals field's value.

func (AccessControl) String 

func (s AccessControl) 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 (*AccessControl) Validate 

func (s *AccessControl) Validate() error

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

type AccessDeniedException 

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

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

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

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 ActionReview 

type ActionReview struct {

	// Field values that an end user needs to provide to Amazon Q Business for Amazon
	// Q Business to perform the requested plugin action.
	Payload map[string]*ActionReviewPayloadField `locationName:"payload" type:"map"`

	// A string used to retain information about the hierarchical contexts within
	// an action review payload.
	PayloadFieldNameSeparator *string `locationName:"payloadFieldNameSeparator" min:"1" type:"string"`

	// The identifier of the plugin associated with the action review.
	PluginId *string `locationName:"pluginId" min:"36" type:"string"`

	// The type of plugin.
	PluginType *string `locationName:"pluginType" type:"string" enum:"PluginType"`
	// contains filtered or unexported fields
}

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

func (ActionReview) GoString 

func (s ActionReview) 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 (*ActionReview) SetPayload 

func (s *ActionReview) SetPayload(v map[string]*ActionReviewPayloadField) *ActionReview

SetPayload sets the Payload field's value.

func (*ActionReview) SetPayloadFieldNameSeparator 

func (s *ActionReview) SetPayloadFieldNameSeparator(v string) *ActionReview

SetPayloadFieldNameSeparator sets the PayloadFieldNameSeparator field's value.

func (*ActionReview) SetPluginId 

func (s *ActionReview) SetPluginId(v string) *ActionReview

SetPluginId sets the PluginId field's value.

func (*ActionReview) SetPluginType 

func (s *ActionReview) SetPluginType(v string) *ActionReview

SetPluginType sets the PluginType field's value.

func (ActionReview) String 

func (s ActionReview) 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 ActionReviewEvent added in v1.51.32 

type ActionReviewEvent struct {

	// The identifier of the conversation with which the action review event is
	// associated.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// Field values that an end user needs to provide to Amazon Q Business for Amazon
	// Q Business to perform the requested plugin action.
	Payload map[string]*ActionReviewPayloadField `locationName:"payload" type:"map"`

	// A string used to retain information about the hierarchical contexts within
	// an action review event payload.
	PayloadFieldNameSeparator *string `locationName:"payloadFieldNameSeparator" min:"1" type:"string"`

	// The identifier of the plugin associated with the action review event.
	PluginId *string `locationName:"pluginId" min:"36" type:"string"`

	// The type of plugin.
	PluginType *string `locationName:"pluginType" type:"string" enum:"PluginType"`

	// The identifier of an Amazon Q Business AI generated associated with the action
	// review event.
	SystemMessageId *string `locationName:"systemMessageId" min:"36" type:"string"`

	// The identifier of the conversation with which the plugin action is associated.
	UserMessageId *string `locationName:"userMessageId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

func (ActionReviewEvent) GoString added in v1.51.32 

func (s ActionReviewEvent) 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 (*ActionReviewEvent) MarshalEvent added in v1.51.32 

func (s *ActionReviewEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ActionReviewEvent) SetConversationId added in v1.51.32 

func (s *ActionReviewEvent) SetConversationId(v string) *ActionReviewEvent

SetConversationId sets the ConversationId field's value.

func (*ActionReviewEvent) SetPayload added in v1.51.32 

func (s *ActionReviewEvent) SetPayload(v map[string]*ActionReviewPayloadField) *ActionReviewEvent

SetPayload sets the Payload field's value.

func (*ActionReviewEvent) SetPayloadFieldNameSeparator added in v1.51.32 

func (s *ActionReviewEvent) SetPayloadFieldNameSeparator(v string) *ActionReviewEvent

SetPayloadFieldNameSeparator sets the PayloadFieldNameSeparator field's value.

func (*ActionReviewEvent) SetPluginId added in v1.51.32 

func (s *ActionReviewEvent) SetPluginId(v string) *ActionReviewEvent

SetPluginId sets the PluginId field's value.

func (*ActionReviewEvent) SetPluginType added in v1.51.32 

func (s *ActionReviewEvent) SetPluginType(v string) *ActionReviewEvent

SetPluginType sets the PluginType field's value.

func (*ActionReviewEvent) SetSystemMessageId added in v1.51.32 

func (s *ActionReviewEvent) SetSystemMessageId(v string) *ActionReviewEvent

SetSystemMessageId sets the SystemMessageId field's value.

func (*ActionReviewEvent) SetUserMessageId added in v1.51.32 

func (s *ActionReviewEvent) SetUserMessageId(v string) *ActionReviewEvent

SetUserMessageId sets the UserMessageId field's value.

func (ActionReviewEvent) String added in v1.51.32 

func (s ActionReviewEvent) 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 (*ActionReviewEvent) UnmarshalEvent added in v1.51.32 

func (s *ActionReviewEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ActionReviewEvent value. This method is only used internally within the SDK's EventStream handling.

type ActionReviewPayloadField 

type ActionReviewPayloadField struct {

	// The expected data format for the action review input field value. For example,
	// in PTO request, from and to would be of datetime allowed format.
	AllowedFormat *string `locationName:"allowedFormat" min:"1" type:"string"`

	// Information about the field values that an end user can use to provide to
	// Amazon Q Business for Amazon Q Business to perform the requested plugin action.
	AllowedValues []*ActionReviewPayloadFieldAllowedValue `locationName:"allowedValues" type:"list"`

	// The field level description of each action review input field. This could
	// be an explanation of the field. In the Amazon Q Business web experience,
	// these descriptions could be used to display as tool tips to help users understand
	// the field.
	DisplayDescription *string `locationName:"displayDescription" min:"1" type:"string"`

	// The name of the field.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The display order of fields in a payload.
	DisplayOrder *int64 `locationName:"displayOrder" type:"integer"`

	// Information about whether the field is required.
	Required *bool `locationName:"required" type:"boolean"`

	// The type of field.
	Type *string `locationName:"type" type:"string" enum:"ActionPayloadFieldType"`
	// contains filtered or unexported fields
}

A user input field in an plugin action review payload.

func (ActionReviewPayloadField) GoString 

func (s ActionReviewPayloadField) 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 (*ActionReviewPayloadField) SetAllowedFormat added in v1.51.32 

func (s *ActionReviewPayloadField) SetAllowedFormat(v string) *ActionReviewPayloadField

SetAllowedFormat sets the AllowedFormat field's value.

func (*ActionReviewPayloadField) SetAllowedValues 

func (s *ActionReviewPayloadField) SetAllowedValues(v []*ActionReviewPayloadFieldAllowedValue) *ActionReviewPayloadField

SetAllowedValues sets the AllowedValues field's value.

func (*ActionReviewPayloadField) SetDisplayDescription added in v1.51.32 

func (s *ActionReviewPayloadField) SetDisplayDescription(v string) *ActionReviewPayloadField

SetDisplayDescription sets the DisplayDescription field's value.

func (*ActionReviewPayloadField) SetDisplayName 

func (s *ActionReviewPayloadField) SetDisplayName(v string) *ActionReviewPayloadField

SetDisplayName sets the DisplayName field's value.

func (*ActionReviewPayloadField) SetDisplayOrder 

func (s *ActionReviewPayloadField) SetDisplayOrder(v int64) *ActionReviewPayloadField

SetDisplayOrder sets the DisplayOrder field's value.

func (*ActionReviewPayloadField) SetRequired 

func (s *ActionReviewPayloadField) SetRequired(v bool) *ActionReviewPayloadField

SetRequired sets the Required field's value.

func (*ActionReviewPayloadField) SetType 

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

SetType sets the Type field's value.

func (ActionReviewPayloadField) String 

func (s ActionReviewPayloadField) 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 ActionReviewPayloadFieldAllowedValue 

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

Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

func (ActionReviewPayloadFieldAllowedValue) GoString 

func (s ActionReviewPayloadFieldAllowedValue) 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 (ActionReviewPayloadFieldAllowedValue) String 

func (s ActionReviewPayloadFieldAllowedValue) 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 Application 

type Application struct {

	// The identifier for the Amazon Q Business application.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// The Unix timestamp when the Amazon Q Business application was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The name of the Amazon Q Business application.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The status of the Amazon Q Business application. The application is ready
	// to use when the status is ACTIVE.
	Status *string `locationName:"status" type:"string" enum:"ApplicationStatus"`

	// The Unix timestamp when the Amazon Q Business application was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information for an Amazon Q Business application.

func (Application) GoString 

func (s Application) 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 (*Application) SetApplicationId 

func (s *Application) SetApplicationId(v string) *Application

SetApplicationId sets the ApplicationId field's value.

func (*Application) SetCreatedAt 

func (s *Application) SetCreatedAt(v time.Time) *Application

SetCreatedAt sets the CreatedAt field's value.

func (*Application) SetDisplayName 

func (s *Application) SetDisplayName(v string) *Application

SetDisplayName sets the DisplayName field's value.

func (*Application) SetStatus 

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

SetStatus sets the Status field's value.

func (*Application) SetUpdatedAt 

func (s *Application) SetUpdatedAt(v time.Time) *Application

SetUpdatedAt sets the UpdatedAt field's value.

func (Application) String 

func (s Application) 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 AppliedAttachmentsConfiguration 

type AppliedAttachmentsConfiguration struct {

	// Information about whether file upload during chat functionality is activated
	// for your application.
	AttachmentsControlMode *string `locationName:"attachmentsControlMode" type:"string" enum:"AttachmentsControlMode"`
	// contains filtered or unexported fields
}

Configuration information about the file upload during chat feature for your application.

func (AppliedAttachmentsConfiguration) GoString 

func (s AppliedAttachmentsConfiguration) 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 (*AppliedAttachmentsConfiguration) SetAttachmentsControlMode 

func (s *AppliedAttachmentsConfiguration) SetAttachmentsControlMode(v string) *AppliedAttachmentsConfiguration

SetAttachmentsControlMode sets the AttachmentsControlMode field's value.

func (AppliedAttachmentsConfiguration) String 

func (s AppliedAttachmentsConfiguration) 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 AppliedCreatorModeConfiguration added in v1.51.23 

type AppliedCreatorModeConfiguration struct {

	// Information about whether creator mode is enabled or disabled for an Amazon
	// Q Business application.
	//
	// CreatorModeControl is a required field
	CreatorModeControl *string `locationName:"creatorModeControl" type:"string" required:"true" enum:"CreatorModeControl"`
	// contains filtered or unexported fields
}

The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.

For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope).

func (AppliedCreatorModeConfiguration) GoString added in v1.51.23 

func (s AppliedCreatorModeConfiguration) 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 (*AppliedCreatorModeConfiguration) SetCreatorModeControl added in v1.51.23 

func (s *AppliedCreatorModeConfiguration) SetCreatorModeControl(v string) *AppliedCreatorModeConfiguration

SetCreatorModeControl sets the CreatorModeControl field's value.

func (AppliedCreatorModeConfiguration) String added in v1.51.23 

func (s AppliedCreatorModeConfiguration) 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 AttachmentInputEvent added in v1.51.32 

type AttachmentInputEvent struct {

	// A file directly uploaded into a web experience chat.
	Attachment *AttachmentInput_ `locationName:"attachment" type:"structure"`
	// contains filtered or unexported fields
}

A file input event activated by a end user request to upload files into their web experience chat.

func (AttachmentInputEvent) GoString added in v1.51.32 

func (s AttachmentInputEvent) 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 (*AttachmentInputEvent) MarshalEvent added in v1.51.32 

func (s *AttachmentInputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AttachmentInputEvent) SetAttachment added in v1.51.32 

func (s *AttachmentInputEvent) SetAttachment(v *AttachmentInput_) *AttachmentInputEvent

SetAttachment sets the Attachment field's value.

func (AttachmentInputEvent) String added in v1.51.32 

func (s AttachmentInputEvent) 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 (*AttachmentInputEvent) UnmarshalEvent added in v1.51.32 

func (s *AttachmentInputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AttachmentInputEvent value. This method is only used internally within the SDK's EventStream handling.

type AttachmentInput_ 

type AttachmentInput_ struct {

	// The data contained within the uploaded file.
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

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

A file directly uploaded into a web experience chat.

func (AttachmentInput_) GoString 

func (s AttachmentInput_) 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 (*AttachmentInput_) SetData 

func (s *AttachmentInput_) SetData(v []byte) *AttachmentInput_

SetData sets the Data field's value.

func (*AttachmentInput_) SetName 

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

SetName sets the Name field's value.

func (AttachmentInput_) String 

func (s AttachmentInput_) 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 (*AttachmentInput_) Validate 

func (s *AttachmentInput_) Validate() error

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

type AttachmentOutput_ 

type AttachmentOutput_ struct {

	// An error associated with a file uploaded during chat.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The name of a file uploaded during chat.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The status of a file uploaded during chat.
	Status *string `locationName:"status" type:"string" enum:"AttachmentStatus"`
	// contains filtered or unexported fields
}

The details of a file uploaded during chat.

func (AttachmentOutput_) GoString 

func (s AttachmentOutput_) 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 (*AttachmentOutput_) SetError 

func (s *AttachmentOutput_) SetError(v *ErrorDetail) *AttachmentOutput_

SetError sets the Error field's value.

func (*AttachmentOutput_) SetName 

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

SetName sets the Name field's value.

func (*AttachmentOutput_) SetStatus 

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

SetStatus sets the Status field's value.

func (AttachmentOutput_) String 

func (s AttachmentOutput_) 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 AttachmentsConfiguration 

type AttachmentsConfiguration struct {

	// Status information about whether file upload functionality is activated or
	// deactivated for your end user.
	//
	// AttachmentsControlMode is a required field
	AttachmentsControlMode *string `locationName:"attachmentsControlMode" type:"string" required:"true" enum:"AttachmentsControlMode"`
	// contains filtered or unexported fields
}

Configuration information for the file upload during chat feature.

func (AttachmentsConfiguration) GoString 

func (s AttachmentsConfiguration) 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 (*AttachmentsConfiguration) SetAttachmentsControlMode 

func (s *AttachmentsConfiguration) SetAttachmentsControlMode(v string) *AttachmentsConfiguration

SetAttachmentsControlMode sets the AttachmentsControlMode field's value.

func (AttachmentsConfiguration) String 

func (s AttachmentsConfiguration) 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 (*AttachmentsConfiguration) Validate 

func (s *AttachmentsConfiguration) Validate() error

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

type AttributeFilter 

type AttributeFilter struct {

	// Performs a logical AND operation on all supplied filters.
	AndAllFilters []*AttributeFilter `locationName:"andAllFilters" type:"list"`

	// Returns true when a document contains all the specified document attributes
	// or metadata fields. Supported for the following document attribute value
	// types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// stringListValue.
	ContainsAll *DocumentAttribute `locationName:"containsAll" type:"structure"`

	// Returns true when a document contains any of the specified document attributes
	// or metadata fields. Supported for the following document attribute value
	// types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// stringListValue.
	ContainsAny *DocumentAttribute `locationName:"containsAny" type:"structure"`

	// Performs an equals operation on two document attributes or metadata fields.
	// Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// dateValue, longValue, stringListValue and stringValue.
	EqualsTo *DocumentAttribute `locationName:"equalsTo" type:"structure"`

	// Performs a greater than operation on two document attributes or metadata
	// fields. Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// dateValue and longValue.
	GreaterThan *DocumentAttribute `locationName:"greaterThan" type:"structure"`

	// Performs a greater or equals than operation on two document attributes or
	// metadata fields. Supported for the following document attribute value types
	// (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// dateValue and longValue.
	GreaterThanOrEquals *DocumentAttribute `locationName:"greaterThanOrEquals" type:"structure"`

	// Performs a less than operation on two document attributes or metadata fields.
	// Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// dateValue and longValue.
	LessThan *DocumentAttribute `locationName:"lessThan" type:"structure"`

	// Performs a less than or equals operation on two document attributes or metadata
	// fields.Supported for the following document attribute value type (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// dateValue and longValue.
	LessThanOrEquals *DocumentAttribute `locationName:"lessThanOrEquals" type:"structure"`

	// Performs a logical NOT operation on all supplied filters.
	NotFilter *AttributeFilter `locationName:"notFilter" type:"structure"`

	// Performs a logical OR operation on all supplied filters.
	OrAllFilters []*AttributeFilter `locationName:"orAllFilters" type:"list"`
	// contains filtered or unexported fields
}

Enables filtering of responses based on document attributes or metadata fields.

func (AttributeFilter) GoString 

func (s AttributeFilter) 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 (*AttributeFilter) SetAndAllFilters 

func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter

SetAndAllFilters sets the AndAllFilters field's value.

func (*AttributeFilter) SetContainsAll 

func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter

SetContainsAll sets the ContainsAll field's value.

func (*AttributeFilter) SetContainsAny 

func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter

SetContainsAny sets the ContainsAny field's value.

func (*AttributeFilter) SetEqualsTo 

func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter

SetEqualsTo sets the EqualsTo field's value.

func (*AttributeFilter) SetGreaterThan 

func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter

SetGreaterThan sets the GreaterThan field's value.

func (*AttributeFilter) SetGreaterThanOrEquals 

func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter

SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value.

func (*AttributeFilter) SetLessThan 

func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter

SetLessThan sets the LessThan field's value.

func (*AttributeFilter) SetLessThanOrEquals 

func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter

SetLessThanOrEquals sets the LessThanOrEquals field's value.

func (*AttributeFilter) SetNotFilter 

func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter

SetNotFilter sets the NotFilter field's value.

func (*AttributeFilter) SetOrAllFilters 

func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter

SetOrAllFilters sets the OrAllFilters field's value.

func (AttributeFilter) String 

func (s AttributeFilter) 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 (*AttributeFilter) Validate 

func (s *AttributeFilter) Validate() error

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

type AuthChallengeRequest added in v1.51.32 

type AuthChallengeRequest struct {

	// The URL sent by Amazon Q Business to the third party authentication server
	// to authenticate a custom plugin user through an OAuth protocol.
	//
	// AuthorizationUrl is a required field
	AuthorizationUrl *string `locationName:"authorizationUrl" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.

func (AuthChallengeRequest) GoString added in v1.51.32 

func (s AuthChallengeRequest) 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 (*AuthChallengeRequest) SetAuthorizationUrl added in v1.51.32 

func (s *AuthChallengeRequest) SetAuthorizationUrl(v string) *AuthChallengeRequest

SetAuthorizationUrl sets the AuthorizationUrl field's value.

func (AuthChallengeRequest) String added in v1.51.32 

func (s AuthChallengeRequest) 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 AuthChallengeRequestEvent added in v1.51.32 

type AuthChallengeRequestEvent struct {

	// The URL sent by Amazon Q Business to a third party authentication server
	// in response to an authentication verification event activated by an end user
	// request to use a custom plugin.
	//
	// AuthorizationUrl is a required field
	AuthorizationUrl *string `locationName:"authorizationUrl" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (AuthChallengeRequestEvent) GoString added in v1.51.32 

func (s AuthChallengeRequestEvent) 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 (*AuthChallengeRequestEvent) MarshalEvent added in v1.51.32 

func (s *AuthChallengeRequestEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AuthChallengeRequestEvent) SetAuthorizationUrl added in v1.51.32 

func (s *AuthChallengeRequestEvent) SetAuthorizationUrl(v string) *AuthChallengeRequestEvent

SetAuthorizationUrl sets the AuthorizationUrl field's value.

func (AuthChallengeRequestEvent) String added in v1.51.32 

func (s AuthChallengeRequestEvent) 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 (*AuthChallengeRequestEvent) UnmarshalEvent added in v1.51.32 

func (s *AuthChallengeRequestEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AuthChallengeRequestEvent value. This method is only used internally within the SDK's EventStream handling.

type AuthChallengeResponse added in v1.51.32 

type AuthChallengeResponse struct {

	// The mapping of key-value pairs in an authentication challenge response.
	//
	// ResponseMap is a required field
	ResponseMap map[string]*string `locationName:"responseMap" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.

func (AuthChallengeResponse) GoString added in v1.51.32 

func (s AuthChallengeResponse) 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 (*AuthChallengeResponse) SetResponseMap added in v1.51.32 

func (s *AuthChallengeResponse) SetResponseMap(v map[string]*string) *AuthChallengeResponse

SetResponseMap sets the ResponseMap field's value.

func (AuthChallengeResponse) String added in v1.51.32 

func (s AuthChallengeResponse) 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 (*AuthChallengeResponse) Validate added in v1.51.32 

func (s *AuthChallengeResponse) Validate() error

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

type AuthChallengeResponseEvent added in v1.51.32 

type AuthChallengeResponseEvent struct {

	// The mapping of key-value pairs in an authentication challenge response.
	//
	// ResponseMap is a required field
	ResponseMap map[string]*string `locationName:"responseMap" type:"map" required:"true"`
	// contains filtered or unexported fields
}

An authentication verification event response by a third party authentication server to Amazon Q Business.

func (AuthChallengeResponseEvent) GoString added in v1.51.32 

func (s AuthChallengeResponseEvent) 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 (*AuthChallengeResponseEvent) MarshalEvent added in v1.51.32 

func (s *AuthChallengeResponseEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*AuthChallengeResponseEvent) SetResponseMap added in v1.51.32 

func (s *AuthChallengeResponseEvent) SetResponseMap(v map[string]*string) *AuthChallengeResponseEvent

SetResponseMap sets the ResponseMap field's value.

func (AuthChallengeResponseEvent) String added in v1.51.32 

func (s AuthChallengeResponseEvent) 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 (*AuthChallengeResponseEvent) UnmarshalEvent added in v1.51.32 

func (s *AuthChallengeResponseEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the AuthChallengeResponseEvent value. This method is only used internally within the SDK's EventStream handling.

type BasicAuthConfiguration 

type BasicAuthConfiguration struct {

	// The ARN of an IAM role used by Amazon Q Business to access the basic authentication
	// credentials stored in a Secrets Manager secret.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The ARN of the Secrets Manager secret that stores the basic authentication
	// credentials used for plugin configuration..
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the basic authentication credentials used to configure a plugin.

func (BasicAuthConfiguration) GoString 

func (s BasicAuthConfiguration) 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 (*BasicAuthConfiguration) SetRoleArn 

func (s *BasicAuthConfiguration) SetRoleArn(v string) *BasicAuthConfiguration

SetRoleArn sets the RoleArn field's value.

func (*BasicAuthConfiguration) SetSecretArn 

func (s *BasicAuthConfiguration) SetSecretArn(v string) *BasicAuthConfiguration

SetSecretArn sets the SecretArn field's value.

func (BasicAuthConfiguration) String 

func (s BasicAuthConfiguration) 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 (*BasicAuthConfiguration) Validate 

func (s *BasicAuthConfiguration) Validate() error

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

type BatchDeleteDocumentInput 

type BatchDeleteDocumentInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source sync during which the documents were deleted.
	DataSourceSyncId *string `locationName:"dataSourceSyncId" min:"36" type:"string"`

	// Documents deleted from the Amazon Q Business index.
	//
	// Documents is a required field
	Documents []*DeleteDocument `locationName:"documents" type:"list" required:"true"`

	// The identifier of the Amazon Q Business index that contains the documents
	// to delete.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteDocumentInput) GoString 

func (s BatchDeleteDocumentInput) 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 (*BatchDeleteDocumentInput) SetApplicationId 

func (s *BatchDeleteDocumentInput) SetApplicationId(v string) *BatchDeleteDocumentInput

SetApplicationId sets the ApplicationId field's value.

func (*BatchDeleteDocumentInput) SetDataSourceSyncId 

func (s *BatchDeleteDocumentInput) SetDataSourceSyncId(v string) *BatchDeleteDocumentInput

SetDataSourceSyncId sets the DataSourceSyncId field's value.

func (*BatchDeleteDocumentInput) SetDocuments 

func (s *BatchDeleteDocumentInput) SetDocuments(v []*DeleteDocument) *BatchDeleteDocumentInput

SetDocuments sets the Documents field's value.

func (*BatchDeleteDocumentInput) SetIndexId 

func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInput

SetIndexId sets the IndexId field's value.

func (BatchDeleteDocumentInput) String 

func (s BatchDeleteDocumentInput) 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 (*BatchDeleteDocumentInput) Validate 

func (s *BatchDeleteDocumentInput) Validate() error

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

type BatchDeleteDocumentOutput 

type BatchDeleteDocumentOutput struct {

	// A list of documents that couldn't be removed from the Amazon Q Business index.
	// Each entry contains an error message that indicates why the document couldn't
	// be removed from the index.
	FailedDocuments []*FailedDocument `locationName:"failedDocuments" type:"list"`
	// contains filtered or unexported fields
}

func (BatchDeleteDocumentOutput) GoString 

func (s BatchDeleteDocumentOutput) 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 (*BatchDeleteDocumentOutput) SetFailedDocuments 

func (s *BatchDeleteDocumentOutput) SetFailedDocuments(v []*FailedDocument) *BatchDeleteDocumentOutput

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchDeleteDocumentOutput) String 

func (s BatchDeleteDocumentOutput) 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 BatchPutDocumentInput 

type BatchPutDocumentInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source sync during which the documents were added.
	DataSourceSyncId *string `locationName:"dataSourceSyncId" min:"36" type:"string"`

	// One or more documents to add to the index.
	//
	// Documents is a required field
	Documents []*Document `locationName:"documents" min:"1" type:"list" required:"true"`

	// The identifier of the Amazon Q Business index to add the documents to.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

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

func (BatchPutDocumentInput) GoString 

func (s BatchPutDocumentInput) 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 (*BatchPutDocumentInput) SetApplicationId 

func (s *BatchPutDocumentInput) SetApplicationId(v string) *BatchPutDocumentInput

SetApplicationId sets the ApplicationId field's value.

func (*BatchPutDocumentInput) SetDataSourceSyncId 

func (s *BatchPutDocumentInput) SetDataSourceSyncId(v string) *BatchPutDocumentInput

SetDataSourceSyncId sets the DataSourceSyncId field's value.

func (*BatchPutDocumentInput) SetDocuments 

func (s *BatchPutDocumentInput) SetDocuments(v []*Document) *BatchPutDocumentInput

SetDocuments sets the Documents field's value.

func (*BatchPutDocumentInput) SetIndexId 

func (s *BatchPutDocumentInput) SetIndexId(v string) *BatchPutDocumentInput

SetIndexId sets the IndexId field's value.

func (*BatchPutDocumentInput) SetRoleArn 

func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput

SetRoleArn sets the RoleArn field's value.

func (BatchPutDocumentInput) String 

func (s BatchPutDocumentInput) 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 (*BatchPutDocumentInput) Validate 

func (s *BatchPutDocumentInput) Validate() error

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

type BatchPutDocumentOutput 

type BatchPutDocumentOutput struct {

	// A list of documents that were not added to the Amazon Q Business index because
	// the document failed a validation check. Each document contains an error message
	// that indicates why the document couldn't be added to the index.
	FailedDocuments []*FailedDocument `locationName:"failedDocuments" type:"list"`
	// contains filtered or unexported fields
}

func (BatchPutDocumentOutput) GoString 

func (s BatchPutDocumentOutput) 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 (*BatchPutDocumentOutput) SetFailedDocuments 

func (s *BatchPutDocumentOutput) SetFailedDocuments(v []*FailedDocument) *BatchPutDocumentOutput

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchPutDocumentOutput) String 

func (s BatchPutDocumentOutput) 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 BlockedPhrasesConfiguration 

type BlockedPhrasesConfiguration struct {

	// A list of phrases blocked from a Amazon Q Business web experience chat.
	BlockedPhrases []*string `locationName:"blockedPhrases" type:"list"`

	// The configured custom message displayed to an end user informing them that
	// they've used a blocked phrase during chat.
	SystemMessageOverride *string `locationName:"systemMessageOverride" type:"string"`
	// contains filtered or unexported fields
}

Provides information about the phrases blocked from chat by your chat control configuration.

func (BlockedPhrasesConfiguration) GoString 

func (s BlockedPhrasesConfiguration) 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 (*BlockedPhrasesConfiguration) SetBlockedPhrases 

func (s *BlockedPhrasesConfiguration) SetBlockedPhrases(v []*string) *BlockedPhrasesConfiguration

SetBlockedPhrases sets the BlockedPhrases field's value.

func (*BlockedPhrasesConfiguration) SetSystemMessageOverride 

func (s *BlockedPhrasesConfiguration) SetSystemMessageOverride(v string) *BlockedPhrasesConfiguration

SetSystemMessageOverride sets the SystemMessageOverride field's value.

func (BlockedPhrasesConfiguration) String 

func (s BlockedPhrasesConfiguration) 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 BlockedPhrasesConfigurationUpdate 

type BlockedPhrasesConfigurationUpdate struct {

	// Creates or updates a blocked phrases configuration in your Amazon Q Business
	// application.
	BlockedPhrasesToCreateOrUpdate []*string `locationName:"blockedPhrasesToCreateOrUpdate" type:"list"`

	// Deletes a blocked phrases configuration in your Amazon Q Business application.
	BlockedPhrasesToDelete []*string `locationName:"blockedPhrasesToDelete" type:"list"`

	// The configured custom message displayed to your end user when they use blocked
	// phrase during chat.
	SystemMessageOverride *string `locationName:"systemMessageOverride" type:"string"`
	// contains filtered or unexported fields
}

Updates a blocked phrases configuration in your Amazon Q Business application.

func (BlockedPhrasesConfigurationUpdate) GoString 

func (s BlockedPhrasesConfigurationUpdate) 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 (*BlockedPhrasesConfigurationUpdate) SetBlockedPhrasesToCreateOrUpdate 

func (s *BlockedPhrasesConfigurationUpdate) SetBlockedPhrasesToCreateOrUpdate(v []*string) *BlockedPhrasesConfigurationUpdate

SetBlockedPhrasesToCreateOrUpdate sets the BlockedPhrasesToCreateOrUpdate field's value.

func (*BlockedPhrasesConfigurationUpdate) SetBlockedPhrasesToDelete 

func (s *BlockedPhrasesConfigurationUpdate) SetBlockedPhrasesToDelete(v []*string) *BlockedPhrasesConfigurationUpdate

SetBlockedPhrasesToDelete sets the BlockedPhrasesToDelete field's value.

func (*BlockedPhrasesConfigurationUpdate) SetSystemMessageOverride 

func (s *BlockedPhrasesConfigurationUpdate) SetSystemMessageOverride(v string) *BlockedPhrasesConfigurationUpdate

SetSystemMessageOverride sets the SystemMessageOverride field's value.

func (BlockedPhrasesConfigurationUpdate) String 

func (s BlockedPhrasesConfigurationUpdate) 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 ChatEventStream added in v1.51.32 

type ChatEventStream struct {

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

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

ChatEventStream provides the event stream handling for the Chat.

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

func NewChatEventStream added in v1.51.32 

func NewChatEventStream(opts ...func(*ChatEventStream)) *ChatEventStream

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

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

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

es := NewChatEventStream(func(o *ChatEventStream){
    es.Writer = myMockStreamWriter
    es.Reader = myMockStreamReader
})

func (*ChatEventStream) Close added in v1.51.32 

func (es *ChatEventStream) Close() (err error)

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

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

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*ChatEventStream) Err added in v1.51.32 

func (es *ChatEventStream) Err() error

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

func (*ChatEventStream) Events added in v1.51.32 

func (es *ChatEventStream) Events() <-chan ChatOutputStreamEvent

Events returns a channel to read events from.

These events are:

  • ActionReviewEvent
  • AuthChallengeRequestEvent
  • FailedAttachmentEvent
  • MetadataEvent
  • TextOutputEvent
  • ChatOutputStreamUnknownEvent

func (*ChatEventStream) Send added in v1.51.32 

func (es *ChatEventStream) Send(ctx aws.Context, event ChatInputStreamEvent) error

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

These events are:

  • AttachmentInputEvent
  • AuthChallengeResponseEvent
  • ConfigurationEvent
  • EndOfInputEvent
  • TextInputEvent

type ChatInput added in v1.51.32 

type ChatInput struct {

	// The identifier of the Amazon Q Business application linked to a streaming
	// Amazon Q Business conversation.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// A token that you provide to identify the chat input.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string `location:"querystring" locationName:"conversationId" min:"36" type:"string"`

	// The identifier used to associate a user message with a AI generated response.
	ParentMessageId *string `location:"querystring" locationName:"parentMessageId" min:"36" type:"string"`

	// The groups that a user associated with the chat input belongs to.
	UserGroups []*string `location:"querystring" locationName:"userGroups" type:"list"`

	// The identifier of the user attached to the chat input.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ChatInput) GoString added in v1.51.32 

func (s ChatInput) 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 (*ChatInput) SetApplicationId added in v1.51.32 

func (s *ChatInput) SetApplicationId(v string) *ChatInput

SetApplicationId sets the ApplicationId field's value.

func (*ChatInput) SetClientToken added in v1.51.32 

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

SetClientToken sets the ClientToken field's value.

func (*ChatInput) SetConversationId added in v1.51.32 

func (s *ChatInput) SetConversationId(v string) *ChatInput

SetConversationId sets the ConversationId field's value.

func (*ChatInput) SetParentMessageId added in v1.51.32 

func (s *ChatInput) SetParentMessageId(v string) *ChatInput

SetParentMessageId sets the ParentMessageId field's value.

func (*ChatInput) SetUserGroups added in v1.51.32 

func (s *ChatInput) SetUserGroups(v []*string) *ChatInput

SetUserGroups sets the UserGroups field's value.

func (*ChatInput) SetUserId added in v1.51.32 

func (s *ChatInput) SetUserId(v string) *ChatInput

SetUserId sets the UserId field's value.

func (ChatInput) String added in v1.51.32 

func (s ChatInput) 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 (*ChatInput) Validate added in v1.51.32 

func (s *ChatInput) Validate() error

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

type ChatInputStreamEvent added in v1.51.32 

type ChatInputStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

ChatInputStreamEvent groups together all EventStream events writes for ChatInputStream.

These events are:

  • AttachmentInputEvent
  • AuthChallengeResponseEvent
  • ConfigurationEvent
  • EndOfInputEvent
  • TextInputEvent

type ChatInputStreamWriter added in v1.51.32 

type ChatInputStreamWriter interface {
	// Sends writes events to the stream blocking until the event has been
	// written. An error is returned if the write fails.
	Send(aws.Context, ChatInputStreamEvent) error

	// Close will stop the writer writing to the event stream.
	Close() error

	// Returns any error that has occurred while writing to the event stream.
	Err() error
}

ChatInputStreamWriter provides the interface for writing events to the stream. The default implementation for this interface will be ChatInputStream.

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

These events are:

  • AttachmentInputEvent
  • AuthChallengeResponseEvent
  • ConfigurationEvent
  • EndOfInputEvent
  • TextInputEvent

type ChatModeConfiguration added in v1.51.23 

type ChatModeConfiguration struct {

	// Configuration information required to invoke chat in PLUGIN_MODE.
	PluginConfiguration *PluginConfiguration `locationName:"pluginConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope).

func (ChatModeConfiguration) GoString added in v1.51.23 

func (s ChatModeConfiguration) 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 (*ChatModeConfiguration) SetPluginConfiguration added in v1.51.23 

func (s *ChatModeConfiguration) SetPluginConfiguration(v *PluginConfiguration) *ChatModeConfiguration

SetPluginConfiguration sets the PluginConfiguration field's value.

func (ChatModeConfiguration) String added in v1.51.23 

func (s ChatModeConfiguration) 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 (*ChatModeConfiguration) Validate added in v1.51.23 

func (s *ChatModeConfiguration) Validate() error

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

type ChatOutput added in v1.51.32 

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

func (*ChatOutput) GetStream added in v1.51.32 

func (s *ChatOutput) GetStream() *ChatEventStream

GetStream returns the type to interact with the event stream.

func (ChatOutput) GoString added in v1.51.32 

func (s ChatOutput) 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 (ChatOutput) String added in v1.51.32 

func (s ChatOutput) 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 ChatOutputStreamEvent added in v1.51.32 

type ChatOutputStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

ChatOutputStreamEvent groups together all EventStream events writes for ChatOutputStream.

These events are:

  • ActionReviewEvent
  • AuthChallengeRequestEvent
  • FailedAttachmentEvent
  • MetadataEvent
  • TextOutputEvent

type ChatOutputStreamReader added in v1.51.32 

type ChatOutputStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan ChatOutputStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

ChatOutputStreamReader provides the interface for reading to the stream. The default implementation for this interface will be ChatOutputStream.

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

These events are:

  • ActionReviewEvent
  • AuthChallengeRequestEvent
  • FailedAttachmentEvent
  • MetadataEvent
  • TextOutputEvent
  • ChatOutputStreamUnknownEvent

type ChatOutputStreamUnknownEvent added in v1.51.32 

type ChatOutputStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

ChatOutputStreamUnknownEvent provides a failsafe event for the ChatOutputStream group of events when an unknown event is received.

func (*ChatOutputStreamUnknownEvent) MarshalEvent added in v1.51.32 

func (e *ChatOutputStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
	msg eventstream.Message, err error,
)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ChatOutputStreamUnknownEvent) UnmarshalEvent added in v1.51.32 

func (e *ChatOutputStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ChatOutputStream value. This method is only used internally within the SDK's EventStream handling.

type ChatSyncInput 

type ChatSyncInput struct {

	// The identifier of the Amazon Q Business application linked to the Amazon
	// Q Business conversation.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// A list of files uploaded directly during chat. You can upload a maximum of
	// 5 files of upto 10 MB each.
	Attachments []*AttachmentInput_ `locationName:"attachments" min:"1" type:"list"`

	// Enables filtering of Amazon Q Business web experience responses based on
	// document attributes or metadata fields.
	AttributeFilter *AttributeFilter `locationName:"attributeFilter" type:"structure"`

	// An authentication verification event response by a third party authentication
	// server to Amazon Q Business.
	AuthChallengeResponse *AuthChallengeResponse `locationName:"authChallengeResponse" type:"structure"`

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

	// The chat mode configuration for an Amazon Q Business application.
	ChatModeConfiguration *ChatModeConfiguration `locationName:"chatModeConfiguration" type:"structure"`

	// A token that you provide to identify a chat request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// The identifier of the previous system message in a conversation.
	ParentMessageId *string `locationName:"parentMessageId" min:"36" type:"string"`

	// The groups that a user associated with the chat input belongs to.
	UserGroups []*string `location:"querystring" locationName:"userGroups" type:"list"`

	// The identifier of the user attached to the chat input.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`

	// A end user message in a conversation.
	UserMessage *string `locationName:"userMessage" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ChatSyncInput) GoString 

func (s ChatSyncInput) 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 (*ChatSyncInput) SetApplicationId 

func (s *ChatSyncInput) SetApplicationId(v string) *ChatSyncInput

SetApplicationId sets the ApplicationId field's value.

func (*ChatSyncInput) SetAttachments 

func (s *ChatSyncInput) SetAttachments(v []*AttachmentInput_) *ChatSyncInput

SetAttachments sets the Attachments field's value.

func (*ChatSyncInput) SetAttributeFilter 

func (s *ChatSyncInput) SetAttributeFilter(v *AttributeFilter) *ChatSyncInput

SetAttributeFilter sets the AttributeFilter field's value.

func (*ChatSyncInput) SetAuthChallengeResponse added in v1.51.32 

func (s *ChatSyncInput) SetAuthChallengeResponse(v *AuthChallengeResponse) *ChatSyncInput

SetAuthChallengeResponse sets the AuthChallengeResponse field's value.

func (*ChatSyncInput) SetChatMode added in v1.51.23 

func (s *ChatSyncInput) SetChatMode(v string) *ChatSyncInput

SetChatMode sets the ChatMode field's value.

func (*ChatSyncInput) SetChatModeConfiguration added in v1.51.23 

func (s *ChatSyncInput) SetChatModeConfiguration(v *ChatModeConfiguration) *ChatSyncInput

SetChatModeConfiguration sets the ChatModeConfiguration field's value.

func (*ChatSyncInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*ChatSyncInput) SetConversationId 

func (s *ChatSyncInput) SetConversationId(v string) *ChatSyncInput

SetConversationId sets the ConversationId field's value.

func (*ChatSyncInput) SetParentMessageId 

func (s *ChatSyncInput) SetParentMessageId(v string) *ChatSyncInput

SetParentMessageId sets the ParentMessageId field's value.

func (*ChatSyncInput) SetUserGroups 

func (s *ChatSyncInput) SetUserGroups(v []*string) *ChatSyncInput

SetUserGroups sets the UserGroups field's value.

func (*ChatSyncInput) SetUserId 

func (s *ChatSyncInput) SetUserId(v string) *ChatSyncInput

SetUserId sets the UserId field's value.

func (*ChatSyncInput) SetUserMessage 

func (s *ChatSyncInput) SetUserMessage(v string) *ChatSyncInput

SetUserMessage sets the UserMessage field's value.

func (ChatSyncInput) String 

func (s ChatSyncInput) 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 (*ChatSyncInput) Validate 

func (s *ChatSyncInput) Validate() error

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

type ChatSyncOutput 

type ChatSyncOutput struct {

	// A request from Amazon Q Business to the end user for information Amazon Q
	// Business needs to successfully complete a requested plugin action.
	ActionReview *ActionReview `locationName:"actionReview" type:"structure"`

	// An authentication verification event activated by an end user request to
	// use a custom plugin.
	AuthChallengeRequest *AuthChallengeRequest `locationName:"authChallengeRequest" type:"structure"`

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// A list of files which failed to upload during chat.
	FailedAttachments []*AttachmentOutput_ `locationName:"failedAttachments" type:"list"`

	// The source documents used to generate the conversation response.
	SourceAttributions []*SourceAttribution `locationName:"sourceAttributions" type:"list"`

	// An AI-generated message in a conversation.
	SystemMessage *string `locationName:"systemMessage" min:"1" type:"string"`

	// The identifier of an Amazon Q Business AI generated message within the conversation.
	SystemMessageId *string `locationName:"systemMessageId" min:"36" type:"string"`

	// The identifier of an Amazon Q Business end user text input message within
	// the conversation.
	UserMessageId *string `locationName:"userMessageId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (ChatSyncOutput) GoString 

func (s ChatSyncOutput) 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 (*ChatSyncOutput) SetActionReview 

func (s *ChatSyncOutput) SetActionReview(v *ActionReview) *ChatSyncOutput

SetActionReview sets the ActionReview field's value.

func (*ChatSyncOutput) SetAuthChallengeRequest added in v1.51.32 

func (s *ChatSyncOutput) SetAuthChallengeRequest(v *AuthChallengeRequest) *ChatSyncOutput

SetAuthChallengeRequest sets the AuthChallengeRequest field's value.

func (*ChatSyncOutput) SetConversationId 

func (s *ChatSyncOutput) SetConversationId(v string) *ChatSyncOutput

SetConversationId sets the ConversationId field's value.

func (*ChatSyncOutput) SetFailedAttachments 

func (s *ChatSyncOutput) SetFailedAttachments(v []*AttachmentOutput_) *ChatSyncOutput

SetFailedAttachments sets the FailedAttachments field's value.

func (*ChatSyncOutput) SetSourceAttributions 

func (s *ChatSyncOutput) SetSourceAttributions(v []*SourceAttribution) *ChatSyncOutput

SetSourceAttributions sets the SourceAttributions field's value.

func (*ChatSyncOutput) SetSystemMessage 

func (s *ChatSyncOutput) SetSystemMessage(v string) *ChatSyncOutput

SetSystemMessage sets the SystemMessage field's value.

func (*ChatSyncOutput) SetSystemMessageId 

func (s *ChatSyncOutput) SetSystemMessageId(v string) *ChatSyncOutput

SetSystemMessageId sets the SystemMessageId field's value.

func (*ChatSyncOutput) SetUserMessageId 

func (s *ChatSyncOutput) SetUserMessageId(v string) *ChatSyncOutput

SetUserMessageId sets the UserMessageId field's value.

func (ChatSyncOutput) String 

func (s ChatSyncOutput) 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 ConfigurationEvent added in v1.51.32 

type ConfigurationEvent struct {

	// Enables filtering of responses based on document attributes or metadata fields.
	AttributeFilter *AttributeFilter `locationName:"attributeFilter" type:"structure"`

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

	// Configuration information for Amazon Q Business conversation modes.
	//
	// For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html)
	// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope).
	ChatModeConfiguration *ChatModeConfiguration `locationName:"chatModeConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

A configuration event activated by an end user request to select a specific chat mode.

func (ConfigurationEvent) GoString added in v1.51.32 

func (s ConfigurationEvent) 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 (*ConfigurationEvent) MarshalEvent added in v1.51.32 

func (s *ConfigurationEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ConfigurationEvent) SetAttributeFilter added in v1.51.32 

func (s *ConfigurationEvent) SetAttributeFilter(v *AttributeFilter) *ConfigurationEvent

SetAttributeFilter sets the AttributeFilter field's value.

func (*ConfigurationEvent) SetChatMode added in v1.51.32 

func (s *ConfigurationEvent) SetChatMode(v string) *ConfigurationEvent

SetChatMode sets the ChatMode field's value.

func (*ConfigurationEvent) SetChatModeConfiguration added in v1.51.32 

func (s *ConfigurationEvent) SetChatModeConfiguration(v *ChatModeConfiguration) *ConfigurationEvent

SetChatModeConfiguration sets the ChatModeConfiguration field's value.

func (ConfigurationEvent) String added in v1.51.32 

func (s ConfigurationEvent) 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 (*ConfigurationEvent) UnmarshalEvent added in v1.51.32 

func (s *ConfigurationEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ConfigurationEvent value. This method is only used internally within the SDK's EventStream handling.

type ConflictException 

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

	// The message describing a ConflictException.
	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" min:"1" type:"string" required:"true"`

	// The type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

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 ContentBlockerRule 

type ContentBlockerRule struct {

	// The configured custom message displayed to an end user informing them that
	// they've used a blocked phrase during chat.
	SystemMessageOverride *string `locationName:"systemMessageOverride" type:"string"`
	// contains filtered or unexported fields
}

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.

func (ContentBlockerRule) GoString 

func (s ContentBlockerRule) 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 (*ContentBlockerRule) SetSystemMessageOverride 

func (s *ContentBlockerRule) SetSystemMessageOverride(v string) *ContentBlockerRule

SetSystemMessageOverride sets the SystemMessageOverride field's value.

func (ContentBlockerRule) String 

func (s ContentBlockerRule) 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 ContentRetrievalRule 

type ContentRetrievalRule struct {

	// Specifies data sources in a Amazon Q Business application to use for content
	// generation.
	EligibleDataSources []*EligibleDataSource `locationName:"eligibleDataSources" type:"list"`
	// contains filtered or unexported fields
}

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

func (ContentRetrievalRule) GoString 

func (s ContentRetrievalRule) 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 (*ContentRetrievalRule) SetEligibleDataSources 

func (s *ContentRetrievalRule) SetEligibleDataSources(v []*EligibleDataSource) *ContentRetrievalRule

SetEligibleDataSources sets the EligibleDataSources field's value.

func (ContentRetrievalRule) String 

func (s ContentRetrievalRule) 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 (*ContentRetrievalRule) Validate 

func (s *ContentRetrievalRule) Validate() error

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

type Conversation 

type Conversation struct {

	// The identifier of the Amazon Q Business conversation.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// The start time of the conversation.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The title of the conversation.
	Title *string `locationName:"title" type:"string"`
	// contains filtered or unexported fields
}

A conversation in an Amazon Q Business application.

func (Conversation) GoString 

func (s Conversation) 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 (*Conversation) SetConversationId 

func (s *Conversation) SetConversationId(v string) *Conversation

SetConversationId sets the ConversationId field's value.

func (*Conversation) SetStartTime 

func (s *Conversation) SetStartTime(v time.Time) *Conversation

SetStartTime sets the StartTime field's value.

func (*Conversation) SetTitle 

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

SetTitle sets the Title field's value.

func (Conversation) String 

func (s Conversation) 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 CreateApplicationInput 

type CreateApplicationInput struct {

	// An option to allow end users to upload files directly during chat.
	AttachmentsConfiguration *AttachmentsConfiguration `locationName:"attachmentsConfiguration" type:"structure"`

	// A token that you provide to identify the request to create your Amazon Q
	// Business application.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description for the Amazon Q Business application.
	Description *string `locationName:"description" type:"string"`

	// A name for the Amazon Q Business application.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"`

	// The identifier of the KMS key that is used to encrypt your data. Amazon Q
	// Business doesn't support asymmetric keys.
	EncryptionConfiguration *EncryptionConfiguration `locationName:"encryptionConfiguration" type:"structure"`

	// The Amazon Resource Name (ARN) of the IAM Identity Center instance you are
	// either creating for—or connecting to—your Amazon Q Business application.
	IdentityCenterInstanceArn *string `locationName:"identityCenterInstanceArn" min:"10" type:"string"`

	// Configuration information about chat response personalization. For more information,
	// see Personalizing chat responses (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html)
	PersonalizationConfiguration *PersonalizationConfiguration `locationName:"personalizationConfiguration" type:"structure"`

	// An option to allow end users to create and use Amazon Q Apps in the web experience.
	QAppsConfiguration *QAppsConfiguration `locationName:"qAppsConfiguration" type:"structure"`

	// The Amazon Resource Name (ARN) of an IAM role with permissions to access
	// your Amazon CloudWatch logs and metrics.
	RoleArn *string `locationName:"roleArn" type:"string"`

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

func (CreateApplicationInput) GoString 

func (s CreateApplicationInput) 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 (*CreateApplicationInput) SetAttachmentsConfiguration 

func (s *CreateApplicationInput) SetAttachmentsConfiguration(v *AttachmentsConfiguration) *CreateApplicationInput

SetAttachmentsConfiguration sets the AttachmentsConfiguration field's value.

func (*CreateApplicationInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateApplicationInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateApplicationInput) SetDisplayName 

func (s *CreateApplicationInput) SetDisplayName(v string) *CreateApplicationInput

SetDisplayName sets the DisplayName field's value.

func (*CreateApplicationInput) SetEncryptionConfiguration 

func (s *CreateApplicationInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *CreateApplicationInput

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*CreateApplicationInput) SetIdentityCenterInstanceArn added in v1.51.23 

func (s *CreateApplicationInput) SetIdentityCenterInstanceArn(v string) *CreateApplicationInput

SetIdentityCenterInstanceArn sets the IdentityCenterInstanceArn field's value.

func (*CreateApplicationInput) SetPersonalizationConfiguration added in v1.54.15 

func (s *CreateApplicationInput) SetPersonalizationConfiguration(v *PersonalizationConfiguration) *CreateApplicationInput

SetPersonalizationConfiguration sets the PersonalizationConfiguration field's value.

func (*CreateApplicationInput) SetQAppsConfiguration added in v1.54.7 

func (s *CreateApplicationInput) SetQAppsConfiguration(v *QAppsConfiguration) *CreateApplicationInput

SetQAppsConfiguration sets the QAppsConfiguration field's value.

func (*CreateApplicationInput) SetRoleArn 

func (s *CreateApplicationInput) SetRoleArn(v string) *CreateApplicationInput

SetRoleArn sets the RoleArn field's value.

func (*CreateApplicationInput) SetTags 

func (s *CreateApplicationInput) SetTags(v []*Tag) *CreateApplicationInput

SetTags sets the Tags field's value.

func (CreateApplicationInput) String 

func (s CreateApplicationInput) 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 (*CreateApplicationInput) Validate 

func (s *CreateApplicationInput) Validate() error

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

type CreateApplicationOutput 

type CreateApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application.
	ApplicationArn *string `locationName:"applicationArn" type:"string"`

	// The identifier of the Amazon Q Business application.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateApplicationOutput) GoString 

func (s CreateApplicationOutput) 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 (*CreateApplicationOutput) SetApplicationArn 

func (s *CreateApplicationOutput) SetApplicationArn(v string) *CreateApplicationOutput

SetApplicationArn sets the ApplicationArn field's value.

func (*CreateApplicationOutput) SetApplicationId 

func (s *CreateApplicationOutput) SetApplicationId(v string) *CreateApplicationOutput

SetApplicationId sets the ApplicationId field's value.

func (CreateApplicationOutput) String 

func (s CreateApplicationOutput) 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 CreateIndexInput 

type CreateIndexInput struct {

	// The identifier of the Amazon Q Business application using the index.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The capacity units you want to provision for your index. You can add and
	// remove capacity to fit your usage needs.
	CapacityConfiguration *IndexCapacityConfiguration `locationName:"capacityConfiguration" type:"structure"`

	// A token that you provide to identify the request to create an index. Multiple
	// calls to the CreateIndex API with the same client token will create only
	// one index.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// A description for the Amazon Q Business index.
	Description *string `locationName:"description" type:"string"`

	// A name for the Amazon Q Business index.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"`

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

	// The index type that's suitable for your needs. For more information on what's
	// included in each type of index, see Amazon Q Business tiers (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers).
	Type *string `locationName:"type" type:"string" enum:"IndexType"`
	// contains filtered or unexported fields
}

func (CreateIndexInput) GoString 

func (s CreateIndexInput) 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 (*CreateIndexInput) SetApplicationId 

func (s *CreateIndexInput) SetApplicationId(v string) *CreateIndexInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateIndexInput) SetCapacityConfiguration 

func (s *CreateIndexInput) SetCapacityConfiguration(v *IndexCapacityConfiguration) *CreateIndexInput

SetCapacityConfiguration sets the CapacityConfiguration field's value.

func (*CreateIndexInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateIndexInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateIndexInput) SetDisplayName 

func (s *CreateIndexInput) SetDisplayName(v string) *CreateIndexInput

SetDisplayName sets the DisplayName field's value.

func (*CreateIndexInput) SetTags 

func (s *CreateIndexInput) SetTags(v []*Tag) *CreateIndexInput

SetTags sets the Tags field's value.

func (*CreateIndexInput) SetType added in v1.51.32 

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

SetType sets the Type field's value.

func (CreateIndexInput) String 

func (s CreateIndexInput) 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 (*CreateIndexInput) Validate 

func (s *CreateIndexInput) Validate() error

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

type CreateIndexOutput 

type CreateIndexOutput struct {

	// The Amazon Resource Name (ARN) of an Amazon Q Business index.
	IndexArn *string `locationName:"indexArn" type:"string"`

	// The identifier for the Amazon Q Business index.
	IndexId *string `locationName:"indexId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateIndexOutput) GoString 

func (s CreateIndexOutput) 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 (*CreateIndexOutput) SetIndexArn 

func (s *CreateIndexOutput) SetIndexArn(v string) *CreateIndexOutput

SetIndexArn sets the IndexArn field's value.

func (*CreateIndexOutput) SetIndexId 

func (s *CreateIndexOutput) SetIndexId(v string) *CreateIndexOutput

SetIndexId sets the IndexId field's value.

func (CreateIndexOutput) String 

func (s CreateIndexOutput) 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 CreatePluginInput 

type CreatePluginInput struct {

	// The identifier of the application that will contain the plugin.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// Authentication configuration information for an Amazon Q Business plugin.
	//
	// AuthConfiguration is a required field
	AuthConfiguration *PluginAuthConfiguration `locationName:"authConfiguration" type:"structure" required:"true"`

	// A token that you provide to identify the request to create your Amazon Q
	// Business plugin.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// Contains configuration for a custom plugin.
	CustomPluginConfiguration *CustomPluginConfiguration `locationName:"customPluginConfiguration" type:"structure"`

	// A the name for your plugin.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"`

	// The source URL used for plugin configuration.
	ServerUrl *string `locationName:"serverUrl" min:"1" type:"string"`

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

	// The type of plugin you want to create.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"PluginType"`
	// contains filtered or unexported fields
}

func (CreatePluginInput) GoString 

func (s CreatePluginInput) 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 (*CreatePluginInput) SetApplicationId 

func (s *CreatePluginInput) SetApplicationId(v string) *CreatePluginInput

SetApplicationId sets the ApplicationId field's value.

func (*CreatePluginInput) SetAuthConfiguration 

func (s *CreatePluginInput) SetAuthConfiguration(v *PluginAuthConfiguration) *CreatePluginInput

SetAuthConfiguration sets the AuthConfiguration field's value.

func (*CreatePluginInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreatePluginInput) SetCustomPluginConfiguration added in v1.51.32 

func (s *CreatePluginInput) SetCustomPluginConfiguration(v *CustomPluginConfiguration) *CreatePluginInput

SetCustomPluginConfiguration sets the CustomPluginConfiguration field's value.

func (*CreatePluginInput) SetDisplayName 

func (s *CreatePluginInput) SetDisplayName(v string) *CreatePluginInput

SetDisplayName sets the DisplayName field's value.

func (*CreatePluginInput) SetServerUrl 

func (s *CreatePluginInput) SetServerUrl(v string) *CreatePluginInput

SetServerUrl sets the ServerUrl field's value.

func (*CreatePluginInput) SetTags 

func (s *CreatePluginInput) SetTags(v []*Tag) *CreatePluginInput

SetTags sets the Tags field's value.

func (*CreatePluginInput) SetType 

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

SetType sets the Type field's value.

func (CreatePluginInput) String 

func (s CreatePluginInput) 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 (*CreatePluginInput) Validate 

func (s *CreatePluginInput) Validate() error

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

type CreatePluginOutput 

type CreatePluginOutput struct {

	// The current status of a plugin. A plugin is modified asynchronously.
	BuildStatus *string `locationName:"buildStatus" type:"string" enum:"PluginBuildStatus"`

	// The Amazon Resource Name (ARN) of a plugin.
	PluginArn *string `locationName:"pluginArn" type:"string"`

	// The identifier of the plugin created.
	PluginId *string `locationName:"pluginId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreatePluginOutput) GoString 

func (s CreatePluginOutput) 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 (*CreatePluginOutput) SetBuildStatus added in v1.51.32 

func (s *CreatePluginOutput) SetBuildStatus(v string) *CreatePluginOutput

SetBuildStatus sets the BuildStatus field's value.

func (*CreatePluginOutput) SetPluginArn 

func (s *CreatePluginOutput) SetPluginArn(v string) *CreatePluginOutput

SetPluginArn sets the PluginArn field's value.

func (*CreatePluginOutput) SetPluginId 

func (s *CreatePluginOutput) SetPluginId(v string) *CreatePluginOutput

SetPluginId sets the PluginId field's value.

func (CreatePluginOutput) String 

func (s CreatePluginOutput) 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 CreateRetrieverInput 

type CreateRetrieverInput struct {

	// The identifier of your Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// A token that you provide to identify the request to create your Amazon Q
	// Business application retriever.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// Provides information on how the retriever used for your Amazon Q Business
	// application is configured.
	//
	// Configuration is a required field
	Configuration *RetrieverConfiguration `locationName:"configuration" type:"structure" required:"true"`

	// The name of your retriever.
	//
	// DisplayName is a required field
	DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"`

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

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

	// The type of retriever you are using.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"RetrieverType"`
	// contains filtered or unexported fields
}

func (CreateRetrieverInput) GoString 

func (s CreateRetrieverInput) 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 (*CreateRetrieverInput) SetApplicationId 

func (s *CreateRetrieverInput) SetApplicationId(v string) *CreateRetrieverInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateRetrieverInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateRetrieverInput) SetConfiguration 

func (s *CreateRetrieverInput) SetConfiguration(v *RetrieverConfiguration) *CreateRetrieverInput

SetConfiguration sets the Configuration field's value.

func (*CreateRetrieverInput) SetDisplayName 

func (s *CreateRetrieverInput) SetDisplayName(v string) *CreateRetrieverInput

SetDisplayName sets the DisplayName field's value.

func (*CreateRetrieverInput) SetRoleArn 

func (s *CreateRetrieverInput) SetRoleArn(v string) *CreateRetrieverInput

SetRoleArn sets the RoleArn field's value.

func (*CreateRetrieverInput) SetTags 

func (s *CreateRetrieverInput) SetTags(v []*Tag) *CreateRetrieverInput

SetTags sets the Tags field's value.

func (*CreateRetrieverInput) SetType 

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

SetType sets the Type field's value.

func (CreateRetrieverInput) String 

func (s CreateRetrieverInput) 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 (*CreateRetrieverInput) Validate 

func (s *CreateRetrieverInput) Validate() error

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

type CreateRetrieverOutput 

type CreateRetrieverOutput struct {

	// The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
	RetrieverArn *string `locationName:"retrieverArn" type:"string"`

	// The identifier of the retriever you are using.
	RetrieverId *string `locationName:"retrieverId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateRetrieverOutput) GoString 

func (s CreateRetrieverOutput) 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 (*CreateRetrieverOutput) SetRetrieverArn 

func (s *CreateRetrieverOutput) SetRetrieverArn(v string) *CreateRetrieverOutput

SetRetrieverArn sets the RetrieverArn field's value.

func (*CreateRetrieverOutput) SetRetrieverId 

func (s *CreateRetrieverOutput) SetRetrieverId(v string) *CreateRetrieverOutput

SetRetrieverId sets the RetrieverId field's value.

func (CreateRetrieverOutput) String 

func (s CreateRetrieverOutput) 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 CreateUserInput 

type CreateUserInput struct {

	// The identifier of the application for which the user mapping will be created.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// A token that you provide to identify the request to create your Amazon Q
	// Business user mapping.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The list of user aliases in the mapping.
	UserAliases []*UserAlias `locationName:"userAliases" type:"list"`

	// The user emails attached to a user mapping.
	//
	// UserId is a required field
	UserId *string `locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString 

func (s CreateUserInput) 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 (*CreateUserInput) SetApplicationId 

func (s *CreateUserInput) SetApplicationId(v string) *CreateUserInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateUserInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateUserInput) SetUserAliases 

func (s *CreateUserInput) SetUserAliases(v []*UserAlias) *CreateUserInput

SetUserAliases sets the UserAliases field's value.

func (*CreateUserInput) SetUserId 

func (s *CreateUserInput) SetUserId(v string) *CreateUserInput

SetUserId sets the UserId field's value.

func (CreateUserInput) String 

func (s CreateUserInput) 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 (*CreateUserInput) Validate 

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput 

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

func (CreateUserOutput) GoString 

func (s CreateUserOutput) 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 (CreateUserOutput) String 

func (s CreateUserOutput) 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 CreateWebExperienceInput 

type CreateWebExperienceInput struct {

	// The identifier of the Amazon Q Business web experience.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// A token you provide to identify a request to create an Amazon Q Business
	// web experience.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the service role attached to your web experience.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// Determines whether sample prompts are enabled in the web experience for an
	// end user.
	SamplePromptsControlMode *string `locationName:"samplePromptsControlMode" type:"string" enum:"WebExperienceSamplePromptsControlMode"`

	// A subtitle to personalize your Amazon Q Business web experience.
	Subtitle *string `locationName:"subtitle" type:"string"`

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

	// The title for your Amazon Q Business web experience.
	Title *string `locationName:"title" type:"string"`

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

func (CreateWebExperienceInput) GoString 

func (s CreateWebExperienceInput) 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 (*CreateWebExperienceInput) SetApplicationId 

func (s *CreateWebExperienceInput) SetApplicationId(v string) *CreateWebExperienceInput

SetApplicationId sets the ApplicationId field's value.

func (*CreateWebExperienceInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateWebExperienceInput) SetRoleArn added in v1.51.23 

func (s *CreateWebExperienceInput) SetRoleArn(v string) *CreateWebExperienceInput

SetRoleArn sets the RoleArn field's value.

func (*CreateWebExperienceInput) SetSamplePromptsControlMode 

func (s *CreateWebExperienceInput) SetSamplePromptsControlMode(v string) *CreateWebExperienceInput

SetSamplePromptsControlMode sets the SamplePromptsControlMode field's value.

func (*CreateWebExperienceInput) SetSubtitle 

func (s *CreateWebExperienceInput) SetSubtitle(v string) *CreateWebExperienceInput

SetSubtitle sets the Subtitle field's value.

func (*CreateWebExperienceInput) SetTags 

func (s *CreateWebExperienceInput) SetTags(v []*Tag) *CreateWebExperienceInput

SetTags sets the Tags field's value.

func (*CreateWebExperienceInput) SetTitle 

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

SetTitle sets the Title field's value.

func (*CreateWebExperienceInput) SetWelcomeMessage 

func (s *CreateWebExperienceInput) SetWelcomeMessage(v string) *CreateWebExperienceInput

SetWelcomeMessage sets the WelcomeMessage field's value.

func (CreateWebExperienceInput) String 

func (s CreateWebExperienceInput) 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 (*CreateWebExperienceInput) Validate 

func (s *CreateWebExperienceInput) Validate() error

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

type CreateWebExperienceOutput 

type CreateWebExperienceOutput struct {

	// The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
	WebExperienceArn *string `locationName:"webExperienceArn" type:"string"`

	// The identifier of the Amazon Q Business web experience.
	WebExperienceId *string `locationName:"webExperienceId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateWebExperienceOutput) GoString 

func (s CreateWebExperienceOutput) 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 (*CreateWebExperienceOutput) SetWebExperienceArn 

func (s *CreateWebExperienceOutput) SetWebExperienceArn(v string) *CreateWebExperienceOutput

SetWebExperienceArn sets the WebExperienceArn field's value.

func (*CreateWebExperienceOutput) SetWebExperienceId 

func (s *CreateWebExperienceOutput) SetWebExperienceId(v string) *CreateWebExperienceOutput

SetWebExperienceId sets the WebExperienceId field's value.

func (CreateWebExperienceOutput) String 

func (s CreateWebExperienceOutput) 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 CreatorModeConfiguration added in v1.51.23 

type CreatorModeConfiguration struct {

	// Status information about whether CREATOR_MODE has been enabled or disabled.
	// The default status is DISABLED.
	//
	// CreatorModeControl is a required field
	CreatorModeControl *string `locationName:"creatorModeControl" type:"string" required:"true" enum:"CreatorModeControl"`
	// contains filtered or unexported fields
}

Configuration information required to invoke chat in CREATOR_MODE.

For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope).

func (CreatorModeConfiguration) GoString added in v1.51.23 

func (s CreatorModeConfiguration) 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 (*CreatorModeConfiguration) SetCreatorModeControl added in v1.51.23 

func (s *CreatorModeConfiguration) SetCreatorModeControl(v string) *CreatorModeConfiguration

SetCreatorModeControl sets the CreatorModeControl field's value.

func (CreatorModeConfiguration) String added in v1.51.23 

func (s CreatorModeConfiguration) 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 (*CreatorModeConfiguration) Validate added in v1.51.23 

func (s *CreatorModeConfiguration) Validate() error

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

type CustomPluginConfiguration added in v1.51.32 

type CustomPluginConfiguration struct {

	// Contains either details about the S3 object containing the OpenAPI schema
	// for the action group or the JSON or YAML-formatted payload defining the schema.
	//
	// ApiSchema is a required field
	ApiSchema *APISchema `locationName:"apiSchema" type:"structure" required:"true"`

	// The type of OpenAPI schema to use.
	//
	// ApiSchemaType is a required field
	ApiSchemaType *string `locationName:"apiSchemaType" type:"string" required:"true" enum:"APISchemaType"`

	// A description for your custom plugin configuration.
	//
	// Description is a required field
	Description *string `locationName:"description" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information required to create a custom plugin.

func (CustomPluginConfiguration) GoString added in v1.51.32 

func (s CustomPluginConfiguration) 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 (*CustomPluginConfiguration) SetApiSchema added in v1.51.32 

func (s *CustomPluginConfiguration) SetApiSchema(v *APISchema) *CustomPluginConfiguration

SetApiSchema sets the ApiSchema field's value.

func (*CustomPluginConfiguration) SetApiSchemaType added in v1.51.32 

func (s *CustomPluginConfiguration) SetApiSchemaType(v string) *CustomPluginConfiguration

SetApiSchemaType sets the ApiSchemaType field's value.

func (*CustomPluginConfiguration) SetDescription added in v1.51.32 

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

SetDescription sets the Description field's value.

func (CustomPluginConfiguration) String added in v1.51.32 

func (s CustomPluginConfiguration) 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 (*CustomPluginConfiguration) Validate added in v1.51.32 

func (s *CustomPluginConfiguration) Validate() error

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

type DataSource 

type DataSource struct {

	// The Unix timestamp when the Amazon Q Business data source was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The identifier of the Amazon Q Business data source.
	DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"`

	// The name of the Amazon Q Business data source.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The status of the Amazon Q Business data source.
	Status *string `locationName:"status" type:"string" enum:"DataSourceStatus"`

	// The type of the Amazon Q Business data source.
	Type *string `locationName:"type" min:"1" type:"string"`

	// The Unix timestamp when the Amazon Q Business data source was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

A data source in an Amazon Q Business application.

func (DataSource) GoString 

func (s DataSource) 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 (*DataSource) SetCreatedAt 

func (s *DataSource) SetCreatedAt(v time.Time) *DataSource

SetCreatedAt sets the CreatedAt field's value.

func (*DataSource) SetDataSourceId 

func (s *DataSource) SetDataSourceId(v string) *DataSource

SetDataSourceId sets the DataSourceId field's value.

func (*DataSource) SetDisplayName 

func (s *DataSource) SetDisplayName(v string) *DataSource

SetDisplayName sets the DisplayName field's value.

func (*DataSource) SetStatus 

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

SetStatus sets the Status field's value.

func (*DataSource) SetType 

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

SetType sets the Type field's value.

func (*DataSource) SetUpdatedAt 

func (s *DataSource) SetUpdatedAt(v time.Time) *DataSource

SetUpdatedAt sets the UpdatedAt field's value.

func (DataSource) String 

func (s DataSource) 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 DataSourceSyncJob 

type DataSourceSyncJob struct {

	// If the reason that the synchronization failed is due to an error with the
	// underlying data source, this field contains a code that identifies the error.
	DataSourceErrorCode *string `locationName:"dataSourceErrorCode" min:"1" type:"string"`

	// The Unix timestamp when the synchronization job completed.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// If the Status field is set to FAILED, the ErrorCode field indicates the reason
	// the synchronization failed.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The identifier of a data source synchronization job.
	ExecutionId *string `locationName:"executionId" min:"36" type:"string"`

	// Maps a batch delete document request to a specific data source sync job.
	// This is optional and should only be supplied when documents are deleted by
	// a data source connector.
	Metrics *DataSourceSyncJobMetrics `locationName:"metrics" type:"structure"`

	// The Unix time stamp when the data source synchronization job started.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The status of the synchronization job. When the Status field is set to SUCCEEDED,
	// the synchronization job is done. If the status code is FAILED, the ErrorCode
	// and ErrorMessage fields give you the reason for the failure.
	Status *string `locationName:"status" type:"string" enum:"DataSourceSyncJobStatus"`
	// contains filtered or unexported fields
}

Provides information about an Amazon Q Business data source connector synchronization job.

func (DataSourceSyncJob) GoString 

func (s DataSourceSyncJob) 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 (*DataSourceSyncJob) SetDataSourceErrorCode 

func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob

SetDataSourceErrorCode sets the DataSourceErrorCode field's value.

func (*DataSourceSyncJob) SetEndTime 

func (s *DataSourceSyncJob) SetEndTime(v time.Time) *DataSourceSyncJob

SetEndTime sets the EndTime field's value.

func (*DataSourceSyncJob) SetError 

func (s *DataSourceSyncJob) SetError(v *ErrorDetail) *DataSourceSyncJob

SetError sets the Error field's value.

func (*DataSourceSyncJob) SetExecutionId 

func (s *DataSourceSyncJob) SetExecutionId(v string) *DataSourceSyncJob

SetExecutionId sets the ExecutionId field's value.

func (*DataSourceSyncJob) SetMetrics 

func (s *DataSourceSyncJob) SetMetrics(v *DataSourceSyncJobMetrics) *DataSourceSyncJob

SetMetrics sets the Metrics field's value.

func (*DataSourceSyncJob) SetStartTime 

func (s *DataSourceSyncJob) SetStartTime(v time.Time) *DataSourceSyncJob

SetStartTime sets the StartTime field's value.

func (*DataSourceSyncJob) SetStatus 

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

SetStatus sets the Status field's value.

func (DataSourceSyncJob) String 

func (s DataSourceSyncJob) 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 DataSourceSyncJobMetrics 

type DataSourceSyncJobMetrics struct {

	// The current count of documents added from the data source during the data
	// source sync.
	DocumentsAdded *string `locationName:"documentsAdded" type:"string"`

	// The current count of documents deleted from the data source during the data
	// source sync.
	DocumentsDeleted *string `locationName:"documentsDeleted" type:"string"`

	// The current count of documents that failed to sync from the data source during
	// the data source sync.
	DocumentsFailed *string `locationName:"documentsFailed" type:"string"`

	// The current count of documents modified in the data source during the data
	// source sync.
	DocumentsModified *string `locationName:"documentsModified" type:"string"`

	// The current count of documents crawled by the ongoing sync job in the data
	// source.
	DocumentsScanned *string `locationName:"documentsScanned" type:"string"`
	// contains filtered or unexported fields
}

Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.

func (DataSourceSyncJobMetrics) GoString 

func (s DataSourceSyncJobMetrics) 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 (*DataSourceSyncJobMetrics) SetDocumentsAdded 

func (s *DataSourceSyncJobMetrics) SetDocumentsAdded(v string) *DataSourceSyncJobMetrics

SetDocumentsAdded sets the DocumentsAdded field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsDeleted 

func (s *DataSourceSyncJobMetrics) SetDocumentsDeleted(v string) *DataSourceSyncJobMetrics

SetDocumentsDeleted sets the DocumentsDeleted field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsFailed 

func (s *DataSourceSyncJobMetrics) SetDocumentsFailed(v string) *DataSourceSyncJobMetrics

SetDocumentsFailed sets the DocumentsFailed field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsModified 

func (s *DataSourceSyncJobMetrics) SetDocumentsModified(v string) *DataSourceSyncJobMetrics

SetDocumentsModified sets the DocumentsModified field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsScanned 

func (s *DataSourceSyncJobMetrics) SetDocumentsScanned(v string) *DataSourceSyncJobMetrics

SetDocumentsScanned sets the DocumentsScanned field's value.

func (DataSourceSyncJobMetrics) String 

func (s DataSourceSyncJobMetrics) 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 DataSourceVpcConfiguration 

type DataSourceVpcConfiguration struct {

	// A list of identifiers of security groups within your Amazon VPC. The security
	// groups should enable Amazon Q Business to connect to the data source.
	//
	// SecurityGroupIds is a required field
	SecurityGroupIds []*string `locationName:"securityGroupIds" min:"1" type:"list" required:"true"`

	// A list of identifiers for subnets within your Amazon VPC. The subnets should
	// be able to connect to each other in the VPC, and they should have outgoing
	// access to the Internet through a NAT device.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationName:"subnetIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

func (DataSourceVpcConfiguration) GoString 

func (s DataSourceVpcConfiguration) 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 (*DataSourceVpcConfiguration) SetSecurityGroupIds 

func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*DataSourceVpcConfiguration) SetSubnetIds 

func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (DataSourceVpcConfiguration) String 

func (s DataSourceVpcConfiguration) 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 (*DataSourceVpcConfiguration) Validate 

func (s *DataSourceVpcConfiguration) Validate() error

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

type DateAttributeBoostingConfiguration added in v1.50.18 

type DateAttributeBoostingConfiguration struct {

	// Specifies the duration, in seconds, of a boost applies to a DATE type document
	// attribute.
	BoostingDurationInSeconds *int64 `locationName:"boostingDurationInSeconds" type:"long"`

	// Specifies how much a document attribute is boosted.
	//
	// BoostingLevel is a required field
	BoostingLevel *string `locationName:"boostingLevel" type:"string" required:"true" enum:"DocumentAttributeBoostingLevel"`
	// contains filtered or unexported fields
}

Provides information on boosting DATE type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html).

func (DateAttributeBoostingConfiguration) GoString added in v1.50.18 

func (s DateAttributeBoostingConfiguration) 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 (*DateAttributeBoostingConfiguration) SetBoostingDurationInSeconds added in v1.50.18 

func (s *DateAttributeBoostingConfiguration) SetBoostingDurationInSeconds(v int64) *DateAttributeBoostingConfiguration

SetBoostingDurationInSeconds sets the BoostingDurationInSeconds field's value.

func (*DateAttributeBoostingConfiguration) SetBoostingLevel added in v1.50.18 

func (s *DateAttributeBoostingConfiguration) SetBoostingLevel(v string) *DateAttributeBoostingConfiguration

SetBoostingLevel sets the BoostingLevel field's value.

func (DateAttributeBoostingConfiguration) String added in v1.50.18 

func (s DateAttributeBoostingConfiguration) 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 (*DateAttributeBoostingConfiguration) Validate added in v1.50.18 

func (s *DateAttributeBoostingConfiguration) Validate() error

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

type DeleteApplicationInput 

type DeleteApplicationInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApplicationInput) GoString 

func (s DeleteApplicationInput) 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 (*DeleteApplicationInput) SetApplicationId 

func (s *DeleteApplicationInput) SetApplicationId(v string) *DeleteApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteApplicationInput) String 

func (s DeleteApplicationInput) 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 (*DeleteApplicationInput) Validate 

func (s *DeleteApplicationInput) Validate() error

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

type DeleteApplicationOutput 

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

func (DeleteApplicationOutput) GoString 

func (s DeleteApplicationOutput) 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 (DeleteApplicationOutput) String 

func (s DeleteApplicationOutput) 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 DeleteChatControlsConfigurationInput 

type DeleteChatControlsConfigurationInput struct {

	// The identifier of the application the chat controls have been configured
	// for.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteChatControlsConfigurationInput) GoString 

func (s DeleteChatControlsConfigurationInput) 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 (*DeleteChatControlsConfigurationInput) SetApplicationId 

func (s *DeleteChatControlsConfigurationInput) SetApplicationId(v string) *DeleteChatControlsConfigurationInput

SetApplicationId sets the ApplicationId field's value.

func (DeleteChatControlsConfigurationInput) String 

func (s DeleteChatControlsConfigurationInput) 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 (*DeleteChatControlsConfigurationInput) Validate 

func (s *DeleteChatControlsConfigurationInput) Validate() error

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

type DeleteChatControlsConfigurationOutput 

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

func (DeleteChatControlsConfigurationOutput) GoString 

func (s DeleteChatControlsConfigurationOutput) 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 (DeleteChatControlsConfigurationOutput) String 

func (s DeleteChatControlsConfigurationOutput) 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 DeleteConversationInput 

type DeleteConversationInput struct {

	// The identifier of the Amazon Q Business application associated with the conversation.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the Amazon Q Business web experience conversation being
	// deleted.
	//
	// ConversationId is a required field
	ConversationId *string `location:"uri" locationName:"conversationId" min:"36" type:"string" required:"true"`

	// The identifier of the user who is deleting the conversation.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteConversationInput) GoString 

func (s DeleteConversationInput) 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 (*DeleteConversationInput) SetApplicationId 

func (s *DeleteConversationInput) SetApplicationId(v string) *DeleteConversationInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteConversationInput) SetConversationId 

func (s *DeleteConversationInput) SetConversationId(v string) *DeleteConversationInput

SetConversationId sets the ConversationId field's value.

func (*DeleteConversationInput) SetUserId 

func (s *DeleteConversationInput) SetUserId(v string) *DeleteConversationInput

SetUserId sets the UserId field's value.

func (DeleteConversationInput) String 

func (s DeleteConversationInput) 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 (*DeleteConversationInput) Validate 

func (s *DeleteConversationInput) Validate() error

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

type DeleteConversationOutput 

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

func (DeleteConversationOutput) GoString 

func (s DeleteConversationOutput) 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 (DeleteConversationOutput) String 

func (s DeleteConversationOutput) 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 DeleteDataSourceInput 

type DeleteDataSourceInput struct {

	// The identifier of the Amazon Q Business application used with the data source
	// connector.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source connector that you want to delete.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDataSourceInput) GoString 

func (s DeleteDataSourceInput) 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 (*DeleteDataSourceInput) SetApplicationId 

func (s *DeleteDataSourceInput) SetApplicationId(v string) *DeleteDataSourceInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteDataSourceInput) SetDataSourceId 

func (s *DeleteDataSourceInput) SetDataSourceId(v string) *DeleteDataSourceInput

SetDataSourceId sets the DataSourceId field's value.

func (*DeleteDataSourceInput) SetIndexId 

func (s *DeleteDataSourceInput) SetIndexId(v string) *DeleteDataSourceInput

SetIndexId sets the IndexId field's value.

func (DeleteDataSourceInput) String 

func (s DeleteDataSourceInput) 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 (*DeleteDataSourceInput) Validate 

func (s *DeleteDataSourceInput) Validate() error

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

type DeleteDataSourceOutput 

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

func (DeleteDataSourceOutput) GoString 

func (s DeleteDataSourceOutput) 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 (DeleteDataSourceOutput) String 

func (s DeleteDataSourceOutput) 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 DeleteDocument 

type DeleteDocument struct {

	// The identifier of the deleted document.
	//
	// DocumentId is a required field
	DocumentId *string `locationName:"documentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A document deleted from an Amazon Q Business data source connector.

func (DeleteDocument) GoString 

func (s DeleteDocument) 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 (*DeleteDocument) SetDocumentId 

func (s *DeleteDocument) SetDocumentId(v string) *DeleteDocument

SetDocumentId sets the DocumentId field's value.

func (DeleteDocument) String 

func (s DeleteDocument) 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 (*DeleteDocument) Validate 

func (s *DeleteDocument) Validate() error

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

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The identifier of the application in which the group mapping belongs.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source linked to the group
	//
	// A group can be tied to multiple data sources. You can delete a group from
	// accessing documents in a certain data source. For example, the groups "Research",
	// "Engineering", and "Sales and Marketing" are all tied to the company's documents
	// stored in the data sources Confluence and Salesforce. You want to delete
	// "Research" and "Engineering" groups from Salesforce, so that these groups
	// cannot access customer-related documents stored in Salesforce. Only "Sales
	// and Marketing" should access documents in the Salesforce data source.
	DataSourceId *string `location:"querystring" locationName:"dataSourceId" min:"36" type:"string"`

	// The name of the group you want to delete.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"groupName" min:"1" type:"string" required:"true"`

	// The identifier of the index you want to delete the group from.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGroupInput) GoString 

func (s DeleteGroupInput) 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 (*DeleteGroupInput) SetApplicationId 

func (s *DeleteGroupInput) SetApplicationId(v string) *DeleteGroupInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteGroupInput) SetDataSourceId 

func (s *DeleteGroupInput) SetDataSourceId(v string) *DeleteGroupInput

SetDataSourceId sets the DataSourceId field's value.

func (*DeleteGroupInput) SetGroupName 

func (s *DeleteGroupInput) SetGroupName(v string) *DeleteGroupInput

SetGroupName sets the GroupName field's value.

func (*DeleteGroupInput) SetIndexId 

func (s *DeleteGroupInput) SetIndexId(v string) *DeleteGroupInput

SetIndexId sets the IndexId field's value.

func (DeleteGroupInput) String 

func (s DeleteGroupInput) 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 (*DeleteGroupInput) Validate 

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput 

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

func (DeleteGroupOutput) GoString 

func (s DeleteGroupOutput) 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 (DeleteGroupOutput) String 

func (s DeleteGroupOutput) 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 DeleteIndexInput 

type DeleteIndexInput struct {

	// The identifier of the Amazon Q Business application the Amazon Q Business
	// index is linked to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the Amazon Q Business index.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteIndexInput) GoString 

func (s DeleteIndexInput) 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 (*DeleteIndexInput) SetApplicationId 

func (s *DeleteIndexInput) SetApplicationId(v string) *DeleteIndexInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteIndexInput) SetIndexId 

func (s *DeleteIndexInput) SetIndexId(v string) *DeleteIndexInput

SetIndexId sets the IndexId field's value.

func (DeleteIndexInput) String 

func (s DeleteIndexInput) 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 (*DeleteIndexInput) Validate 

func (s *DeleteIndexInput) Validate() error

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

type DeleteIndexOutput 

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

func (DeleteIndexOutput) GoString 

func (s DeleteIndexOutput) 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 (DeleteIndexOutput) String 

func (s DeleteIndexOutput) 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 DeletePluginInput 

type DeletePluginInput struct {

	// The identifier the application attached to the Amazon Q Business plugin.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the plugin being deleted.
	//
	// PluginId is a required field
	PluginId *string `location:"uri" locationName:"pluginId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePluginInput) GoString 

func (s DeletePluginInput) 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 (*DeletePluginInput) SetApplicationId 

func (s *DeletePluginInput) SetApplicationId(v string) *DeletePluginInput

SetApplicationId sets the ApplicationId field's value.

func (*DeletePluginInput) SetPluginId 

func (s *DeletePluginInput) SetPluginId(v string) *DeletePluginInput

SetPluginId sets the PluginId field's value.

func (DeletePluginInput) String 

func (s DeletePluginInput) 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 (*DeletePluginInput) Validate 

func (s *DeletePluginInput) Validate() error

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

type DeletePluginOutput 

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

func (DeletePluginOutput) GoString 

func (s DeletePluginOutput) 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 (DeletePluginOutput) String 

func (s DeletePluginOutput) 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 DeleteRetrieverInput 

type DeleteRetrieverInput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the retriever being deleted.
	//
	// RetrieverId is a required field
	RetrieverId *string `location:"uri" locationName:"retrieverId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRetrieverInput) GoString 

func (s DeleteRetrieverInput) 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 (*DeleteRetrieverInput) SetApplicationId 

func (s *DeleteRetrieverInput) SetApplicationId(v string) *DeleteRetrieverInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteRetrieverInput) SetRetrieverId 

func (s *DeleteRetrieverInput) SetRetrieverId(v string) *DeleteRetrieverInput

SetRetrieverId sets the RetrieverId field's value.

func (DeleteRetrieverInput) String 

func (s DeleteRetrieverInput) 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 (*DeleteRetrieverInput) Validate 

func (s *DeleteRetrieverInput) Validate() error

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

type DeleteRetrieverOutput 

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

func (DeleteRetrieverOutput) GoString 

func (s DeleteRetrieverOutput) 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 (DeleteRetrieverOutput) String 

func (s DeleteRetrieverOutput) 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 DeleteUserInput 

type DeleteUserInput struct {

	// The identifier of the application from which the user is being deleted.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The user email being deleted.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) 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 (*DeleteUserInput) SetApplicationId 

func (s *DeleteUserInput) SetApplicationId(v string) *DeleteUserInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteUserInput) SetUserId 

func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput

SetUserId sets the UserId field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) 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 (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput 

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

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) 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 (DeleteUserOutput) String 

func (s DeleteUserOutput) 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 DeleteWebExperienceInput 

type DeleteWebExperienceInput struct {

	// The identifier of the Amazon Q Business application linked to the Amazon
	// Q Business web experience.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the Amazon Q Business web experience being deleted.
	//
	// WebExperienceId is a required field
	WebExperienceId *string `location:"uri" locationName:"webExperienceId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWebExperienceInput) GoString 

func (s DeleteWebExperienceInput) 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 (*DeleteWebExperienceInput) SetApplicationId 

func (s *DeleteWebExperienceInput) SetApplicationId(v string) *DeleteWebExperienceInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteWebExperienceInput) SetWebExperienceId 

func (s *DeleteWebExperienceInput) SetWebExperienceId(v string) *DeleteWebExperienceInput

SetWebExperienceId sets the WebExperienceId field's value.

func (DeleteWebExperienceInput) String 

func (s DeleteWebExperienceInput) 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 (*DeleteWebExperienceInput) Validate 

func (s *DeleteWebExperienceInput) Validate() error

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

type DeleteWebExperienceOutput 

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

func (DeleteWebExperienceOutput) GoString 

func (s DeleteWebExperienceOutput) 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 (DeleteWebExperienceOutput) String 

func (s DeleteWebExperienceOutput) 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 {

	// Configuration information for access permission to a document.
	AccessConfiguration *AccessConfiguration `locationName:"accessConfiguration" type:"structure"`

	// Custom attributes to apply to the document for refining Amazon Q Business
	// web experience responses.
	Attributes []*DocumentAttribute `locationName:"attributes" min:"1" type:"list"`

	// The contents of the document.
	Content *DocumentContent `locationName:"content" type:"structure"`

	// The file type of the document in the Blob field.
	//
	// If you want to index snippets or subsets of HTML documents instead of the
	// entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>)
	// around the content.
	ContentType *string `locationName:"contentType" type:"string" enum:"ContentType"`

	// The configuration information for altering document metadata and content
	// during the document ingestion process.
	DocumentEnrichmentConfiguration *DocumentEnrichmentConfiguration `locationName:"documentEnrichmentConfiguration" type:"structure"`

	// The identifier of the document.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

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

A document in an Amazon Q Business application.

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

func (s *Document) SetAccessConfiguration(v *AccessConfiguration) *Document

SetAccessConfiguration sets the AccessConfiguration field's value.

func (*Document) SetAttributes 

func (s *Document) SetAttributes(v []*DocumentAttribute) *Document

SetAttributes sets the Attributes field's value.

func (*Document) SetContent 

func (s *Document) SetContent(v *DocumentContent) *Document

SetContent sets the Content field's value.

func (*Document) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*Document) SetDocumentEnrichmentConfiguration 

func (s *Document) SetDocumentEnrichmentConfiguration(v *DocumentEnrichmentConfiguration) *Document

SetDocumentEnrichmentConfiguration sets the DocumentEnrichmentConfiguration field's value.

func (*Document) SetId 

func (s *Document) SetId(v string) *Document

SetId sets the Id field's value.

func (*Document) SetTitle 

func (s *Document) SetTitle(v string) *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".

func (*Document) Validate 

func (s *Document) Validate() error

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

type DocumentAttribute 

type DocumentAttribute struct {

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

	// The value of the attribute.
	//
	// Value is a required field
	Value *DocumentAttributeValue `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A document attribute or metadata field.

func (DocumentAttribute) GoString 

func (s DocumentAttribute) 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 (*DocumentAttribute) SetName 

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

SetName sets the Name field's value.

func (*DocumentAttribute) SetValue 

func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute

SetValue sets the Value field's value.

func (DocumentAttribute) String 

func (s DocumentAttribute) 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 (*DocumentAttribute) Validate 

func (s *DocumentAttribute) Validate() error

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

type DocumentAttributeBoostingConfiguration added in v1.50.18 

type DocumentAttributeBoostingConfiguration struct {

	// Provides information on boosting DATE type document attributes.
	DateConfiguration *DateAttributeBoostingConfiguration `locationName:"dateConfiguration" type:"structure"`

	// Provides information on boosting NUMBER type document attributes.
	NumberConfiguration *NumberAttributeBoostingConfiguration `locationName:"numberConfiguration" type:"structure"`

	// Provides information on boosting STRING type document attributes.
	StringConfiguration *StringAttributeBoostingConfiguration `locationName:"stringConfiguration" type:"structure"`

	// Provides information on boosting STRING_LIST type document attributes.
	StringListConfiguration *StringListAttributeBoostingConfiguration `locationName:"stringListConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html) object of the UpdateIndex (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html) API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html).

func (DocumentAttributeBoostingConfiguration) GoString added in v1.50.18 

func (s DocumentAttributeBoostingConfiguration) 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 (*DocumentAttributeBoostingConfiguration) SetDateConfiguration added in v1.50.18 

func (s *DocumentAttributeBoostingConfiguration) SetDateConfiguration(v *DateAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetDateConfiguration sets the DateConfiguration field's value.

func (*DocumentAttributeBoostingConfiguration) SetNumberConfiguration added in v1.50.18 

func (s *DocumentAttributeBoostingConfiguration) SetNumberConfiguration(v *NumberAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetNumberConfiguration sets the NumberConfiguration field's value.

func (*DocumentAttributeBoostingConfiguration) SetStringConfiguration added in v1.50.18 

func (s *DocumentAttributeBoostingConfiguration) SetStringConfiguration(v *StringAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetStringConfiguration sets the StringConfiguration field's value.

func (*DocumentAttributeBoostingConfiguration) SetStringListConfiguration added in v1.50.18 

func (s *DocumentAttributeBoostingConfiguration) SetStringListConfiguration(v *StringListAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetStringListConfiguration sets the StringListConfiguration field's value.

func (DocumentAttributeBoostingConfiguration) String added in v1.50.18 

func (s DocumentAttributeBoostingConfiguration) 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 (*DocumentAttributeBoostingConfiguration) Validate added in v1.50.18 

func (s *DocumentAttributeBoostingConfiguration) Validate() error

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

type DocumentAttributeCondition 

type DocumentAttributeCondition struct {

	// The identifier of the document attribute used for the condition.
	//
	// For example, 'Source_URI' could be an identifier for the attribute or metadata
	// field that contains source URIs associated with the documents.
	//
	// Amazon Q Business currently doesn't support _document_body as an attribute
	// key used for the condition.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The identifier of the document attribute used for the condition.
	//
	// For example, 'Source_URI' could be an identifier for the attribute or metadata
	// field that contains source URIs associated with the documents.
	//
	// Amazon Q Business currently does not support _document_body as an attribute
	// key used for the condition.
	//
	// Operator is a required field
	Operator *string `locationName:"operator" type:"string" required:"true" enum:"DocumentEnrichmentConditionOperator"`

	// The value of a document attribute. You can only provide one value for a document
	// attribute.
	Value *DocumentAttributeValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

func (DocumentAttributeCondition) GoString 

func (s DocumentAttributeCondition) 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 (*DocumentAttributeCondition) SetKey 

func (s *DocumentAttributeCondition) SetKey(v string) *DocumentAttributeCondition

SetKey sets the Key field's value.

func (*DocumentAttributeCondition) SetOperator 

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

SetOperator sets the Operator field's value.

func (*DocumentAttributeCondition) SetValue 

func (s *DocumentAttributeCondition) SetValue(v *DocumentAttributeValue) *DocumentAttributeCondition

SetValue sets the Value field's value.

func (DocumentAttributeCondition) String 

func (s DocumentAttributeCondition) 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 (*DocumentAttributeCondition) Validate 

func (s *DocumentAttributeCondition) Validate() error

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

type DocumentAttributeConfiguration 

type DocumentAttributeConfiguration struct {

	// The name of the document attribute.
	Name *string `locationName:"name" min:"1" type:"string"`

	// Information about whether the document attribute can be used by an end user
	// to search for information on their web experience.
	Search *string `locationName:"search" type:"string" enum:"Status"`

	// The type of document attribute.
	Type *string `locationName:"type" type:"string" enum:"AttributeType"`
	// contains filtered or unexported fields
}

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html).

func (DocumentAttributeConfiguration) GoString 

func (s DocumentAttributeConfiguration) 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 (*DocumentAttributeConfiguration) SetName 

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

SetName sets the Name field's value.

func (*DocumentAttributeConfiguration) SetSearch 

func (s *DocumentAttributeConfiguration) SetSearch(v string) *DocumentAttributeConfiguration

SetSearch sets the Search field's value.

func (*DocumentAttributeConfiguration) SetType 

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

SetType sets the Type field's value.

func (DocumentAttributeConfiguration) String 

func (s DocumentAttributeConfiguration) 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 (*DocumentAttributeConfiguration) Validate 

func (s *DocumentAttributeConfiguration) Validate() error

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

type DocumentAttributeTarget 

type DocumentAttributeTarget struct {

	// TRUE to delete the existing target value for your specified target attribute
	// key. You cannot create a target value and set this to TRUE.
	AttributeValueOperator *string `locationName:"attributeValueOperator" type:"string" enum:"AttributeValueOperator"`

	// The identifier of the target document attribute or metadata field. For example,
	// 'Department' could be an identifier for the target attribute or metadata
	// field that includes the department names associated with the documents.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The value of a document attribute. You can only provide one value for a document
	// attribute.
	Value *DocumentAttributeValue `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html). Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html).

func (DocumentAttributeTarget) GoString 

func (s DocumentAttributeTarget) 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 (*DocumentAttributeTarget) SetAttributeValueOperator 

func (s *DocumentAttributeTarget) SetAttributeValueOperator(v string) *DocumentAttributeTarget

SetAttributeValueOperator sets the AttributeValueOperator field's value.

func (*DocumentAttributeTarget) SetKey 

func (s *DocumentAttributeTarget) SetKey(v string) *DocumentAttributeTarget

SetKey sets the Key field's value.

func (*DocumentAttributeTarget) SetValue 

func (s *DocumentAttributeTarget) SetValue(v *DocumentAttributeValue) *DocumentAttributeTarget

SetValue sets the Value field's value.

func (DocumentAttributeTarget) String 

func (s DocumentAttributeTarget) 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 (*DocumentAttributeTarget) Validate 

func (s *DocumentAttributeTarget) Validate() error

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

type DocumentAttributeValue 

type DocumentAttributeValue struct {

	// A date expressed as an ISO 8601 string.
	//
	// It's important for the time zone to be included in the ISO 8601 date-time
	// format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time
	// format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European
	// Time.
	DateValue *time.Time `locationName:"dateValue" type:"timestamp"`

	// A long integer value.
	LongValue *int64 `locationName:"longValue" type:"long"`

	// A list of strings.
	StringListValue []*string `locationName:"stringListValue" type:"list"`

	// A string.
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

The value of a document attribute. You can only provide one value for a document attribute.

func (DocumentAttributeValue) GoString 

func (s DocumentAttributeValue) 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 (*DocumentAttributeValue) SetDateValue 

func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue

SetDateValue sets the DateValue field's value.

func (*DocumentAttributeValue) SetLongValue 

func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue

SetLongValue sets the LongValue field's value.

func (*DocumentAttributeValue) SetStringListValue 

func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue

SetStringListValue sets the StringListValue field's value.

func (*DocumentAttributeValue) SetStringValue 

func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue

SetStringValue sets the StringValue field's value.

func (DocumentAttributeValue) String 

func (s DocumentAttributeValue) 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 DocumentContent 

type DocumentContent struct {

	// The contents of the document. Documents passed to the blob parameter must
	// be base64 encoded. Your code might not need to encode the document file bytes
	// if you're using an Amazon Web Services SDK to call Amazon Q Business APIs.
	// If you are calling the Amazon Q Business endpoint directly using REST, you
	// must base64 encode the contents before sending.
	// Blob is automatically base64 encoded/decoded by the SDK.
	Blob []byte `locationName:"blob" type:"blob"`

	// The path to the document in an Amazon S3 bucket.
	S3 *S3 `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

The contents of a document.

func (DocumentContent) GoString 

func (s DocumentContent) 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 (*DocumentContent) SetBlob 

func (s *DocumentContent) SetBlob(v []byte) *DocumentContent

SetBlob sets the Blob field's value.

func (*DocumentContent) SetS3 

func (s *DocumentContent) SetS3(v *S3) *DocumentContent

SetS3 sets the S3 field's value.

func (DocumentContent) String 

func (s DocumentContent) 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 (*DocumentContent) Validate 

func (s *DocumentContent) Validate() error

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

type DocumentDetails 

type DocumentDetails struct {

	// The timestamp for when the document was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The identifier of the document.
	DocumentId *string `locationName:"documentId" min:"1" type:"string"`

	// An error message associated with the document.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The current status of the document.
	Status *string `locationName:"status" type:"string" enum:"DocumentStatus"`

	// The timestamp for when the document was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

The details of a document within an Amazon Q Business index.

func (DocumentDetails) GoString 

func (s DocumentDetails) 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 (*DocumentDetails) SetCreatedAt 

func (s *DocumentDetails) SetCreatedAt(v time.Time) *DocumentDetails

SetCreatedAt sets the CreatedAt field's value.

func (*DocumentDetails) SetDocumentId 

func (s *DocumentDetails) SetDocumentId(v string) *DocumentDetails

SetDocumentId sets the DocumentId field's value.

func (*DocumentDetails) SetError 

func (s *DocumentDetails) SetError(v *ErrorDetail) *DocumentDetails

SetError sets the Error field's value.

func (*DocumentDetails) SetStatus 

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

SetStatus sets the Status field's value.

func (*DocumentDetails) SetUpdatedAt 

func (s *DocumentDetails) SetUpdatedAt(v time.Time) *DocumentDetails

SetUpdatedAt sets the UpdatedAt field's value.

func (DocumentDetails) String 

func (s DocumentDetails) 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 DocumentEnrichmentConfiguration 

type DocumentEnrichmentConfiguration struct {

	// Configuration information to alter document attributes or metadata fields
	// and content when ingesting documents into Amazon Q Business.
	InlineConfigurations []*InlineDocumentEnrichmentConfiguration `locationName:"inlineConfigurations" min:"1" type:"list"`

	// Provides the configuration information for invoking a Lambda function in
	// Lambda to alter document metadata and content when ingesting documents into
	// Amazon Q Business.
	//
	// You can configure your Lambda function using the PreExtractionHookConfiguration
	// parameter if you want to apply advanced alterations on the original or raw
	// documents.
	//
	// If you want to apply advanced alterations on the Amazon Q Business structured
	// documents, you must configure your Lambda function using PostExtractionHookConfiguration.
	//
	// You can only invoke one Lambda function. However, this function can invoke
	// other functions it requires.
	//
	// For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).
	PostExtractionHookConfiguration *HookConfiguration `locationName:"postExtractionHookConfiguration" type:"structure"`

	// Provides the configuration information for invoking a Lambda function in
	// Lambda to alter document metadata and content when ingesting documents into
	// Amazon Q Business.
	//
	// You can configure your Lambda function using the PreExtractionHookConfiguration
	// parameter if you want to apply advanced alterations on the original or raw
	// documents.
	//
	// If you want to apply advanced alterations on the Amazon Q Business structured
	// documents, you must configure your Lambda function using PostExtractionHookConfiguration.
	//
	// You can only invoke one Lambda function. However, this function can invoke
	// other functions it requires.
	//
	// For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).
	PreExtractionHookConfiguration *HookConfiguration `locationName:"preExtractionHookConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).

func (DocumentEnrichmentConfiguration) GoString 

func (s DocumentEnrichmentConfiguration) 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 (*DocumentEnrichmentConfiguration) SetInlineConfigurations 

func (s *DocumentEnrichmentConfiguration) SetInlineConfigurations(v []*InlineDocumentEnrichmentConfiguration) *DocumentEnrichmentConfiguration

SetInlineConfigurations sets the InlineConfigurations field's value.

func (*DocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration 

func (s *DocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration(v *HookConfiguration) *DocumentEnrichmentConfiguration

SetPostExtractionHookConfiguration sets the PostExtractionHookConfiguration field's value.

func (*DocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration 

func (s *DocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration(v *HookConfiguration) *DocumentEnrichmentConfiguration

SetPreExtractionHookConfiguration sets the PreExtractionHookConfiguration field's value.

func (DocumentEnrichmentConfiguration) String 

func (s DocumentEnrichmentConfiguration) 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 (*DocumentEnrichmentConfiguration) Validate 

func (s *DocumentEnrichmentConfiguration) Validate() error

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

type EligibleDataSource 

type EligibleDataSource struct {

	// The identifier of the data source.
	DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"`

	// The identifier of the index the data source is attached to.
	IndexId *string `locationName:"indexId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

The identifier of the data source Amazon Q Business will generate responses from.

func (EligibleDataSource) GoString 

func (s EligibleDataSource) 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 (*EligibleDataSource) SetDataSourceId 

func (s *EligibleDataSource) SetDataSourceId(v string) *EligibleDataSource

SetDataSourceId sets the DataSourceId field's value.

func (*EligibleDataSource) SetIndexId 

func (s *EligibleDataSource) SetIndexId(v string) *EligibleDataSource

SetIndexId sets the IndexId field's value.

func (EligibleDataSource) String 

func (s EligibleDataSource) 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 (*EligibleDataSource) Validate 

func (s *EligibleDataSource) Validate() error

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

type EncryptionConfiguration 

type EncryptionConfiguration struct {

	// The identifier of the KMS key. Amazon Q Business doesn't support asymmetric
	// keys.
	//
	// KmsKeyId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EncryptionConfiguration's
	// String and GoString methods.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

func (EncryptionConfiguration) GoString 

func (s EncryptionConfiguration) 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 (*EncryptionConfiguration) SetKmsKeyId 

func (s *EncryptionConfiguration) SetKmsKeyId(v string) *EncryptionConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (EncryptionConfiguration) String 

func (s EncryptionConfiguration) 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 (*EncryptionConfiguration) Validate 

func (s *EncryptionConfiguration) Validate() error

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

type EndOfInputEvent added in v1.51.32 

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

The end of the streaming input for the Chat API.

func (EndOfInputEvent) GoString added in v1.51.32 

func (s EndOfInputEvent) 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 (*EndOfInputEvent) MarshalEvent added in v1.51.32 

func (s *EndOfInputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (EndOfInputEvent) String added in v1.51.32 

func (s EndOfInputEvent) 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 (*EndOfInputEvent) UnmarshalEvent added in v1.51.32 

func (s *EndOfInputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the EndOfInputEvent value. This method is only used internally within the SDK's EventStream handling.

type ErrorDetail 

type ErrorDetail struct {

	// The code associated with the data source sync error.
	ErrorCode *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`

	// The message explaining the data source sync error.
	ErrorMessage *string `locationName:"errorMessage" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a data source sync error.

func (ErrorDetail) GoString 

func (s ErrorDetail) 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 (*ErrorDetail) SetErrorCode 

func (s *ErrorDetail) SetErrorCode(v string) *ErrorDetail

SetErrorCode sets the ErrorCode field's value.

func (*ErrorDetail) SetErrorMessage 

func (s *ErrorDetail) SetErrorMessage(v string) *ErrorDetail

SetErrorMessage sets the ErrorMessage field's value.

func (ErrorDetail) String 

func (s ErrorDetail) 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 FailedAttachmentEvent added in v1.51.32 

type FailedAttachmentEvent struct {

	// The details of a file uploaded during chat.
	Attachment *AttachmentOutput_ `locationName:"attachment" type:"structure"`

	// The identifier of the conversation associated with the failed file upload.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// The identifier of the AI-generated message associated with the file upload.
	SystemMessageId *string `locationName:"systemMessageId" min:"36" type:"string"`

	// The identifier of the end user chat message associated with the file upload.
	UserMessageId *string `locationName:"userMessageId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

A failed file upload during web experience chat.

func (FailedAttachmentEvent) GoString added in v1.51.32 

func (s FailedAttachmentEvent) 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 (*FailedAttachmentEvent) MarshalEvent added in v1.51.32 

func (s *FailedAttachmentEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*FailedAttachmentEvent) SetAttachment added in v1.51.32 

func (s *FailedAttachmentEvent) SetAttachment(v *AttachmentOutput_) *FailedAttachmentEvent

SetAttachment sets the Attachment field's value.

func (*FailedAttachmentEvent) SetConversationId added in v1.51.32 

func (s *FailedAttachmentEvent) SetConversationId(v string) *FailedAttachmentEvent

SetConversationId sets the ConversationId field's value.

func (*FailedAttachmentEvent) SetSystemMessageId added in v1.51.32 

func (s *FailedAttachmentEvent) SetSystemMessageId(v string) *FailedAttachmentEvent

SetSystemMessageId sets the SystemMessageId field's value.

func (*FailedAttachmentEvent) SetUserMessageId added in v1.51.32 

func (s *FailedAttachmentEvent) SetUserMessageId(v string) *FailedAttachmentEvent

SetUserMessageId sets the UserMessageId field's value.

func (FailedAttachmentEvent) String added in v1.51.32 

func (s FailedAttachmentEvent) 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 (*FailedAttachmentEvent) UnmarshalEvent added in v1.51.32 

func (s *FailedAttachmentEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the FailedAttachmentEvent value. This method is only used internally within the SDK's EventStream handling.

type FailedDocument 

type FailedDocument struct {

	// The identifier of the Amazon Q Business data source connector that contains
	// the failed document.
	DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"`

	// An explanation for why the document couldn't be removed from the index.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The identifier of the document that couldn't be removed from the Amazon Q
	// Business index.
	Id *string `locationName:"id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

func (FailedDocument) GoString 

func (s FailedDocument) 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 (*FailedDocument) SetDataSourceId 

func (s *FailedDocument) SetDataSourceId(v string) *FailedDocument

SetDataSourceId sets the DataSourceId field's value.

func (*FailedDocument) SetError 

func (s *FailedDocument) SetError(v *ErrorDetail) *FailedDocument

SetError sets the Error field's value.

func (*FailedDocument) SetId 

func (s *FailedDocument) SetId(v string) *FailedDocument

SetId sets the Id field's value.

func (FailedDocument) String 

func (s FailedDocument) 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 GetApplicationInput 

type GetApplicationInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetApplicationInput) GoString 

func (s GetApplicationInput) 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 (*GetApplicationInput) SetApplicationId 

func (s *GetApplicationInput) SetApplicationId(v string) *GetApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (GetApplicationInput) String 

func (s GetApplicationInput) 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 (*GetApplicationInput) Validate 

func (s *GetApplicationInput) Validate() error

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

type GetApplicationOutput 

type GetApplicationOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application.
	ApplicationArn *string `locationName:"applicationArn" type:"string"`

	// The identifier of the Amazon Q Business application.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// Settings for whether end users can upload files directly during chat.
	AttachmentsConfiguration *AppliedAttachmentsConfiguration `locationName:"attachmentsConfiguration" type:"structure"`

	// The Unix timestamp when the Amazon Q Business application was last updated.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A description for the Amazon Q Business application.
	Description *string `locationName:"description" type:"string"`

	// The name of the Amazon Q Business application.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The identifier of the Amazon Web Services KMS key that is used to encrypt
	// your data. Amazon Q Business doesn't support asymmetric keys.
	EncryptionConfiguration *EncryptionConfiguration `locationName:"encryptionConfiguration" type:"structure"`

	// If the Status field is set to ERROR, the ErrorMessage field contains a description
	// of the error that caused the synchronization to fail.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached
	// to your Amazon Q Business application.
	IdentityCenterApplicationArn *string `locationName:"identityCenterApplicationArn" min:"10" type:"string"`

	// Configuration information about chat response personalization. For more information,
	// see Personalizing chat responses (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html).
	PersonalizationConfiguration *PersonalizationConfiguration `locationName:"personalizationConfiguration" type:"structure"`

	// Settings for whether end users can create and use Amazon Q Apps in the web
	// experience.
	QAppsConfiguration *QAppsConfiguration `locationName:"qAppsConfiguration" type:"structure"`

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

	// The status of the Amazon Q Business application.
	Status *string `locationName:"status" type:"string" enum:"ApplicationStatus"`

	// The Unix timestamp when the Amazon Q Business application was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetApplicationOutput) GoString 

func (s GetApplicationOutput) 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 (*GetApplicationOutput) SetApplicationArn 

func (s *GetApplicationOutput) SetApplicationArn(v string) *GetApplicationOutput

SetApplicationArn sets the ApplicationArn field's value.

func (*GetApplicationOutput) SetApplicationId 

func (s *GetApplicationOutput) SetApplicationId(v string) *GetApplicationOutput

SetApplicationId sets the ApplicationId field's value.

func (*GetApplicationOutput) SetAttachmentsConfiguration 

func (s *GetApplicationOutput) SetAttachmentsConfiguration(v *AppliedAttachmentsConfiguration) *GetApplicationOutput

SetAttachmentsConfiguration sets the AttachmentsConfiguration field's value.

func (*GetApplicationOutput) SetCreatedAt 

func (s *GetApplicationOutput) SetCreatedAt(v time.Time) *GetApplicationOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetApplicationOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*GetApplicationOutput) SetDisplayName 

func (s *GetApplicationOutput) SetDisplayName(v string) *GetApplicationOutput

SetDisplayName sets the DisplayName field's value.

func (*GetApplicationOutput) SetEncryptionConfiguration 

func (s *GetApplicationOutput) SetEncryptionConfiguration(v *EncryptionConfiguration) *GetApplicationOutput

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*GetApplicationOutput) SetError 

func (s *GetApplicationOutput) SetError(v *ErrorDetail) *GetApplicationOutput

SetError sets the Error field's value.

func (*GetApplicationOutput) SetIdentityCenterApplicationArn added in v1.51.23 

func (s *GetApplicationOutput) SetIdentityCenterApplicationArn(v string) *GetApplicationOutput

SetIdentityCenterApplicationArn sets the IdentityCenterApplicationArn field's value.

func (*GetApplicationOutput) SetPersonalizationConfiguration added in v1.54.15 

func (s *GetApplicationOutput) SetPersonalizationConfiguration(v *PersonalizationConfiguration) *GetApplicationOutput

SetPersonalizationConfiguration sets the PersonalizationConfiguration field's value.

func (*GetApplicationOutput) SetQAppsConfiguration added in v1.54.7 

func (s *GetApplicationOutput) SetQAppsConfiguration(v *QAppsConfiguration) *GetApplicationOutput

SetQAppsConfiguration sets the QAppsConfiguration field's value.

func (*GetApplicationOutput) SetRoleArn 

func (s *GetApplicationOutput) SetRoleArn(v string) *GetApplicationOutput

SetRoleArn sets the RoleArn field's value.

func (*GetApplicationOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetApplicationOutput) SetUpdatedAt 

func (s *GetApplicationOutput) SetUpdatedAt(v time.Time) *GetApplicationOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetApplicationOutput) String 

func (s GetApplicationOutput) 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 GetChatControlsConfigurationInput 

type GetChatControlsConfigurationInput struct {

	// The identifier of the application for which the chat controls are configured.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The maximum number of configured chat controls to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

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

func (GetChatControlsConfigurationInput) GoString 

func (s GetChatControlsConfigurationInput) 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 (*GetChatControlsConfigurationInput) SetApplicationId 

func (s *GetChatControlsConfigurationInput) SetApplicationId(v string) *GetChatControlsConfigurationInput

SetApplicationId sets the ApplicationId field's value.

func (*GetChatControlsConfigurationInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*GetChatControlsConfigurationInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (GetChatControlsConfigurationInput) String 

func (s GetChatControlsConfigurationInput) 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 (*GetChatControlsConfigurationInput) Validate 

func (s *GetChatControlsConfigurationInput) Validate() error

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

type GetChatControlsConfigurationOutput 

type GetChatControlsConfigurationOutput struct {

	// The phrases blocked from chat by your chat control configuration.
	BlockedPhrases *BlockedPhrasesConfiguration `locationName:"blockedPhrases" type:"structure"`

	// The configuration details for CREATOR_MODE.
	CreatorModeConfiguration *AppliedCreatorModeConfiguration `locationName:"creatorModeConfiguration" type:"structure"`

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

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

	// The topic specific controls configured for a Amazon Q Business application.
	TopicConfigurations []*TopicConfiguration `locationName:"topicConfigurations" type:"list"`
	// contains filtered or unexported fields
}

func (GetChatControlsConfigurationOutput) GoString 

func (s GetChatControlsConfigurationOutput) 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 (*GetChatControlsConfigurationOutput) SetBlockedPhrases 

func (s *GetChatControlsConfigurationOutput) SetBlockedPhrases(v *BlockedPhrasesConfiguration) *GetChatControlsConfigurationOutput

SetBlockedPhrases sets the BlockedPhrases field's value.

func (*GetChatControlsConfigurationOutput) SetCreatorModeConfiguration added in v1.51.23 

func (s *GetChatControlsConfigurationOutput) SetCreatorModeConfiguration(v *AppliedCreatorModeConfiguration) *GetChatControlsConfigurationOutput

SetCreatorModeConfiguration sets the CreatorModeConfiguration field's value.

func (*GetChatControlsConfigurationOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetChatControlsConfigurationOutput) SetResponseScope 

func (s *GetChatControlsConfigurationOutput) SetResponseScope(v string) *GetChatControlsConfigurationOutput

SetResponseScope sets the ResponseScope field's value.

func (*GetChatControlsConfigurationOutput) SetTopicConfigurations 

func (s *GetChatControlsConfigurationOutput) SetTopicConfigurations(v []*TopicConfiguration) *GetChatControlsConfigurationOutput

SetTopicConfigurations sets the TopicConfigurations field's value.

func (GetChatControlsConfigurationOutput) String 

func (s GetChatControlsConfigurationOutput) 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 GetDataSourceInput 

type GetDataSourceInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source connector.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"`

	// The identfier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDataSourceInput) GoString 

func (s GetDataSourceInput) 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 (*GetDataSourceInput) SetApplicationId 

func (s *GetDataSourceInput) SetApplicationId(v string) *GetDataSourceInput

SetApplicationId sets the ApplicationId field's value.

func (*GetDataSourceInput) SetDataSourceId 

func (s *GetDataSourceInput) SetDataSourceId(v string) *GetDataSourceInput

SetDataSourceId sets the DataSourceId field's value.

func (*GetDataSourceInput) SetIndexId 

func (s *GetDataSourceInput) SetIndexId(v string) *GetDataSourceInput

SetIndexId sets the IndexId field's value.

func (GetDataSourceInput) String 

func (s GetDataSourceInput) 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 (*GetDataSourceInput) Validate 

func (s *GetDataSourceInput) Validate() error

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

type GetDataSourceOutput 

type GetDataSourceOutput struct {

	// The identifier of the Amazon Q Business application.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// The Unix timestamp when the data source connector was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the data source.
	DataSourceArn *string `locationName:"dataSourceArn" type:"string"`

	// The identifier of the data source connector.
	DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"`

	// The description for the data source connector.
	Description *string `locationName:"description" type:"string"`

	// The name for the data source connector.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

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

	// When the Status field value is FAILED, the ErrorMessage field contains a
	// description of the error that caused the data source connector to fail.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The identifier of the index linked to the data source connector.
	IndexId *string `locationName:"indexId" min:"36" type:"string"`

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

	// The current status of the data source connector. When the Status field value
	// is FAILED, the ErrorMessage field contains a description of the error that
	// caused the data source connector to fail.
	Status *string `locationName:"status" type:"string" enum:"DataSourceStatus"`

	// The schedule for Amazon Q Business to update the index.
	SyncSchedule *string `locationName:"syncSchedule" type:"string"`

	// The type of the data source connector. For example, S3.
	Type *string `locationName:"type" min:"1" type:"string"`

	// The Unix timestamp when the data source connector was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`

	// Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
	// to your data source.
	VpcConfiguration *DataSourceVpcConfiguration `locationName:"vpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDataSourceOutput) GoString 

func (s GetDataSourceOutput) 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 (*GetDataSourceOutput) SetApplicationId 

func (s *GetDataSourceOutput) SetApplicationId(v string) *GetDataSourceOutput

SetApplicationId sets the ApplicationId field's value.

func (*GetDataSourceOutput) SetCreatedAt 

func (s *GetDataSourceOutput) SetCreatedAt(v time.Time) *GetDataSourceOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetDataSourceOutput) SetDataSourceArn 

func (s *GetDataSourceOutput) SetDataSourceArn(v string) *GetDataSourceOutput

SetDataSourceArn sets the DataSourceArn field's value.

func (*GetDataSourceOutput) SetDataSourceId 

func (s *GetDataSourceOutput) SetDataSourceId(v string) *GetDataSourceOutput

SetDataSourceId sets the DataSourceId field's value.

func (*GetDataSourceOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*GetDataSourceOutput) SetDisplayName 

func (s *GetDataSourceOutput) SetDisplayName(v string) *GetDataSourceOutput

SetDisplayName sets the DisplayName field's value.

func (*GetDataSourceOutput) SetDocumentEnrichmentConfiguration 

func (s *GetDataSourceOutput) SetDocumentEnrichmentConfiguration(v *DocumentEnrichmentConfiguration) *GetDataSourceOutput

SetDocumentEnrichmentConfiguration sets the DocumentEnrichmentConfiguration field's value.

func (*GetDataSourceOutput) SetError 

func (s *GetDataSourceOutput) SetError(v *ErrorDetail) *GetDataSourceOutput

SetError sets the Error field's value.

func (*GetDataSourceOutput) SetIndexId 

func (s *GetDataSourceOutput) SetIndexId(v string) *GetDataSourceOutput

SetIndexId sets the IndexId field's value.

func (*GetDataSourceOutput) SetRoleArn 

func (s *GetDataSourceOutput) SetRoleArn(v string) *GetDataSourceOutput

SetRoleArn sets the RoleArn field's value.

func (*GetDataSourceOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetDataSourceOutput) SetSyncSchedule 

func (s *GetDataSourceOutput) SetSyncSchedule(v string) *GetDataSourceOutput

SetSyncSchedule sets the SyncSchedule field's value.

func (*GetDataSourceOutput) SetType 

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

SetType sets the Type field's value.

func (*GetDataSourceOutput) SetUpdatedAt 

func (s *GetDataSourceOutput) SetUpdatedAt(v time.Time) *GetDataSourceOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (*GetDataSourceOutput) SetVpcConfiguration 

func (s *GetDataSourceOutput) SetVpcConfiguration(v *DataSourceVpcConfiguration) *GetDataSourceOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (GetDataSourceOutput) String 

func (s GetDataSourceOutput) 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 GetGroupInput 

type GetGroupInput struct {

	// The identifier of the application id the group is attached to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source the group is attached to.
	DataSourceId *string `location:"querystring" locationName:"dataSourceId" min:"36" type:"string"`

	// The name of the group.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"groupName" min:"1" type:"string" required:"true"`

	// The identifier of the index the group is attached to.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetGroupInput) GoString 

func (s GetGroupInput) 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 (*GetGroupInput) SetApplicationId 

func (s *GetGroupInput) SetApplicationId(v string) *GetGroupInput

SetApplicationId sets the ApplicationId field's value.

func (*GetGroupInput) SetDataSourceId 

func (s *GetGroupInput) SetDataSourceId(v string) *GetGroupInput

SetDataSourceId sets the DataSourceId field's value.

func (*GetGroupInput) SetGroupName 

func (s *GetGroupInput) SetGroupName(v string) *GetGroupInput

SetGroupName sets the GroupName field's value.

func (*GetGroupInput) SetIndexId 

func (s *GetGroupInput) SetIndexId(v string) *GetGroupInput

SetIndexId sets the IndexId field's value.

func (GetGroupInput) String 

func (s GetGroupInput) 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 (*GetGroupInput) Validate 

func (s *GetGroupInput) Validate() error

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

type GetGroupOutput 

type GetGroupOutput struct {

	// The current status of the group.
	Status *GroupStatusDetail `locationName:"status" type:"structure"`

	// The status history of the group.
	StatusHistory []*GroupStatusDetail `locationName:"statusHistory" type:"list"`
	// contains filtered or unexported fields
}

func (GetGroupOutput) GoString 

func (s GetGroupOutput) 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 (*GetGroupOutput) SetStatus 

func (s *GetGroupOutput) SetStatus(v *GroupStatusDetail) *GetGroupOutput

SetStatus sets the Status field's value.

func (*GetGroupOutput) SetStatusHistory 

func (s *GetGroupOutput) SetStatusHistory(v []*GroupStatusDetail) *GetGroupOutput

SetStatusHistory sets the StatusHistory field's value.

func (GetGroupOutput) String 

func (s GetGroupOutput) 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 GetIndexInput 

type GetIndexInput struct {

	// The identifier of the Amazon Q Business application connected to the index.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the Amazon Q Business index you want information on.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetIndexInput) GoString 

func (s GetIndexInput) 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 (*GetIndexInput) SetApplicationId 

func (s *GetIndexInput) SetApplicationId(v string) *GetIndexInput

SetApplicationId sets the ApplicationId field's value.

func (*GetIndexInput) SetIndexId 

func (s *GetIndexInput) SetIndexId(v string) *GetIndexInput

SetIndexId sets the IndexId field's value.

func (GetIndexInput) String 

func (s GetIndexInput) 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 (*GetIndexInput) Validate 

func (s *GetIndexInput) Validate() error

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

type GetIndexOutput 

type GetIndexOutput struct {

	// The identifier of the Amazon Q Business application associated with the index.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// The storage capacity units chosen for your Amazon Q Business index.
	CapacityConfiguration *IndexCapacityConfiguration `locationName:"capacityConfiguration" type:"structure"`

	// The Unix timestamp when the Amazon Q Business index was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The description for the Amazon Q Business index.
	Description *string `locationName:"description" type:"string"`

	// The name of the Amazon Q Business index.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

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

	// When the Status field value is FAILED, the ErrorMessage field contains a
	// message that explains why.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The Amazon Resource Name (ARN) of the Amazon Q Business index.
	IndexArn *string `locationName:"indexArn" type:"string"`

	// The identifier of the Amazon Q Business index.
	IndexId *string `locationName:"indexId" min:"36" type:"string"`

	// Provides information about the number of documents indexed.
	IndexStatistics *IndexStatistics `locationName:"indexStatistics" type:"structure"`

	// The current status of the index. When the value is ACTIVE, the index is ready
	// for use. If the Status field value is FAILED, the ErrorMessage field contains
	// a message that explains why.
	Status *string `locationName:"status" type:"string" enum:"IndexStatus"`

	// The type of index attached to your Amazon Q Business application.
	Type *string `locationName:"type" type:"string" enum:"IndexType"`

	// The Unix timestamp when the Amazon Q Business index was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetIndexOutput) GoString 

func (s GetIndexOutput) 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 (*GetIndexOutput) SetApplicationId 

func (s *GetIndexOutput) SetApplicationId(v string) *GetIndexOutput

SetApplicationId sets the ApplicationId field's value.

func (*GetIndexOutput) SetCapacityConfiguration 

func (s *GetIndexOutput) SetCapacityConfiguration(v *IndexCapacityConfiguration) *GetIndexOutput

SetCapacityConfiguration sets the CapacityConfiguration field's value.

func (*GetIndexOutput) SetCreatedAt 

func (s *GetIndexOutput) SetCreatedAt(v time.Time) *GetIndexOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetIndexOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*GetIndexOutput) SetDisplayName 

func (s *GetIndexOutput) SetDisplayName(v string) *GetIndexOutput

SetDisplayName sets the DisplayName field's value.

func (*GetIndexOutput) SetDocumentAttributeConfigurations 

func (s *GetIndexOutput) SetDocumentAttributeConfigurations(v []*DocumentAttributeConfiguration) *GetIndexOutput

SetDocumentAttributeConfigurations sets the DocumentAttributeConfigurations field's value.

func (*GetIndexOutput) SetError 

func (s *GetIndexOutput) SetError(v *ErrorDetail) *GetIndexOutput

SetError sets the Error field's value.

func (*GetIndexOutput) SetIndexArn 

func (s *GetIndexOutput) SetIndexArn(v string) *GetIndexOutput

SetIndexArn sets the IndexArn field's value.

func (*GetIndexOutput) SetIndexId 

func (s *GetIndexOutput) SetIndexId(v string) *GetIndexOutput

SetIndexId sets the IndexId field's value.

func (*GetIndexOutput) SetIndexStatistics 

func (s *GetIndexOutput) SetIndexStatistics(v *IndexStatistics) *GetIndexOutput

SetIndexStatistics sets the IndexStatistics field's value.

func (*GetIndexOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetIndexOutput) SetType added in v1.51.32 

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

SetType sets the Type field's value.

func (*GetIndexOutput) SetUpdatedAt 

func (s *GetIndexOutput) SetUpdatedAt(v time.Time) *GetIndexOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetIndexOutput) String 

func (s GetIndexOutput) 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 GetPluginInput 

type GetPluginInput struct {

	// The identifier of the application which contains the plugin.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the plugin.
	//
	// PluginId is a required field
	PluginId *string `location:"uri" locationName:"pluginId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPluginInput) GoString 

func (s GetPluginInput) 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 (*GetPluginInput) SetApplicationId 

func (s *GetPluginInput) SetApplicationId(v string) *GetPluginInput

SetApplicationId sets the ApplicationId field's value.

func (*GetPluginInput) SetPluginId 

func (s *GetPluginInput) SetPluginId(v string) *GetPluginInput

SetPluginId sets the PluginId field's value.

func (GetPluginInput) String 

func (s GetPluginInput) 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 (*GetPluginInput) Validate 

func (s *GetPluginInput) Validate() error

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

type GetPluginOutput 

type GetPluginOutput struct {

	// The identifier of the application which contains the plugin.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// Authentication configuration information for an Amazon Q Business plugin.
	AuthConfiguration *PluginAuthConfiguration `locationName:"authConfiguration" type:"structure"`

	// The current status of a plugin. A plugin is modified asynchronously.
	BuildStatus *string `locationName:"buildStatus" type:"string" enum:"PluginBuildStatus"`

	// The timestamp for when the plugin was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Configuration information required to create a custom plugin.
	CustomPluginConfiguration *CustomPluginConfiguration `locationName:"customPluginConfiguration" type:"structure"`

	// The name of the plugin.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the role with permission to access resources
	// needed to create the plugin.
	PluginArn *string `locationName:"pluginArn" type:"string"`

	// The identifier of the plugin.
	PluginId *string `locationName:"pluginId" min:"36" type:"string"`

	// The source URL used for plugin configuration.
	ServerUrl *string `locationName:"serverUrl" min:"1" type:"string"`

	// The current state of the plugin.
	State *string `locationName:"state" type:"string" enum:"PluginState"`

	// The type of the plugin.
	Type *string `locationName:"type" type:"string" enum:"PluginType"`

	// The timestamp for when the plugin was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetPluginOutput) GoString 

func (s GetPluginOutput) 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 (*GetPluginOutput) SetApplicationId 

func (s *GetPluginOutput) SetApplicationId(v string) *GetPluginOutput

SetApplicationId sets the ApplicationId field's value.

func (*GetPluginOutput) SetAuthConfiguration 

func (s *GetPluginOutput) SetAuthConfiguration(v *PluginAuthConfiguration) *GetPluginOutput

SetAuthConfiguration sets the AuthConfiguration field's value.

func (*GetPluginOutput) SetBuildStatus added in v1.51.32 

func (s *GetPluginOutput) SetBuildStatus(v string) *GetPluginOutput

SetBuildStatus sets the BuildStatus field's value.

func (*GetPluginOutput) SetCreatedAt 

func (s *GetPluginOutput) SetCreatedAt(v time.Time) *GetPluginOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetPluginOutput) SetCustomPluginConfiguration added in v1.51.32 

func (s *GetPluginOutput) SetCustomPluginConfiguration(v *CustomPluginConfiguration) *GetPluginOutput

SetCustomPluginConfiguration sets the CustomPluginConfiguration field's value.

func (*GetPluginOutput) SetDisplayName 

func (s *GetPluginOutput) SetDisplayName(v string) *GetPluginOutput

SetDisplayName sets the DisplayName field's value.

func (*GetPluginOutput) SetPluginArn 

func (s *GetPluginOutput) SetPluginArn(v string) *GetPluginOutput

SetPluginArn sets the PluginArn field's value.

func (*GetPluginOutput) SetPluginId 

func (s *GetPluginOutput) SetPluginId(v string) *GetPluginOutput

SetPluginId sets the PluginId field's value.

func (*GetPluginOutput) SetServerUrl 

func (s *GetPluginOutput) SetServerUrl(v string) *GetPluginOutput

SetServerUrl sets the ServerUrl field's value.

func (*GetPluginOutput) SetState 

func (s *GetPluginOutput) SetState(v string) *GetPluginOutput

SetState sets the State field's value.

func (*GetPluginOutput) SetType 

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

SetType sets the Type field's value.

func (*GetPluginOutput) SetUpdatedAt 

func (s *GetPluginOutput) SetUpdatedAt(v time.Time) *GetPluginOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetPluginOutput) String 

func (s GetPluginOutput) 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 GetRetrieverInput 

type GetRetrieverInput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the retriever.
	//
	// RetrieverId is a required field
	RetrieverId *string `location:"uri" locationName:"retrieverId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRetrieverInput) GoString 

func (s GetRetrieverInput) 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 (*GetRetrieverInput) SetApplicationId 

func (s *GetRetrieverInput) SetApplicationId(v string) *GetRetrieverInput

SetApplicationId sets the ApplicationId field's value.

func (*GetRetrieverInput) SetRetrieverId 

func (s *GetRetrieverInput) SetRetrieverId(v string) *GetRetrieverInput

SetRetrieverId sets the RetrieverId field's value.

func (GetRetrieverInput) String 

func (s GetRetrieverInput) 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 (*GetRetrieverInput) Validate 

func (s *GetRetrieverInput) Validate() error

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

type GetRetrieverOutput 

type GetRetrieverOutput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// Provides information on how the retriever used for your Amazon Q Business
	// application is configured.
	Configuration *RetrieverConfiguration `locationName:"configuration" type:"structure"`

	// The Unix timestamp when the retriever was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The name of the retriever.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
	RetrieverArn *string `locationName:"retrieverArn" type:"string"`

	// The identifier of the retriever.
	RetrieverId *string `locationName:"retrieverId" min:"36" type:"string"`

	// The Amazon Resource Name (ARN) of the role with the permission to access
	// the retriever and required resources.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The status of the retriever.
	Status *string `locationName:"status" type:"string" enum:"RetrieverStatus"`

	// The type of the retriever.
	Type *string `locationName:"type" type:"string" enum:"RetrieverType"`

	// The Unix timestamp when the retriever was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetRetrieverOutput) GoString 

func (s GetRetrieverOutput) 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 (*GetRetrieverOutput) SetApplicationId 

func (s *GetRetrieverOutput) SetApplicationId(v string) *GetRetrieverOutput

SetApplicationId sets the ApplicationId field's value.

func (*GetRetrieverOutput) SetConfiguration 

func (s *GetRetrieverOutput) SetConfiguration(v *RetrieverConfiguration) *GetRetrieverOutput

SetConfiguration sets the Configuration field's value.

func (*GetRetrieverOutput) SetCreatedAt 

func (s *GetRetrieverOutput) SetCreatedAt(v time.Time) *GetRetrieverOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetRetrieverOutput) SetDisplayName 

func (s *GetRetrieverOutput) SetDisplayName(v string) *GetRetrieverOutput

SetDisplayName sets the DisplayName field's value.

func (*GetRetrieverOutput) SetRetrieverArn 

func (s *GetRetrieverOutput) SetRetrieverArn(v string) *GetRetrieverOutput

SetRetrieverArn sets the RetrieverArn field's value.

func (*GetRetrieverOutput) SetRetrieverId 

func (s *GetRetrieverOutput) SetRetrieverId(v string) *GetRetrieverOutput

SetRetrieverId sets the RetrieverId field's value.

func (*GetRetrieverOutput) SetRoleArn 

func (s *GetRetrieverOutput) SetRoleArn(v string) *GetRetrieverOutput

SetRoleArn sets the RoleArn field's value.

func (*GetRetrieverOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetRetrieverOutput) SetType 

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

SetType sets the Type field's value.

func (*GetRetrieverOutput) SetUpdatedAt 

func (s *GetRetrieverOutput) SetUpdatedAt(v time.Time) *GetRetrieverOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetRetrieverOutput) String 

func (s GetRetrieverOutput) 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 GetUserInput 

type GetUserInput struct {

	// The identifier of the application connected to the user.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The user email address attached to the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetUserInput) GoString 

func (s GetUserInput) 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 (*GetUserInput) SetApplicationId 

func (s *GetUserInput) SetApplicationId(v string) *GetUserInput

SetApplicationId sets the ApplicationId field's value.

func (*GetUserInput) SetUserId 

func (s *GetUserInput) SetUserId(v string) *GetUserInput

SetUserId sets the UserId field's value.

func (GetUserInput) String 

func (s GetUserInput) 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 (*GetUserInput) Validate 

func (s *GetUserInput) Validate() error

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

type GetUserOutput 

type GetUserOutput struct {

	// A list of user aliases attached to a user.
	UserAliases []*UserAlias `locationName:"userAliases" type:"list"`
	// contains filtered or unexported fields
}

func (GetUserOutput) GoString 

func (s GetUserOutput) 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 (*GetUserOutput) SetUserAliases 

func (s *GetUserOutput) SetUserAliases(v []*UserAlias) *GetUserOutput

SetUserAliases sets the UserAliases field's value.

func (GetUserOutput) String 

func (s GetUserOutput) 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 GetWebExperienceInput 

type GetWebExperienceInput struct {

	// The identifier of the Amazon Q Business application linked to the web experience.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the Amazon Q Business web experience.
	//
	// WebExperienceId is a required field
	WebExperienceId *string `location:"uri" locationName:"webExperienceId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetWebExperienceInput) GoString 

func (s GetWebExperienceInput) 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 (*GetWebExperienceInput) SetApplicationId 

func (s *GetWebExperienceInput) SetApplicationId(v string) *GetWebExperienceInput

SetApplicationId sets the ApplicationId field's value.

func (*GetWebExperienceInput) SetWebExperienceId 

func (s *GetWebExperienceInput) SetWebExperienceId(v string) *GetWebExperienceInput

SetWebExperienceId sets the WebExperienceId field's value.

func (GetWebExperienceInput) String 

func (s GetWebExperienceInput) 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 (*GetWebExperienceInput) Validate 

func (s *GetWebExperienceInput) Validate() error

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

type GetWebExperienceOutput 

type GetWebExperienceOutput struct {

	// The identifier of the Amazon Q Business application linked to the web experience.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// The authentication configuration information for your Amazon Q Business web
	// experience.
	//
	// Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.
	AuthenticationConfiguration *WebExperienceAuthConfiguration `locationName:"authenticationConfiguration" deprecated:"true" type:"structure"`

	// The Unix timestamp when the Amazon Q Business web experience was last created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The endpoint of your Amazon Q Business web experience.
	DefaultEndpoint *string `locationName:"defaultEndpoint" min:"1" type:"string"`

	// When the Status field value is FAILED, the ErrorMessage field contains a
	// description of the error that caused the data source connector to fail.
	Error *ErrorDetail `locationName:"error" type:"structure"`

	// The Amazon Resource Name (ARN) of the service role attached to your web experience.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// Determines whether sample prompts are enabled in the web experience for an
	// end user.
	SamplePromptsControlMode *string `locationName:"samplePromptsControlMode" type:"string" enum:"WebExperienceSamplePromptsControlMode"`

	// The current status of the Amazon Q Business web experience. When the Status
	// field value is FAILED, the ErrorMessage field contains a description of the
	// error that caused the data source connector to fail.
	Status *string `locationName:"status" type:"string" enum:"WebExperienceStatus"`

	// The subtitle for your Amazon Q Business web experience.
	Subtitle *string `locationName:"subtitle" type:"string"`

	// The title for your Amazon Q Business web experience.
	Title *string `locationName:"title" type:"string"`

	// The Unix timestamp when the Amazon Q Business web experience was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`

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

	// The identifier of the Amazon Q Business web experience.
	WebExperienceId *string `locationName:"webExperienceId" min:"36" type:"string"`

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

func (GetWebExperienceOutput) GoString 

func (s GetWebExperienceOutput) 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 (*GetWebExperienceOutput) SetApplicationId 

func (s *GetWebExperienceOutput) SetApplicationId(v string) *GetWebExperienceOutput

SetApplicationId sets the ApplicationId field's value.

func (*GetWebExperienceOutput) SetAuthenticationConfiguration 

func (s *GetWebExperienceOutput) SetAuthenticationConfiguration(v *WebExperienceAuthConfiguration) *GetWebExperienceOutput

SetAuthenticationConfiguration sets the AuthenticationConfiguration field's value.

func (*GetWebExperienceOutput) SetCreatedAt 

func (s *GetWebExperienceOutput) SetCreatedAt(v time.Time) *GetWebExperienceOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetWebExperienceOutput) SetDefaultEndpoint 

func (s *GetWebExperienceOutput) SetDefaultEndpoint(v string) *GetWebExperienceOutput

SetDefaultEndpoint sets the DefaultEndpoint field's value.

func (*GetWebExperienceOutput) SetError 

func (s *GetWebExperienceOutput) SetError(v *ErrorDetail) *GetWebExperienceOutput

SetError sets the Error field's value.

func (*GetWebExperienceOutput) SetRoleArn added in v1.51.23 

func (s *GetWebExperienceOutput) SetRoleArn(v string) *GetWebExperienceOutput

SetRoleArn sets the RoleArn field's value.

func (*GetWebExperienceOutput) SetSamplePromptsControlMode 

func (s *GetWebExperienceOutput) SetSamplePromptsControlMode(v string) *GetWebExperienceOutput

SetSamplePromptsControlMode sets the SamplePromptsControlMode field's value.

func (*GetWebExperienceOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetWebExperienceOutput) SetSubtitle 

func (s *GetWebExperienceOutput) SetSubtitle(v string) *GetWebExperienceOutput

SetSubtitle sets the Subtitle field's value.

func (*GetWebExperienceOutput) SetTitle 

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

SetTitle sets the Title field's value.

func (*GetWebExperienceOutput) SetUpdatedAt 

func (s *GetWebExperienceOutput) SetUpdatedAt(v time.Time) *GetWebExperienceOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (*GetWebExperienceOutput) SetWebExperienceArn 

func (s *GetWebExperienceOutput) SetWebExperienceArn(v string) *GetWebExperienceOutput

SetWebExperienceArn sets the WebExperienceArn field's value.

func (*GetWebExperienceOutput) SetWebExperienceId 

func (s *GetWebExperienceOutput) SetWebExperienceId(v string) *GetWebExperienceOutput

SetWebExperienceId sets the WebExperienceId field's value.

func (*GetWebExperienceOutput) SetWelcomeMessage 

func (s *GetWebExperienceOutput) SetWelcomeMessage(v string) *GetWebExperienceOutput

SetWelcomeMessage sets the WelcomeMessage field's value.

func (GetWebExperienceOutput) String 

func (s GetWebExperienceOutput) 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 GroupMembers 

type GroupMembers struct {

	// A list of sub groups that belong to a group. For example, the sub groups
	// "Research", "Engineering", and "Sales and Marketing" all belong to the group
	// "Company".
	MemberGroups []*MemberGroup `locationName:"memberGroups" min:"1" type:"list"`

	// A list of users that belong to a group. For example, a list of interns all
	// belong to the "Interns" group.
	MemberUsers []*MemberUser `locationName:"memberUsers" min:"1" type:"list"`
	// contains filtered or unexported fields
}

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

func (GroupMembers) GoString 

func (s GroupMembers) 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 (*GroupMembers) SetMemberGroups 

func (s *GroupMembers) SetMemberGroups(v []*MemberGroup) *GroupMembers

SetMemberGroups sets the MemberGroups field's value.

func (*GroupMembers) SetMemberUsers 

func (s *GroupMembers) SetMemberUsers(v []*MemberUser) *GroupMembers

SetMemberUsers sets the MemberUsers field's value.

func (GroupMembers) String 

func (s GroupMembers) 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 (*GroupMembers) Validate 

func (s *GroupMembers) Validate() error

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

type GroupStatusDetail 

type GroupStatusDetail struct {

	// The details of an error associated a group status.
	ErrorDetail *ErrorDetail `locationName:"errorDetail" type:"structure"`

	// The Unix timestamp when the Amazon Q Business application was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The status of a group.
	Status *string `locationName:"status" type:"string" enum:"GroupStatus"`
	// contains filtered or unexported fields
}

Provides the details of a group's status.

func (GroupStatusDetail) GoString 

func (s GroupStatusDetail) 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 (*GroupStatusDetail) SetErrorDetail 

func (s *GroupStatusDetail) SetErrorDetail(v *ErrorDetail) *GroupStatusDetail

SetErrorDetail sets the ErrorDetail field's value.

func (*GroupStatusDetail) SetLastUpdatedAt 

func (s *GroupStatusDetail) SetLastUpdatedAt(v time.Time) *GroupStatusDetail

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*GroupStatusDetail) SetStatus 

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

SetStatus sets the Status field's value.

func (GroupStatusDetail) String 

func (s GroupStatusDetail) 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 GroupSummary 

type GroupSummary struct {

	// The name of the group the summary information is for.
	GroupName *string `locationName:"groupName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Summary information for groups.

func (GroupSummary) GoString 

func (s GroupSummary) 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 (*GroupSummary) SetGroupName 

func (s *GroupSummary) SetGroupName(v string) *GroupSummary

SetGroupName sets the GroupName field's value.

func (GroupSummary) String 

func (s GroupSummary) 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 HookConfiguration 

type HookConfiguration struct {

	// The condition used for when a Lambda function should be invoked.
	//
	// For example, you can specify a condition that if there are empty date-time
	// values, then Amazon Q Business should invoke a function that inserts the
	// current date-time.
	InvocationCondition *DocumentAttributeCondition `locationName:"invocationCondition" type:"structure"`

	// The Amazon Resource Name (ARN) of a role with permission to run a Lambda
	// function during ingestion. For more information, see IAM roles for Custom
	// Document Enrichment (CDE) (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role).
	LambdaArn *string `locationName:"lambdaArn" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration
	// and PostExtractionHookConfiguration for altering document metadata and content
	// during the document ingestion process.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// Stores the original, raw documents or the structured, parsed documents before
	// and after altering them. For more information, see Data contracts for Lambda
	// functions (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts).
	S3BucketName *string `locationName:"s3BucketName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).

func (HookConfiguration) GoString 

func (s HookConfiguration) 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 (*HookConfiguration) SetInvocationCondition 

func (s *HookConfiguration) SetInvocationCondition(v *DocumentAttributeCondition) *HookConfiguration

SetInvocationCondition sets the InvocationCondition field's value.

func (*HookConfiguration) SetLambdaArn 

func (s *HookConfiguration) SetLambdaArn(v string) *HookConfiguration

SetLambdaArn sets the LambdaArn field's value.

func (*HookConfiguration) SetRoleArn 

func (s *HookConfiguration) SetRoleArn(v string) *HookConfiguration

SetRoleArn sets the RoleArn field's value.

func (*HookConfiguration) SetS3BucketName 

func (s *HookConfiguration) SetS3BucketName(v string) *HookConfiguration

SetS3BucketName sets the S3BucketName field's value.

func (HookConfiguration) String 

func (s HookConfiguration) 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 (*HookConfiguration) Validate 

func (s *HookConfiguration) Validate() error

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

type Index 

type Index struct {

	// The Unix timestamp when the index was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The name of the index.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The identifier for the index.
	IndexId *string `locationName:"indexId" min:"36" type:"string"`

	// The current status of the index. When the status is ACTIVE, the index is
	// ready.
	Status *string `locationName:"status" type:"string" enum:"IndexStatus"`

	// The Unix timestamp when the index was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information for your Amazon Q Business index.

func (Index) GoString 

func (s Index) 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 (*Index) SetCreatedAt 

func (s *Index) SetCreatedAt(v time.Time) *Index

SetCreatedAt sets the CreatedAt field's value.

func (*Index) SetDisplayName 

func (s *Index) SetDisplayName(v string) *Index

SetDisplayName sets the DisplayName field's value.

func (*Index) SetIndexId 

func (s *Index) SetIndexId(v string) *Index

SetIndexId sets the IndexId field's value.

func (*Index) SetStatus 

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

SetStatus sets the Status field's value.

func (*Index) SetUpdatedAt 

func (s *Index) SetUpdatedAt(v time.Time) *Index

SetUpdatedAt sets the UpdatedAt field's value.

func (Index) String 

func (s Index) 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 IndexCapacityConfiguration 

type IndexCapacityConfiguration struct {

	// The number of storage units configured for an Amazon Q Business index.
	Units *int64 `locationName:"units" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Provides information about index capacity configuration.

func (IndexCapacityConfiguration) GoString 

func (s IndexCapacityConfiguration) 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 (*IndexCapacityConfiguration) SetUnits 

func (s *IndexCapacityConfiguration) SetUnits(v int64) *IndexCapacityConfiguration

SetUnits sets the Units field's value.

func (IndexCapacityConfiguration) String 

func (s IndexCapacityConfiguration) 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 (*IndexCapacityConfiguration) Validate 

func (s *IndexCapacityConfiguration) Validate() error

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

type IndexStatistics 

type IndexStatistics struct {

	// The number of documents indexed.
	TextDocumentStatistics *TextDocumentStatistics `locationName:"textDocumentStatistics" type:"structure"`
	// contains filtered or unexported fields
}

Provides information about the number of documents in an index.

func (IndexStatistics) GoString 

func (s IndexStatistics) 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 (*IndexStatistics) SetTextDocumentStatistics 

func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics

SetTextDocumentStatistics sets the TextDocumentStatistics field's value.

func (IndexStatistics) String 

func (s IndexStatistics) 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 InlineDocumentEnrichmentConfiguration 

type InlineDocumentEnrichmentConfiguration struct {

	// The condition used for the target document attribute or metadata field when
	// ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget
	// (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html)
	// to apply the condition.
	//
	// For example, you can create the 'Department' target field and have it prefill
	// department names associated with the documents based on information in the
	// 'Source_URI' field. Set the condition that if the 'Source_URI' field contains
	// 'financial' in its URI value, then prefill the target field 'Department'
	// with the target value 'Finance' for the document.
	//
	// Amazon Q Business can't create a target field if it has not already been
	// created as an index field. After you create your index field, you can create
	// a document metadata field using DocumentAttributeTarget. Amazon Q Business
	// then will map your newly created metadata field to your index field.
	Condition *DocumentAttributeCondition `locationName:"condition" type:"structure"`

	// TRUE to delete content if the condition used for the target attribute is
	// met.
	DocumentContentOperator *string `locationName:"documentContentOperator" type:"string" enum:"DocumentContentOperator"`

	// The target document attribute or metadata field you want to alter when ingesting
	// documents into Amazon Q Business.
	//
	// For example, you can delete all customer identification numbers associated
	// with the documents, stored in the document metadata field called 'Customer_ID'
	// by setting the target key as 'Customer_ID' and the deletion flag to TRUE.
	// This removes all customer ID values in the field 'Customer_ID'. This would
	// scrub personally identifiable information from each document's metadata.
	//
	// Amazon Q Business can't create a target field if it has not already been
	// created as an index field. After you create your index field, you can create
	// a document metadata field using DocumentAttributeTarget (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html).
	// Amazon Q Business will then map your newly created document attribute to
	// your index field.
	//
	// You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html).
	Target *DocumentAttributeTarget `locationName:"target" type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html).

For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html).

func (InlineDocumentEnrichmentConfiguration) GoString 

func (s InlineDocumentEnrichmentConfiguration) 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 (*InlineDocumentEnrichmentConfiguration) SetCondition 

func (s *InlineDocumentEnrichmentConfiguration) SetCondition(v *DocumentAttributeCondition) *InlineDocumentEnrichmentConfiguration

SetCondition sets the Condition field's value.

func (*InlineDocumentEnrichmentConfiguration) SetDocumentContentOperator 

func (s *InlineDocumentEnrichmentConfiguration) SetDocumentContentOperator(v string) *InlineDocumentEnrichmentConfiguration

SetDocumentContentOperator sets the DocumentContentOperator field's value.

func (*InlineDocumentEnrichmentConfiguration) SetTarget 

func (s *InlineDocumentEnrichmentConfiguration) SetTarget(v *DocumentAttributeTarget) *InlineDocumentEnrichmentConfiguration

SetTarget sets the Target field's value.

func (InlineDocumentEnrichmentConfiguration) String 

func (s InlineDocumentEnrichmentConfiguration) 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 (*InlineDocumentEnrichmentConfiguration) Validate 

func (s *InlineDocumentEnrichmentConfiguration) Validate() error

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

type InternalServerException 

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

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

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) 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 (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) 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 KendraIndexConfiguration 

type KendraIndexConfiguration struct {

	// The identifier of the Amazon Kendra index.
	//
	// IndexId is a required field
	IndexId *string `locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Stores an Amazon Kendra index as a retriever.

func (KendraIndexConfiguration) GoString 

func (s KendraIndexConfiguration) 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 (*KendraIndexConfiguration) SetIndexId 

func (s *KendraIndexConfiguration) SetIndexId(v string) *KendraIndexConfiguration

SetIndexId sets the IndexId field's value.

func (KendraIndexConfiguration) String 

func (s KendraIndexConfiguration) 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 (*KendraIndexConfiguration) Validate 

func (s *KendraIndexConfiguration) Validate() error

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

type LicenseNotFoundException 

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

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

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

func (*LicenseNotFoundException) Code 

func (s *LicenseNotFoundException) Code() string

Code returns the exception type name.

func (*LicenseNotFoundException) Error 

func (s *LicenseNotFoundException) Error() string

func (LicenseNotFoundException) GoString 

func (s LicenseNotFoundException) 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 (*LicenseNotFoundException) Message 

func (s *LicenseNotFoundException) Message() string

Message returns the exception's message.

func (*LicenseNotFoundException) OrigErr 

func (s *LicenseNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LicenseNotFoundException) RequestID 

func (s *LicenseNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LicenseNotFoundException) StatusCode 

func (s *LicenseNotFoundException) StatusCode() int

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

func (LicenseNotFoundException) String 

func (s LicenseNotFoundException) 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 ListApplicationsInput 

type ListApplicationsInput struct {

	// The maximum number of Amazon Q Business applications to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

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

func (ListApplicationsInput) GoString 

func (s ListApplicationsInput) 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 (*ListApplicationsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListApplicationsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListApplicationsInput) String 

func (s ListApplicationsInput) 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 (*ListApplicationsInput) Validate 

func (s *ListApplicationsInput) Validate() error

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

type ListApplicationsOutput 

type ListApplicationsOutput struct {

	// An array of summary information on the configuration of one or more Amazon
	// Q Business applications.
	Applications []*Application `locationName:"applications" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token. You can
	// use this token in a subsequent request to retrieve the next set of applications.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListApplicationsOutput) GoString 

func (s ListApplicationsOutput) 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 (*ListApplicationsOutput) SetApplications 

func (s *ListApplicationsOutput) SetApplications(v []*Application) *ListApplicationsOutput

SetApplications sets the Applications field's value.

func (*ListApplicationsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListApplicationsOutput) String 

func (s ListApplicationsOutput) 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 ListConversationsInput 

type ListConversationsInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The maximum number of Amazon Q Business conversations to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// If the maxResults response was incomplete because there is more data to retrieve,
	// Amazon Q Business returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of Amazon Q Business conversations.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The identifier of the user involved in the Amazon Q Business web experience
	// conversation.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListConversationsInput) GoString 

func (s ListConversationsInput) 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 (*ListConversationsInput) SetApplicationId 

func (s *ListConversationsInput) SetApplicationId(v string) *ListConversationsInput

SetApplicationId sets the ApplicationId field's value.

func (*ListConversationsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListConversationsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListConversationsInput) SetUserId 

func (s *ListConversationsInput) SetUserId(v string) *ListConversationsInput

SetUserId sets the UserId field's value.

func (ListConversationsInput) String 

func (s ListConversationsInput) 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 (*ListConversationsInput) Validate 

func (s *ListConversationsInput) Validate() error

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

type ListConversationsOutput 

type ListConversationsOutput struct {

	// An array of summary information on the configuration of one or more Amazon
	// Q Business web experiences.
	Conversations []*Conversation `locationName:"conversations" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token, which
	// you can use in a later request to list the next set of messages.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListConversationsOutput) GoString 

func (s ListConversationsOutput) 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 (*ListConversationsOutput) SetConversations 

func (s *ListConversationsOutput) SetConversations(v []*Conversation) *ListConversationsOutput

SetConversations sets the Conversations field's value.

func (*ListConversationsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListConversationsOutput) String 

func (s ListConversationsOutput) 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 ListDataSourceSyncJobsInput 

type ListDataSourceSyncJobsInput struct {

	// The identifier of the Amazon Q Business application connected to the data
	// source.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source connector.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"`

	// The end time of the data source connector sync.
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp"`

	// The identifier of the index used with the Amazon Q Business data source connector.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

	// The maximum number of synchronization jobs to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// If the maxResults response was incpmplete because there is more data to retriever,
	// Amazon Q Business returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of responses.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The start time of the data source connector sync.
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp"`

	// Only returns synchronization jobs with the Status field equal to the specified
	// status.
	StatusFilter *string `location:"querystring" locationName:"syncStatus" type:"string" enum:"DataSourceSyncJobStatus"`
	// contains filtered or unexported fields
}

func (ListDataSourceSyncJobsInput) GoString 

func (s ListDataSourceSyncJobsInput) 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 (*ListDataSourceSyncJobsInput) SetApplicationId 

func (s *ListDataSourceSyncJobsInput) SetApplicationId(v string) *ListDataSourceSyncJobsInput

SetApplicationId sets the ApplicationId field's value.

func (*ListDataSourceSyncJobsInput) SetDataSourceId 

func (s *ListDataSourceSyncJobsInput) SetDataSourceId(v string) *ListDataSourceSyncJobsInput

SetDataSourceId sets the DataSourceId field's value.

func (*ListDataSourceSyncJobsInput) SetEndTime 

func (s *ListDataSourceSyncJobsInput) SetEndTime(v time.Time) *ListDataSourceSyncJobsInput

SetEndTime sets the EndTime field's value.

func (*ListDataSourceSyncJobsInput) SetIndexId 

func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput

SetIndexId sets the IndexId field's value.

func (*ListDataSourceSyncJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourceSyncJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListDataSourceSyncJobsInput) SetStartTime 

func (s *ListDataSourceSyncJobsInput) SetStartTime(v time.Time) *ListDataSourceSyncJobsInput

SetStartTime sets the StartTime field's value.

func (*ListDataSourceSyncJobsInput) SetStatusFilter 

func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput

SetStatusFilter sets the StatusFilter field's value.

func (ListDataSourceSyncJobsInput) String 

func (s ListDataSourceSyncJobsInput) 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 (*ListDataSourceSyncJobsInput) Validate 

func (s *ListDataSourceSyncJobsInput) Validate() error

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

type ListDataSourceSyncJobsOutput 

type ListDataSourceSyncJobsOutput struct {

	// A history of synchronization jobs for the data source connector.
	History []*DataSourceSyncJob `locationName:"history" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token. You can
	// use this token in any subsequent request to retrieve the next set of jobs.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataSourceSyncJobsOutput) GoString 

func (s ListDataSourceSyncJobsOutput) 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 (*ListDataSourceSyncJobsOutput) SetHistory 

func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput

SetHistory sets the History field's value.

func (*ListDataSourceSyncJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDataSourceSyncJobsOutput) String 

func (s ListDataSourceSyncJobsOutput) 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 ListDataSourcesInput 

type ListDataSourcesInput struct {

	// The identifier of the Amazon Q Business application linked to the data source
	// connectors.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the index used with one or more data source connectors.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

	// The maximum number of data source connectors to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

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

func (ListDataSourcesInput) GoString 

func (s ListDataSourcesInput) 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 (*ListDataSourcesInput) SetApplicationId 

func (s *ListDataSourcesInput) SetApplicationId(v string) *ListDataSourcesInput

SetApplicationId sets the ApplicationId field's value.

func (*ListDataSourcesInput) SetIndexId 

func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput

SetIndexId sets the IndexId field's value.

func (*ListDataSourcesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourcesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDataSourcesInput) String 

func (s ListDataSourcesInput) 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 (*ListDataSourcesInput) Validate 

func (s *ListDataSourcesInput) Validate() error

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

type ListDataSourcesOutput 

type ListDataSourcesOutput struct {

	// An array of summary information for one or more data source connector.
	DataSources []*DataSource `locationName:"dataSources" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token. You can
	// use this token in a subsequent request to retrieve the next set of data source
	// connectors.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataSourcesOutput) GoString 

func (s ListDataSourcesOutput) 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 (*ListDataSourcesOutput) SetDataSources 

func (s *ListDataSourcesOutput) SetDataSources(v []*DataSource) *ListDataSourcesOutput

SetDataSources sets the DataSources field's value.

func (*ListDataSourcesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDataSourcesOutput) String 

func (s ListDataSourcesOutput) 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 ListDocumentsInput 

type ListDocumentsInput struct {

	// The identifier of the application id the documents are attached to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data sources the documents are attached to.
	DataSourceIds []*string `location:"querystring" locationName:"dataSourceIds" min:"1" type:"list"`

	// The identifier of the index the documents are attached to.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

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

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

func (ListDocumentsInput) GoString 

func (s ListDocumentsInput) 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 (*ListDocumentsInput) SetApplicationId 

func (s *ListDocumentsInput) SetApplicationId(v string) *ListDocumentsInput

SetApplicationId sets the ApplicationId field's value.

func (*ListDocumentsInput) SetDataSourceIds 

func (s *ListDocumentsInput) SetDataSourceIds(v []*string) *ListDocumentsInput

SetDataSourceIds sets the DataSourceIds field's value.

func (*ListDocumentsInput) SetIndexId 

func (s *ListDocumentsInput) SetIndexId(v string) *ListDocumentsInput

SetIndexId sets the IndexId field's value.

func (*ListDocumentsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDocumentsInput) String 

func (s ListDocumentsInput) 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 (*ListDocumentsInput) Validate 

func (s *ListDocumentsInput) Validate() error

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

type ListDocumentsOutput 

type ListDocumentsOutput struct {

	// A list of document details.
	DocumentDetailList []*DocumentDetails `locationName:"documentDetailList" type:"list"`

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

func (ListDocumentsOutput) GoString 

func (s ListDocumentsOutput) 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 (*ListDocumentsOutput) SetDocumentDetailList 

func (s *ListDocumentsOutput) SetDocumentDetailList(v []*DocumentDetails) *ListDocumentsOutput

SetDocumentDetailList sets the DocumentDetailList field's value.

func (*ListDocumentsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDocumentsOutput) String 

func (s ListDocumentsOutput) 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 ListGroupsInput 

type ListGroupsInput struct {

	// The identifier of the application for getting a list of groups mapped to
	// users.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source for getting a list of groups mapped to
	// users.
	DataSourceId *string `location:"querystring" locationName:"dataSourceId" min:"36" type:"string"`

	// The identifier of the index for getting a list of groups mapped to users.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

	// The maximum number of returned groups that are mapped to users.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Q Business returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of groups that are mapped
	// to users.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The timestamp identifier used for the latest PUT or DELETE action for mapping
	// users to their groups.
	//
	// UpdatedEarlierThan is a required field
	UpdatedEarlierThan *time.Time `location:"querystring" locationName:"updatedEarlierThan" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (ListGroupsInput) GoString 

func (s ListGroupsInput) 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 (*ListGroupsInput) SetApplicationId 

func (s *ListGroupsInput) SetApplicationId(v string) *ListGroupsInput

SetApplicationId sets the ApplicationId field's value.

func (*ListGroupsInput) SetDataSourceId 

func (s *ListGroupsInput) SetDataSourceId(v string) *ListGroupsInput

SetDataSourceId sets the DataSourceId field's value.

func (*ListGroupsInput) SetIndexId 

func (s *ListGroupsInput) SetIndexId(v string) *ListGroupsInput

SetIndexId sets the IndexId field's value.

func (*ListGroupsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListGroupsInput) SetUpdatedEarlierThan 

func (s *ListGroupsInput) SetUpdatedEarlierThan(v time.Time) *ListGroupsInput

SetUpdatedEarlierThan sets the UpdatedEarlierThan field's value.

func (ListGroupsInput) String 

func (s ListGroupsInput) 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 (*ListGroupsInput) Validate 

func (s *ListGroupsInput) Validate() error

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

type ListGroupsOutput 

type ListGroupsOutput struct {

	// Summary information for list of groups that are mapped to users.
	Items []*GroupSummary `locationName:"items" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token that you
	// can use in the subsequent request to retrieve the next set of groups that
	// are mapped to users.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupsOutput) GoString 

func (s ListGroupsOutput) 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 (*ListGroupsOutput) SetItems 

func (s *ListGroupsOutput) SetItems(v []*GroupSummary) *ListGroupsOutput

SetItems sets the Items field's value.

func (*ListGroupsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListGroupsOutput) String 

func (s ListGroupsOutput) 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 ListIndicesInput 

type ListIndicesInput struct {

	// The identifier of the Amazon Q Business application connected to the index.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

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

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

func (ListIndicesInput) GoString 

func (s ListIndicesInput) 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 (*ListIndicesInput) SetApplicationId 

func (s *ListIndicesInput) SetApplicationId(v string) *ListIndicesInput

SetApplicationId sets the ApplicationId field's value.

func (*ListIndicesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListIndicesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListIndicesInput) String 

func (s ListIndicesInput) 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 (*ListIndicesInput) Validate 

func (s *ListIndicesInput) Validate() error

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

type ListIndicesOutput 

type ListIndicesOutput struct {

	// An array of information on the items in one or more indexes.
	Indices []*Index `locationName:"indices" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token that you
	// can use in the subsequent request to retrieve the next set of indexes.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListIndicesOutput) GoString 

func (s ListIndicesOutput) 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 (*ListIndicesOutput) SetIndices 

func (s *ListIndicesOutput) SetIndices(v []*Index) *ListIndicesOutput

SetIndices sets the Indices field's value.

func (*ListIndicesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListIndicesOutput) String 

func (s ListIndicesOutput) 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 ListMessagesInput 

type ListMessagesInput struct {

	// The identifier for the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the Amazon Q Business web experience conversation.
	//
	// ConversationId is a required field
	ConversationId *string `location:"uri" locationName:"conversationId" min:"36" type:"string" required:"true"`

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

	// If the number of retrievers returned exceeds maxResults, Amazon Q Business
	// returns a next token as a pagination token to retrieve the next set of messages.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The identifier of the user involved in the Amazon Q Business web experience
	// conversation.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMessagesInput) GoString 

func (s ListMessagesInput) 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 (*ListMessagesInput) SetApplicationId 

func (s *ListMessagesInput) SetApplicationId(v string) *ListMessagesInput

SetApplicationId sets the ApplicationId field's value.

func (*ListMessagesInput) SetConversationId 

func (s *ListMessagesInput) SetConversationId(v string) *ListMessagesInput

SetConversationId sets the ConversationId field's value.

func (*ListMessagesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMessagesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListMessagesInput) SetUserId 

func (s *ListMessagesInput) SetUserId(v string) *ListMessagesInput

SetUserId sets the UserId field's value.

func (ListMessagesInput) String 

func (s ListMessagesInput) 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 (*ListMessagesInput) Validate 

func (s *ListMessagesInput) Validate() error

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

type ListMessagesOutput 

type ListMessagesOutput struct {

	// An array of information on one or more messages.
	Messages []*Message `locationName:"messages" type:"list"`

	// If the response is truncated, Amazon Q Business returns this token, which
	// you can use in a later request to list the next set of messages.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMessagesOutput) GoString 

func (s ListMessagesOutput) 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 (*ListMessagesOutput) SetMessages 

func (s *ListMessagesOutput) SetMessages(v []*Message) *ListMessagesOutput

SetMessages sets the Messages field's value.

func (*ListMessagesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListMessagesOutput) String 

func (s ListMessagesOutput) 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 ListPluginsInput 

type ListPluginsInput struct {

	// The identifier of the application the plugin is attached to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

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

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

func (ListPluginsInput) GoString 

func (s ListPluginsInput) 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 (*ListPluginsInput) SetApplicationId 

func (s *ListPluginsInput) SetApplicationId(v string) *ListPluginsInput

SetApplicationId sets the ApplicationId field's value.

func (*ListPluginsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListPluginsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListPluginsInput) String 

func (s ListPluginsInput) 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 (*ListPluginsInput) Validate 

func (s *ListPluginsInput) Validate() error

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

type ListPluginsOutput 

type ListPluginsOutput struct {

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

	// Information about a configured plugin.
	Plugins []*Plugin `locationName:"plugins" type:"list"`
	// contains filtered or unexported fields
}

func (ListPluginsOutput) GoString 

func (s ListPluginsOutput) 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 (*ListPluginsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListPluginsOutput) SetPlugins 

func (s *ListPluginsOutput) SetPlugins(v []*Plugin) *ListPluginsOutput

SetPlugins sets the Plugins field's value.

func (ListPluginsOutput) String 

func (s ListPluginsOutput) 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 ListRetrieversInput 

type ListRetrieversInput struct {

	// The identifier of the Amazon Q Business application using the retriever.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The maximum number of retrievers returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// If the number of retrievers returned exceeds maxResults, Amazon Q Business
	// returns a next token as a pagination token to retrieve the next set of retrievers.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRetrieversInput) GoString 

func (s ListRetrieversInput) 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 (*ListRetrieversInput) SetApplicationId 

func (s *ListRetrieversInput) SetApplicationId(v string) *ListRetrieversInput

SetApplicationId sets the ApplicationId field's value.

func (*ListRetrieversInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListRetrieversInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListRetrieversInput) String 

func (s ListRetrieversInput) 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 (*ListRetrieversInput) Validate 

func (s *ListRetrieversInput) Validate() error

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

type ListRetrieversOutput 

type ListRetrieversOutput struct {

	// If the response is truncated, Amazon Q Business returns this token, which
	// you can use in a later request to list the next set of retrievers.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// An array of summary information for one or more retrievers.
	Retrievers []*Retriever `locationName:"retrievers" type:"list"`
	// contains filtered or unexported fields
}

func (ListRetrieversOutput) GoString 

func (s ListRetrieversOutput) 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 (*ListRetrieversOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListRetrieversOutput) SetRetrievers 

func (s *ListRetrieversOutput) SetRetrievers(v []*Retriever) *ListRetrieversOutput

SetRetrievers sets the Retrievers field's value.

func (ListRetrieversOutput) String 

func (s ListRetrieversOutput) 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 Amazon Q Business application or data
	// source to get a list of tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" 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 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

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 {

	// A list of tags associated with the Amazon Q Business application or data
	// source.
	Tags []*Tag `locationName:"tags" type:"list"`
	// 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 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

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 ListWebExperiencesInput 

type ListWebExperiencesInput struct {

	// The identifier of the Amazon Q Business application linked to the listed
	// web experiences.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The maximum number of Amazon Q Business Web Experiences to return.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

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

func (ListWebExperiencesInput) GoString 

func (s ListWebExperiencesInput) 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 (*ListWebExperiencesInput) SetApplicationId 

func (s *ListWebExperiencesInput) SetApplicationId(v string) *ListWebExperiencesInput

SetApplicationId sets the ApplicationId field's value.

func (*ListWebExperiencesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListWebExperiencesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListWebExperiencesInput) String 

func (s ListWebExperiencesInput) 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 (*ListWebExperiencesInput) Validate 

func (s *ListWebExperiencesInput) Validate() error

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

type ListWebExperiencesOutput 

type ListWebExperiencesOutput struct {

	// If the response is truncated, Amazon Q Business returns this token, which
	// you can use in a later request to list the next set of messages.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// An array of summary information for one or more Amazon Q Business experiences.
	WebExperiences []*WebExperience `locationName:"webExperiences" type:"list"`
	// contains filtered or unexported fields
}

func (ListWebExperiencesOutput) GoString 

func (s ListWebExperiencesOutput) 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 (*ListWebExperiencesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListWebExperiencesOutput) SetWebExperiences 

func (s *ListWebExperiencesOutput) SetWebExperiences(v []*WebExperience) *ListWebExperiencesOutput

SetWebExperiences sets the WebExperiences field's value.

func (ListWebExperiencesOutput) String 

func (s ListWebExperiencesOutput) 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 MemberGroup 

type MemberGroup struct {

	// The name of the sub group.
	//
	// GroupName is a required field
	GroupName *string `locationName:"groupName" min:"1" type:"string" required:"true"`

	// The type of the sub group.
	Type *string `locationName:"type" type:"string" enum:"MembershipType"`
	// contains filtered or unexported fields
}

The sub groups that belong to a group.

func (MemberGroup) GoString 

func (s MemberGroup) 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 (*MemberGroup) SetGroupName 

func (s *MemberGroup) SetGroupName(v string) *MemberGroup

SetGroupName sets the GroupName field's value.

func (*MemberGroup) SetType 

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

SetType sets the Type field's value.

func (MemberGroup) String 

func (s MemberGroup) 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 (*MemberGroup) Validate 

func (s *MemberGroup) Validate() error

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

type MemberUser 

type MemberUser struct {

	// The type of the user.
	Type *string `locationName:"type" type:"string" enum:"MembershipType"`

	// The identifier of the user you want to map to a group.
	//
	// UserId is a required field
	UserId *string `locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The users that belong to a group.

func (MemberUser) GoString 

func (s MemberUser) 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 (*MemberUser) SetType 

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

SetType sets the Type field's value.

func (*MemberUser) SetUserId 

func (s *MemberUser) SetUserId(v string) *MemberUser

SetUserId sets the UserId field's value.

func (MemberUser) String 

func (s MemberUser) 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 (*MemberUser) Validate 

func (s *MemberUser) Validate() error

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

type Message 

type Message struct {

	// An output event that Amazon Q Business returns to an user who wants to perform
	// a plugin action during a non-streaming chat conversation. It contains information
	// about the selected action with a list of possible user input fields, some
	// pre-populated by Amazon Q Business.
	ActionReview *ActionReview `locationName:"actionReview" type:"structure"`

	// A file directly uploaded into an Amazon Q Business web experience chat.
	Attachments []*AttachmentOutput_ `locationName:"attachments" type:"list"`

	// The content of the Amazon Q Business web experience message.
	Body *string `locationName:"body" type:"string"`

	// The identifier of the Amazon Q Business web experience message.
	MessageId *string `locationName:"messageId" min:"1" type:"string"`

	// The source documents used to generate Amazon Q Business web experience message.
	SourceAttribution []*SourceAttribution `locationName:"sourceAttribution" type:"list"`

	// The timestamp of the first Amazon Q Business web experience message.
	Time *time.Time `locationName:"time" type:"timestamp"`

	// The type of Amazon Q Business message, whether HUMAN or AI generated.
	Type *string `locationName:"type" type:"string" enum:"MessageType"`
	// contains filtered or unexported fields
}

A message in an Amazon Q Business web experience.

func (Message) GoString 

func (s Message) 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 (*Message) SetActionReview 

func (s *Message) SetActionReview(v *ActionReview) *Message

SetActionReview sets the ActionReview field's value.

func (*Message) SetAttachments 

func (s *Message) SetAttachments(v []*AttachmentOutput_) *Message

SetAttachments sets the Attachments field's value.

func (*Message) SetBody 

func (s *Message) SetBody(v string) *Message

SetBody sets the Body field's value.

func (*Message) SetMessageId 

func (s *Message) SetMessageId(v string) *Message

SetMessageId sets the MessageId field's value.

func (*Message) SetSourceAttribution 

func (s *Message) SetSourceAttribution(v []*SourceAttribution) *Message

SetSourceAttribution sets the SourceAttribution field's value.

func (*Message) SetTime 

func (s *Message) SetTime(v time.Time) *Message

SetTime sets the Time field's value.

func (*Message) SetType 

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

SetType sets the Type field's value.

func (Message) String 

func (s Message) 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 MessageUsefulnessFeedback 

type MessageUsefulnessFeedback struct {

	// A comment given by an end user on the usefulness of an AI-generated chat
	// message.
	Comment *string `locationName:"comment" type:"string"`

	// The reason for a usefulness rating.
	Reason *string `locationName:"reason" type:"string" enum:"MessageUsefulnessReason"`

	// The timestamp for when the feedback was submitted.
	//
	// SubmittedAt is a required field
	SubmittedAt *time.Time `locationName:"submittedAt" type:"timestamp" required:"true"`

	// The usefulness value assigned by an end user to a message.
	//
	// Usefulness is a required field
	Usefulness *string `locationName:"usefulness" type:"string" required:"true" enum:"MessageUsefulness"`
	// contains filtered or unexported fields
}

End user feedback on an AI-generated web experience chat message usefulness.

func (MessageUsefulnessFeedback) GoString 

func (s MessageUsefulnessFeedback) 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 (*MessageUsefulnessFeedback) SetComment 

func (s *MessageUsefulnessFeedback) SetComment(v string) *MessageUsefulnessFeedback

SetComment sets the Comment field's value.

func (*MessageUsefulnessFeedback) SetReason 

func (s *MessageUsefulnessFeedback) SetReason(v string) *MessageUsefulnessFeedback

SetReason sets the Reason field's value.

func (*MessageUsefulnessFeedback) SetSubmittedAt 

func (s *MessageUsefulnessFeedback) SetSubmittedAt(v time.Time) *MessageUsefulnessFeedback

SetSubmittedAt sets the SubmittedAt field's value.

func (*MessageUsefulnessFeedback) SetUsefulness 

func (s *MessageUsefulnessFeedback) SetUsefulness(v string) *MessageUsefulnessFeedback

SetUsefulness sets the Usefulness field's value.

func (MessageUsefulnessFeedback) String 

func (s MessageUsefulnessFeedback) 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 (*MessageUsefulnessFeedback) Validate 

func (s *MessageUsefulnessFeedback) Validate() error

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

type MetadataEvent added in v1.51.32 

type MetadataEvent struct {

	// The identifier of the conversation with which the generated metadata is associated.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// The final text output message generated by the system.
	FinalTextMessage *string `locationName:"finalTextMessage" min:"1" type:"string"`

	// The source documents used to generate the conversation response.
	SourceAttributions []*SourceAttribution `locationName:"sourceAttributions" type:"list"`

	// The identifier of an Amazon Q Business AI generated message within the conversation.
	SystemMessageId *string `locationName:"systemMessageId" min:"36" type:"string"`

	// The identifier of an Amazon Q Business end user text input message within
	// the conversation.
	UserMessageId *string `locationName:"userMessageId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

func (MetadataEvent) GoString added in v1.51.32 

func (s MetadataEvent) 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 (*MetadataEvent) MarshalEvent added in v1.51.32 

func (s *MetadataEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*MetadataEvent) SetConversationId added in v1.51.32 

func (s *MetadataEvent) SetConversationId(v string) *MetadataEvent

SetConversationId sets the ConversationId field's value.

func (*MetadataEvent) SetFinalTextMessage added in v1.51.32 

func (s *MetadataEvent) SetFinalTextMessage(v string) *MetadataEvent

SetFinalTextMessage sets the FinalTextMessage field's value.

func (*MetadataEvent) SetSourceAttributions added in v1.51.32 

func (s *MetadataEvent) SetSourceAttributions(v []*SourceAttribution) *MetadataEvent

SetSourceAttributions sets the SourceAttributions field's value.

func (*MetadataEvent) SetSystemMessageId added in v1.51.32 

func (s *MetadataEvent) SetSystemMessageId(v string) *MetadataEvent

SetSystemMessageId sets the SystemMessageId field's value.

func (*MetadataEvent) SetUserMessageId added in v1.51.32 

func (s *MetadataEvent) SetUserMessageId(v string) *MetadataEvent

SetUserMessageId sets the UserMessageId field's value.

func (MetadataEvent) String added in v1.51.32 

func (s MetadataEvent) 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 (*MetadataEvent) UnmarshalEvent added in v1.51.32 

func (s *MetadataEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the MetadataEvent value. This method is only used internally within the SDK's EventStream handling.

type NativeIndexConfiguration 

type NativeIndexConfiguration struct {

	// Overrides the default boosts applied by Amazon Q Business to supported document
	// attribute data types.
	BoostingOverride map[string]*DocumentAttributeBoostingConfiguration `locationName:"boostingOverride" min:"1" type:"map"`

	// The identifier for the Amazon Q Business index.
	//
	// IndexId is a required field
	IndexId *string `locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information for an Amazon Q Business index.

func (NativeIndexConfiguration) GoString 

func (s NativeIndexConfiguration) 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 (*NativeIndexConfiguration) SetBoostingOverride added in v1.50.18 

func (s *NativeIndexConfiguration) SetBoostingOverride(v map[string]*DocumentAttributeBoostingConfiguration) *NativeIndexConfiguration

SetBoostingOverride sets the BoostingOverride field's value.

func (*NativeIndexConfiguration) SetIndexId 

func (s *NativeIndexConfiguration) SetIndexId(v string) *NativeIndexConfiguration

SetIndexId sets the IndexId field's value.

func (NativeIndexConfiguration) String 

func (s NativeIndexConfiguration) 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 (*NativeIndexConfiguration) Validate 

func (s *NativeIndexConfiguration) Validate() error

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

type NoAuthConfiguration added in v1.51.32 

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

Information about invoking a custom plugin without any authentication or authorization requirement.

func (NoAuthConfiguration) GoString added in v1.51.32 

func (s NoAuthConfiguration) 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 (NoAuthConfiguration) String added in v1.51.32 

func (s NoAuthConfiguration) 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 NumberAttributeBoostingConfiguration added in v1.50.18 

type NumberAttributeBoostingConfiguration struct {

	// Specifies the duration, in seconds, of a boost applies to a NUMBER type document
	// attribute.
	//
	// BoostingLevel is a required field
	BoostingLevel *string `locationName:"boostingLevel" type:"string" required:"true" enum:"DocumentAttributeBoostingLevel"`

	// Specifies how much a document attribute is boosted.
	BoostingType *string `locationName:"boostingType" type:"string" enum:"NumberAttributeBoostingType"`
	// contains filtered or unexported fields
}

Provides information on boosting NUMBER type document attributes.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html).

func (NumberAttributeBoostingConfiguration) GoString added in v1.50.18 

func (s NumberAttributeBoostingConfiguration) 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 (*NumberAttributeBoostingConfiguration) SetBoostingLevel added in v1.50.18 

func (s *NumberAttributeBoostingConfiguration) SetBoostingLevel(v string) *NumberAttributeBoostingConfiguration

SetBoostingLevel sets the BoostingLevel field's value.

func (*NumberAttributeBoostingConfiguration) SetBoostingType added in v1.50.18 

func (s *NumberAttributeBoostingConfiguration) SetBoostingType(v string) *NumberAttributeBoostingConfiguration

SetBoostingType sets the BoostingType field's value.

func (NumberAttributeBoostingConfiguration) String added in v1.50.18 

func (s NumberAttributeBoostingConfiguration) 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 (*NumberAttributeBoostingConfiguration) Validate added in v1.50.18 

func (s *NumberAttributeBoostingConfiguration) Validate() error

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

type OAuth2ClientCredentialConfiguration 

type OAuth2ClientCredentialConfiguration struct {

	// The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0
	// authentication credentials stored in a Secrets Manager secret.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token
	// used for plugin configuration.
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

func (OAuth2ClientCredentialConfiguration) GoString 

func (s OAuth2ClientCredentialConfiguration) 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 (*OAuth2ClientCredentialConfiguration) SetRoleArn 

func (s *OAuth2ClientCredentialConfiguration) SetRoleArn(v string) *OAuth2ClientCredentialConfiguration

SetRoleArn sets the RoleArn field's value.

func (*OAuth2ClientCredentialConfiguration) SetSecretArn 

func (s *OAuth2ClientCredentialConfiguration) SetSecretArn(v string) *OAuth2ClientCredentialConfiguration

SetSecretArn sets the SecretArn field's value.

func (OAuth2ClientCredentialConfiguration) String 

func (s OAuth2ClientCredentialConfiguration) 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 (*OAuth2ClientCredentialConfiguration) Validate 

func (s *OAuth2ClientCredentialConfiguration) Validate() error

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

type PersonalizationConfiguration added in v1.54.15 

type PersonalizationConfiguration struct {

	// An option to allow Amazon Q Business to customize chat responses using user
	// specific metadata—specifically, location and job information—in your
	// IAM Identity Center instance.
	//
	// PersonalizationControlMode is a required field
	PersonalizationControlMode *string `locationName:"personalizationControlMode" type:"string" required:"true" enum:"PersonalizationControlMode"`
	// contains filtered or unexported fields
}

Configuration information about chat response personalization. For more information, see Personalizing chat responses (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html).

func (PersonalizationConfiguration) GoString added in v1.54.15 

func (s PersonalizationConfiguration) 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 (*PersonalizationConfiguration) SetPersonalizationControlMode added in v1.54.15 

func (s *PersonalizationConfiguration) SetPersonalizationControlMode(v string) *PersonalizationConfiguration

SetPersonalizationControlMode sets the PersonalizationControlMode field's value.

func (PersonalizationConfiguration) String added in v1.54.15 

func (s PersonalizationConfiguration) 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 (*PersonalizationConfiguration) Validate added in v1.54.15 

func (s *PersonalizationConfiguration) Validate() error

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

type Plugin 

type Plugin struct {

	// The status of the plugin.
	BuildStatus *string `locationName:"buildStatus" type:"string" enum:"PluginBuildStatus"`

	// The timestamp for when the plugin was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The name of the plugin.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The identifier of the plugin.
	PluginId *string `locationName:"pluginId" min:"36" type:"string"`

	// The plugin server URL used for configuration.
	ServerUrl *string `locationName:"serverUrl" min:"1" type:"string"`

	// The current status of the plugin.
	State *string `locationName:"state" type:"string" enum:"PluginState"`

	// The type of the plugin.
	Type *string `locationName:"type" type:"string" enum:"PluginType"`

	// The timestamp for when the plugin was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Information about an Amazon Q Business plugin and its configuration.

func (Plugin) GoString 

func (s Plugin) 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 (*Plugin) SetBuildStatus added in v1.51.32 

func (s *Plugin) SetBuildStatus(v string) *Plugin

SetBuildStatus sets the BuildStatus field's value.

func (*Plugin) SetCreatedAt 

func (s *Plugin) SetCreatedAt(v time.Time) *Plugin

SetCreatedAt sets the CreatedAt field's value.

func (*Plugin) SetDisplayName 

func (s *Plugin) SetDisplayName(v string) *Plugin

SetDisplayName sets the DisplayName field's value.

func (*Plugin) SetPluginId 

func (s *Plugin) SetPluginId(v string) *Plugin

SetPluginId sets the PluginId field's value.

func (*Plugin) SetServerUrl 

func (s *Plugin) SetServerUrl(v string) *Plugin

SetServerUrl sets the ServerUrl field's value.

func (*Plugin) SetState 

func (s *Plugin) SetState(v string) *Plugin

SetState sets the State field's value.

func (*Plugin) SetType 

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

SetType sets the Type field's value.

func (*Plugin) SetUpdatedAt 

func (s *Plugin) SetUpdatedAt(v time.Time) *Plugin

SetUpdatedAt sets the UpdatedAt field's value.

func (Plugin) String 

func (s Plugin) 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 PluginAuthConfiguration 

type PluginAuthConfiguration struct {

	// Information about the basic authentication credentials used to configure
	// a plugin.
	BasicAuthConfiguration *BasicAuthConfiguration `locationName:"basicAuthConfiguration" type:"structure"`

	// Information about invoking a custom plugin without any authentication.
	NoAuthConfiguration *NoAuthConfiguration `locationName:"noAuthConfiguration" type:"structure"`

	// Information about the OAuth 2.0 authentication credential/token used to configure
	// a plugin.
	OAuth2ClientCredentialConfiguration *OAuth2ClientCredentialConfiguration `locationName:"oAuth2ClientCredentialConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Authentication configuration information for an Amazon Q Business plugin.

func (PluginAuthConfiguration) GoString 

func (s PluginAuthConfiguration) 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 (*PluginAuthConfiguration) SetBasicAuthConfiguration 

func (s *PluginAuthConfiguration) SetBasicAuthConfiguration(v *BasicAuthConfiguration) *PluginAuthConfiguration

SetBasicAuthConfiguration sets the BasicAuthConfiguration field's value.

func (*PluginAuthConfiguration) SetNoAuthConfiguration added in v1.51.32 

func (s *PluginAuthConfiguration) SetNoAuthConfiguration(v *NoAuthConfiguration) *PluginAuthConfiguration

SetNoAuthConfiguration sets the NoAuthConfiguration field's value.

func (*PluginAuthConfiguration) SetOAuth2ClientCredentialConfiguration 

func (s *PluginAuthConfiguration) SetOAuth2ClientCredentialConfiguration(v *OAuth2ClientCredentialConfiguration) *PluginAuthConfiguration

SetOAuth2ClientCredentialConfiguration sets the OAuth2ClientCredentialConfiguration field's value.

func (PluginAuthConfiguration) String 

func (s PluginAuthConfiguration) 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 (*PluginAuthConfiguration) Validate 

func (s *PluginAuthConfiguration) Validate() error

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

type PluginConfiguration added in v1.51.23 

type PluginConfiguration struct {

	// The identifier of the plugin you want to use.
	//
	// PluginId is a required field
	PluginId *string `locationName:"pluginId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information required to invoke chat in PLUGIN_MODE.

For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html), Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html), and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope).

func (PluginConfiguration) GoString added in v1.51.23 

func (s PluginConfiguration) 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 (*PluginConfiguration) SetPluginId added in v1.51.23 

func (s *PluginConfiguration) SetPluginId(v string) *PluginConfiguration

SetPluginId sets the PluginId field's value.

func (PluginConfiguration) String added in v1.51.23 

func (s PluginConfiguration) 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 (*PluginConfiguration) Validate added in v1.51.23 

func (s *PluginConfiguration) Validate() error

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

type Principal 

type Principal struct {

	// The group associated with the principal.
	Group *PrincipalGroup `locationName:"group" type:"structure"`

	// The user associated with the principal.
	User *PrincipalUser `locationName:"user" type:"structure"`
	// contains filtered or unexported fields
}

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

func (Principal) GoString 

func (s Principal) 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 (*Principal) SetGroup 

func (s *Principal) SetGroup(v *PrincipalGroup) *Principal

SetGroup sets the Group field's value.

func (*Principal) SetUser 

func (s *Principal) SetUser(v *PrincipalUser) *Principal

SetUser sets the User field's value.

func (Principal) String 

func (s Principal) 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 (*Principal) Validate 

func (s *Principal) Validate() error

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

type PrincipalGroup 

type PrincipalGroup struct {

	// Provides information about whether to allow or deny access to the principal.
	//
	// Access is a required field
	Access *string `locationName:"access" type:"string" required:"true" enum:"ReadAccessType"`

	// The type of group.
	MembershipType *string `locationName:"membershipType" type:"string" enum:"MembershipType"`

	// The name of the group.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a group associated with the principal.

func (PrincipalGroup) GoString 

func (s PrincipalGroup) 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 (*PrincipalGroup) SetAccess 

func (s *PrincipalGroup) SetAccess(v string) *PrincipalGroup

SetAccess sets the Access field's value.

func (*PrincipalGroup) SetMembershipType 

func (s *PrincipalGroup) SetMembershipType(v string) *PrincipalGroup

SetMembershipType sets the MembershipType field's value.

func (*PrincipalGroup) SetName 

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

SetName sets the Name field's value.

func (PrincipalGroup) String 

func (s PrincipalGroup) 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 (*PrincipalGroup) Validate 

func (s *PrincipalGroup) Validate() error

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

type PrincipalUser 

type PrincipalUser struct {

	// Provides information about whether to allow or deny access to the principal.
	//
	// Access is a required field
	Access *string `locationName:"access" type:"string" required:"true" enum:"ReadAccessType"`

	// The identifier of the user.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The type of group.
	MembershipType *string `locationName:"membershipType" type:"string" enum:"MembershipType"`
	// contains filtered or unexported fields
}

Provides information about a user associated with a principal.

func (PrincipalUser) GoString 

func (s PrincipalUser) 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 (*PrincipalUser) SetAccess 

func (s *PrincipalUser) SetAccess(v string) *PrincipalUser

SetAccess sets the Access field's value.

func (*PrincipalUser) SetId 

func (s *PrincipalUser) SetId(v string) *PrincipalUser

SetId sets the Id field's value.

func (*PrincipalUser) SetMembershipType 

func (s *PrincipalUser) SetMembershipType(v string) *PrincipalUser

SetMembershipType sets the MembershipType field's value.

func (PrincipalUser) String 

func (s PrincipalUser) 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 (*PrincipalUser) Validate 

func (s *PrincipalUser) Validate() error

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

type PutFeedbackInput 

type PutFeedbackInput struct {

	// The identifier of the application associated with the feedback.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the conversation the feedback is attached to.
	//
	// ConversationId is a required field
	ConversationId *string `location:"uri" locationName:"conversationId" min:"36" type:"string" required:"true"`

	// The timestamp for when the feedback was recorded.
	MessageCopiedAt *time.Time `locationName:"messageCopiedAt" type:"timestamp"`

	// The identifier of the chat message that the feedback was given for.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"36" type:"string" required:"true"`

	// The feedback usefulness value given by the user to the chat message.
	MessageUsefulness *MessageUsefulnessFeedback `locationName:"messageUsefulness" type:"structure"`

	// The identifier of the user giving the feedback.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutFeedbackInput) GoString 

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

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

SetApplicationId sets the ApplicationId field's value.

func (*PutFeedbackInput) SetConversationId 

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

SetConversationId sets the ConversationId field's value.

func (*PutFeedbackInput) SetMessageCopiedAt 

func (s *PutFeedbackInput) SetMessageCopiedAt(v time.Time) *PutFeedbackInput

SetMessageCopiedAt sets the MessageCopiedAt field's value.

func (*PutFeedbackInput) SetMessageId 

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

SetMessageId sets the MessageId field's value.

func (*PutFeedbackInput) SetMessageUsefulness 

func (s *PutFeedbackInput) SetMessageUsefulness(v *MessageUsefulnessFeedback) *PutFeedbackInput

SetMessageUsefulness sets the MessageUsefulness field's value.

func (*PutFeedbackInput) SetUserId 

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

SetUserId sets the UserId field's value.

func (PutFeedbackInput) String 

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 

func (s *PutFeedbackInput) Validate() error

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

type PutFeedbackOutput 

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

func (PutFeedbackOutput) GoString 

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

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 PutGroupInput 

type PutGroupInput struct {

	// The identifier of the application in which the user and group mapping belongs.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

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

	// A list of users or sub groups that belong to a group. This is for generating
	// Amazon Q Business chat results only from document a user has access to.
	//
	// GroupMembers is a required field
	GroupMembers *GroupMembers `locationName:"groupMembers" type:"structure" required:"true"`

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

	// The identifier of the index in which you want to map users to their groups.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

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

func (PutGroupInput) GoString 

func (s PutGroupInput) 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 (*PutGroupInput) SetApplicationId 

func (s *PutGroupInput) SetApplicationId(v string) *PutGroupInput

SetApplicationId sets the ApplicationId field's value.

func (*PutGroupInput) SetDataSourceId 

func (s *PutGroupInput) SetDataSourceId(v string) *PutGroupInput

SetDataSourceId sets the DataSourceId field's value.

func (*PutGroupInput) SetGroupMembers 

func (s *PutGroupInput) SetGroupMembers(v *GroupMembers) *PutGroupInput

SetGroupMembers sets the GroupMembers field's value.

func (*PutGroupInput) SetGroupName 

func (s *PutGroupInput) SetGroupName(v string) *PutGroupInput

SetGroupName sets the GroupName field's value.

func (*PutGroupInput) SetIndexId 

func (s *PutGroupInput) SetIndexId(v string) *PutGroupInput

SetIndexId sets the IndexId field's value.

func (*PutGroupInput) SetType 

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

SetType sets the Type field's value.

func (PutGroupInput) String 

func (s PutGroupInput) 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 (*PutGroupInput) Validate 

func (s *PutGroupInput) Validate() error

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

type PutGroupOutput 

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

func (PutGroupOutput) GoString 

func (s PutGroupOutput) 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 (PutGroupOutput) String 

func (s PutGroupOutput) 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 QAppsConfiguration added in v1.54.7 

type QAppsConfiguration struct {

	// Status information about whether end users can create and use Amazon Q Apps
	// in the web experience.
	//
	// QAppsControlMode is a required field
	QAppsControlMode *string `locationName:"qAppsControlMode" type:"string" required:"true" enum:"QAppsControlMode"`
	// contains filtered or unexported fields
}

Configuration information about Amazon Q Apps. (preview feature)

func (QAppsConfiguration) GoString added in v1.54.7 

func (s QAppsConfiguration) 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 (*QAppsConfiguration) SetQAppsControlMode added in v1.54.7 

func (s *QAppsConfiguration) SetQAppsControlMode(v string) *QAppsConfiguration

SetQAppsControlMode sets the QAppsControlMode field's value.

func (QAppsConfiguration) String added in v1.54.7 

func (s QAppsConfiguration) 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 (*QAppsConfiguration) Validate added in v1.54.7 

func (s *QAppsConfiguration) Validate() error

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

type QBusiness 

type QBusiness struct {
	*client.Client
}

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

QBusiness 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) *QBusiness

New creates a new instance of the QBusiness 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 QBusiness client from just a session.
svc := qbusiness.New(mySession)

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

func (*QBusiness) BatchDeleteDocument 

func (c *QBusiness) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocument API operation for QBusiness.

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

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

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 QBusiness's API operation BatchDeleteDocument for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchDeleteDocument

func (*QBusiness) BatchDeleteDocumentRequest 

func (c *QBusiness) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)

BatchDeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDocument 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 BatchDeleteDocument for more information on using the BatchDeleteDocument 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 BatchDeleteDocumentRequest method.
req, resp := client.BatchDeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchDeleteDocument

func (*QBusiness) BatchDeleteDocumentWithContext 

func (c *QBusiness) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocumentWithContext is the same as BatchDeleteDocument with the addition of the ability to pass a context and additional request options.

See BatchDeleteDocument 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 (*QBusiness) BatchPutDocument 

func (c *QBusiness) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)

BatchPutDocument API operation for QBusiness.

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

You use this API to:

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

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

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

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

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 QBusiness's API operation BatchPutDocument for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchPutDocument

func (*QBusiness) BatchPutDocumentRequest 

func (c *QBusiness) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)

BatchPutDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchPutDocument 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 BatchPutDocument for more information on using the BatchPutDocument 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 BatchPutDocumentRequest method.
req, resp := client.BatchPutDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchPutDocument

func (*QBusiness) BatchPutDocumentWithContext 

func (c *QBusiness) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)

BatchPutDocumentWithContext is the same as BatchPutDocument with the addition of the ability to pass a context and additional request options.

See BatchPutDocument 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 (*QBusiness) Chat added in v1.51.32 

func (c *QBusiness) Chat(input *ChatInput) (*ChatOutput, error)

Chat API operation for QBusiness.

Starts or continues a streaming Amazon Q Business conversation.

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 QBusiness's API operation Chat for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Chat

func (*QBusiness) ChatRequest added in v1.51.32 

func (c *QBusiness) ChatRequest(input *ChatInput) (req *request.Request, output *ChatOutput)

ChatRequest generates a "aws/request.Request" representing the client's request for the Chat 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 Chat for more information on using the Chat 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 ChatRequest method.
req, resp := client.ChatRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Chat

func (*QBusiness) ChatSync 

func (c *QBusiness) ChatSync(input *ChatSyncInput) (*ChatSyncOutput, error)

ChatSync API operation for QBusiness.

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

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 QBusiness's API operation ChatSync for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatSync

func (*QBusiness) ChatSyncRequest 

func (c *QBusiness) ChatSyncRequest(input *ChatSyncInput) (req *request.Request, output *ChatSyncOutput)

ChatSyncRequest generates a "aws/request.Request" representing the client's request for the ChatSync 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 ChatSync for more information on using the ChatSync 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 ChatSyncRequest method.
req, resp := client.ChatSyncRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatSync

func (*QBusiness) ChatSyncWithContext 

func (c *QBusiness) ChatSyncWithContext(ctx aws.Context, input *ChatSyncInput, opts ...request.Option) (*ChatSyncOutput, error)

ChatSyncWithContext is the same as ChatSync with the addition of the ability to pass a context and additional request options.

See ChatSync 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 (*QBusiness) ChatWithContext added in v1.51.32 

func (c *QBusiness) ChatWithContext(ctx aws.Context, input *ChatInput, opts ...request.Option) (*ChatOutput, error)

ChatWithContext is the same as Chat with the addition of the ability to pass a context and additional request options.

See Chat 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 (*QBusiness) CreateApplication 

func (c *QBusiness) CreateApplication(input *CreateApplicationInput) (*CreateApplicationOutput, error)

CreateApplication API operation for QBusiness.

Creates an Amazon Q Business application.

There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers). You must use the Amazon Q Business console to assign subscription tiers to users.

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 QBusiness's API operation CreateApplication for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplication

func (*QBusiness) CreateApplicationRequest 

func (c *QBusiness) CreateApplicationRequest(input *CreateApplicationInput) (req *request.Request, output *CreateApplicationOutput)

CreateApplicationRequest generates a "aws/request.Request" representing the client's request for the CreateApplication 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 CreateApplication for more information on using the CreateApplication 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 CreateApplicationRequest method.
req, resp := client.CreateApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplication

func (*QBusiness) CreateApplicationWithContext 

func (c *QBusiness) CreateApplicationWithContext(ctx aws.Context, input *CreateApplicationInput, opts ...request.Option) (*CreateApplicationOutput, error)

CreateApplicationWithContext is the same as CreateApplication with the addition of the ability to pass a context and additional request options.

See CreateApplication 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 (*QBusiness) CreateIndex 

func (c *QBusiness) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)

CreateIndex API operation for QBusiness.

Creates an Amazon Q Business index.

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

Once the index is active, you can index your documents using the BatchPutDocument (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html) API or the CreateDataSource (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) API.

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 QBusiness's API operation CreateIndex for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateIndex

func (*QBusiness) CreateIndexRequest 

func (c *QBusiness) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)

CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex 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 CreateIndex for more information on using the CreateIndex 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 CreateIndexRequest method.
req, resp := client.CreateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateIndex

func (*QBusiness) CreateIndexWithContext 

func (c *QBusiness) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)

CreateIndexWithContext is the same as CreateIndex with the addition of the ability to pass a context and additional request options.

See CreateIndex 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 (*QBusiness) CreatePlugin 

func (c *QBusiness) CreatePlugin(input *CreatePluginInput) (*CreatePluginOutput, error)

CreatePlugin API operation for QBusiness.

Creates an Amazon Q Business plugin.

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 QBusiness's API operation CreatePlugin for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreatePlugin

func (*QBusiness) CreatePluginRequest 

func (c *QBusiness) CreatePluginRequest(input *CreatePluginInput) (req *request.Request, output *CreatePluginOutput)

CreatePluginRequest generates a "aws/request.Request" representing the client's request for the CreatePlugin 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 CreatePlugin for more information on using the CreatePlugin 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 CreatePluginRequest method.
req, resp := client.CreatePluginRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreatePlugin

func (*QBusiness) CreatePluginWithContext 

func (c *QBusiness) CreatePluginWithContext(ctx aws.Context, input *CreatePluginInput, opts ...request.Option) (*CreatePluginOutput, error)

CreatePluginWithContext is the same as CreatePlugin with the addition of the ability to pass a context and additional request options.

See CreatePlugin 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 (*QBusiness) CreateRetriever 

func (c *QBusiness) CreateRetriever(input *CreateRetrieverInput) (*CreateRetrieverOutput, error)

CreateRetriever API operation for QBusiness.

Adds a retriever to your Amazon Q Business application.

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 QBusiness's API operation CreateRetriever for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateRetriever

func (*QBusiness) CreateRetrieverRequest 

func (c *QBusiness) CreateRetrieverRequest(input *CreateRetrieverInput) (req *request.Request, output *CreateRetrieverOutput)

CreateRetrieverRequest generates a "aws/request.Request" representing the client's request for the CreateRetriever 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 CreateRetriever for more information on using the CreateRetriever 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 CreateRetrieverRequest method.
req, resp := client.CreateRetrieverRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateRetriever

func (*QBusiness) CreateRetrieverWithContext 

func (c *QBusiness) CreateRetrieverWithContext(ctx aws.Context, input *CreateRetrieverInput, opts ...request.Option) (*CreateRetrieverOutput, error)

CreateRetrieverWithContext is the same as CreateRetriever with the addition of the ability to pass a context and additional request options.

See CreateRetriever 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 (*QBusiness) CreateUser 

func (c *QBusiness) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for QBusiness.

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

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 QBusiness's API operation CreateUser for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateUser

func (*QBusiness) CreateUserRequest 

func (c *QBusiness) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser 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 CreateUser for more information on using the CreateUser 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 CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateUser

func (*QBusiness) CreateUserWithContext 

func (c *QBusiness) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser 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 (*QBusiness) CreateWebExperience 

func (c *QBusiness) CreateWebExperience(input *CreateWebExperienceInput) (*CreateWebExperienceOutput, error)

CreateWebExperience API operation for QBusiness.

Creates an Amazon Q Business web experience.

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 QBusiness's API operation CreateWebExperience for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperience

func (*QBusiness) CreateWebExperienceRequest 

func (c *QBusiness) CreateWebExperienceRequest(input *CreateWebExperienceInput) (req *request.Request, output *CreateWebExperienceOutput)

CreateWebExperienceRequest generates a "aws/request.Request" representing the client's request for the CreateWebExperience 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 CreateWebExperience for more information on using the CreateWebExperience 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 CreateWebExperienceRequest method.
req, resp := client.CreateWebExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperience

func (*QBusiness) CreateWebExperienceWithContext 

func (c *QBusiness) CreateWebExperienceWithContext(ctx aws.Context, input *CreateWebExperienceInput, opts ...request.Option) (*CreateWebExperienceOutput, error)

CreateWebExperienceWithContext is the same as CreateWebExperience with the addition of the ability to pass a context and additional request options.

See CreateWebExperience 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 (*QBusiness) DeleteApplication 

func (c *QBusiness) DeleteApplication(input *DeleteApplicationInput) (*DeleteApplicationOutput, error)

DeleteApplication API operation for QBusiness.

Deletes an Amazon Q Business application.

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 QBusiness's API operation DeleteApplication for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteApplication

func (*QBusiness) DeleteApplicationRequest 

func (c *QBusiness) DeleteApplicationRequest(input *DeleteApplicationInput) (req *request.Request, output *DeleteApplicationOutput)

DeleteApplicationRequest generates a "aws/request.Request" representing the client's request for the DeleteApplication 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 DeleteApplication for more information on using the DeleteApplication 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 DeleteApplicationRequest method.
req, resp := client.DeleteApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteApplication

func (*QBusiness) DeleteApplicationWithContext 

func (c *QBusiness) DeleteApplicationWithContext(ctx aws.Context, input *DeleteApplicationInput, opts ...request.Option) (*DeleteApplicationOutput, error)

DeleteApplicationWithContext is the same as DeleteApplication with the addition of the ability to pass a context and additional request options.

See DeleteApplication 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 (*QBusiness) DeleteChatControlsConfiguration 

func (c *QBusiness) DeleteChatControlsConfiguration(input *DeleteChatControlsConfigurationInput) (*DeleteChatControlsConfigurationOutput, error)

DeleteChatControlsConfiguration API operation for QBusiness.

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

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 QBusiness's API operation DeleteChatControlsConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteChatControlsConfiguration

func (*QBusiness) DeleteChatControlsConfigurationRequest 

func (c *QBusiness) DeleteChatControlsConfigurationRequest(input *DeleteChatControlsConfigurationInput) (req *request.Request, output *DeleteChatControlsConfigurationOutput)

DeleteChatControlsConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteChatControlsConfiguration 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 DeleteChatControlsConfiguration for more information on using the DeleteChatControlsConfiguration 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 DeleteChatControlsConfigurationRequest method.
req, resp := client.DeleteChatControlsConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteChatControlsConfiguration

func (*QBusiness) DeleteChatControlsConfigurationWithContext 

func (c *QBusiness) DeleteChatControlsConfigurationWithContext(ctx aws.Context, input *DeleteChatControlsConfigurationInput, opts ...request.Option) (*DeleteChatControlsConfigurationOutput, error)

DeleteChatControlsConfigurationWithContext is the same as DeleteChatControlsConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteChatControlsConfiguration 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 (*QBusiness) DeleteConversation 

func (c *QBusiness) DeleteConversation(input *DeleteConversationInput) (*DeleteConversationOutput, error)

DeleteConversation API operation for QBusiness.

Deletes an Amazon Q Business web experience conversation.

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 QBusiness's API operation DeleteConversation for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteConversation

func (*QBusiness) DeleteConversationRequest 

func (c *QBusiness) DeleteConversationRequest(input *DeleteConversationInput) (req *request.Request, output *DeleteConversationOutput)

DeleteConversationRequest generates a "aws/request.Request" representing the client's request for the DeleteConversation 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 DeleteConversation for more information on using the DeleteConversation 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 DeleteConversationRequest method.
req, resp := client.DeleteConversationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteConversation

func (*QBusiness) DeleteConversationWithContext 

func (c *QBusiness) DeleteConversationWithContext(ctx aws.Context, input *DeleteConversationInput, opts ...request.Option) (*DeleteConversationOutput, error)

DeleteConversationWithContext is the same as DeleteConversation with the addition of the ability to pass a context and additional request options.

See DeleteConversation 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 (*QBusiness) DeleteDataSource 

func (c *QBusiness) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)

DeleteDataSource API operation for QBusiness.

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

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 QBusiness's API operation DeleteDataSource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteDataSource

func (*QBusiness) DeleteDataSourceRequest 

func (c *QBusiness) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)

DeleteDataSourceRequest generates a "aws/request.Request" representing the client's request for the DeleteDataSource 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 DeleteDataSource for more information on using the DeleteDataSource 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 DeleteDataSourceRequest method.
req, resp := client.DeleteDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteDataSource

func (*QBusiness) DeleteDataSourceWithContext 

func (c *QBusiness) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)

DeleteDataSourceWithContext is the same as DeleteDataSource with the addition of the ability to pass a context and additional request options.

See DeleteDataSource 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 (*QBusiness) DeleteGroup 

func (c *QBusiness) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup API operation for QBusiness.

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

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

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 QBusiness's API operation DeleteGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteGroup

func (*QBusiness) DeleteGroupRequest 

func (c *QBusiness) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)

DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup 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 DeleteGroup for more information on using the DeleteGroup 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 DeleteGroupRequest method.
req, resp := client.DeleteGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteGroup

func (*QBusiness) DeleteGroupWithContext 

func (c *QBusiness) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)

DeleteGroupWithContext is the same as DeleteGroup with the addition of the ability to pass a context and additional request options.

See DeleteGroup 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 (*QBusiness) DeleteIndex 

func (c *QBusiness) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)

DeleteIndex API operation for QBusiness.

Deletes an Amazon Q Business index.

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 QBusiness's API operation DeleteIndex for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteIndex

func (*QBusiness) DeleteIndexRequest 

func (c *QBusiness) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)

DeleteIndexRequest generates a "aws/request.Request" representing the client's request for the DeleteIndex 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 DeleteIndex for more information on using the DeleteIndex 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 DeleteIndexRequest method.
req, resp := client.DeleteIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteIndex

func (*QBusiness) DeleteIndexWithContext 

func (c *QBusiness) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)

DeleteIndexWithContext is the same as DeleteIndex with the addition of the ability to pass a context and additional request options.

See DeleteIndex 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 (*QBusiness) DeletePlugin 

func (c *QBusiness) DeletePlugin(input *DeletePluginInput) (*DeletePluginOutput, error)

DeletePlugin API operation for QBusiness.

Deletes an Amazon Q Business plugin.

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 QBusiness's API operation DeletePlugin for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeletePlugin

func (*QBusiness) DeletePluginRequest 

func (c *QBusiness) DeletePluginRequest(input *DeletePluginInput) (req *request.Request, output *DeletePluginOutput)

DeletePluginRequest generates a "aws/request.Request" representing the client's request for the DeletePlugin 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 DeletePlugin for more information on using the DeletePlugin 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 DeletePluginRequest method.
req, resp := client.DeletePluginRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeletePlugin

func (*QBusiness) DeletePluginWithContext 

func (c *QBusiness) DeletePluginWithContext(ctx aws.Context, input *DeletePluginInput, opts ...request.Option) (*DeletePluginOutput, error)

DeletePluginWithContext is the same as DeletePlugin with the addition of the ability to pass a context and additional request options.

See DeletePlugin 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 (*QBusiness) DeleteRetriever 

func (c *QBusiness) DeleteRetriever(input *DeleteRetrieverInput) (*DeleteRetrieverOutput, error)

DeleteRetriever API operation for QBusiness.

Deletes the retriever used by an Amazon Q Business application.

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 QBusiness's API operation DeleteRetriever for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteRetriever

func (*QBusiness) DeleteRetrieverRequest 

func (c *QBusiness) DeleteRetrieverRequest(input *DeleteRetrieverInput) (req *request.Request, output *DeleteRetrieverOutput)

DeleteRetrieverRequest generates a "aws/request.Request" representing the client's request for the DeleteRetriever 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 DeleteRetriever for more information on using the DeleteRetriever 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 DeleteRetrieverRequest method.
req, resp := client.DeleteRetrieverRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteRetriever

func (*QBusiness) DeleteRetrieverWithContext 

func (c *QBusiness) DeleteRetrieverWithContext(ctx aws.Context, input *DeleteRetrieverInput, opts ...request.Option) (*DeleteRetrieverOutput, error)

DeleteRetrieverWithContext is the same as DeleteRetriever with the addition of the ability to pass a context and additional request options.

See DeleteRetriever 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 (*QBusiness) DeleteUser 

func (c *QBusiness) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for QBusiness.

Deletes a user by email id.

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 QBusiness's API operation DeleteUser for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteUser

func (*QBusiness) DeleteUserRequest 

func (c *QBusiness) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser 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 DeleteUser for more information on using the DeleteUser 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 DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteUser

func (*QBusiness) DeleteUserWithContext 

func (c *QBusiness) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser 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 (*QBusiness) DeleteWebExperience 

func (c *QBusiness) DeleteWebExperience(input *DeleteWebExperienceInput) (*DeleteWebExperienceOutput, error)

DeleteWebExperience API operation for QBusiness.

Deletes an Amazon Q Business web experience.

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 QBusiness's API operation DeleteWebExperience for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteWebExperience

func (*QBusiness) DeleteWebExperienceRequest 

func (c *QBusiness) DeleteWebExperienceRequest(input *DeleteWebExperienceInput) (req *request.Request, output *DeleteWebExperienceOutput)

DeleteWebExperienceRequest generates a "aws/request.Request" representing the client's request for the DeleteWebExperience 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 DeleteWebExperience for more information on using the DeleteWebExperience 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 DeleteWebExperienceRequest method.
req, resp := client.DeleteWebExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteWebExperience

func (*QBusiness) DeleteWebExperienceWithContext 

func (c *QBusiness) DeleteWebExperienceWithContext(ctx aws.Context, input *DeleteWebExperienceInput, opts ...request.Option) (*DeleteWebExperienceOutput, error)

DeleteWebExperienceWithContext is the same as DeleteWebExperience with the addition of the ability to pass a context and additional request options.

See DeleteWebExperience 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 (*QBusiness) GetApplication 

func (c *QBusiness) GetApplication(input *GetApplicationInput) (*GetApplicationOutput, error)

GetApplication API operation for QBusiness.

Gets information about an existing Amazon Q Business application.

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 QBusiness's API operation GetApplication for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplication

func (*QBusiness) GetApplicationRequest 

func (c *QBusiness) GetApplicationRequest(input *GetApplicationInput) (req *request.Request, output *GetApplicationOutput)

GetApplicationRequest generates a "aws/request.Request" representing the client's request for the GetApplication 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 GetApplication for more information on using the GetApplication 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 GetApplicationRequest method.
req, resp := client.GetApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplication

func (*QBusiness) GetApplicationWithContext 

func (c *QBusiness) GetApplicationWithContext(ctx aws.Context, input *GetApplicationInput, opts ...request.Option) (*GetApplicationOutput, error)

GetApplicationWithContext is the same as GetApplication with the addition of the ability to pass a context and additional request options.

See GetApplication 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 (*QBusiness) GetChatControlsConfiguration 

func (c *QBusiness) GetChatControlsConfiguration(input *GetChatControlsConfigurationInput) (*GetChatControlsConfigurationOutput, error)

GetChatControlsConfiguration API operation for QBusiness.

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

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 QBusiness's API operation GetChatControlsConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfiguration

func (*QBusiness) GetChatControlsConfigurationPages 

func (c *QBusiness) GetChatControlsConfigurationPages(input *GetChatControlsConfigurationInput, fn func(*GetChatControlsConfigurationOutput, bool) bool) error

GetChatControlsConfigurationPages iterates over the pages of a GetChatControlsConfiguration operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetChatControlsConfiguration 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 GetChatControlsConfiguration operation.
pageNum := 0
err := client.GetChatControlsConfigurationPages(params,
    func(page *qbusiness.GetChatControlsConfigurationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) GetChatControlsConfigurationPagesWithContext 

func (c *QBusiness) GetChatControlsConfigurationPagesWithContext(ctx aws.Context, input *GetChatControlsConfigurationInput, fn func(*GetChatControlsConfigurationOutput, bool) bool, opts ...request.Option) error

GetChatControlsConfigurationPagesWithContext same as GetChatControlsConfigurationPages 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 (*QBusiness) GetChatControlsConfigurationRequest 

func (c *QBusiness) GetChatControlsConfigurationRequest(input *GetChatControlsConfigurationInput) (req *request.Request, output *GetChatControlsConfigurationOutput)

GetChatControlsConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetChatControlsConfiguration 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 GetChatControlsConfiguration for more information on using the GetChatControlsConfiguration 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 GetChatControlsConfigurationRequest method.
req, resp := client.GetChatControlsConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfiguration

func (*QBusiness) GetChatControlsConfigurationWithContext 

func (c *QBusiness) GetChatControlsConfigurationWithContext(ctx aws.Context, input *GetChatControlsConfigurationInput, opts ...request.Option) (*GetChatControlsConfigurationOutput, error)

GetChatControlsConfigurationWithContext is the same as GetChatControlsConfiguration with the addition of the ability to pass a context and additional request options.

See GetChatControlsConfiguration 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 (*QBusiness) GetDataSource 

func (c *QBusiness) GetDataSource(input *GetDataSourceInput) (*GetDataSourceOutput, error)

GetDataSource API operation for QBusiness.

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

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 QBusiness's API operation GetDataSource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSource

func (*QBusiness) GetDataSourceRequest 

func (c *QBusiness) GetDataSourceRequest(input *GetDataSourceInput) (req *request.Request, output *GetDataSourceOutput)

GetDataSourceRequest generates a "aws/request.Request" representing the client's request for the GetDataSource 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 GetDataSource for more information on using the GetDataSource 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 GetDataSourceRequest method.
req, resp := client.GetDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSource

func (*QBusiness) GetDataSourceWithContext 

func (c *QBusiness) GetDataSourceWithContext(ctx aws.Context, input *GetDataSourceInput, opts ...request.Option) (*GetDataSourceOutput, error)

GetDataSourceWithContext is the same as GetDataSource with the addition of the ability to pass a context and additional request options.

See GetDataSource 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 (*QBusiness) GetGroup 

func (c *QBusiness) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)

GetGroup API operation for QBusiness.

Describes a group by group 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 QBusiness's API operation GetGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetGroup

func (*QBusiness) GetGroupRequest 

func (c *QBusiness) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)

GetGroupRequest generates a "aws/request.Request" representing the client's request for the GetGroup 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 GetGroup for more information on using the GetGroup 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 GetGroupRequest method.
req, resp := client.GetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetGroup

func (*QBusiness) GetGroupWithContext 

func (c *QBusiness) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)

GetGroupWithContext is the same as GetGroup with the addition of the ability to pass a context and additional request options.

See GetGroup 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 (*QBusiness) GetIndex 

func (c *QBusiness) GetIndex(input *GetIndexInput) (*GetIndexOutput, error)

GetIndex API operation for QBusiness.

Gets information about an existing Amazon Q Business index.

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 QBusiness's API operation GetIndex for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndex

func (*QBusiness) GetIndexRequest 

func (c *QBusiness) GetIndexRequest(input *GetIndexInput) (req *request.Request, output *GetIndexOutput)

GetIndexRequest generates a "aws/request.Request" representing the client's request for the GetIndex 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 GetIndex for more information on using the GetIndex 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 GetIndexRequest method.
req, resp := client.GetIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndex

func (*QBusiness) GetIndexWithContext 

func (c *QBusiness) GetIndexWithContext(ctx aws.Context, input *GetIndexInput, opts ...request.Option) (*GetIndexOutput, error)

GetIndexWithContext is the same as GetIndex with the addition of the ability to pass a context and additional request options.

See GetIndex 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 (*QBusiness) GetPlugin 

func (c *QBusiness) GetPlugin(input *GetPluginInput) (*GetPluginOutput, error)

GetPlugin API operation for QBusiness.

Gets information about an existing Amazon Q Business plugin.

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 QBusiness's API operation GetPlugin for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPlugin

func (*QBusiness) GetPluginRequest 

func (c *QBusiness) GetPluginRequest(input *GetPluginInput) (req *request.Request, output *GetPluginOutput)

GetPluginRequest generates a "aws/request.Request" representing the client's request for the GetPlugin 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 GetPlugin for more information on using the GetPlugin 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 GetPluginRequest method.
req, resp := client.GetPluginRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPlugin

func (*QBusiness) GetPluginWithContext 

func (c *QBusiness) GetPluginWithContext(ctx aws.Context, input *GetPluginInput, opts ...request.Option) (*GetPluginOutput, error)

GetPluginWithContext is the same as GetPlugin with the addition of the ability to pass a context and additional request options.

See GetPlugin 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 (*QBusiness) GetRetriever 

func (c *QBusiness) GetRetriever(input *GetRetrieverInput) (*GetRetrieverOutput, error)

GetRetriever API operation for QBusiness.

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

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 QBusiness's API operation GetRetriever for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetRetriever

func (*QBusiness) GetRetrieverRequest 

func (c *QBusiness) GetRetrieverRequest(input *GetRetrieverInput) (req *request.Request, output *GetRetrieverOutput)

GetRetrieverRequest generates a "aws/request.Request" representing the client's request for the GetRetriever 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 GetRetriever for more information on using the GetRetriever 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 GetRetrieverRequest method.
req, resp := client.GetRetrieverRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetRetriever

func (*QBusiness) GetRetrieverWithContext 

func (c *QBusiness) GetRetrieverWithContext(ctx aws.Context, input *GetRetrieverInput, opts ...request.Option) (*GetRetrieverOutput, error)

GetRetrieverWithContext is the same as GetRetriever with the addition of the ability to pass a context and additional request options.

See GetRetriever 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 (*QBusiness) GetUser 

func (c *QBusiness) GetUser(input *GetUserInput) (*GetUserOutput, error)

GetUser API operation for QBusiness.

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

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 QBusiness's API operation GetUser for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetUser

func (*QBusiness) GetUserRequest 

func (c *QBusiness) GetUserRequest(input *GetUserInput) (req *request.Request, output *GetUserOutput)

GetUserRequest generates a "aws/request.Request" representing the client's request for the GetUser 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 GetUser for more information on using the GetUser 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 GetUserRequest method.
req, resp := client.GetUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetUser

func (*QBusiness) GetUserWithContext 

func (c *QBusiness) GetUserWithContext(ctx aws.Context, input *GetUserInput, opts ...request.Option) (*GetUserOutput, error)

GetUserWithContext is the same as GetUser with the addition of the ability to pass a context and additional request options.

See GetUser 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 (*QBusiness) GetWebExperience 

func (c *QBusiness) GetWebExperience(input *GetWebExperienceInput) (*GetWebExperienceOutput, error)

GetWebExperience API operation for QBusiness.

Gets information about an existing Amazon Q Business web experience.

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 QBusiness's API operation GetWebExperience for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperience

func (*QBusiness) GetWebExperienceRequest 

func (c *QBusiness) GetWebExperienceRequest(input *GetWebExperienceInput) (req *request.Request, output *GetWebExperienceOutput)

GetWebExperienceRequest generates a "aws/request.Request" representing the client's request for the GetWebExperience 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 GetWebExperience for more information on using the GetWebExperience 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 GetWebExperienceRequest method.
req, resp := client.GetWebExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperience

func (*QBusiness) GetWebExperienceWithContext 

func (c *QBusiness) GetWebExperienceWithContext(ctx aws.Context, input *GetWebExperienceInput, opts ...request.Option) (*GetWebExperienceOutput, error)

GetWebExperienceWithContext is the same as GetWebExperience with the addition of the ability to pass a context and additional request options.

See GetWebExperience 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 (*QBusiness) ListApplications 

func (c *QBusiness) ListApplications(input *ListApplicationsInput) (*ListApplicationsOutput, error)

ListApplications API operation for QBusiness.

Lists Amazon Q Business applications.

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 QBusiness's API operation ListApplications for usage and error information.

Returned Error Types:

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplications

func (*QBusiness) ListApplicationsPages 

func (c *QBusiness) ListApplicationsPages(input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool) error

ListApplicationsPages iterates over the pages of a ListApplications operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListApplications 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 ListApplications operation.
pageNum := 0
err := client.ListApplicationsPages(params,
    func(page *qbusiness.ListApplicationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListApplicationsPagesWithContext 

func (c *QBusiness) ListApplicationsPagesWithContext(ctx aws.Context, input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool, opts ...request.Option) error

ListApplicationsPagesWithContext same as ListApplicationsPages 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 (*QBusiness) ListApplicationsRequest 

func (c *QBusiness) ListApplicationsRequest(input *ListApplicationsInput) (req *request.Request, output *ListApplicationsOutput)

ListApplicationsRequest generates a "aws/request.Request" representing the client's request for the ListApplications 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 ListApplications for more information on using the ListApplications 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 ListApplicationsRequest method.
req, resp := client.ListApplicationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplications

func (*QBusiness) ListApplicationsWithContext 

func (c *QBusiness) ListApplicationsWithContext(ctx aws.Context, input *ListApplicationsInput, opts ...request.Option) (*ListApplicationsOutput, error)

ListApplicationsWithContext is the same as ListApplications with the addition of the ability to pass a context and additional request options.

See ListApplications 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 (*QBusiness) ListConversations 

func (c *QBusiness) ListConversations(input *ListConversationsInput) (*ListConversationsOutput, error)

ListConversations API operation for QBusiness.

Lists one or more Amazon Q Business conversations.

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 QBusiness's API operation ListConversations for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversations

func (*QBusiness) ListConversationsPages 

func (c *QBusiness) ListConversationsPages(input *ListConversationsInput, fn func(*ListConversationsOutput, bool) bool) error

ListConversationsPages iterates over the pages of a ListConversations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConversations 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 ListConversations operation.
pageNum := 0
err := client.ListConversationsPages(params,
    func(page *qbusiness.ListConversationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListConversationsPagesWithContext 

func (c *QBusiness) ListConversationsPagesWithContext(ctx aws.Context, input *ListConversationsInput, fn func(*ListConversationsOutput, bool) bool, opts ...request.Option) error

ListConversationsPagesWithContext same as ListConversationsPages 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 (*QBusiness) ListConversationsRequest 

func (c *QBusiness) ListConversationsRequest(input *ListConversationsInput) (req *request.Request, output *ListConversationsOutput)

ListConversationsRequest generates a "aws/request.Request" representing the client's request for the ListConversations 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 ListConversations for more information on using the ListConversations 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 ListConversationsRequest method.
req, resp := client.ListConversationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversations

func (*QBusiness) ListConversationsWithContext 

func (c *QBusiness) ListConversationsWithContext(ctx aws.Context, input *ListConversationsInput, opts ...request.Option) (*ListConversationsOutput, error)

ListConversationsWithContext is the same as ListConversations with the addition of the ability to pass a context and additional request options.

See ListConversations 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 (*QBusiness) ListDataSourceSyncJobs 

func (c *QBusiness) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobs API operation for QBusiness.

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

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 QBusiness's API operation ListDataSourceSyncJobs for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourceSyncJobs

func (*QBusiness) ListDataSourceSyncJobsPages 

func (c *QBusiness) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error

ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSourceSyncJobs 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 ListDataSourceSyncJobs operation.
pageNum := 0
err := client.ListDataSourceSyncJobsPages(params,
    func(page *qbusiness.ListDataSourceSyncJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListDataSourceSyncJobsPagesWithContext 

func (c *QBusiness) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error

ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages 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 (*QBusiness) ListDataSourceSyncJobsRequest 

func (c *QBusiness) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)

ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the client's request for the ListDataSourceSyncJobs 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 ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs 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 ListDataSourceSyncJobsRequest method.
req, resp := client.ListDataSourceSyncJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourceSyncJobs

func (*QBusiness) ListDataSourceSyncJobsWithContext 

func (c *QBusiness) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of the ability to pass a context and additional request options.

See ListDataSourceSyncJobs 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 (*QBusiness) ListDataSources 

func (c *QBusiness) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)

ListDataSources API operation for QBusiness.

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

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 QBusiness's API operation ListDataSources for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSources

func (*QBusiness) ListDataSourcesPages 

func (c *QBusiness) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error

ListDataSourcesPages iterates over the pages of a ListDataSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSources 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 ListDataSources operation.
pageNum := 0
err := client.ListDataSourcesPages(params,
    func(page *qbusiness.ListDataSourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListDataSourcesPagesWithContext 

func (c *QBusiness) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error

ListDataSourcesPagesWithContext same as ListDataSourcesPages 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 (*QBusiness) ListDataSourcesRequest 

func (c *QBusiness) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)

ListDataSourcesRequest generates a "aws/request.Request" representing the client's request for the ListDataSources 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 ListDataSources for more information on using the ListDataSources 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 ListDataSourcesRequest method.
req, resp := client.ListDataSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSources

func (*QBusiness) ListDataSourcesWithContext 

func (c *QBusiness) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)

ListDataSourcesWithContext is the same as ListDataSources with the addition of the ability to pass a context and additional request options.

See ListDataSources 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 (*QBusiness) ListDocuments 

func (c *QBusiness) ListDocuments(input *ListDocumentsInput) (*ListDocumentsOutput, error)

ListDocuments API operation for QBusiness.

A list of documents attached to an index.

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 QBusiness's API operation ListDocuments for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDocuments

func (*QBusiness) ListDocumentsPages 

func (c *QBusiness) ListDocumentsPages(input *ListDocumentsInput, fn func(*ListDocumentsOutput, bool) bool) error

ListDocumentsPages iterates over the pages of a ListDocuments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDocuments 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 ListDocuments operation.
pageNum := 0
err := client.ListDocumentsPages(params,
    func(page *qbusiness.ListDocumentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListDocumentsPagesWithContext 

func (c *QBusiness) ListDocumentsPagesWithContext(ctx aws.Context, input *ListDocumentsInput, fn func(*ListDocumentsOutput, bool) bool, opts ...request.Option) error

ListDocumentsPagesWithContext same as ListDocumentsPages 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 (*QBusiness) ListDocumentsRequest 

func (c *QBusiness) ListDocumentsRequest(input *ListDocumentsInput) (req *request.Request, output *ListDocumentsOutput)

ListDocumentsRequest generates a "aws/request.Request" representing the client's request for the ListDocuments 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 ListDocuments for more information on using the ListDocuments 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 ListDocumentsRequest method.
req, resp := client.ListDocumentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDocuments

func (*QBusiness) ListDocumentsWithContext 

func (c *QBusiness) ListDocumentsWithContext(ctx aws.Context, input *ListDocumentsInput, opts ...request.Option) (*ListDocumentsOutput, error)

ListDocumentsWithContext is the same as ListDocuments with the addition of the ability to pass a context and additional request options.

See ListDocuments 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 (*QBusiness) ListGroups 

func (c *QBusiness) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups API operation for QBusiness.

Provides a list of groups that are mapped to users.

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 QBusiness's API operation ListGroups for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroups

func (*QBusiness) ListGroupsPages 

func (c *QBusiness) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error

ListGroupsPages iterates over the pages of a ListGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGroups 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 ListGroups operation.
pageNum := 0
err := client.ListGroupsPages(params,
    func(page *qbusiness.ListGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListGroupsPagesWithContext 

func (c *QBusiness) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error

ListGroupsPagesWithContext same as ListGroupsPages 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 (*QBusiness) ListGroupsRequest 

func (c *QBusiness) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)

ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups 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 ListGroups for more information on using the ListGroups 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 ListGroupsRequest method.
req, resp := client.ListGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroups

func (*QBusiness) ListGroupsWithContext 

func (c *QBusiness) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)

ListGroupsWithContext is the same as ListGroups with the addition of the ability to pass a context and additional request options.

See ListGroups 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 (*QBusiness) ListIndices 

func (c *QBusiness) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)

ListIndices API operation for QBusiness.

Lists the Amazon Q Business indices you have created.

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 QBusiness's API operation ListIndices for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndices

func (*QBusiness) ListIndicesPages 

func (c *QBusiness) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error

ListIndicesPages iterates over the pages of a ListIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndices 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 ListIndices operation.
pageNum := 0
err := client.ListIndicesPages(params,
    func(page *qbusiness.ListIndicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListIndicesPagesWithContext 

func (c *QBusiness) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error

ListIndicesPagesWithContext same as ListIndicesPages 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 (*QBusiness) ListIndicesRequest 

func (c *QBusiness) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)

ListIndicesRequest generates a "aws/request.Request" representing the client's request for the ListIndices 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 ListIndices for more information on using the ListIndices 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 ListIndicesRequest method.
req, resp := client.ListIndicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndices

func (*QBusiness) ListIndicesWithContext 

func (c *QBusiness) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)

ListIndicesWithContext is the same as ListIndices with the addition of the ability to pass a context and additional request options.

See ListIndices 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 (*QBusiness) ListMessages 

func (c *QBusiness) ListMessages(input *ListMessagesInput) (*ListMessagesOutput, error)

ListMessages API operation for QBusiness.

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

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 QBusiness's API operation ListMessages for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • LicenseNotFoundException You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessages

func (*QBusiness) ListMessagesPages 

func (c *QBusiness) ListMessagesPages(input *ListMessagesInput, fn func(*ListMessagesOutput, bool) bool) error

ListMessagesPages iterates over the pages of a ListMessages operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMessages 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 ListMessages operation.
pageNum := 0
err := client.ListMessagesPages(params,
    func(page *qbusiness.ListMessagesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListMessagesPagesWithContext 

func (c *QBusiness) ListMessagesPagesWithContext(ctx aws.Context, input *ListMessagesInput, fn func(*ListMessagesOutput, bool) bool, opts ...request.Option) error

ListMessagesPagesWithContext same as ListMessagesPages 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 (*QBusiness) ListMessagesRequest 

func (c *QBusiness) ListMessagesRequest(input *ListMessagesInput) (req *request.Request, output *ListMessagesOutput)

ListMessagesRequest generates a "aws/request.Request" representing the client's request for the ListMessages 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 ListMessages for more information on using the ListMessages 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 ListMessagesRequest method.
req, resp := client.ListMessagesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessages

func (*QBusiness) ListMessagesWithContext 

func (c *QBusiness) ListMessagesWithContext(ctx aws.Context, input *ListMessagesInput, opts ...request.Option) (*ListMessagesOutput, error)

ListMessagesWithContext is the same as ListMessages with the addition of the ability to pass a context and additional request options.

See ListMessages 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 (*QBusiness) ListPlugins 

func (c *QBusiness) ListPlugins(input *ListPluginsInput) (*ListPluginsOutput, error)

ListPlugins API operation for QBusiness.

Lists configured Amazon Q Business plugins.

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 QBusiness's API operation ListPlugins for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPlugins

func (*QBusiness) ListPluginsPages 

func (c *QBusiness) ListPluginsPages(input *ListPluginsInput, fn func(*ListPluginsOutput, bool) bool) error

ListPluginsPages iterates over the pages of a ListPlugins operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPlugins 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 ListPlugins operation.
pageNum := 0
err := client.ListPluginsPages(params,
    func(page *qbusiness.ListPluginsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListPluginsPagesWithContext 

func (c *QBusiness) ListPluginsPagesWithContext(ctx aws.Context, input *ListPluginsInput, fn func(*ListPluginsOutput, bool) bool, opts ...request.Option) error

ListPluginsPagesWithContext same as ListPluginsPages 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 (*QBusiness) ListPluginsRequest 

func (c *QBusiness) ListPluginsRequest(input *ListPluginsInput) (req *request.Request, output *ListPluginsOutput)

ListPluginsRequest generates a "aws/request.Request" representing the client's request for the ListPlugins 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 ListPlugins for more information on using the ListPlugins 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 ListPluginsRequest method.
req, resp := client.ListPluginsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPlugins

func (*QBusiness) ListPluginsWithContext 

func (c *QBusiness) ListPluginsWithContext(ctx aws.Context, input *ListPluginsInput, opts ...request.Option) (*ListPluginsOutput, error)

ListPluginsWithContext is the same as ListPlugins with the addition of the ability to pass a context and additional request options.

See ListPlugins 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 (*QBusiness) ListRetrievers 

func (c *QBusiness) ListRetrievers(input *ListRetrieversInput) (*ListRetrieversOutput, error)

ListRetrievers API operation for QBusiness.

Lists the retriever used by an Amazon Q Business application.

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 QBusiness's API operation ListRetrievers for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListRetrievers

func (*QBusiness) ListRetrieversPages 

func (c *QBusiness) ListRetrieversPages(input *ListRetrieversInput, fn func(*ListRetrieversOutput, bool) bool) error

ListRetrieversPages iterates over the pages of a ListRetrievers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRetrievers 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 ListRetrievers operation.
pageNum := 0
err := client.ListRetrieversPages(params,
    func(page *qbusiness.ListRetrieversOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListRetrieversPagesWithContext 

func (c *QBusiness) ListRetrieversPagesWithContext(ctx aws.Context, input *ListRetrieversInput, fn func(*ListRetrieversOutput, bool) bool, opts ...request.Option) error

ListRetrieversPagesWithContext same as ListRetrieversPages 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 (*QBusiness) ListRetrieversRequest 

func (c *QBusiness) ListRetrieversRequest(input *ListRetrieversInput) (req *request.Request, output *ListRetrieversOutput)

ListRetrieversRequest generates a "aws/request.Request" representing the client's request for the ListRetrievers 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 ListRetrievers for more information on using the ListRetrievers 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 ListRetrieversRequest method.
req, resp := client.ListRetrieversRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListRetrievers

func (*QBusiness) ListRetrieversWithContext 

func (c *QBusiness) ListRetrieversWithContext(ctx aws.Context, input *ListRetrieversInput, opts ...request.Option) (*ListRetrieversOutput, error)

ListRetrieversWithContext is the same as ListRetrievers with the addition of the ability to pass a context and additional request options.

See ListRetrievers 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 (*QBusiness) ListTagsForResource 

func (c *QBusiness) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for QBusiness.

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

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 QBusiness's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListTagsForResource

func (*QBusiness) ListTagsForResourceRequest 

func (c *QBusiness) 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/qbusiness-2023-11-27/ListTagsForResource

func (*QBusiness) ListTagsForResourceWithContext 

func (c *QBusiness) 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 (*QBusiness) ListWebExperiences 

func (c *QBusiness) ListWebExperiences(input *ListWebExperiencesInput) (*ListWebExperiencesOutput, error)

ListWebExperiences API operation for QBusiness.

Lists one or more Amazon Q Business Web Experiences.

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 QBusiness's API operation ListWebExperiences for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListWebExperiences

func (*QBusiness) ListWebExperiencesPages 

func (c *QBusiness) ListWebExperiencesPages(input *ListWebExperiencesInput, fn func(*ListWebExperiencesOutput, bool) bool) error

ListWebExperiencesPages iterates over the pages of a ListWebExperiences operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWebExperiences 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 ListWebExperiences operation.
pageNum := 0
err := client.ListWebExperiencesPages(params,
    func(page *qbusiness.ListWebExperiencesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*QBusiness) ListWebExperiencesPagesWithContext 

func (c *QBusiness) ListWebExperiencesPagesWithContext(ctx aws.Context, input *ListWebExperiencesInput, fn func(*ListWebExperiencesOutput, bool) bool, opts ...request.Option) error

ListWebExperiencesPagesWithContext same as ListWebExperiencesPages 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 (*QBusiness) ListWebExperiencesRequest 

func (c *QBusiness) ListWebExperiencesRequest(input *ListWebExperiencesInput) (req *request.Request, output *ListWebExperiencesOutput)

ListWebExperiencesRequest generates a "aws/request.Request" representing the client's request for the ListWebExperiences 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 ListWebExperiences for more information on using the ListWebExperiences 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 ListWebExperiencesRequest method.
req, resp := client.ListWebExperiencesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListWebExperiences

func (*QBusiness) ListWebExperiencesWithContext 

func (c *QBusiness) ListWebExperiencesWithContext(ctx aws.Context, input *ListWebExperiencesInput, opts ...request.Option) (*ListWebExperiencesOutput, error)

ListWebExperiencesWithContext is the same as ListWebExperiences with the addition of the ability to pass a context and additional request options.

See ListWebExperiences 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 (*QBusiness) PutFeedback 

func (c *QBusiness) PutFeedback(input *PutFeedbackInput) (*PutFeedbackOutput, error)

PutFeedback API operation for QBusiness.

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

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 QBusiness's API operation PutFeedback for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutFeedback

func (*QBusiness) PutFeedbackRequest 

func (c *QBusiness) 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/qbusiness-2023-11-27/PutFeedback

func (*QBusiness) PutFeedbackWithContext 

func (c *QBusiness) 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 (*QBusiness) PutGroup 

func (c *QBusiness) PutGroup(input *PutGroupInput) (*PutGroupOutput, error)

PutGroup API operation for QBusiness.

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

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

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 QBusiness's API operation PutGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroup

func (*QBusiness) PutGroupRequest 

func (c *QBusiness) PutGroupRequest(input *PutGroupInput) (req *request.Request, output *PutGroupOutput)

PutGroupRequest generates a "aws/request.Request" representing the client's request for the PutGroup 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 PutGroup for more information on using the PutGroup 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 PutGroupRequest method.
req, resp := client.PutGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroup

func (*QBusiness) PutGroupWithContext 

func (c *QBusiness) PutGroupWithContext(ctx aws.Context, input *PutGroupInput, opts ...request.Option) (*PutGroupOutput, error)

PutGroupWithContext is the same as PutGroup with the addition of the ability to pass a context and additional request options.

See PutGroup 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 (*QBusiness) StartDataSourceSyncJob 

func (c *QBusiness) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error)

StartDataSourceSyncJob API operation for QBusiness.

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

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 QBusiness's API operation StartDataSourceSyncJob for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StartDataSourceSyncJob

func (*QBusiness) StartDataSourceSyncJobRequest 

func (c *QBusiness) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput)

StartDataSourceSyncJobRequest generates a "aws/request.Request" representing the client's request for the StartDataSourceSyncJob 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 StartDataSourceSyncJob for more information on using the StartDataSourceSyncJob 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 StartDataSourceSyncJobRequest method.
req, resp := client.StartDataSourceSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StartDataSourceSyncJob

func (*QBusiness) StartDataSourceSyncJobWithContext 

func (c *QBusiness) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error)

StartDataSourceSyncJobWithContext is the same as StartDataSourceSyncJob with the addition of the ability to pass a context and additional request options.

See StartDataSourceSyncJob 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 (*QBusiness) StopDataSourceSyncJob 

func (c *QBusiness) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error)

StopDataSourceSyncJob API operation for QBusiness.

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

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 QBusiness's API operation StopDataSourceSyncJob for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StopDataSourceSyncJob

func (*QBusiness) StopDataSourceSyncJobRequest 

func (c *QBusiness) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput)

StopDataSourceSyncJobRequest generates a "aws/request.Request" representing the client's request for the StopDataSourceSyncJob 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 StopDataSourceSyncJob for more information on using the StopDataSourceSyncJob 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 StopDataSourceSyncJobRequest method.
req, resp := client.StopDataSourceSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StopDataSourceSyncJob

func (*QBusiness) StopDataSourceSyncJobWithContext 

func (c *QBusiness) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error)

StopDataSourceSyncJobWithContext is the same as StopDataSourceSyncJob with the addition of the ability to pass a context and additional request options.

See StopDataSourceSyncJob 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 (*QBusiness) TagResource 

func (c *QBusiness) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for QBusiness.

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

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 QBusiness's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/TagResource

func (*QBusiness) TagResourceRequest 

func (c *QBusiness) 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/qbusiness-2023-11-27/TagResource

func (*QBusiness) TagResourceWithContext 

func (c *QBusiness) 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 (*QBusiness) UntagResource 

func (c *QBusiness) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for QBusiness.

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

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 QBusiness's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UntagResource

func (*QBusiness) UntagResourceRequest 

func (c *QBusiness) 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/qbusiness-2023-11-27/UntagResource

func (*QBusiness) UntagResourceWithContext 

func (c *QBusiness) 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 (*QBusiness) UpdateApplication 

func (c *QBusiness) UpdateApplication(input *UpdateApplicationInput) (*UpdateApplicationOutput, error)

UpdateApplication API operation for QBusiness.

Updates an existing Amazon Q Business application.

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 QBusiness's API operation UpdateApplication for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplication

func (*QBusiness) UpdateApplicationRequest 

func (c *QBusiness) UpdateApplicationRequest(input *UpdateApplicationInput) (req *request.Request, output *UpdateApplicationOutput)

UpdateApplicationRequest generates a "aws/request.Request" representing the client's request for the UpdateApplication 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 UpdateApplication for more information on using the UpdateApplication 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 UpdateApplicationRequest method.
req, resp := client.UpdateApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplication

func (*QBusiness) UpdateApplicationWithContext 

func (c *QBusiness) UpdateApplicationWithContext(ctx aws.Context, input *UpdateApplicationInput, opts ...request.Option) (*UpdateApplicationOutput, error)

UpdateApplicationWithContext is the same as UpdateApplication with the addition of the ability to pass a context and additional request options.

See UpdateApplication 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 (*QBusiness) UpdateChatControlsConfiguration 

func (c *QBusiness) UpdateChatControlsConfiguration(input *UpdateChatControlsConfigurationInput) (*UpdateChatControlsConfigurationOutput, error)

UpdateChatControlsConfiguration API operation for QBusiness.

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

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 QBusiness's API operation UpdateChatControlsConfiguration for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatControlsConfiguration

func (*QBusiness) UpdateChatControlsConfigurationRequest 

func (c *QBusiness) UpdateChatControlsConfigurationRequest(input *UpdateChatControlsConfigurationInput) (req *request.Request, output *UpdateChatControlsConfigurationOutput)

UpdateChatControlsConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateChatControlsConfiguration 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 UpdateChatControlsConfiguration for more information on using the UpdateChatControlsConfiguration 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 UpdateChatControlsConfigurationRequest method.
req, resp := client.UpdateChatControlsConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatControlsConfiguration

func (*QBusiness) UpdateChatControlsConfigurationWithContext 

func (c *QBusiness) UpdateChatControlsConfigurationWithContext(ctx aws.Context, input *UpdateChatControlsConfigurationInput, opts ...request.Option) (*UpdateChatControlsConfigurationOutput, error)

UpdateChatControlsConfigurationWithContext is the same as UpdateChatControlsConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateChatControlsConfiguration 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 (*QBusiness) UpdateDataSource 

func (c *QBusiness) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)

UpdateDataSource API operation for QBusiness.

Updates an existing Amazon Q Business data source connector.

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 QBusiness's API operation UpdateDataSource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSource

func (*QBusiness) UpdateDataSourceRequest 

func (c *QBusiness) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)

UpdateDataSourceRequest generates a "aws/request.Request" representing the client's request for the UpdateDataSource 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 UpdateDataSource for more information on using the UpdateDataSource 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 UpdateDataSourceRequest method.
req, resp := client.UpdateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSource

func (*QBusiness) UpdateDataSourceWithContext 

func (c *QBusiness) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)

UpdateDataSourceWithContext is the same as UpdateDataSource with the addition of the ability to pass a context and additional request options.

See UpdateDataSource 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 (*QBusiness) UpdateIndex 

func (c *QBusiness) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error)

UpdateIndex API operation for QBusiness.

Updates an Amazon Q Business index.

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 QBusiness's API operation UpdateIndex for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndex

func (*QBusiness) UpdateIndexRequest 

func (c *QBusiness) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput)

UpdateIndexRequest generates a "aws/request.Request" representing the client's request for the UpdateIndex 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 UpdateIndex for more information on using the UpdateIndex 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 UpdateIndexRequest method.
req, resp := client.UpdateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndex

func (*QBusiness) UpdateIndexWithContext 

func (c *QBusiness) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error)

UpdateIndexWithContext is the same as UpdateIndex with the addition of the ability to pass a context and additional request options.

See UpdateIndex 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 (*QBusiness) UpdatePlugin 

func (c *QBusiness) UpdatePlugin(input *UpdatePluginInput) (*UpdatePluginOutput, error)

UpdatePlugin API operation for QBusiness.

Updates an Amazon Q Business plugin.

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 QBusiness's API operation UpdatePlugin for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdatePlugin

func (*QBusiness) UpdatePluginRequest 

func (c *QBusiness) UpdatePluginRequest(input *UpdatePluginInput) (req *request.Request, output *UpdatePluginOutput)

UpdatePluginRequest generates a "aws/request.Request" representing the client's request for the UpdatePlugin 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 UpdatePlugin for more information on using the UpdatePlugin 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 UpdatePluginRequest method.
req, resp := client.UpdatePluginRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdatePlugin

func (*QBusiness) UpdatePluginWithContext 

func (c *QBusiness) UpdatePluginWithContext(ctx aws.Context, input *UpdatePluginInput, opts ...request.Option) (*UpdatePluginOutput, error)

UpdatePluginWithContext is the same as UpdatePlugin with the addition of the ability to pass a context and additional request options.

See UpdatePlugin 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 (*QBusiness) UpdateRetriever 

func (c *QBusiness) UpdateRetriever(input *UpdateRetrieverInput) (*UpdateRetrieverOutput, error)

UpdateRetriever API operation for QBusiness.

Updates the retriever used for your Amazon Q Business application.

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 QBusiness's API operation UpdateRetriever for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateRetriever

func (*QBusiness) UpdateRetrieverRequest 

func (c *QBusiness) UpdateRetrieverRequest(input *UpdateRetrieverInput) (req *request.Request, output *UpdateRetrieverOutput)

UpdateRetrieverRequest generates a "aws/request.Request" representing the client's request for the UpdateRetriever 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 UpdateRetriever for more information on using the UpdateRetriever 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 UpdateRetrieverRequest method.
req, resp := client.UpdateRetrieverRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateRetriever

func (*QBusiness) UpdateRetrieverWithContext 

func (c *QBusiness) UpdateRetrieverWithContext(ctx aws.Context, input *UpdateRetrieverInput, opts ...request.Option) (*UpdateRetrieverOutput, error)

UpdateRetrieverWithContext is the same as UpdateRetriever with the addition of the ability to pass a context and additional request options.

See UpdateRetriever 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 (*QBusiness) UpdateUser 

func (c *QBusiness) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for QBusiness.

Updates a information associated with a user id.

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 QBusiness's API operation UpdateUser for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Q Business service.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateUser

func (*QBusiness) UpdateUserRequest 

func (c *QBusiness) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser 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 UpdateUser for more information on using the UpdateUser 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 UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateUser

func (*QBusiness) UpdateUserWithContext 

func (c *QBusiness) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.

See UpdateUser 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 (*QBusiness) UpdateWebExperience 

func (c *QBusiness) UpdateWebExperience(input *UpdateWebExperienceInput) (*UpdateWebExperienceOutput, error)

UpdateWebExperience API operation for QBusiness.

Updates an Amazon Q Business web experience.

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 QBusiness's API operation UpdateWebExperience for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

  • ConflictException You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

  • ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.

  • ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

  • AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience

func (*QBusiness) UpdateWebExperienceRequest 

func (c *QBusiness) UpdateWebExperienceRequest(input *UpdateWebExperienceInput) (req *request.Request, output *UpdateWebExperienceOutput)

UpdateWebExperienceRequest generates a "aws/request.Request" representing the client's request for the UpdateWebExperience 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 UpdateWebExperience for more information on using the UpdateWebExperience 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 UpdateWebExperienceRequest method.
req, resp := client.UpdateWebExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience

func (*QBusiness) UpdateWebExperienceWithContext 

func (c *QBusiness) UpdateWebExperienceWithContext(ctx aws.Context, input *UpdateWebExperienceInput, opts ...request.Option) (*UpdateWebExperienceOutput, error)

UpdateWebExperienceWithContext is the same as UpdateWebExperience with the addition of the ability to pass a context and additional request options.

See UpdateWebExperience 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 ResourceNotFoundException 

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

	// The message describing a ResourceNotFoundException.
	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" min:"1" type:"string" required:"true"`

	// The type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

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 Retriever 

type Retriever struct {

	// The identifier of the Amazon Q Business application using the retriever.
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string"`

	// The name of your retriever.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The identifier of the retriever used by your Amazon Q Business application.
	RetrieverId *string `locationName:"retrieverId" min:"36" type:"string"`

	// The status of your retriever.
	Status *string `locationName:"status" type:"string" enum:"RetrieverStatus"`

	// The type of your retriever.
	Type *string `locationName:"type" type:"string" enum:"RetrieverType"`
	// contains filtered or unexported fields
}

Summary information for the retriever used for your Amazon Q Business application.

func (Retriever) GoString 

func (s Retriever) 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 (*Retriever) SetApplicationId 

func (s *Retriever) SetApplicationId(v string) *Retriever

SetApplicationId sets the ApplicationId field's value.

func (*Retriever) SetDisplayName 

func (s *Retriever) SetDisplayName(v string) *Retriever

SetDisplayName sets the DisplayName field's value.

func (*Retriever) SetRetrieverId 

func (s *Retriever) SetRetrieverId(v string) *Retriever

SetRetrieverId sets the RetrieverId field's value.

func (*Retriever) SetStatus 

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

SetStatus sets the Status field's value.

func (*Retriever) SetType 

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

SetType sets the Type field's value.

func (Retriever) String 

func (s Retriever) 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 RetrieverConfiguration 

type RetrieverConfiguration struct {

	// Provides information on how the Amazon Kendra index used as a retriever for
	// your Amazon Q Business application is configured.
	KendraIndexConfiguration *KendraIndexConfiguration `locationName:"kendraIndexConfiguration" type:"structure"`

	// Provides information on how a Amazon Q Business index used as a retriever
	// for your Amazon Q Business application is configured.
	NativeIndexConfiguration *NativeIndexConfiguration `locationName:"nativeIndexConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

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

func (RetrieverConfiguration) GoString 

func (s RetrieverConfiguration) 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 (*RetrieverConfiguration) SetKendraIndexConfiguration 

func (s *RetrieverConfiguration) SetKendraIndexConfiguration(v *KendraIndexConfiguration) *RetrieverConfiguration

SetKendraIndexConfiguration sets the KendraIndexConfiguration field's value.

func (*RetrieverConfiguration) SetNativeIndexConfiguration 

func (s *RetrieverConfiguration) SetNativeIndexConfiguration(v *NativeIndexConfiguration) *RetrieverConfiguration

SetNativeIndexConfiguration sets the NativeIndexConfiguration field's value.

func (RetrieverConfiguration) String 

func (s RetrieverConfiguration) 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 (*RetrieverConfiguration) Validate 

func (s *RetrieverConfiguration) Validate() error

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

type Rule 

type Rule struct {

	// Users and groups to be excluded from a rule.
	ExcludedUsersAndGroups *UsersAndGroups `locationName:"excludedUsersAndGroups" type:"structure"`

	// Users and groups to be included in a rule.
	IncludedUsersAndGroups *UsersAndGroups `locationName:"includedUsersAndGroups" type:"structure"`

	// The configuration information for a rule.
	RuleConfiguration *RuleConfiguration `locationName:"ruleConfiguration" type:"structure"`

	// The type of rule.
	//
	// RuleType is a required field
	RuleType *string `locationName:"ruleType" type:"string" required:"true" enum:"RuleType"`
	// contains filtered or unexported fields
}

Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.

func (Rule) GoString 

func (s Rule) 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 (*Rule) SetExcludedUsersAndGroups 

func (s *Rule) SetExcludedUsersAndGroups(v *UsersAndGroups) *Rule

SetExcludedUsersAndGroups sets the ExcludedUsersAndGroups field's value.

func (*Rule) SetIncludedUsersAndGroups 

func (s *Rule) SetIncludedUsersAndGroups(v *UsersAndGroups) *Rule

SetIncludedUsersAndGroups sets the IncludedUsersAndGroups field's value.

func (*Rule) SetRuleConfiguration 

func (s *Rule) SetRuleConfiguration(v *RuleConfiguration) *Rule

SetRuleConfiguration sets the RuleConfiguration field's value.

func (*Rule) SetRuleType 

func (s *Rule) SetRuleType(v string) *Rule

SetRuleType sets the RuleType field's value.

func (Rule) String 

func (s Rule) 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 (*Rule) Validate 

func (s *Rule) Validate() error

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

type RuleConfiguration 

type RuleConfiguration struct {

	// A rule for configuring how Amazon Q Business responds when it encounters
	// a a blocked topic.
	ContentBlockerRule *ContentBlockerRule `locationName:"contentBlockerRule" type:"structure"`

	// Rules for retrieving content from data sources connected to a Amazon Q Business
	// application for a specific topic control configuration.
	ContentRetrievalRule *ContentRetrievalRule `locationName:"contentRetrievalRule" type:"structure"`
	// contains filtered or unexported fields
}

Provides configuration information about a rule.

func (RuleConfiguration) GoString 

func (s RuleConfiguration) 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 (*RuleConfiguration) SetContentBlockerRule 

func (s *RuleConfiguration) SetContentBlockerRule(v *ContentBlockerRule) *RuleConfiguration

SetContentBlockerRule sets the ContentBlockerRule field's value.

func (*RuleConfiguration) SetContentRetrievalRule 

func (s *RuleConfiguration) SetContentRetrievalRule(v *ContentRetrievalRule) *RuleConfiguration

SetContentRetrievalRule sets the ContentRetrievalRule field's value.

func (RuleConfiguration) String 

func (s RuleConfiguration) 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 (*RuleConfiguration) Validate 

func (s *RuleConfiguration) Validate() error

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

type S3 

type S3 struct {

	// The name of the S3 bucket that contains the file.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"1" type:"string" required:"true"`

	// The name of the file.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

func (S3) GoString 

func (s S3) 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 (*S3) SetBucket 

func (s *S3) SetBucket(v string) *S3

SetBucket sets the Bucket field's value.

func (*S3) SetKey 

func (s *S3) SetKey(v string) *S3

SetKey sets the Key field's value.

func (S3) String 

func (s S3) 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 (*S3) Validate 

func (s *S3) Validate() error

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

type SamlConfiguration 

type SamlConfiguration struct {

	// The metadata XML that your IdP generated.
	//
	// MetadataXML is a required field
	MetadataXML *string `locationName:"metadataXML" min:"1000" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role assumed by users when they
	// authenticate into their Amazon Q Business web experience, containing the
	// relevant Amazon Q Business permissions for conversing with Amazon Q Business.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The group attribute name in your IdP that maps to user groups.
	UserGroupAttribute *string `locationName:"userGroupAttribute" min:"1" type:"string"`

	// The user attribute name in your IdP that maps to the user email.
	//
	// UserIdAttribute is a required field
	UserIdAttribute *string `locationName:"userIdAttribute" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

func (SamlConfiguration) GoString 

func (s SamlConfiguration) 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 (*SamlConfiguration) SetMetadataXML 

func (s *SamlConfiguration) SetMetadataXML(v string) *SamlConfiguration

SetMetadataXML sets the MetadataXML field's value.

func (*SamlConfiguration) SetRoleArn 

func (s *SamlConfiguration) SetRoleArn(v string) *SamlConfiguration

SetRoleArn sets the RoleArn field's value.

func (*SamlConfiguration) SetUserGroupAttribute 

func (s *SamlConfiguration) SetUserGroupAttribute(v string) *SamlConfiguration

SetUserGroupAttribute sets the UserGroupAttribute field's value.

func (*SamlConfiguration) SetUserIdAttribute 

func (s *SamlConfiguration) SetUserIdAttribute(v string) *SamlConfiguration

SetUserIdAttribute sets the UserIdAttribute field's value.

func (SamlConfiguration) String 

func (s SamlConfiguration) 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 (*SamlConfiguration) Validate 

func (s *SamlConfiguration) Validate() error

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

type ServiceQuotaExceededException 

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

	// The message describing a ServiceQuotaExceededException.
	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" min:"1" type:"string" required:"true"`

	// The type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

You have exceeded the set limits for your Amazon Q Business service.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) 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 (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

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 

func (s ServiceQuotaExceededException) 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 SnippetExcerpt added in v1.51.32 

type SnippetExcerpt struct {

	// The relevant text excerpt from a source that was used to generate a citation
	// text segment in an Amazon Q chat response.
	Text *string `locationName:"text" type:"string"`
	// contains filtered or unexported fields
}

Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

func (SnippetExcerpt) GoString added in v1.51.32 

func (s SnippetExcerpt) 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 (*SnippetExcerpt) SetText added in v1.51.32 

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

SetText sets the Text field's value.

func (SnippetExcerpt) String added in v1.51.32 

func (s SnippetExcerpt) 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 SourceAttribution 

type SourceAttribution struct {

	// The number attached to a citation in an Amazon Q Business generated response.
	CitationNumber *int64 `locationName:"citationNumber" type:"integer"`

	// The content extract from the document on which the generated response is
	// based.
	Snippet *string `locationName:"snippet" min:"1" type:"string"`

	// A text extract from a source document that is used for source attribution.
	TextMessageSegments []*TextSegment `locationName:"textMessageSegments" type:"list"`

	// The title of the document which is the source for the Amazon Q Business generated
	// response.
	Title *string `locationName:"title" min:"1" type:"string"`

	// The Unix timestamp when the Amazon Q Business application was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`

	// The URL of the document which is the source for the Amazon Q Business generated
	// response.
	Url *string `locationName:"url" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The documents used to generate an Amazon Q Business web experience response.

func (SourceAttribution) GoString 

func (s SourceAttribution) 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 (*SourceAttribution) SetCitationNumber 

func (s *SourceAttribution) SetCitationNumber(v int64) *SourceAttribution

SetCitationNumber sets the CitationNumber field's value.

func (*SourceAttribution) SetSnippet 

func (s *SourceAttribution) SetSnippet(v string) *SourceAttribution

SetSnippet sets the Snippet field's value.

func (*SourceAttribution) SetTextMessageSegments 

func (s *SourceAttribution) SetTextMessageSegments(v []*TextSegment) *SourceAttribution

SetTextMessageSegments sets the TextMessageSegments field's value.

func (*SourceAttribution) SetTitle 

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

SetTitle sets the Title field's value.

func (*SourceAttribution) SetUpdatedAt 

func (s *SourceAttribution) SetUpdatedAt(v time.Time) *SourceAttribution

SetUpdatedAt sets the UpdatedAt field's value.

func (*SourceAttribution) SetUrl 

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

SetUrl sets the Url field's value.

func (SourceAttribution) String 

func (s SourceAttribution) 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 StartDataSourceSyncJobInput 

type StartDataSourceSyncJobInput struct {

	// The identifier of Amazon Q Business application the data source is connected
	// to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source connector.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartDataSourceSyncJobInput) GoString 

func (s StartDataSourceSyncJobInput) 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 (*StartDataSourceSyncJobInput) SetApplicationId 

func (s *StartDataSourceSyncJobInput) SetApplicationId(v string) *StartDataSourceSyncJobInput

SetApplicationId sets the ApplicationId field's value.

func (*StartDataSourceSyncJobInput) SetDataSourceId 

func (s *StartDataSourceSyncJobInput) SetDataSourceId(v string) *StartDataSourceSyncJobInput

SetDataSourceId sets the DataSourceId field's value.

func (*StartDataSourceSyncJobInput) SetIndexId 

func (s *StartDataSourceSyncJobInput) SetIndexId(v string) *StartDataSourceSyncJobInput

SetIndexId sets the IndexId field's value.

func (StartDataSourceSyncJobInput) String 

func (s StartDataSourceSyncJobInput) 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 (*StartDataSourceSyncJobInput) Validate 

func (s *StartDataSourceSyncJobInput) Validate() error

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

type StartDataSourceSyncJobOutput 

type StartDataSourceSyncJobOutput struct {

	// The identifier for a particular synchronization job.
	ExecutionId *string `locationName:"executionId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (StartDataSourceSyncJobOutput) GoString 

func (s StartDataSourceSyncJobOutput) 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 (*StartDataSourceSyncJobOutput) SetExecutionId 

func (s *StartDataSourceSyncJobOutput) SetExecutionId(v string) *StartDataSourceSyncJobOutput

SetExecutionId sets the ExecutionId field's value.

func (StartDataSourceSyncJobOutput) String 

func (s StartDataSourceSyncJobOutput) 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 StopDataSourceSyncJobInput 

type StopDataSourceSyncJobInput struct {

	// The identifier of the Amazon Q Business application that the data source
	// is connected to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source connector.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"`

	// The identifier of the index used with the Amazon Q Business data source connector.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDataSourceSyncJobInput) GoString 

func (s StopDataSourceSyncJobInput) 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 (*StopDataSourceSyncJobInput) SetApplicationId 

func (s *StopDataSourceSyncJobInput) SetApplicationId(v string) *StopDataSourceSyncJobInput

SetApplicationId sets the ApplicationId field's value.

func (*StopDataSourceSyncJobInput) SetDataSourceId 

func (s *StopDataSourceSyncJobInput) SetDataSourceId(v string) *StopDataSourceSyncJobInput

SetDataSourceId sets the DataSourceId field's value.

func (*StopDataSourceSyncJobInput) SetIndexId 

func (s *StopDataSourceSyncJobInput) SetIndexId(v string) *StopDataSourceSyncJobInput

SetIndexId sets the IndexId field's value.

func (StopDataSourceSyncJobInput) String 

func (s StopDataSourceSyncJobInput) 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 (*StopDataSourceSyncJobInput) Validate 

func (s *StopDataSourceSyncJobInput) Validate() error

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

type StopDataSourceSyncJobOutput 

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

func (StopDataSourceSyncJobOutput) GoString 

func (s StopDataSourceSyncJobOutput) 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 (StopDataSourceSyncJobOutput) String 

func (s StopDataSourceSyncJobOutput) 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 StringAttributeBoostingConfiguration added in v1.50.18 

type StringAttributeBoostingConfiguration struct {

	// Specifies specific values of a STRING type document attribute being boosted.
	AttributeValueBoosting map[string]*string `locationName:"attributeValueBoosting" min:"1" type:"map"`

	// Specifies how much a document attribute is boosted.
	//
	// BoostingLevel is a required field
	BoostingLevel *string `locationName:"boostingLevel" type:"string" required:"true" enum:"DocumentAttributeBoostingLevel"`
	// contains filtered or unexported fields
}

Provides information on boosting STRING type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html) object of the UpdateIndex (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html) API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html).

func (StringAttributeBoostingConfiguration) GoString added in v1.50.18 

func (s StringAttributeBoostingConfiguration) 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 (*StringAttributeBoostingConfiguration) SetAttributeValueBoosting added in v1.50.18 

func (s *StringAttributeBoostingConfiguration) SetAttributeValueBoosting(v map[string]*string) *StringAttributeBoostingConfiguration

SetAttributeValueBoosting sets the AttributeValueBoosting field's value.

func (*StringAttributeBoostingConfiguration) SetBoostingLevel added in v1.50.18 

func (s *StringAttributeBoostingConfiguration) SetBoostingLevel(v string) *StringAttributeBoostingConfiguration

SetBoostingLevel sets the BoostingLevel field's value.

func (StringAttributeBoostingConfiguration) String added in v1.50.18 

func (s StringAttributeBoostingConfiguration) 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 (*StringAttributeBoostingConfiguration) Validate added in v1.50.18 

func (s *StringAttributeBoostingConfiguration) Validate() error

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

type StringListAttributeBoostingConfiguration added in v1.50.18 

type StringListAttributeBoostingConfiguration struct {

	// Specifies how much a document attribute is boosted.
	//
	// BoostingLevel is a required field
	BoostingLevel *string `locationName:"boostingLevel" type:"string" required:"true" enum:"DocumentAttributeBoostingLevel"`
	// contains filtered or unexported fields
}

Provides information on boosting STRING_LIST type document attributes.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html) object of the UpdateIndex (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html) API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html).

func (StringListAttributeBoostingConfiguration) GoString added in v1.50.18 

func (s StringListAttributeBoostingConfiguration) 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 (*StringListAttributeBoostingConfiguration) SetBoostingLevel added in v1.50.18 

func (s *StringListAttributeBoostingConfiguration) SetBoostingLevel(v string) *StringListAttributeBoostingConfiguration

SetBoostingLevel sets the BoostingLevel field's value.

func (StringListAttributeBoostingConfiguration) String added in v1.50.18 

func (s StringListAttributeBoostingConfiguration) 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 (*StringListAttributeBoostingConfiguration) Validate added in v1.50.18 

func (s *StringListAttributeBoostingConfiguration) Validate() error

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

type Tag 

type Tag struct {

	// The key for the tag. Keys are not case sensitive and must be unique for the
	// Amazon Q Business application or data source.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The value associated with the tag. The value may be an empty string but it
	// can't be null.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

func (Tag) GoString 

func (s Tag) 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 (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

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

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) 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 (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application or data
	// source to tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" type:"string" required:"true"`

	// A list of tag keys to add to the Amazon Q Business application or data source.
	// If a tag already exists, the existing value is replaced with the new value.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" type:"list" 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 []*Tag) *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 TextDocumentStatistics 

type TextDocumentStatistics struct {

	// The total size, in bytes, of the indexed documents.
	IndexedTextBytes *int64 `locationName:"indexedTextBytes" type:"long"`

	// The number of text documents indexed.
	IndexedTextDocumentCount *int64 `locationName:"indexedTextDocumentCount" type:"integer"`
	// contains filtered or unexported fields
}

Provides information about text documents in an index.

func (TextDocumentStatistics) GoString 

func (s TextDocumentStatistics) 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 (*TextDocumentStatistics) SetIndexedTextBytes 

func (s *TextDocumentStatistics) SetIndexedTextBytes(v int64) *TextDocumentStatistics

SetIndexedTextBytes sets the IndexedTextBytes field's value.

func (*TextDocumentStatistics) SetIndexedTextDocumentCount 

func (s *TextDocumentStatistics) SetIndexedTextDocumentCount(v int64) *TextDocumentStatistics

SetIndexedTextDocumentCount sets the IndexedTextDocumentCount field's value.

func (TextDocumentStatistics) String 

func (s TextDocumentStatistics) 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 TextInputEvent added in v1.51.32 

type TextInputEvent struct {

	// A user message in a text message input event.
	//
	// UserMessage is a required field
	UserMessage *string `locationName:"userMessage" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An input event for a end user message in an Amazon Q Business web experience.

func (TextInputEvent) GoString added in v1.51.32 

func (s TextInputEvent) 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 (*TextInputEvent) MarshalEvent added in v1.51.32 

func (s *TextInputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TextInputEvent) SetUserMessage added in v1.51.32 

func (s *TextInputEvent) SetUserMessage(v string) *TextInputEvent

SetUserMessage sets the UserMessage field's value.

func (TextInputEvent) String added in v1.51.32 

func (s TextInputEvent) 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 (*TextInputEvent) UnmarshalEvent added in v1.51.32 

func (s *TextInputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the TextInputEvent value. This method is only used internally within the SDK's EventStream handling.

type TextOutputEvent added in v1.51.32 

type TextOutputEvent struct {

	// The identifier of the conversation with which the text output event is associated.
	ConversationId *string `locationName:"conversationId" min:"36" type:"string"`

	// An AI-generated message in a TextOutputEvent.
	SystemMessage *string `locationName:"systemMessage" min:"1" type:"string"`

	// The identifier of an AI-generated message in a TextOutputEvent.
	SystemMessageId *string `locationName:"systemMessageId" min:"36" type:"string"`

	// The identifier of an end user message in a TextOutputEvent.
	UserMessageId *string `locationName:"userMessageId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

An output event for an AI-generated response in an Amazon Q Business web experience.

func (TextOutputEvent) GoString added in v1.51.32 

func (s TextOutputEvent) 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 (*TextOutputEvent) MarshalEvent added in v1.51.32 

func (s *TextOutputEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TextOutputEvent) SetConversationId added in v1.51.32 

func (s *TextOutputEvent) SetConversationId(v string) *TextOutputEvent

SetConversationId sets the ConversationId field's value.

func (*TextOutputEvent) SetSystemMessage added in v1.51.32 

func (s *TextOutputEvent) SetSystemMessage(v string) *TextOutputEvent

SetSystemMessage sets the SystemMessage field's value.

func (*TextOutputEvent) SetSystemMessageId added in v1.51.32 

func (s *TextOutputEvent) SetSystemMessageId(v string) *TextOutputEvent

SetSystemMessageId sets the SystemMessageId field's value.

func (*TextOutputEvent) SetUserMessageId added in v1.51.32 

func (s *TextOutputEvent) SetUserMessageId(v string) *TextOutputEvent

SetUserMessageId sets the UserMessageId field's value.

func (TextOutputEvent) String added in v1.51.32 

func (s TextOutputEvent) 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 (*TextOutputEvent) UnmarshalEvent added in v1.51.32 

func (s *TextOutputEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the TextOutputEvent value. This method is only used internally within the SDK's EventStream handling.

type TextSegment 

type TextSegment struct {

	// The zero-based location in the response string where the source attribution
	// starts.
	BeginOffset *int64 `locationName:"beginOffset" type:"integer"`

	// The zero-based location in the response string where the source attribution
	// ends.
	EndOffset *int64 `locationName:"endOffset" type:"integer"`

	// The relevant text excerpt from a source that was used to generate a citation
	// text segment in an Amazon Q Business chat response.
	SnippetExcerpt *SnippetExcerpt `locationName:"snippetExcerpt" type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a text extract in a chat response that can be attributed to a source document.

func (TextSegment) GoString 

func (s TextSegment) 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 (*TextSegment) SetBeginOffset 

func (s *TextSegment) SetBeginOffset(v int64) *TextSegment

SetBeginOffset sets the BeginOffset field's value.

func (*TextSegment) SetEndOffset 

func (s *TextSegment) SetEndOffset(v int64) *TextSegment

SetEndOffset sets the EndOffset field's value.

func (*TextSegment) SetSnippetExcerpt added in v1.51.32 

func (s *TextSegment) SetSnippetExcerpt(v *SnippetExcerpt) *TextSegment

SetSnippetExcerpt sets the SnippetExcerpt field's value.

func (TextSegment) String 

func (s TextSegment) 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 ThrottlingException 

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

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

The request was denied due to throttling. Reduce the number of requests and try again.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) 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 (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) 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 TopicConfiguration 

type TopicConfiguration struct {

	// A description for your topic control configuration. Use this to outline how
	// the large language model (LLM) should use this topic control configuration.
	Description *string `locationName:"description" type:"string"`

	// A list of example phrases that you expect the end user to use in relation
	// to the topic.
	ExampleChatMessages []*string `locationName:"exampleChatMessages" type:"list"`

	// A name for your topic control configuration.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Rules defined for a topic configuration.
	//
	// Rules is a required field
	Rules []*Rule `locationName:"rules" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The topic specific controls configured for an Amazon Q Business application.

func (TopicConfiguration) GoString 

func (s TopicConfiguration) 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 (*TopicConfiguration) SetDescription 

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

SetDescription sets the Description field's value.

func (*TopicConfiguration) SetExampleChatMessages 

func (s *TopicConfiguration) SetExampleChatMessages(v []*string) *TopicConfiguration

SetExampleChatMessages sets the ExampleChatMessages field's value.

func (*TopicConfiguration) SetName 

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

SetName sets the Name field's value.

func (*TopicConfiguration) SetRules 

func (s *TopicConfiguration) SetRules(v []*Rule) *TopicConfiguration

SetRules sets the Rules field's value.

func (TopicConfiguration) String 

func (s TopicConfiguration) 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 (*TopicConfiguration) Validate 

func (s *TopicConfiguration) Validate() error

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Q Business application, or data
	// source to remove the tag from.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" type:"string" required:"true"`

	// A list of tag keys to remove from the Amazon Q Business application or data
	// source. If a tag key does not exist on the resource, it is ignored.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" 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 UpdateApplicationInput 

type UpdateApplicationInput struct {

	// The identifier of the Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// An option to allow end users to upload files directly during chat.
	AttachmentsConfiguration *AttachmentsConfiguration `locationName:"attachmentsConfiguration" type:"structure"`

	// A description for the Amazon Q Business application.
	Description *string `locationName:"description" type:"string"`

	// A name for the Amazon Q Business application.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM Identity Center instance you are
	// either creating for—or connecting to—your Amazon Q Business application.
	IdentityCenterInstanceArn *string `locationName:"identityCenterInstanceArn" min:"10" type:"string"`

	// Configuration information about chat response personalization. For more information,
	// see Personalizing chat responses (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html).
	PersonalizationConfiguration *PersonalizationConfiguration `locationName:"personalizationConfiguration" type:"structure"`

	// An option to allow end users to create and use Amazon Q Apps in the web experience.
	QAppsConfiguration *QAppsConfiguration `locationName:"qAppsConfiguration" type:"structure"`

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

func (UpdateApplicationInput) GoString 

func (s UpdateApplicationInput) 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 (*UpdateApplicationInput) SetApplicationId 

func (s *UpdateApplicationInput) SetApplicationId(v string) *UpdateApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateApplicationInput) SetAttachmentsConfiguration 

func (s *UpdateApplicationInput) SetAttachmentsConfiguration(v *AttachmentsConfiguration) *UpdateApplicationInput

SetAttachmentsConfiguration sets the AttachmentsConfiguration field's value.

func (*UpdateApplicationInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateApplicationInput) SetDisplayName 

func (s *UpdateApplicationInput) SetDisplayName(v string) *UpdateApplicationInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateApplicationInput) SetIdentityCenterInstanceArn added in v1.51.32 

func (s *UpdateApplicationInput) SetIdentityCenterInstanceArn(v string) *UpdateApplicationInput

SetIdentityCenterInstanceArn sets the IdentityCenterInstanceArn field's value.

func (*UpdateApplicationInput) SetPersonalizationConfiguration added in v1.54.15 

func (s *UpdateApplicationInput) SetPersonalizationConfiguration(v *PersonalizationConfiguration) *UpdateApplicationInput

SetPersonalizationConfiguration sets the PersonalizationConfiguration field's value.

func (*UpdateApplicationInput) SetQAppsConfiguration added in v1.54.7 

func (s *UpdateApplicationInput) SetQAppsConfiguration(v *QAppsConfiguration) *UpdateApplicationInput

SetQAppsConfiguration sets the QAppsConfiguration field's value.

func (*UpdateApplicationInput) SetRoleArn 

func (s *UpdateApplicationInput) SetRoleArn(v string) *UpdateApplicationInput

SetRoleArn sets the RoleArn field's value.

func (UpdateApplicationInput) String 

func (s UpdateApplicationInput) 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 (*UpdateApplicationInput) Validate 

func (s *UpdateApplicationInput) Validate() error

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

type UpdateApplicationOutput 

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

func (UpdateApplicationOutput) GoString 

func (s UpdateApplicationOutput) 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 (UpdateApplicationOutput) String 

func (s UpdateApplicationOutput) 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 UpdateChatControlsConfigurationInput 

type UpdateChatControlsConfigurationInput struct {

	// The identifier of the application for which the chat controls are configured.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The phrases blocked from chat by your chat control configuration.
	BlockedPhrasesConfigurationUpdate *BlockedPhrasesConfigurationUpdate `locationName:"blockedPhrasesConfigurationUpdate" type:"structure"`

	// A token that you provide to identify the request to update a Amazon Q Business
	// application chat configuration.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The configuration details for CREATOR_MODE.
	CreatorModeConfiguration *CreatorModeConfiguration `locationName:"creatorModeConfiguration" type:"structure"`

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

	// The configured topic specific chat controls you want to update.
	TopicConfigurationsToCreateOrUpdate []*TopicConfiguration `locationName:"topicConfigurationsToCreateOrUpdate" type:"list"`

	// The configured topic specific chat controls you want to delete.
	TopicConfigurationsToDelete []*TopicConfiguration `locationName:"topicConfigurationsToDelete" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateChatControlsConfigurationInput) GoString 

func (s UpdateChatControlsConfigurationInput) 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 (*UpdateChatControlsConfigurationInput) SetApplicationId 

func (s *UpdateChatControlsConfigurationInput) SetApplicationId(v string) *UpdateChatControlsConfigurationInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateChatControlsConfigurationInput) SetBlockedPhrasesConfigurationUpdate 

func (s *UpdateChatControlsConfigurationInput) SetBlockedPhrasesConfigurationUpdate(v *BlockedPhrasesConfigurationUpdate) *UpdateChatControlsConfigurationInput

SetBlockedPhrasesConfigurationUpdate sets the BlockedPhrasesConfigurationUpdate field's value.

func (*UpdateChatControlsConfigurationInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*UpdateChatControlsConfigurationInput) SetCreatorModeConfiguration added in v1.51.23 

func (s *UpdateChatControlsConfigurationInput) SetCreatorModeConfiguration(v *CreatorModeConfiguration) *UpdateChatControlsConfigurationInput

SetCreatorModeConfiguration sets the CreatorModeConfiguration field's value.

func (*UpdateChatControlsConfigurationInput) SetResponseScope 

func (s *UpdateChatControlsConfigurationInput) SetResponseScope(v string) *UpdateChatControlsConfigurationInput

SetResponseScope sets the ResponseScope field's value.

func (*UpdateChatControlsConfigurationInput) SetTopicConfigurationsToCreateOrUpdate 

func (s *UpdateChatControlsConfigurationInput) SetTopicConfigurationsToCreateOrUpdate(v []*TopicConfiguration) *UpdateChatControlsConfigurationInput

SetTopicConfigurationsToCreateOrUpdate sets the TopicConfigurationsToCreateOrUpdate field's value.

func (*UpdateChatControlsConfigurationInput) SetTopicConfigurationsToDelete 

func (s *UpdateChatControlsConfigurationInput) SetTopicConfigurationsToDelete(v []*TopicConfiguration) *UpdateChatControlsConfigurationInput

SetTopicConfigurationsToDelete sets the TopicConfigurationsToDelete field's value.

func (UpdateChatControlsConfigurationInput) String 

func (s UpdateChatControlsConfigurationInput) 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 (*UpdateChatControlsConfigurationInput) Validate 

func (s *UpdateChatControlsConfigurationInput) Validate() error

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

type UpdateChatControlsConfigurationOutput 

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

func (UpdateChatControlsConfigurationOutput) GoString 

func (s UpdateChatControlsConfigurationOutput) 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 (UpdateChatControlsConfigurationOutput) String 

func (s UpdateChatControlsConfigurationOutput) 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 UpdateDataSourceInput 

type UpdateDataSourceInput struct {

	// The identifier of the Amazon Q Business application the data source is attached
	// to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The identifier of the data source connector.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"`

	// The description of the data source connector.
	Description *string `locationName:"description" type:"string"`

	// A name of the data source connector.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

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

	// The identifier of the index attached to the data source connector.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`

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

	// The chosen update frequency for your data source.
	SyncSchedule *string `locationName:"syncSchedule" type:"string"`

	// Provides configuration information needed to connect to an Amazon VPC (Virtual
	// Private Cloud).
	VpcConfiguration *DataSourceVpcConfiguration `locationName:"vpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDataSourceInput) GoString 

func (s UpdateDataSourceInput) 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 (*UpdateDataSourceInput) SetApplicationId 

func (s *UpdateDataSourceInput) SetApplicationId(v string) *UpdateDataSourceInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateDataSourceInput) SetDataSourceId 

func (s *UpdateDataSourceInput) SetDataSourceId(v string) *UpdateDataSourceInput

SetDataSourceId sets the DataSourceId field's value.

func (*UpdateDataSourceInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateDataSourceInput) SetDisplayName 

func (s *UpdateDataSourceInput) SetDisplayName(v string) *UpdateDataSourceInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateDataSourceInput) SetDocumentEnrichmentConfiguration 

func (s *UpdateDataSourceInput) SetDocumentEnrichmentConfiguration(v *DocumentEnrichmentConfiguration) *UpdateDataSourceInput

SetDocumentEnrichmentConfiguration sets the DocumentEnrichmentConfiguration field's value.

func (*UpdateDataSourceInput) SetIndexId 

func (s *UpdateDataSourceInput) SetIndexId(v string) *UpdateDataSourceInput

SetIndexId sets the IndexId field's value.

func (*UpdateDataSourceInput) SetRoleArn 

func (s *UpdateDataSourceInput) SetRoleArn(v string) *UpdateDataSourceInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateDataSourceInput) SetSyncSchedule 

func (s *UpdateDataSourceInput) SetSyncSchedule(v string) *UpdateDataSourceInput

SetSyncSchedule sets the SyncSchedule field's value.

func (*UpdateDataSourceInput) SetVpcConfiguration 

func (s *UpdateDataSourceInput) SetVpcConfiguration(v *DataSourceVpcConfiguration) *UpdateDataSourceInput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (UpdateDataSourceInput) String 

func (s UpdateDataSourceInput) 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 (*UpdateDataSourceInput) Validate 

func (s *UpdateDataSourceInput) Validate() error

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

type UpdateDataSourceOutput 

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

func (UpdateDataSourceOutput) GoString 

func (s UpdateDataSourceOutput) 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 (UpdateDataSourceOutput) String 

func (s UpdateDataSourceOutput) 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 UpdateIndexInput 

type UpdateIndexInput struct {

	// The identifier of the Amazon Q Business application connected to the index.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The storage capacity units you want to provision for your Amazon Q Business
	// index. You can add and remove capacity to fit your usage needs.
	CapacityConfiguration *IndexCapacityConfiguration `locationName:"capacityConfiguration" type:"structure"`

	// The description of the Amazon Q Business index.
	Description *string `locationName:"description" type:"string"`

	// The name of the Amazon Q Business index.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

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

	// The identifier of the Amazon Q Business index.
	//
	// IndexId is a required field
	IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateIndexInput) GoString 

func (s UpdateIndexInput) 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 (*UpdateIndexInput) SetApplicationId 

func (s *UpdateIndexInput) SetApplicationId(v string) *UpdateIndexInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateIndexInput) SetCapacityConfiguration 

func (s *UpdateIndexInput) SetCapacityConfiguration(v *IndexCapacityConfiguration) *UpdateIndexInput

SetCapacityConfiguration sets the CapacityConfiguration field's value.

func (*UpdateIndexInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateIndexInput) SetDisplayName 

func (s *UpdateIndexInput) SetDisplayName(v string) *UpdateIndexInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateIndexInput) SetDocumentAttributeConfigurations 

func (s *UpdateIndexInput) SetDocumentAttributeConfigurations(v []*DocumentAttributeConfiguration) *UpdateIndexInput

SetDocumentAttributeConfigurations sets the DocumentAttributeConfigurations field's value.

func (*UpdateIndexInput) SetIndexId 

func (s *UpdateIndexInput) SetIndexId(v string) *UpdateIndexInput

SetIndexId sets the IndexId field's value.

func (UpdateIndexInput) String 

func (s UpdateIndexInput) 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 (*UpdateIndexInput) Validate 

func (s *UpdateIndexInput) Validate() error

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

type UpdateIndexOutput 

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

func (UpdateIndexOutput) GoString 

func (s UpdateIndexOutput) 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 (UpdateIndexOutput) String 

func (s UpdateIndexOutput) 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 UpdatePluginInput 

type UpdatePluginInput struct {

	// The identifier of the application the plugin is attached to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The authentication configuration the plugin is using.
	AuthConfiguration *PluginAuthConfiguration `locationName:"authConfiguration" type:"structure"`

	// The configuration for a custom plugin.
	CustomPluginConfiguration *CustomPluginConfiguration `locationName:"customPluginConfiguration" type:"structure"`

	// The name of the plugin.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The identifier of the plugin.
	//
	// PluginId is a required field
	PluginId *string `location:"uri" locationName:"pluginId" min:"36" type:"string" required:"true"`

	// The source URL used for plugin configuration.
	ServerUrl *string `locationName:"serverUrl" min:"1" type:"string"`

	// The status of the plugin.
	State *string `locationName:"state" type:"string" enum:"PluginState"`
	// contains filtered or unexported fields
}

func (UpdatePluginInput) GoString 

func (s UpdatePluginInput) 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 (*UpdatePluginInput) SetApplicationId 

func (s *UpdatePluginInput) SetApplicationId(v string) *UpdatePluginInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdatePluginInput) SetAuthConfiguration 

func (s *UpdatePluginInput) SetAuthConfiguration(v *PluginAuthConfiguration) *UpdatePluginInput

SetAuthConfiguration sets the AuthConfiguration field's value.

func (*UpdatePluginInput) SetCustomPluginConfiguration added in v1.51.32 

func (s *UpdatePluginInput) SetCustomPluginConfiguration(v *CustomPluginConfiguration) *UpdatePluginInput

SetCustomPluginConfiguration sets the CustomPluginConfiguration field's value.

func (*UpdatePluginInput) SetDisplayName 

func (s *UpdatePluginInput) SetDisplayName(v string) *UpdatePluginInput

SetDisplayName sets the DisplayName field's value.

func (*UpdatePluginInput) SetPluginId 

func (s *UpdatePluginInput) SetPluginId(v string) *UpdatePluginInput

SetPluginId sets the PluginId field's value.

func (*UpdatePluginInput) SetServerUrl 

func (s *UpdatePluginInput) SetServerUrl(v string) *UpdatePluginInput

SetServerUrl sets the ServerUrl field's value.

func (*UpdatePluginInput) SetState 

func (s *UpdatePluginInput) SetState(v string) *UpdatePluginInput

SetState sets the State field's value.

func (UpdatePluginInput) String 

func (s UpdatePluginInput) 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 (*UpdatePluginInput) Validate 

func (s *UpdatePluginInput) Validate() error

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

type UpdatePluginOutput 

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

func (UpdatePluginOutput) GoString 

func (s UpdatePluginOutput) 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 (UpdatePluginOutput) String 

func (s UpdatePluginOutput) 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 UpdateRetrieverInput 

type UpdateRetrieverInput struct {

	// The identifier of your Amazon Q Business application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// Provides information on how the retriever used for your Amazon Q Business
	// application is configured.
	Configuration *RetrieverConfiguration `locationName:"configuration" type:"structure"`

	// The name of your retriever.
	DisplayName *string `locationName:"displayName" min:"1" type:"string"`

	// The identifier of your retriever.
	//
	// RetrieverId is a required field
	RetrieverId *string `location:"uri" locationName:"retrieverId" min:"36" type:"string" required:"true"`

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

func (UpdateRetrieverInput) GoString 

func (s UpdateRetrieverInput) 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 (*UpdateRetrieverInput) SetApplicationId 

func (s *UpdateRetrieverInput) SetApplicationId(v string) *UpdateRetrieverInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateRetrieverInput) SetConfiguration 

func (s *UpdateRetrieverInput) SetConfiguration(v *RetrieverConfiguration) *UpdateRetrieverInput

SetConfiguration sets the Configuration field's value.

func (*UpdateRetrieverInput) SetDisplayName 

func (s *UpdateRetrieverInput) SetDisplayName(v string) *UpdateRetrieverInput

SetDisplayName sets the DisplayName field's value.

func (*UpdateRetrieverInput) SetRetrieverId 

func (s *UpdateRetrieverInput) SetRetrieverId(v string) *UpdateRetrieverInput

SetRetrieverId sets the RetrieverId field's value.

func (*UpdateRetrieverInput) SetRoleArn 

func (s *UpdateRetrieverInput) SetRoleArn(v string) *UpdateRetrieverInput

SetRoleArn sets the RoleArn field's value.

func (UpdateRetrieverInput) String 

func (s UpdateRetrieverInput) 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 (*UpdateRetrieverInput) Validate 

func (s *UpdateRetrieverInput) Validate() error

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

type UpdateRetrieverOutput 

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

func (UpdateRetrieverOutput) GoString 

func (s UpdateRetrieverOutput) 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 (UpdateRetrieverOutput) String 

func (s UpdateRetrieverOutput) 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 UpdateUserInput 

type UpdateUserInput struct {

	// The identifier of the application the user is attached to.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The user aliases attached to the user id that are to be deleted.
	UserAliasesToDelete []*UserAlias `locationName:"userAliasesToDelete" type:"list"`

	// The user aliases attached to the user id that are to be updated.
	UserAliasesToUpdate []*UserAlias `locationName:"userAliasesToUpdate" type:"list"`

	// The email id attached to the user.
	//
	// UserId is a required field
	UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserInput) GoString 

func (s UpdateUserInput) 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 (*UpdateUserInput) SetApplicationId 

func (s *UpdateUserInput) SetApplicationId(v string) *UpdateUserInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateUserInput) SetUserAliasesToDelete 

func (s *UpdateUserInput) SetUserAliasesToDelete(v []*UserAlias) *UpdateUserInput

SetUserAliasesToDelete sets the UserAliasesToDelete field's value.

func (*UpdateUserInput) SetUserAliasesToUpdate 

func (s *UpdateUserInput) SetUserAliasesToUpdate(v []*UserAlias) *UpdateUserInput

SetUserAliasesToUpdate sets the UserAliasesToUpdate field's value.

func (*UpdateUserInput) SetUserId 

func (s *UpdateUserInput) SetUserId(v string) *UpdateUserInput

SetUserId sets the UserId field's value.

func (UpdateUserInput) String 

func (s UpdateUserInput) 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 (*UpdateUserInput) Validate 

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The user aliases that have been to be added to a user id.
	UserAliasesAdded []*UserAlias `locationName:"userAliasesAdded" type:"list"`

	// The user aliases that have been deleted from a user id.
	UserAliasesDeleted []*UserAlias `locationName:"userAliasesDeleted" type:"list"`

	// The user aliases attached to a user id that have been updated.
	UserAliasesUpdated []*UserAlias `locationName:"userAliasesUpdated" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) 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 (*UpdateUserOutput) SetUserAliasesAdded 

func (s *UpdateUserOutput) SetUserAliasesAdded(v []*UserAlias) *UpdateUserOutput

SetUserAliasesAdded sets the UserAliasesAdded field's value.

func (*UpdateUserOutput) SetUserAliasesDeleted 

func (s *UpdateUserOutput) SetUserAliasesDeleted(v []*UserAlias) *UpdateUserOutput

SetUserAliasesDeleted sets the UserAliasesDeleted field's value.

func (*UpdateUserOutput) SetUserAliasesUpdated 

func (s *UpdateUserOutput) SetUserAliasesUpdated(v []*UserAlias) *UpdateUserOutput

SetUserAliasesUpdated sets the UserAliasesUpdated field's value.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) 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 UpdateWebExperienceInput 

type UpdateWebExperienceInput struct {

	// The identifier of the Amazon Q Business application attached to the web experience.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The authentication configuration of the Amazon Q Business web experience.
	//
	// Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.
	AuthenticationConfiguration *WebExperienceAuthConfiguration `locationName:"authenticationConfiguration" deprecated:"true" type:"structure"`

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

	// Determines whether sample prompts are enabled in the web experience for an
	// end user.
	SamplePromptsControlMode *string `locationName:"samplePromptsControlMode" type:"string" enum:"WebExperienceSamplePromptsControlMode"`

	// The subtitle of the Amazon Q Business web experience.
	Subtitle *string `locationName:"subtitle" type:"string"`

	// The title of the Amazon Q Business web experience.
	Title *string `locationName:"title" type:"string"`

	// The identifier of the Amazon Q Business web experience.
	//
	// WebExperienceId is a required field
	WebExperienceId *string `location:"uri" locationName:"webExperienceId" min:"36" type:"string" required:"true"`

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

func (UpdateWebExperienceInput) GoString 

func (s UpdateWebExperienceInput) 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 (*UpdateWebExperienceInput) SetApplicationId 

func (s *UpdateWebExperienceInput) SetApplicationId(v string) *UpdateWebExperienceInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateWebExperienceInput) SetAuthenticationConfiguration 

func (s *UpdateWebExperienceInput) SetAuthenticationConfiguration(v *WebExperienceAuthConfiguration) *UpdateWebExperienceInput

SetAuthenticationConfiguration sets the AuthenticationConfiguration field's value.

func (*UpdateWebExperienceInput) SetRoleArn added in v1.51.32 

func (s *UpdateWebExperienceInput) SetRoleArn(v string) *UpdateWebExperienceInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateWebExperienceInput) SetSamplePromptsControlMode 

func (s *UpdateWebExperienceInput) SetSamplePromptsControlMode(v string) *UpdateWebExperienceInput

SetSamplePromptsControlMode sets the SamplePromptsControlMode field's value.

func (*UpdateWebExperienceInput) SetSubtitle 

func (s *UpdateWebExperienceInput) SetSubtitle(v string) *UpdateWebExperienceInput

SetSubtitle sets the Subtitle field's value.

func (*UpdateWebExperienceInput) SetTitle 

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

SetTitle sets the Title field's value.

func (*UpdateWebExperienceInput) SetWebExperienceId 

func (s *UpdateWebExperienceInput) SetWebExperienceId(v string) *UpdateWebExperienceInput

SetWebExperienceId sets the WebExperienceId field's value.

func (*UpdateWebExperienceInput) SetWelcomeMessage 

func (s *UpdateWebExperienceInput) SetWelcomeMessage(v string) *UpdateWebExperienceInput

SetWelcomeMessage sets the WelcomeMessage field's value.

func (UpdateWebExperienceInput) String 

func (s UpdateWebExperienceInput) 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 (*UpdateWebExperienceInput) Validate 

func (s *UpdateWebExperienceInput) Validate() error

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

type UpdateWebExperienceOutput 

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

func (UpdateWebExperienceOutput) GoString 

func (s UpdateWebExperienceOutput) 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 (UpdateWebExperienceOutput) String 

func (s UpdateWebExperienceOutput) 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 UserAlias 

type UserAlias struct {

	// The identifier of the data source that the user aliases are associated with.
	DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"`

	// The identifier of the index that the user aliases are associated with.
	IndexId *string `locationName:"indexId" min:"36" type:"string"`

	// The identifier of the user id associated with the user aliases.
	//
	// UserId is a required field
	UserId *string `locationName:"userId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Aliases attached to a user id within an Amazon Q Business application.

func (UserAlias) GoString 

func (s UserAlias) 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 (*UserAlias) SetDataSourceId 

func (s *UserAlias) SetDataSourceId(v string) *UserAlias

SetDataSourceId sets the DataSourceId field's value.

func (*UserAlias) SetIndexId 

func (s *UserAlias) SetIndexId(v string) *UserAlias

SetIndexId sets the IndexId field's value.

func (*UserAlias) SetUserId 

func (s *UserAlias) SetUserId(v string) *UserAlias

SetUserId sets the UserId field's value.

func (UserAlias) String 

func (s UserAlias) 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 (*UserAlias) Validate 

func (s *UserAlias) Validate() error

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

type UsersAndGroups 

type UsersAndGroups struct {

	// The user groups associated with a topic control rule.
	UserGroups []*string `locationName:"userGroups" type:"list"`

	// The user ids associated with a topic control rule.
	UserIds []*string `locationName:"userIds" type:"list"`
	// contains filtered or unexported fields
}

Provides information about users and groups associated with a topic control rule.

func (UsersAndGroups) GoString 

func (s UsersAndGroups) 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 (*UsersAndGroups) SetUserGroups 

func (s *UsersAndGroups) SetUserGroups(v []*string) *UsersAndGroups

SetUserGroups sets the UserGroups field's value.

func (*UsersAndGroups) SetUserIds 

func (s *UsersAndGroups) SetUserIds(v []*string) *UsersAndGroups

SetUserIds sets the UserIds field's value.

func (UsersAndGroups) String 

func (s UsersAndGroups) 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:"-"`

	// The input field(s) that failed validation.
	Fields []*ValidationExceptionField `locationName:"fields" type:"list"`

	// The message describing the ValidationException.
	Message_ *string `locationName:"message" min:"1" type:"string"`

	// The reason for the ValidationException.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

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

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message about the validation exception.
	//
	// Message is a required field
	Message *string `locationName:"message" min:"1" type:"string" required:"true"`

	// The field name where the invalid entry was detected.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input failed to meet the constraints specified by Amazon Q Business in a specified field.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) 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 (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

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

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) 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 WebExperience 

type WebExperience struct {

	// The Unix timestamp when the Amazon Q Business application was last updated.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The endpoint URLs for your Amazon Q Business web experience. The URLs are
	// unique and fully hosted by Amazon Web Services.
	DefaultEndpoint *string `locationName:"defaultEndpoint" min:"1" type:"string"`

	// The status of your Amazon Q Business web experience.
	Status *string `locationName:"status" type:"string" enum:"WebExperienceStatus"`

	// The Unix timestamp when your Amazon Q Business web experience was updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`

	// The identifier of your Amazon Q Business web experience.
	WebExperienceId *string `locationName:"webExperienceId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

Provides information for an Amazon Q Business web experience.

func (WebExperience) GoString 

func (s WebExperience) 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 (*WebExperience) SetCreatedAt 

func (s *WebExperience) SetCreatedAt(v time.Time) *WebExperience

SetCreatedAt sets the CreatedAt field's value.

func (*WebExperience) SetDefaultEndpoint 

func (s *WebExperience) SetDefaultEndpoint(v string) *WebExperience

SetDefaultEndpoint sets the DefaultEndpoint field's value.

func (*WebExperience) SetStatus 

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

SetStatus sets the Status field's value.

func (*WebExperience) SetUpdatedAt 

func (s *WebExperience) SetUpdatedAt(v time.Time) *WebExperience

SetUpdatedAt sets the UpdatedAt field's value.

func (*WebExperience) SetWebExperienceId 

func (s *WebExperience) SetWebExperienceId(v string) *WebExperience

SetWebExperienceId sets the WebExperienceId field's value.

func (WebExperience) String 

func (s WebExperience) 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 WebExperienceAuthConfiguration 

type WebExperienceAuthConfiguration struct {

	// Provides the SAML 2.0 compliant identity provider (IdP) configuration information
	// Amazon Q Business needs to deploy a Amazon Q Business web experience.
	SamlConfiguration *SamlConfiguration `locationName:"samlConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

func (WebExperienceAuthConfiguration) GoString 

func (s WebExperienceAuthConfiguration) 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 (*WebExperienceAuthConfiguration) SetSamlConfiguration 

func (s *WebExperienceAuthConfiguration) SetSamlConfiguration(v *SamlConfiguration) *WebExperienceAuthConfiguration

SetSamlConfiguration sets the SamlConfiguration field's value.

func (WebExperienceAuthConfiguration) String 

func (s WebExperienceAuthConfiguration) 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 (*WebExperienceAuthConfiguration) Validate 

func (s *WebExperienceAuthConfiguration) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package qbusinessiface provides an interface to enable mocking the QBusiness service client for testing your code.
 Package qbusinessiface provides an interface to enable mocking the QBusiness service client for testing your code.

Jump to

Keyboard shortcuts

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