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

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

const (
    // AttachmentStatusFailed is a AttachmentStatus enum value
    AttachmentStatusFailed = "FAILED"

    // AttachmentStatusSucceeded is a AttachmentStatus enum value
    AttachmentStatusSucceeded = "SUCCEEDED"
)

const (
    // AttachmentsControlModeEnabled is a AttachmentsControlMode enum value
    AttachmentsControlModeEnabled = "ENABLED"

    // AttachmentsControlModeDisabled is a AttachmentsControlMode enum value
    AttachmentsControlModeDisabled = "DISABLED"
)

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

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

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

const (
    // CreatorModeControlEnabled is a CreatorModeControl enum value
    CreatorModeControlEnabled = "ENABLED"

    // CreatorModeControlDisabled is a CreatorModeControl enum value
    CreatorModeControlDisabled = "DISABLED"
)

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

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

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

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

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

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

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

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

const (
    // IndexTypeEnterprise is a IndexType enum value
    IndexTypeEnterprise = "ENTERPRISE"

    // IndexTypeStarter is a IndexType enum value
    IndexTypeStarter = "STARTER"
)

const (
    // MemberRelationAnd is a MemberRelation enum value
    MemberRelationAnd = "AND"

    // MemberRelationOr is a MemberRelation enum value
    MemberRelationOr = "OR"
)

const (
    // MembershipTypeIndex is a MembershipType enum value
    MembershipTypeIndex = "INDEX"

    // MembershipTypeDatasource is a MembershipType enum value
    MembershipTypeDatasource = "DATASOURCE"
)

const (
    // MessageTypeUser is a MessageType enum value
    MessageTypeUser = "USER"

    // MessageTypeSystem is a MessageType enum value
    MessageTypeSystem = "SYSTEM"
)

const (
    // MessageUsefulnessUseful is a MessageUsefulness enum value
    MessageUsefulnessUseful = "USEFUL"

    // MessageUsefulnessNotUseful is a MessageUsefulness enum value
    MessageUsefulnessNotUseful = "NOT_USEFUL"
)

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

const (
    // NumberAttributeBoostingTypePrioritizeLargerValues is a NumberAttributeBoostingType enum value
    NumberAttributeBoostingTypePrioritizeLargerValues = "PRIORITIZE_LARGER_VALUES"

    // NumberAttributeBoostingTypePrioritizeSmallerValues is a NumberAttributeBoostingType enum value
    NumberAttributeBoostingTypePrioritizeSmallerValues = "PRIORITIZE_SMALLER_VALUES"
)

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

const (
    // PluginStateEnabled is a PluginState enum value
    PluginStateEnabled = "ENABLED"

    // PluginStateDisabled is a PluginState enum value
    PluginStateDisabled = "DISABLED"
)

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

const (
    // ReadAccessTypeAllow is a ReadAccessType enum value
    ReadAccessTypeAllow = "ALLOW"

    // ReadAccessTypeDeny is a ReadAccessType enum value
    ReadAccessTypeDeny = "DENY"
)

const (
    // ResponseScopeEnterpriseContentOnly is a ResponseScope enum value
    ResponseScopeEnterpriseContentOnly = "ENTERPRISE_CONTENT_ONLY"

    // ResponseScopeExtendedKnowledgeEnabled is a ResponseScope enum value
    ResponseScopeExtendedKnowledgeEnabled = "EXTENDED_KNOWLEDGE_ENABLED"
)

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

const (
    // RetrieverTypeNativeIndex is a RetrieverType enum value
    RetrieverTypeNativeIndex = "NATIVE_INDEX"

    // RetrieverTypeKendraIndex is a RetrieverType enum value
    RetrieverTypeKendraIndex = "KENDRA_INDEX"
)

const (
    // RuleTypeContentBlockerRule is a RuleType enum value
    RuleTypeContentBlockerRule = "CONTENT_BLOCKER_RULE"

    // RuleTypeContentRetrievalRule is a RuleType enum value
    RuleTypeContentRetrievalRule = "CONTENT_RETRIEVAL_RULE"
)

const (
    // StatusEnabled is a Status enum value
    StatusEnabled = "ENABLED"

    // StatusDisabled is a Status enum value
    StatusDisabled = "DISABLED"
)

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

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

const (
    // WebExperienceSamplePromptsControlModeEnabled is a WebExperienceSamplePromptsControlMode enum value
    WebExperienceSamplePromptsControlModeEnabled = "ENABLED"

    // WebExperienceSamplePromptsControlModeDisabled is a WebExperienceSamplePromptsControlMode enum value
    WebExperienceSamplePromptsControlModeDisabled = "DISABLED"
)

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

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

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

const (
    // APISchemaTypeOpenApiV3 is a APISchemaType enum value
    APISchemaTypeOpenApiV3 = "OPEN_API_V3"
)

const (
    // AttributeValueOperatorDelete is a AttributeValueOperator enum value
    AttributeValueOperatorDelete = "DELETE"
)

const (
    // DocumentContentOperatorDelete is a DocumentContentOperator enum value
    DocumentContentOperatorDelete = "DELETE"
)

func APISchemaType_Values ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

func NumberAttributeBoostingType_Values() []string

NumberAttributeBoostingType_Values returns all elements of the NumberAttributeBoostingType enum

func PluginBuildStatus_Values ¶

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

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

type APISchema ¶

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 ¶

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 ¶

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

SetPayload sets the Payload field's value.

func (*APISchema) SetS3 ¶

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

SetS3 sets the S3 field's value.

func (APISchema) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetConversationId sets the ConversationId field's value.

func (*ActionReviewEvent) SetPayload ¶

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

SetPayload sets the Payload field's value.

func (*ActionReviewEvent) SetPayloadFieldNameSeparator ¶

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

SetPayloadFieldNameSeparator sets the PayloadFieldNameSeparator field's value.

func (*ActionReviewEvent) SetPluginId ¶

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

SetPluginId sets the PluginId field's value.

func (*ActionReviewEvent) SetPluginType ¶

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

SetPluginType sets the PluginType field's value.

func (*ActionReviewEvent) SetSystemMessageId ¶

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

SetSystemMessageId sets the SystemMessageId field's value.

func (*ActionReviewEvent) SetUserMessageId ¶

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

SetUserMessageId sets the UserMessageId field's value.

func (ActionReviewEvent) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetCreatorModeControl sets the CreatorModeControl field's value.

func (AppliedCreatorModeConfiguration) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetAttachment sets the Attachment field's value.

func (AttachmentInputEvent) String ¶

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 ¶

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):
    // dateValue, longValue, stringListValue and stringValue.
    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 ¶

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 ¶

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 ¶

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

SetAuthorizationUrl sets the AuthorizationUrl field's value.

func (AuthChallengeRequest) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetAuthorizationUrl sets the AuthorizationUrl field's value.

func (AuthChallengeRequestEvent) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetResponseMap sets the ResponseMap field's value.

func (AuthChallengeResponse) String ¶

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 ¶

func (s *AuthChallengeResponse) Validate() error

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

type AuthChallengeResponseEvent ¶

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 ¶

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 ¶

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 ¶

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

SetResponseMap sets the ResponseMap field's value.

func (AuthChallengeResponseEvent) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

func (es *ChatEventStream) Err() error

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

func (*ChatEventStream) Events ¶

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

Events returns a channel to read events from.

These events are:

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

func (*ChatEventStream) Send ¶

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 ¶

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 ¶

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 ¶

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

SetApplicationId sets the ApplicationId field's value.

func (*ChatInput) SetClientToken ¶

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

SetClientToken sets the ClientToken field's value.

func (*ChatInput) SetConversationId ¶

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

SetConversationId sets the ConversationId field's value.

func (*ChatInput) SetParentMessageId ¶

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

SetParentMessageId sets the ParentMessageId field's value.

func (*ChatInput) SetUserGroups ¶

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

SetUserGroups sets the UserGroups field's value.

func (*ChatInput) SetUserId ¶

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

SetUserId sets the UserId field's value.

func (ChatInput) String ¶

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 ¶

func (s *ChatInput) Validate() error

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

type ChatInputStreamEvent ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetPluginConfiguration sets the PluginConfiguration field's value.

func (ChatModeConfiguration) String ¶

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 ¶

func (s *ChatModeConfiguration) Validate() error

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

type ChatOutput ¶

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

func (*ChatOutput) GetStream ¶

func (s *ChatOutput) GetStream() *ChatEventStream

GetStream returns the type to interact with the event stream.

func (ChatOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 end user text input 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 ¶

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

SetAuthChallengeResponse sets the AuthChallengeResponse field's value.

func (*ChatSyncInput) SetChatMode ¶

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

SetChatMode sets the ChatMode field's value.

func (*ChatSyncInput) SetChatModeConfiguration ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetAttributeFilter sets the AttributeFilter field's value.

func (*ConfigurationEvent) SetChatMode ¶

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

SetChatMode sets the ChatMode field's value.

func (*ConfigurationEvent) SetChatModeConfiguration ¶

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

SetChatModeConfiguration sets the ChatModeConfiguration field's value.

func (ConfigurationEvent) String ¶

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 ¶

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

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

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

SetIdentityCenterInstanceArn sets the IdentityCenterInstanceArn 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 or index tier, see Amazon Q Business tiers
    // (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetCreatorModeControl sets the CreatorModeControl field's value.

func (CreatorModeConfiguration) String ¶

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 ¶

func (s *CreatorModeConfiguration) Validate() error

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

type CustomPluginConfiguration ¶

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 ¶

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 ¶

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

SetApiSchema sets the ApiSchema field's value.

func (*CustomPluginConfiguration) SetApiSchemaType ¶

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

SetApiSchemaType sets the ApiSchemaType field's value.

func (*CustomPluginConfiguration) SetDescription ¶

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

SetDescription sets the Description field's value.

func (CustomPluginConfiguration) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetBoostingDurationInSeconds sets the BoostingDurationInSeconds field's value.

func (*DateAttributeBoostingConfiguration) SetBoostingLevel ¶

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

SetBoostingLevel sets the BoostingLevel field's value.

func (DateAttributeBoostingConfiguration) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

func (s *DocumentAttributeBoostingConfiguration) SetDateConfiguration(v *DateAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetDateConfiguration sets the DateConfiguration field's value.

func (*DocumentAttributeBoostingConfiguration) SetNumberConfiguration ¶

func (s *DocumentAttributeBoostingConfiguration) SetNumberConfiguration(v *NumberAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetNumberConfiguration sets the NumberConfiguration field's value.

func (*DocumentAttributeBoostingConfiguration) SetStringConfiguration ¶

func (s *DocumentAttributeBoostingConfiguration) SetStringConfiguration(v *StringAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetStringConfiguration sets the StringConfiguration field's value.

func (*DocumentAttributeBoostingConfiguration) SetStringListConfiguration ¶

func (s *DocumentAttributeBoostingConfiguration) SetStringListConfiguration(v *StringListAttributeBoostingConfiguration) *DocumentAttributeBoostingConfiguration

SetStringListConfiguration sets the StringListConfiguration field's value.

func (DocumentAttributeBoostingConfiguration) String ¶

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 ¶

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 ¶

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

The end of the streaming input for the Chat API.

func (EndOfInputEvent) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

func (s *FailedAttachmentEvent) SetAttachment(v *AttachmentOutput_) *FailedAttachmentEvent

SetAttachment sets the Attachment field's value.

func (*FailedAttachmentEvent) SetConversationId ¶

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

SetConversationId sets the ConversationId field's value.

func (*FailedAttachmentEvent) SetSystemMessageId ¶

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

SetSystemMessageId sets the SystemMessageId field's value.

func (*FailedAttachmentEvent) SetUserMessageId ¶

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

SetUserMessageId sets the UserMessageId field's value.

func (FailedAttachmentEvent) String ¶

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 ¶

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

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

func (s *GetApplicationOutput) SetIdentityCenterApplicationArn(v string) *GetApplicationOutput

SetIdentityCenterApplicationArn sets the IdentityCenterApplicationArn 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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶