package types
import "github.com/aws/aws-sdk-go-v2/service/connect/types"
Index ¶
- type AccessDeniedException
- func (e *AccessDeniedException) Error() string
- func (e *AccessDeniedException) ErrorCode() string
- func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *AccessDeniedException) ErrorMessage() string
- type AccessType
- type ActionSummary
- type ActionType
- type AdditionalEmailRecipients
- type AgentAvailabilityTimer
- type AgentConfig
- type AgentContactReference
- type AgentFirst
- type AgentHierarchyGroup
- type AgentHierarchyGroups
- type AgentInfo
- type AgentQualityMetrics
- type AgentStatus
- type AgentStatusIdentifier
- type AgentStatusReference
- type AgentStatusSearchCriteria
- type AgentStatusSearchFilter
- type AgentStatusState
- type AgentStatusSummary
- type AgentStatusType
- type AgentsCriteria
- type AiAgentInfo
- type AiUseCase
- type AliasConfiguration
- type AllowedCapabilities
- type AllowedUserAction
- type AnalyticsDataAssociationResult
- type AnalyticsDataSetsResult
- type AnswerMachineDetectionConfig
- type AnsweringMachineDetectionStatus
- type Application
- type ApplicationType
- type ArtifactStatus
- type AssignContactCategoryActionDefinition
- type AssignSlaActionDefinition
- type AssociatedContactSummary
- type AttachedFile
- type AttachedFileError
- type AttachedFileInvalidRequestExceptionReason
- type AttachedFileServiceQuotaExceededExceptionReason
- type AttachmentReference
- type Attendee
- type Attribute
- type AttributeAndCondition
- type AttributeCondition
- type AudioFeatures
- type AudioQualityMetricsInfo
- type AuthenticationProfile
- type AuthenticationProfileSummary
- type AutoEvaluationConfiguration
- type AutoEvaluationDetails
- type AutoEvaluationStatus
- type AutomaticFailConfiguration
- type AvailableNumberSummary
- type BatchCreateDataTableValueFailureResult
- type BatchCreateDataTableValueSuccessResult
- type BatchDeleteDataTableValueFailureResult
- type BatchDeleteDataTableValueSuccessResult
- type BatchDescribeDataTableValueFailureResult
- type BatchDescribeDataTableValueSuccessResult
- type BatchUpdateDataTableValueFailureResult
- type BatchUpdateDataTableValueSuccessResult
- type BehaviorType
- type BooleanComparisonType
- type BooleanCondition
- type Campaign
- type CaseSlaConfiguration
- type Channel
- type ChatContactMetrics
- type ChatEvent
- type ChatEventType
- type ChatMessage
- type ChatMetrics
- type ChatParticipantRoleConfig
- type ChatStreamingConfiguration
- type ClaimedPhoneNumberSummary
- type CommonAttributeAndCondition
- type Comparison
- type Condition
- type ConditionalOperationFailedException
- func (e *ConditionalOperationFailedException) Error() string
- func (e *ConditionalOperationFailedException) ErrorCode() string
- func (e *ConditionalOperationFailedException) ErrorFault() smithy.ErrorFault
- func (e *ConditionalOperationFailedException) ErrorMessage() string
- type ConflictException
- func (e *ConflictException) Error() string
- func (e *ConflictException) ErrorCode() string
- func (e *ConflictException) ErrorFault() smithy.ErrorFault
- func (e *ConflictException) ErrorMessage() string
- type ConnectionData
- type Contact
- type ContactAnalysis
- type ContactConfiguration
- type ContactDataRequest
- type ContactDetails
- type ContactEvaluation
- type ContactFilter
- type ContactFlow
- type ContactFlowAttributeAndCondition
- type ContactFlowAttributeFilter
- type ContactFlowModule
- type ContactFlowModuleAliasInfo
- type ContactFlowModuleAliasSummary
- type ContactFlowModuleSearchCriteria
- type ContactFlowModuleSearchFilter
- type ContactFlowModuleState
- type ContactFlowModuleStatus
- type ContactFlowModuleSummary
- type ContactFlowModuleVersionSummary
- type ContactFlowNotPublishedException
- func (e *ContactFlowNotPublishedException) Error() string
- func (e *ContactFlowNotPublishedException) ErrorCode() string
- func (e *ContactFlowNotPublishedException) ErrorFault() smithy.ErrorFault
- func (e *ContactFlowNotPublishedException) ErrorMessage() string
- type ContactFlowSearchCriteria
- type ContactFlowSearchFilter
- type ContactFlowState
- type ContactFlowStatus
- type ContactFlowSummary
- type ContactFlowType
- type ContactFlowTypeCondition
- type ContactFlowVersionSummary
- type ContactInitiationMethod
- type ContactInteractionType
- type ContactMediaProcessingFailureMode
- type ContactMetricInfo
- type ContactMetricName
- type ContactMetricResult
- type ContactMetricValue
- type ContactMetricValueMemberNumber
- type ContactNotFoundException
- func (e *ContactNotFoundException) Error() string
- func (e *ContactNotFoundException) ErrorCode() string
- func (e *ContactNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ContactNotFoundException) ErrorMessage() string
- type ContactParticipantRole
- type ContactRecordingType
- type ContactSearchSummary
- type ContactSearchSummaryAgentInfo
- type ContactSearchSummaryQueueInfo
- type ContactSearchSummarySegmentAttributeValue
- type ContactState
- type ControlPlaneAttributeFilter
- type ControlPlaneTagFilter
- type ControlPlaneUserAttributeFilter
- type CreateCaseActionDefinition
- type CreatedByInfo
- type CreatedByInfoMemberAWSIdentityArn
- type CreatedByInfoMemberConnectUserArn
- type Credentials
- type CrossChannelBehavior
- type CurrentMetric
- type CurrentMetricData
- type CurrentMetricName
- type CurrentMetricResult
- type CurrentMetricSortCriteria
- type Customer
- type CustomerQualityMetrics
- type CustomerVoiceActivity
- type DataTable
- type DataTableAccessControlConfiguration
- type DataTableAttribute
- type DataTableAttributeValueType
- type DataTableDeleteValueIdentifier
- type DataTableEvaluatedValue
- type DataTableLockLevel
- type DataTableLockVersion
- type DataTableSearchCriteria
- type DataTableSearchFilter
- type DataTableStatus
- type DataTableSummary
- type DataTableValue
- type DataTableValueEvaluationSet
- type DataTableValueIdentifier
- type DataTableValueSummary
- type DateComparisonType
- type DateCondition
- type DateReference
- type DateTimeComparisonType
- type DateTimeCondition
- type DecimalComparisonType
- type DecimalCondition
- type DefaultVocabulary
- type DestinationNotAllowedException
- func (e *DestinationNotAllowedException) Error() string
- func (e *DestinationNotAllowedException) ErrorCode() string
- func (e *DestinationNotAllowedException) ErrorFault() smithy.ErrorFault
- func (e *DestinationNotAllowedException) ErrorMessage() string
- type DeviceInfo
- type DeviceType
- type Dimensions
- type DirectoryType
- type DisconnectDetails
- type DisconnectReason
- type Distribution
- type DownloadUrlMetadata
- type DuplicateResourceException
- func (e *DuplicateResourceException) Error() string
- func (e *DuplicateResourceException) ErrorCode() string
- func (e *DuplicateResourceException) ErrorFault() smithy.ErrorFault
- func (e *DuplicateResourceException) ErrorMessage() string
- type EffectiveHoursOfOperations
- type EmailAddressInfo
- type EmailAddressMetadata
- type EmailAddressSearchCriteria
- type EmailAddressSearchFilter
- type EmailAttachment
- type EmailHeaderType
- type EmailMessageReference
- type EmailRecipient
- type EmailReference
- type EmptyFieldValue
- type EncryptionConfig
- type EncryptionType
- type EndAssociatedTasksActionDefinition
- type Endpoint
- type EndpointInfo
- type EndpointType
- type EntityType
- type ErrorResult
- type Evaluation
- type EvaluationAcknowledgement
- type EvaluationAcknowledgementSummary
- type EvaluationAnswerData
- type EvaluationAnswerDataMemberDateTimeValue
- type EvaluationAnswerDataMemberNotApplicable
- type EvaluationAnswerDataMemberNumericValue
- type EvaluationAnswerDataMemberStringValue
- type EvaluationAnswerDataMemberStringValues
- type EvaluationAnswerInput
- type EvaluationAnswerOutput
- type EvaluationAutomationRuleCategory
- type EvaluationContactLensAnswerAnalysisDetails
- type EvaluationContactParticipant
- type EvaluationForm
- type EvaluationFormAutoEvaluationConfiguration
- type EvaluationFormContent
- type EvaluationFormItem
- type EvaluationFormItemEnablementAction
- type EvaluationFormItemEnablementCondition
- type EvaluationFormItemEnablementConditionOperand
- type EvaluationFormItemEnablementConditionOperandMemberCondition
- type EvaluationFormItemEnablementConditionOperandMemberExpression
- type EvaluationFormItemEnablementConfiguration
- type EvaluationFormItemEnablementExpression
- type EvaluationFormItemEnablementOperator
- type EvaluationFormItemEnablementSource
- type EvaluationFormItemEnablementSourceType
- type EvaluationFormItemEnablementSourceValue
- type EvaluationFormItemEnablementSourceValueType
- type EvaluationFormItemMemberQuestion
- type EvaluationFormItemMemberSection
- type EvaluationFormItemSourceValuesComparator
- type EvaluationFormLanguageCode
- type EvaluationFormLanguageConfiguration
- type EvaluationFormMultiSelectQuestionAutomation
- type EvaluationFormMultiSelectQuestionAutomationOption
- type EvaluationFormMultiSelectQuestionAutomationOptionMemberRuleCategory
- type EvaluationFormMultiSelectQuestionDisplayMode
- type EvaluationFormMultiSelectQuestionOption
- type EvaluationFormMultiSelectQuestionProperties
- type EvaluationFormNumericQuestionAutomation
- type EvaluationFormNumericQuestionAutomationMemberAnswerSource
- type EvaluationFormNumericQuestionAutomationMemberPropertyValue
- type EvaluationFormNumericQuestionOption
- type EvaluationFormNumericQuestionProperties
- type EvaluationFormQuestion
- type EvaluationFormQuestionAutomationAnswerSource
- type EvaluationFormQuestionAutomationAnswerSourceType
- type EvaluationFormQuestionType
- type EvaluationFormQuestionTypeProperties
- type EvaluationFormQuestionTypePropertiesMemberMultiSelect
- type EvaluationFormQuestionTypePropertiesMemberNumeric
- type EvaluationFormQuestionTypePropertiesMemberSingleSelect
- type EvaluationFormQuestionTypePropertiesMemberText
- type EvaluationFormScoringMode
- type EvaluationFormScoringStatus
- type EvaluationFormScoringStrategy
- type EvaluationFormSearchCriteria
- type EvaluationFormSearchFilter
- type EvaluationFormSearchSummary
- type EvaluationFormSection
- type EvaluationFormSingleSelectQuestionAutomation
- type EvaluationFormSingleSelectQuestionAutomationOption
- type EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory
- type EvaluationFormSingleSelectQuestionDisplayMode
- type EvaluationFormSingleSelectQuestionOption
- type EvaluationFormSingleSelectQuestionProperties
- type EvaluationFormSummary
- type EvaluationFormTargetConfiguration
- type EvaluationFormTextQuestionAutomation
- type EvaluationFormTextQuestionProperties
- type EvaluationFormVersionStatus
- type EvaluationFormVersionSummary
- type EvaluationGenAIAnswerAnalysisDetails
- type EvaluationMetadata
- type EvaluationNote
- type EvaluationQuestionAnswerAnalysisDetails
- type EvaluationQuestionAnswerAnalysisDetailsMemberContactLens
- type EvaluationQuestionAnswerAnalysisDetailsMemberGenAI
- type EvaluationQuestionAnswerAnalysisType
- type EvaluationQuestionInputDetails
- type EvaluationScore
- type EvaluationSearchCriteria
- type EvaluationSearchFilter
- type EvaluationSearchMetadata
- type EvaluationSearchSummary
- type EvaluationStatus
- type EvaluationSuggestedAnswer
- type EvaluationSuggestedAnswerStatus
- type EvaluationSuggestedAnswerTranscriptMillisecondOffsets
- type EvaluationSummary
- type EvaluationTranscriptPointOfInterest
- type EvaluationTranscriptType
- type EvaluationType
- type EvaluatorUserUnion
- type EvaluatorUserUnionMemberConnectUserArn
- type EventBridgeActionDefinition
- type EventSourceName
- type Expiry
- type Expression
- type ExternalInvocationConfiguration
- type FailedBatchAssociationSummary
- type FailedRequest
- type FailureReasonCode
- type FieldValue
- type FieldValueUnion
- type FileStatusType
- type FileUseCaseType
- type FilterV2
- type FilterV2StringCondition
- type FilterV2StringConditionComparisonOperator
- type Filters
- type FlowAssociationResourceType
- type FlowAssociationSummary
- type FlowModule
- type FlowModuleType
- type FlowQuickConnectConfig
- type FontFamily
- type GranularAccessControlConfiguration
- type Grouping
- type HierarchyGroup
- type HierarchyGroupCondition
- type HierarchyGroupMatchType
- type HierarchyGroupSummary
- type HierarchyGroupSummaryReference
- type HierarchyGroups
- type HierarchyLevel
- type HierarchyLevelUpdate
- type HierarchyPath
- type HierarchyPathReference
- type HierarchyStructure
- type HierarchyStructureUpdate
- type HistoricalMetric
- type HistoricalMetricData
- type HistoricalMetricName
- type HistoricalMetricResult
- type HoursOfOperation
- type HoursOfOperationConfig
- type HoursOfOperationDays
- type HoursOfOperationOverride
- type HoursOfOperationOverrideConfig
- type HoursOfOperationOverrideSearchCriteria
- type HoursOfOperationSearchCriteria
- type HoursOfOperationSearchFilter
- type HoursOfOperationSummary
- type HoursOfOperationTimeSlice
- type IdempotencyException
- func (e *IdempotencyException) Error() string
- func (e *IdempotencyException) ErrorCode() string
- func (e *IdempotencyException) ErrorFault() smithy.ErrorFault
- func (e *IdempotencyException) ErrorMessage() string
- type ImagesLogo
- type InboundAdditionalRecipients
- type InboundEmailContent
- type InboundMessageSourceType
- type InboundRawMessage
- type InitiateAs
- type InputPredefinedAttributeConfiguration
- type Instance
- type InstanceAttributeType
- type InstanceReplicationStatus
- type InstanceStatus
- type InstanceStatusReason
- type InstanceStorageConfig
- type InstanceStorageResourceType
- type InstanceSummary
- type IntegrationAssociationSummary
- type IntegrationType
- type InternalServiceException
- func (e *InternalServiceException) Error() string
- func (e *InternalServiceException) ErrorCode() string
- func (e *InternalServiceException) ErrorFault() smithy.ErrorFault
- func (e *InternalServiceException) ErrorMessage() string
- type IntervalDetails
- type IntervalPeriod
- type InvalidContactFlowException
- func (e *InvalidContactFlowException) Error() string
- func (e *InvalidContactFlowException) ErrorCode() string
- func (e *InvalidContactFlowException) ErrorFault() smithy.ErrorFault
- func (e *InvalidContactFlowException) ErrorMessage() string
- type InvalidContactFlowModuleException
- func (e *InvalidContactFlowModuleException) Error() string
- func (e *InvalidContactFlowModuleException) ErrorCode() string
- func (e *InvalidContactFlowModuleException) ErrorFault() smithy.ErrorFault
- func (e *InvalidContactFlowModuleException) ErrorMessage() string
- type InvalidParameterException
- func (e *InvalidParameterException) Error() string
- func (e *InvalidParameterException) ErrorCode() string
- func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault
- func (e *InvalidParameterException) ErrorMessage() string
- type InvalidRequestException
- func (e *InvalidRequestException) Error() string
- func (e *InvalidRequestException) ErrorCode() string
- func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *InvalidRequestException) ErrorMessage() string
- type InvalidRequestExceptionReason
- type InvalidRequestExceptionReasonMemberAttachedFileInvalidRequestExceptionReason
- type InvisibleFieldInfo
- type IvrRecordingTrack
- type KinesisFirehoseConfig
- type KinesisStreamConfig
- type KinesisVideoStreamConfig
- type LexBot
- type LexBotConfig
- type LexV2Bot
- type LexVersion
- type LimitExceededException
- func (e *LimitExceededException) Error() string
- func (e *LimitExceededException) ErrorCode() string
- func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *LimitExceededException) ErrorMessage() string
- type ListCondition
- type ListFlowAssociationResourceType
- type ListPhoneNumbersSummary
- type MatchCriteria
- type MaximumResultReturnedException
- func (e *MaximumResultReturnedException) Error() string
- func (e *MaximumResultReturnedException) ErrorCode() string
- func (e *MaximumResultReturnedException) ErrorFault() smithy.ErrorFault
- func (e *MaximumResultReturnedException) ErrorMessage() string
- type MediaConcurrency
- type MediaItem
- type MediaPlacement
- type MediaStreamType
- type MediaType
- type Meeting
- type MeetingFeatureStatus
- type MeetingFeaturesConfiguration
- type MetricDataV2
- type MetricFilterV2
- type MetricInterval
- type MetricResultV2
- type MetricV2
- type MonitorCapability
- type MultiSelectQuestionRuleCategoryAutomation
- type MultiSelectQuestionRuleCategoryAutomationCondition
- type NameCriteria
- type NewSessionDetails
- type NextContactEntry
- type NextContactMetadata
- type NextContactMetadataMemberQuickConnectContactData
- type NextContactType
- type NotificationContentType
- type NotificationDeliveryType
- type NotificationRecipientType
- type NumberComparisonType
- type NumberCondition
- type NumberReference
- type NumericQuestionPropertyAutomationLabel
- type NumericQuestionPropertyValueAutomation
- type OperationalHour
- type OutboundAdditionalRecipients
- type OutboundCallerConfig
- type OutboundContactNotPermittedException
- func (e *OutboundContactNotPermittedException) Error() string
- func (e *OutboundContactNotPermittedException) ErrorCode() string
- func (e *OutboundContactNotPermittedException) ErrorFault() smithy.ErrorFault
- func (e *OutboundContactNotPermittedException) ErrorMessage() string
- type OutboundEmailConfig
- type OutboundEmailContent
- type OutboundMessageSourceType
- type OutboundRawMessage
- type OutboundStrategy
- type OutboundStrategyConfig
- type OutboundStrategyType
- type OutputTypeNotFoundException
- func (e *OutputTypeNotFoundException) Error() string
- func (e *OutputTypeNotFoundException) ErrorCode() string
- func (e *OutputTypeNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *OutputTypeNotFoundException) ErrorMessage() string
- type OverrideDays
- type OverrideTimeSlice
- type PaletteCanvas
- type PaletteHeader
- type PaletteNavigation
- type PalettePrimary
- type ParticipantCapabilities
- type ParticipantConfiguration
- type ParticipantDetails
- type ParticipantDetailsToAdd
- type ParticipantMetrics
- type ParticipantRole
- type ParticipantState
- type ParticipantTimerAction
- type ParticipantTimerConfiguration
- type ParticipantTimerType
- type ParticipantTimerValue
- type ParticipantTimerValueMemberParticipantTimerAction
- type ParticipantTimerValueMemberParticipantTimerDurationInMinutes
- type ParticipantTokenCredentials
- type ParticipantType
- type PersistentChat
- type PhoneNumberCountryCode
- type PhoneNumberQuickConnectConfig
- type PhoneNumberStatus
- type PhoneNumberSummary
- type PhoneNumberType
- type PhoneNumberWorkflowStatus
- type PhoneType
- type PostAcceptTimeoutConfig
- type PredefinedAttribute
- type PredefinedAttributeConfiguration
- type PredefinedAttributeSearchCriteria
- type PredefinedAttributeSummary
- type PredefinedAttributeValues
- type PredefinedAttributeValuesMemberStringList
- type Preview
- type PrimaryAttributeAccessControlConfigurationItem
- type PrimaryAttributeValue
- type PrimaryAttributeValueFilter
- type PrimaryValue
- type PrimaryValueResponse
- type ProblemDetail
- type Prompt
- type PromptSearchCriteria
- type PromptSearchFilter
- type PromptSummary
- type PropertyValidationException
- func (e *PropertyValidationException) Error() string
- func (e *PropertyValidationException) ErrorCode() string
- func (e *PropertyValidationException) ErrorFault() smithy.ErrorFault
- func (e *PropertyValidationException) ErrorMessage() string
- type PropertyValidationExceptionProperty
- type PropertyValidationExceptionReason
- type QualityMetrics
- type QuestionRuleCategoryAutomationCondition
- type Queue
- type QueueInfo
- type QueueInfoInput
- type QueueQuickConnectConfig
- type QueueReference
- type QueueSearchCriteria
- type QueueSearchFilter
- type QueueStatus
- type QueueSummary
- type QueueType
- type QuickConnect
- type QuickConnectConfig
- type QuickConnectContactData
- type QuickConnectSearchCriteria
- type QuickConnectSearchFilter
- type QuickConnectSummary
- type QuickConnectType
- type Range
- type ReadOnlyFieldInfo
- type RealTimeContactAnalysisAttachment
- type RealTimeContactAnalysisCategoryDetails
- type RealTimeContactAnalysisCharacterInterval
- type RealTimeContactAnalysisIssueDetected
- type RealTimeContactAnalysisOutputType
- type RealTimeContactAnalysisPointOfInterest
- type RealTimeContactAnalysisPostContactSummaryFailureCode
- type RealTimeContactAnalysisPostContactSummaryStatus
- type RealTimeContactAnalysisSegmentAttachments
- type RealTimeContactAnalysisSegmentCategories
- type RealTimeContactAnalysisSegmentEvent
- type RealTimeContactAnalysisSegmentIssues
- type RealTimeContactAnalysisSegmentPostContactSummary
- type RealTimeContactAnalysisSegmentTranscript
- type RealTimeContactAnalysisSegmentType
- type RealTimeContactAnalysisSentimentLabel
- type RealTimeContactAnalysisStatus
- type RealTimeContactAnalysisSupportedChannel
- type RealTimeContactAnalysisTimeData
- type RealTimeContactAnalysisTimeDataMemberAbsoluteTime
- type RealTimeContactAnalysisTranscriptItemRedaction
- type RealTimeContactAnalysisTranscriptItemWithCharacterOffsets
- type RealTimeContactAnalysisTranscriptItemWithContent
- type RealtimeContactAnalysisSegment
- type RealtimeContactAnalysisSegmentMemberAttachments
- type RealtimeContactAnalysisSegmentMemberCategories
- type RealtimeContactAnalysisSegmentMemberEvent
- type RealtimeContactAnalysisSegmentMemberIssues
- type RealtimeContactAnalysisSegmentMemberPostContactSummary
- type RealtimeContactAnalysisSegmentMemberTranscript
- type RecordPrimaryValue
- type RecordingInfo
- type RecordingStatus
- type Reference
- type ReferenceStatus
- type ReferenceSummary
- type ReferenceSummaryMemberAttachment
- type ReferenceSummaryMemberDate
- type ReferenceSummaryMemberEmail
- type ReferenceSummaryMemberEmailMessage
- type ReferenceSummaryMemberEmailMessagePlainText
- type ReferenceSummaryMemberNumber
- type ReferenceSummaryMemberString
- type ReferenceSummaryMemberUrl
- type ReferenceType
- type RehydrationType
- type ReplicationConfiguration
- type ReplicationStatusSummary
- type RequiredFieldInfo
- type ResourceConflictException
- func (e *ResourceConflictException) Error() string
- func (e *ResourceConflictException) ErrorCode() string
- func (e *ResourceConflictException) ErrorFault() smithy.ErrorFault
- func (e *ResourceConflictException) ErrorMessage() string
- type ResourceInUseException
- func (e *ResourceInUseException) Error() string
- func (e *ResourceInUseException) ErrorCode() string
- func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault
- func (e *ResourceInUseException) ErrorMessage() string
- type ResourceNotFoundException
- func (e *ResourceNotFoundException) Error() string
- func (e *ResourceNotFoundException) ErrorCode() string
- func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotFoundException) ErrorMessage() string
- type ResourceNotReadyException
- func (e *ResourceNotReadyException) Error() string
- func (e *ResourceNotReadyException) ErrorCode() string
- func (e *ResourceNotReadyException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotReadyException) ErrorMessage() string
- type ResourceTagsSearchCriteria
- type ResourceType
- type ResponseMode
- type RoutingCriteria
- type RoutingCriteriaInput
- type RoutingCriteriaInputStep
- type RoutingCriteriaInputStepExpiry
- type RoutingCriteriaStepStatus
- type RoutingProfile
- type RoutingProfileManualAssignmentQueueConfig
- type RoutingProfileManualAssignmentQueueConfigSummary
- type RoutingProfileQueueConfig
- type RoutingProfileQueueConfigSummary
- type RoutingProfileQueueReference
- type RoutingProfileReference
- type RoutingProfileSearchCriteria
- type RoutingProfileSearchFilter
- type RoutingProfileSummary
- type Rule
- type RuleAction
- type RulePublishStatus
- type RuleSummary
- type RuleTriggerEventSource
- type S3Config
- type ScreenShareCapability
- type SearchContactsAdditionalTimeRange
- type SearchContactsAdditionalTimeRangeCriteria
- type SearchContactsMatchType
- type SearchContactsTimeRange
- type SearchContactsTimeRangeConditionType
- type SearchContactsTimeRangeType
- type SearchContactsTimestampCondition
- type SearchCriteria
- type SearchableAgentCriteriaStep
- type SearchableContactAttributes
- type SearchableContactAttributesCriteria
- type SearchableQueueType
- type SearchableRoutingCriteria
- type SearchableRoutingCriteriaStep
- type SearchableSegmentAttributes
- type SearchableSegmentAttributesCriteria
- type SecurityKey
- type SecurityProfile
- type SecurityProfileItem
- type SecurityProfileSearchCriteria
- type SecurityProfileSearchSummary
- type SecurityProfileSummary
- type SecurityProfilesSearchFilter
- type SegmentAttributeValue
- type SendNotificationActionDefinition
- type ServiceQuotaExceededException
- func (e *ServiceQuotaExceededException) Error() string
- func (e *ServiceQuotaExceededException) ErrorCode() string
- func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
- func (e *ServiceQuotaExceededException) ErrorMessage() string
- type ServiceQuotaExceededExceptionReason
- type ServiceQuotaExceededExceptionReasonMemberAttachedFileServiceQuotaExceededExceptionReason
- type SignInConfig
- type SignInDistribution
- type SingleSelectQuestionRuleCategoryAutomation
- type SingleSelectQuestionRuleCategoryAutomationCondition
- type SlaAssignmentType
- type SlaType
- type Sort
- type SortOrder
- type SortableFieldName
- type SourceCampaign
- type SourceType
- type StateTransition
- type Statistic
- type Status
- type Step
- type StorageType
- type StringComparisonType
- type StringCondition
- type StringReference
- type SubmitAutoEvaluationActionDefinition
- type SuccessfulBatchAssociationSummary
- type SuccessfulRequest
- type TagCondition
- type TagSearchCondition
- type TagSet
- type TargetListType
- type TaskActionDefinition
- type TaskTemplateConstraints
- type TaskTemplateDefaultFieldValue
- type TaskTemplateDefaults
- type TaskTemplateField
- type TaskTemplateFieldIdentifier
- type TaskTemplateFieldType
- type TaskTemplateInfoV2
- type TaskTemplateMetadata
- type TaskTemplateStatus
- type TelephonyConfig
- type TemplateAttributes
- type TemplatedMessageConfig
- type Threshold
- type ThresholdV2
- type ThrottlingException
- func (e *ThrottlingException) Error() string
- func (e *ThrottlingException) ErrorCode() string
- func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
- func (e *ThrottlingException) ErrorMessage() string
- type TimerEligibleParticipantRoles
- type TooManyRequestsException
- func (e *TooManyRequestsException) Error() string
- func (e *TooManyRequestsException) ErrorCode() string
- func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault
- func (e *TooManyRequestsException) ErrorMessage() string
- type TrafficDistributionGroup
- type TrafficDistributionGroupStatus
- type TrafficDistributionGroupSummary
- type TrafficDistributionGroupUserSummary
- type TrafficType
- type Transcript
- type TranscriptCriteria
- type Unit
- type UnknownUnionMember
- type UpdateCaseActionDefinition
- type UpdateParticipantRoleConfigChannelInfo
- type UpdateParticipantRoleConfigChannelInfoMemberChat
- type UploadUrlMetadata
- type UrlReference
- type UseCase
- type UseCaseType
- type User
- type UserData
- type UserDataFilters
- type UserHierarchyGroupSearchCriteria
- type UserHierarchyGroupSearchFilter
- type UserIdentityInfo
- type UserIdentityInfoLite
- type UserInfo
- type UserNotFoundException
- func (e *UserNotFoundException) Error() string
- func (e *UserNotFoundException) ErrorCode() string
- func (e *UserNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *UserNotFoundException) ErrorMessage() string
- type UserPhoneConfig
- type UserProficiency
- type UserProficiencyDisassociate
- type UserQuickConnectConfig
- type UserReference
- type UserSearchCriteria
- type UserSearchFilter
- type UserSearchSummary
- type UserSummary
- type Validation
- type ValidationEnum
- type VideoCapability
- type View
- type ViewContent
- type ViewInputContent
- type ViewSearchCriteria
- type ViewSearchFilter
- type ViewStatus
- type ViewSummary
- type ViewType
- type ViewVersionSummary
- type Visibility
- type Vocabulary
- type VocabularyLanguageCode
- type VocabularyState
- type VocabularySummary
- type VoiceRecordingConfiguration
- type VoiceRecordingTrack
- type WisdomInfo
- type Workspace
- type WorkspaceAssociationSearchCriteria
- type WorkspaceAssociationSearchFilter
- type WorkspaceAssociationSearchSummary
- type WorkspaceFontFamily
- type WorkspacePage
- type WorkspaceSearchCriteria
- type WorkspaceSearchFilter
- type WorkspaceSearchSummary
- type WorkspaceSummary
- type WorkspaceTheme
- type WorkspaceThemeConfig
- type WorkspaceThemeImages
- type WorkspaceThemePalette
- type WorkspaceThemeTypography
Examples ¶
- ContactMetricValue (OutputUsage)
- CreatedByInfo (OutputUsage)
- EvaluationAnswerData (OutputUsage)
- EvaluationFormItem (OutputUsage)
- EvaluationFormItemEnablementConditionOperand (OutputUsage)
- EvaluationFormMultiSelectQuestionAutomationOption (OutputUsage)
- EvaluationFormNumericQuestionAutomation (OutputUsage)
- EvaluationFormQuestionTypeProperties (OutputUsage)
- EvaluationFormSingleSelectQuestionAutomationOption (OutputUsage)
- EvaluationQuestionAnswerAnalysisDetails (OutputUsage)
- EvaluatorUserUnion (OutputUsage)
- InvalidRequestExceptionReason (OutputUsage)
- NextContactMetadata (OutputUsage)
- ParticipantTimerValue (OutputUsage)
- PredefinedAttributeValues (OutputUsage)
- RealTimeContactAnalysisTimeData (OutputUsage)
- RealtimeContactAnalysisSegment (OutputUsage)
- ReferenceSummary (OutputUsage)
- ServiceQuotaExceededExceptionReason (OutputUsage)
- UpdateParticipantRoleConfigChannelInfo (OutputUsage)
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
You do not have sufficient permissions to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AccessType ¶
type AccessType string
const ( AccessTypeAllow AccessType = "ALLOW" )
Enum values for AccessType
func (AccessType) Values ¶
func (AccessType) Values() []AccessType
Values returns all known values for AccessType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ActionSummary ¶
type ActionSummary struct {
// The action type.
//
// This member is required.
ActionType ActionType
// contains filtered or unexported fields
}
Information about an action.
type ActionType ¶
type ActionType string
const ( ActionTypeCreateTask ActionType = "CREATE_TASK" ActionTypeAssignContactCategory ActionType = "ASSIGN_CONTACT_CATEGORY" ActionTypeGenerateEventbridgeEvent ActionType = "GENERATE_EVENTBRIDGE_EVENT" ActionTypeSendNotification ActionType = "SEND_NOTIFICATION" ActionTypeCreateCase ActionType = "CREATE_CASE" ActionTypeUpdateCase ActionType = "UPDATE_CASE" ActionTypeAssignSla ActionType = "ASSIGN_SLA" ActionTypeEndAssociatedTasks ActionType = "END_ASSOCIATED_TASKS" ActionTypeSubmitAutoEvaluation ActionType = "SUBMIT_AUTO_EVALUATION" )
Enum values for ActionType
func (ActionType) Values ¶
func (ActionType) Values() []ActionType
Values returns all known values for ActionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AdditionalEmailRecipients ¶
type AdditionalEmailRecipients struct {
// List of additional CC email recipients for an email contact.
CcList []EmailRecipient
// List of additional TO email recipients for an email contact.
ToList []EmailRecipient
// contains filtered or unexported fields
}
List of additional email addresses for an email contact.
type AgentAvailabilityTimer ¶
type AgentAvailabilityTimer string
const ( AgentAvailabilityTimerTimeSinceLastActivity AgentAvailabilityTimer = "TIME_SINCE_LAST_ACTIVITY" AgentAvailabilityTimerTimeSinceLastInbound AgentAvailabilityTimer = "TIME_SINCE_LAST_INBOUND" )
Enum values for AgentAvailabilityTimer
func (AgentAvailabilityTimer) Values ¶
func (AgentAvailabilityTimer) Values() []AgentAvailabilityTimer
Values returns all known values for AgentAvailabilityTimer. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AgentConfig ¶
type AgentConfig struct {
// Information about traffic distributions.
//
// This member is required.
Distributions []Distribution
// contains filtered or unexported fields
}
The distribution of agents between the instance and its replica(s).
type AgentContactReference ¶
type AgentContactReference struct {
// The [state of the contact].
//
// When AgentContactState is set to CONNECTED_ONHOLD , StateStartTimestamp is not
// changed. Instead, StateStartTimestamp reflects the time the contact was
// CONNECTED to the agent.
//
// [state of the contact]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
AgentContactState ContactState
// The channel of the contact.
Channel Channel
// The time at which the contact was connected to an agent.
ConnectedToAgentTimestamp *time.Time
// The identifier of the contact in this instance of Amazon Connect.
ContactId *string
// How the contact was initiated.
InitiationMethod ContactInitiationMethod
// Contains information about a queue resource for which metrics are returned.
Queue *QueueReference
// The epoch timestamp when the contact state started.
StateStartTimestamp *time.Time
// contains filtered or unexported fields
}
Information about the contact associated to the user.
type AgentFirst ¶
type AgentFirst struct {
// Information about preview configuration of agent first outbound strategy
Preview *Preview
// contains filtered or unexported fields
}
Information about agent-first outbound strategy configuration.
type AgentHierarchyGroup ¶
type AgentHierarchyGroup struct {
// The Amazon Resource Name (ARN) of the group.
Arn *string
// contains filtered or unexported fields
}
Information about an agent hierarchy group.
type AgentHierarchyGroups ¶
type AgentHierarchyGroups struct {
// The identifiers for level 1 hierarchy groups.
L1Ids []string
// The identifiers for level 2 hierarchy groups.
L2Ids []string
// The identifiers for level 3 hierarchy groups.
L3Ids []string
// The identifiers for level 4 hierarchy groups.
L4Ids []string
// The identifiers for level 5 hierarchy groups.
L5Ids []string
// contains filtered or unexported fields
}
A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchiesin the Amazon Connect Administrator Guide.
type AgentInfo ¶
type AgentInfo struct {
// The timestamp when the contact was accepted by the agent.
AcceptedByAgentTimestamp *time.Time
// The difference in time, in whole seconds, between AfterContactWorkStartTimestamp
// and AfterContactWorkEndTimestamp .
AfterContactWorkDuration *int32
// The date and time when the agent ended After Contact Work for the contact, in
// UTC time. In cases when agent finishes doing AfterContactWork for chat contacts
// and switches their activity status to offline or equivalent without clearing the
// contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp .
AfterContactWorkEndTimestamp *time.Time
// The date and time when the agent started doing After Contact Work for the
// contact, in UTC time.
AfterContactWorkStartTimestamp *time.Time
// The total hold duration in seconds initiated by the agent.
AgentInitiatedHoldDuration *int32
// Agent pause duration for a contact in seconds.
AgentPauseDurationInSeconds *int32
// The configuration for the allowed video and screen sharing capabilities for
// participants present over the call. For more information, see [Set up in-app, web, video calling, and screen sharing capabilities]in the Amazon
// Connect Administrator Guide.
//
// [Set up in-app, web, video calling, and screen sharing capabilities]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
Capabilities *ParticipantCapabilities
// The timestamp when the contact was connected to the agent.
ConnectedToAgentTimestamp *time.Time
// Information regarding Agent’s device.
DeviceInfo *DeviceInfo
// The agent hierarchy groups for the agent.
HierarchyGroups *HierarchyGroups
// The identifier of the agent who accepted the contact.
Id *string
// The timestamp when the agent finished previewing the contact.
PreviewEndTimestamp *time.Time
// List of StateTransition for a supervisor.
StateTransitions []StateTransition
// contains filtered or unexported fields
}
Information about the agent who accepted the contact.
type AgentQualityMetrics ¶
type AgentQualityMetrics struct {
// Information about the audio quality of the Agent
Audio *AudioQualityMetricsInfo
// contains filtered or unexported fields
}
Information about the quality of the Agent's media connection
type AgentStatus ¶
type AgentStatus struct {
// The Amazon Resource Name (ARN) of the agent status.
AgentStatusARN *string
// The identifier of the agent status.
AgentStatusId *string
// The description of the agent status.
Description *string
// The display order of the agent status.
DisplayOrder *int32
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the agent status.
Name *string
// The state of the agent status.
State AgentStatusState
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The type of agent status.
Type AgentStatusType
// contains filtered or unexported fields
}
Contains information about an agent status.
type AgentStatusIdentifier ¶
type AgentStatusIdentifier struct {
// The Amazon Resource Name (ARN) of the agent status.
Arn *string
// The identifier of the agent status.
Id *string
// contains filtered or unexported fields
}
Information about the agent status assigned to the user.
type AgentStatusReference ¶
type AgentStatusReference struct {
// The Amazon Resource Name (ARN) of the agent's status.
StatusArn *string
// The name of the agent status.
StatusName *string
// The start timestamp of the agent's status.
StatusStartTimestamp *time.Time
// contains filtered or unexported fields
}
Information about the agent's status.
type AgentStatusSearchCriteria ¶
type AgentStatusSearchCriteria struct {
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , description , state ,
// type , displayOrder , and resourceID .
AndConditions []AgentStatusSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []AgentStatusSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , description , state ,
// type , displayOrder , and resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return agent statuses.
type AgentStatusSearchFilter ¶
type AgentStatusSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type AgentStatusState ¶
type AgentStatusState string
const ( AgentStatusStateEnabled AgentStatusState = "ENABLED" AgentStatusStateDisabled AgentStatusState = "DISABLED" )
Enum values for AgentStatusState
func (AgentStatusState) Values ¶
func (AgentStatusState) Values() []AgentStatusState
Values returns all known values for AgentStatusState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AgentStatusSummary ¶
type AgentStatusSummary struct {
// The Amazon Resource Name (ARN) for the agent status.
Arn *string
// The identifier for an agent status.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the agent status.
Name *string
// The type of the agent status.
Type AgentStatusType
// contains filtered or unexported fields
}
Summary information for an agent status.
type AgentStatusType ¶
type AgentStatusType string
const ( AgentStatusTypeRoutable AgentStatusType = "ROUTABLE" AgentStatusTypeCustom AgentStatusType = "CUSTOM" AgentStatusTypeOffline AgentStatusType = "OFFLINE" )
Enum values for AgentStatusType
func (AgentStatusType) Values ¶
func (AgentStatusType) Values() []AgentStatusType
Values returns all known values for AgentStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AgentsCriteria ¶
type AgentsCriteria struct {
// An object to specify a list of agents, by user ID.
AgentIds []string
// contains filtered or unexported fields
}
Can be used to define a list of preferred agents to target the contact to within the queue. Note that agents must have the queue in their routing profile in order to be offered the contact.
type AiAgentInfo ¶
type AiAgentInfo struct {
// A boolean flag indicating whether the contact initially handled by this AI
// agent was escalated to a human agent.
AiAgentEscalated bool
// The unique identifier that specifies both the AI agent ID and its version
// number that was involved in the contact
AiAgentVersionId *string
// The use case or scenario for which the AI agent is involved in the contact
AiUseCase AiUseCase
// contains filtered or unexported fields
}
Information of the AI agent involved in the contact.
type AiUseCase ¶
type AiUseCase string
const ( AiUseCaseAgentAssistance AiUseCase = "AgentAssistance" AiUseCaseSelfService AiUseCase = "SelfService" )
Enum values for AiUseCase
func (AiUseCase) Values ¶
Values returns all known values for AiUseCase. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AliasConfiguration ¶
type AliasConfiguration struct {
// The email address ID.
//
// This member is required.
EmailAddressId *string
// contains filtered or unexported fields
}
Configuration information of an email alias.
type AllowedCapabilities ¶
type AllowedCapabilities struct {
// Information about the agent's video sharing capabilities.
Agent *ParticipantCapabilities
// Information about the customer's video sharing capabilities.
Customer *ParticipantCapabilities
// contains filtered or unexported fields
}
Information about the capabilities enabled for participants of the contact.
type AllowedUserAction ¶
type AllowedUserAction string
const ( AllowedUserActionCall AllowedUserAction = "CALL" AllowedUserActionDiscard AllowedUserAction = "DISCARD" )
Enum values for AllowedUserAction
func (AllowedUserAction) Values ¶
func (AllowedUserAction) Values() []AllowedUserAction
Values returns all known values for AllowedUserAction. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AnalyticsDataAssociationResult ¶
type AnalyticsDataAssociationResult struct {
// The identifier of the dataset.
DataSetId *string
// The Amazon Resource Name (ARN) of the Resource Access Manager share.
*string
// The Resource Access Manager share ID.
*string
// The Amazon Web Services Resource Access Manager status of association.
*string
// The identifier of the target account.
TargetAccountId *string
// contains filtered or unexported fields
}
This API is in preview release for Amazon Connect and is subject to change.
Information about associations that are successfully created: DataSetId , TargetAccountId , ResourceShareId , ResourceShareArn .
type AnalyticsDataSetsResult ¶
type AnalyticsDataSetsResult struct {
// The identifier of the dataset.
DataSetId *string
// The name of the dataset.
DataSetName *string
// contains filtered or unexported fields
}
Information about datasets that are available to associate with: DataSetId , DataSetName .
type AnswerMachineDetectionConfig ¶
type AnswerMachineDetectionConfig struct {
// Wait for the answering machine prompt.
AwaitAnswerMachinePrompt bool
// The flag to indicate if answer machine detection analysis needs to be performed
// for a voice call. If set to true , TrafficType must be set as CAMPAIGN .
EnableAnswerMachineDetection bool
// contains filtered or unexported fields
}
Configuration of the answering machine detection.
type AnsweringMachineDetectionStatus ¶
type AnsweringMachineDetectionStatus string
const ( AnsweringMachineDetectionStatusAnswered AnsweringMachineDetectionStatus = "ANSWERED" AnsweringMachineDetectionStatusUndetected AnsweringMachineDetectionStatus = "UNDETECTED" AnsweringMachineDetectionStatusError AnsweringMachineDetectionStatus = "ERROR" AnsweringMachineDetectionStatusHumanAnswered AnsweringMachineDetectionStatus = "HUMAN_ANSWERED" AnsweringMachineDetectionStatusSitToneDetected AnsweringMachineDetectionStatus = "SIT_TONE_DETECTED" AnsweringMachineDetectionStatusSitToneBusy AnsweringMachineDetectionStatus = "SIT_TONE_BUSY" AnsweringMachineDetectionStatusSitToneInvalidNumber AnsweringMachineDetectionStatus = "SIT_TONE_INVALID_NUMBER" AnsweringMachineDetectionStatusFaxMachineDetected AnsweringMachineDetectionStatus = "FAX_MACHINE_DETECTED" AnsweringMachineDetectionStatusVoicemailBeep AnsweringMachineDetectionStatus = "VOICEMAIL_BEEP" AnsweringMachineDetectionStatusVoicemailNoBeep AnsweringMachineDetectionStatus = "VOICEMAIL_NO_BEEP" AnsweringMachineDetectionStatusAmdUnresolved AnsweringMachineDetectionStatus = "AMD_UNRESOLVED" AnsweringMachineDetectionStatusAmdUnanswered AnsweringMachineDetectionStatus = "AMD_UNANSWERED" AnsweringMachineDetectionStatusAmdError AnsweringMachineDetectionStatus = "AMD_ERROR" AnsweringMachineDetectionStatusAmdNotApplicable AnsweringMachineDetectionStatus = "AMD_NOT_APPLICABLE" )
Enum values for AnsweringMachineDetectionStatus
func (AnsweringMachineDetectionStatus) Values ¶
func (AnsweringMachineDetectionStatus) Values() []AnsweringMachineDetectionStatus
Values returns all known values for AnsweringMachineDetectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Application ¶
type Application struct {
// The permissions that the agent is granted on the application. For third-party
// applications, only the ACCESS permission is supported. For MCP Servers, the
// permissions are tool Identifiers accepted by MCP Server.
ApplicationPermissions []string
// Namespace of the application that you want to give access to.
Namespace *string
// Type of Application.
Type ApplicationType
// contains filtered or unexported fields
}
This API is in preview release for Amazon Connect and is subject to change.
A third-party application's metadata.
type ApplicationType ¶
type ApplicationType string
const ( ApplicationTypeMcp ApplicationType = "MCP" ApplicationTypeThirdPartyApplication ApplicationType = "THIRD_PARTY_APPLICATION" )
Enum values for ApplicationType
func (ApplicationType) Values ¶
func (ApplicationType) Values() []ApplicationType
Values returns all known values for ApplicationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ArtifactStatus ¶
type ArtifactStatus string
const ( ArtifactStatusApproved ArtifactStatus = "APPROVED" ArtifactStatusRejected ArtifactStatus = "REJECTED" ArtifactStatusInProgress ArtifactStatus = "IN_PROGRESS" )
Enum values for ArtifactStatus
func (ArtifactStatus) Values ¶
func (ArtifactStatus) Values() []ArtifactStatus
Values returns all known values for ArtifactStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AssignContactCategoryActionDefinition ¶
type AssignContactCategoryActionDefinition struct {
// contains filtered or unexported fields
}
This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable . Contact is categorized using the rule name.
RuleName is used as ContactCategory .
type AssignSlaActionDefinition ¶
type AssignSlaActionDefinition struct {
// Type of SLA assignment.
//
// This member is required.
SlaAssignmentType SlaAssignmentType
// The SLA configuration for Case SLA Assignment.
CaseSlaConfiguration *CaseSlaConfiguration
// contains filtered or unexported fields
}
The AssignSla action definition.
type AssociatedContactSummary ¶
type AssociatedContactSummary struct {
// How the contact reached your contact center.
Channel Channel
// The Amazon Resource Name (ARN) of the contact
ContactArn *string
// The identifier of the contact in this instance of Amazon Connect.
ContactId *string
// The date and time that the customer endpoint disconnected from the current
// contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the
// previous contact indicates the date and time when that contact ended.
DisconnectTimestamp *time.Time
// If this contact is related to other contacts, this is the ID of the initial
// contact.
InitialContactId *string
// Indicates how the contact was initiated.
InitiationMethod ContactInitiationMethod
// The date and time this contact was initiated, in UTC time.
InitiationTimestamp *time.Time
// If this contact is not the first contact, this is the ID of the previous
// contact.
PreviousContactId *string
// The contactId that is related to this contact.
RelatedContactId *string
// contains filtered or unexported fields
}
Contact summary of a contact in contact tree associated with unique identifier.
type AttachedFile ¶
type AttachedFile struct {
// The time of Creation of the file resource as an ISO timestamp. It's specified
// in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ . For example,
// 2024-05-03T02:41:28.172Z .
//
// This member is required.
CreationTime *string
// The unique identifier of the attached file resource (ARN).
//
// This member is required.
FileArn *string
// The unique identifier of the attached file resource.
//
// This member is required.
FileId *string
// A case-sensitive name of the attached file being uploaded.
//
// This member is required.
FileName *string
// The size of the attached file in bytes.
//
// This member is required.
FileSizeInBytes *int64
// The current status of the attached file.
//
// This member is required.
FileStatus FileStatusType
// The resource to which the attached file is (being) uploaded to. [Cases] are the only
// current supported resource.
//
// This value must be a valid ARN.
//
// [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html
AssociatedResourceArn *string
// Represents the identity that created the file.
CreatedBy CreatedByInfo
// The use case for the file.
FileUseCaseType FileUseCaseType
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} } .
Tags map[string]string
// contains filtered or unexported fields
}
Information about the attached file.
type AttachedFileError ¶
type AttachedFileError struct {
// Status code describing the failure.
ErrorCode *string
// Why the attached file couldn't be retrieved.
ErrorMessage *string
// The unique identifier of the attached file resource.
FileId *string
// contains filtered or unexported fields
}
Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
type AttachedFileInvalidRequestExceptionReason ¶
type AttachedFileInvalidRequestExceptionReason string
const ( AttachedFileInvalidRequestExceptionReasonInvalidFileSize AttachedFileInvalidRequestExceptionReason = "INVALID_FILE_SIZE" AttachedFileInvalidRequestExceptionReasonInvalidFileType AttachedFileInvalidRequestExceptionReason = "INVALID_FILE_TYPE" AttachedFileInvalidRequestExceptionReasonInvalidFileName AttachedFileInvalidRequestExceptionReason = "INVALID_FILE_NAME" )
Enum values for AttachedFileInvalidRequestExceptionReason
func (AttachedFileInvalidRequestExceptionReason) Values ¶
func (AttachedFileInvalidRequestExceptionReason) Values() []AttachedFileInvalidRequestExceptionReason
Values returns all known values for AttachedFileInvalidRequestExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AttachedFileServiceQuotaExceededExceptionReason ¶
type AttachedFileServiceQuotaExceededExceptionReason string
const ( AttachedFileServiceQuotaExceededExceptionReasonTotalFileSizeExceeded AttachedFileServiceQuotaExceededExceptionReason = "TOTAL_FILE_SIZE_EXCEEDED" AttachedFileServiceQuotaExceededExceptionReasonTotalFileCountExceeded AttachedFileServiceQuotaExceededExceptionReason = "TOTAL_FILE_COUNT_EXCEEDED" )
Enum values for AttachedFileServiceQuotaExceededExceptionReason
func (AttachedFileServiceQuotaExceededExceptionReason) Values ¶
func (AttachedFileServiceQuotaExceededExceptionReason) Values() []AttachedFileServiceQuotaExceededExceptionReason
Values returns all known values for AttachedFileServiceQuotaExceededExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AttachmentReference ¶
type AttachmentReference struct {
// The Amazon Resource Name (ARN) of the attachment reference.
Arn *string
// Identifier of the attachment reference.
Name *string
// Status of the attachment reference type.
Status ReferenceStatus
// The location path of the attachment reference.
Value *string
// contains filtered or unexported fields
}
Information about a reference when the referenceType is ATTACHMENT . Otherwise, null.
type Attendee ¶
type Attendee struct {
// The Amazon Chime SDK attendee ID.
AttendeeId *string
// The join token used by the Amazon Chime SDK attendee.
JoinToken *string
// contains filtered or unexported fields
}
The attendee information, including attendee ID and join token.
type Attribute ¶
type Attribute struct {
// The type of attribute.
AttributeType InstanceAttributeType
// The value of the attribute.
Value *string
// contains filtered or unexported fields
}
A toggle for an individual feature at the instance level.
type AttributeAndCondition ¶
type AttributeAndCondition struct {
// A leaf node condition which can be used to specify a hierarchy group condition.
HierarchyGroupCondition *HierarchyGroupCondition
// A leaf node condition which can be used to specify a tag condition.
TagConditions []TagCondition
// contains filtered or unexported fields
}
A list of conditions which would be applied together with an AND condition.
type AttributeCondition ¶
type AttributeCondition struct {
// The operator of the condition.
ComparisonOperator *string
// An object to define AgentsCriteria .
MatchCriteria *MatchCriteria
// The name of predefined attribute.
Name *string
// The proficiency level of the condition.
ProficiencyLevel *float32
// An Object to define the minimum and maximum proficiency levels.
Range *Range
// The value of predefined attribute.
Value *string
// contains filtered or unexported fields
}
An object to specify the predefined attribute condition.
type AudioFeatures ¶
type AudioFeatures struct {
// Makes echo reduction available to clients who connect to the meeting.
EchoReduction MeetingFeatureStatus
// contains filtered or unexported fields
}
Has audio-specific configurations as the operating parameter for Echo Reduction.
type AudioQualityMetricsInfo ¶
type AudioQualityMetricsInfo struct {
// List of potential issues causing degradation of quality on a media connection.
// If the service did not detect any potential quality issues the list is empty.
//
// Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
PotentialQualityIssues []string
// Number measuring the estimated quality of the media connection.
QualityScore float32
// contains filtered or unexported fields
}
Contains information for score and potential quality issues for Audio
type AuthenticationProfile ¶
type AuthenticationProfile struct {
// A list of IP address range strings that are allowed to access the Amazon
// Connect instance. For more information about how to configure IP addresses, see [Configure IP address based access control]
// in the Amazon Connect Administrator Guide.
//
// [Configure IP address based access control]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac
AllowedIps []string
// The Amazon Resource Name (ARN) for the authentication profile.
Arn *string
// A list of IP address range strings that are blocked from accessing the Amazon
// Connect instance. For more information about how to configure IP addresses, see [Configure IP address based access control]
// in the Amazon Connect Administrator Guide.
//
// [Configure IP address based access control]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac
BlockedIps []string
// The timestamp when the authentication profile was created.
CreatedTime *time.Time
// The description for the authentication profile.
Description *string
// A unique identifier for the authentication profile.
Id *string
// Shows whether the authentication profile is the default authentication profile
// for the Amazon Connect instance. The default authentication profile applies to
// all agents in an Amazon Connect instance, unless overridden by another
// authentication profile.
IsDefault bool
// The Amazon Web Services Region where the authentication profile was last
// modified.
LastModifiedRegion *string
// The timestamp when the authentication profile was last modified.
LastModifiedTime *time.Time
// The long lived session duration for users logged in to Amazon Connect, in
// minutes. After this time period, users must log in again. For more information,
// see [Configure the session duration]in the Amazon Connect Administrator Guide.
//
// [Configure the session duration]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
MaxSessionDuration *int32
// The name for the authentication profile.
Name *string
// The short lived session duration configuration for users logged in to Amazon
// Connect, in minutes. This value determines the maximum possible time before an
// agent is authenticated. For more information, see [Configure the session duration]in the Amazon Connect
// Administrator Guide.
//
// [Configure the session duration]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
//
// Deprecated: PeriodicSessionDuration is deprecated. Use
// SessionInactivityDuration instead.
PeriodicSessionDuration *int32
// The period, in minutes, before an agent is automatically signed out of the
// contact center when they go inactive.
SessionInactivityDuration *int32
// Determines if automatic logout on user inactivity is enabled.
SessionInactivityHandlingEnabled *bool
// contains filtered or unexported fields
}
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts.
type AuthenticationProfileSummary ¶
type AuthenticationProfileSummary struct {
// The Amazon Resource Name (ARN) of the authentication profile summary.
Arn *string
// The unique identifier of the authentication profile.
Id *string
// Shows whether the authentication profile is the default authentication profile
// for the Amazon Connect instance. The default authentication profile applies to
// all agents in an Amazon Connect instance, unless overridden by another
// authentication profile.
IsDefault bool
// The Amazon Web Services Region when the authentication profile summary was last
// modified.
LastModifiedRegion *string
// The timestamp when the authentication profile summary was last modified.
LastModifiedTime *time.Time
// The name of the authentication profile summary.
Name *string
// contains filtered or unexported fields
}
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
A summary of a given authentication profile.
type AutoEvaluationConfiguration ¶
type AutoEvaluationConfiguration struct {
// Whether automated evaluations are enabled.
//
// This member is required.
Enabled bool
// contains filtered or unexported fields
}
Configuration information about automated evaluations.
type AutoEvaluationDetails ¶
type AutoEvaluationDetails struct {
// Whether automated evaluation is enabled.
//
// This member is required.
AutoEvaluationEnabled bool
// The status of the contact auto-evaluation.
AutoEvaluationStatus AutoEvaluationStatus
// contains filtered or unexported fields
}
Details about automated evaluations.
type AutoEvaluationStatus ¶
type AutoEvaluationStatus string
const ( AutoEvaluationStatusInProgress AutoEvaluationStatus = "IN_PROGRESS" AutoEvaluationStatusFailed AutoEvaluationStatus = "FAILED" AutoEvaluationStatusSucceeded AutoEvaluationStatus = "SUCCEEDED" )
Enum values for AutoEvaluationStatus
func (AutoEvaluationStatus) Values ¶
func (AutoEvaluationStatus) Values() []AutoEvaluationStatus
Values returns all known values for AutoEvaluationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AutomaticFailConfiguration ¶
type AutomaticFailConfiguration struct {
// The referenceId of the target section for auto failure.
TargetSection *string
// contains filtered or unexported fields
}
Information about automatic fail configuration for an evaluation form.
type AvailableNumberSummary ¶
type AvailableNumberSummary struct {
// The phone number. Phone numbers are formatted [+] [country code] [subscriber
// number including area code] .
PhoneNumber *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The type of phone number.
PhoneNumberType PhoneNumberType
// contains filtered or unexported fields
}
Information about available phone numbers.
type BatchCreateDataTableValueFailureResult ¶
type BatchCreateDataTableValueFailureResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's message.
//
// This member is required.
Message *string
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A batch create data table value failure result.
type BatchCreateDataTableValueSuccessResult ¶
type BatchCreateDataTableValueSuccessResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's lock version.
//
// This member is required.
LockVersion *DataTableLockVersion
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// The result's record ID.
//
// This member is required.
RecordId *string
// contains filtered or unexported fields
}
A batch create data table value success result.
type BatchDeleteDataTableValueFailureResult ¶
type BatchDeleteDataTableValueFailureResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's message.
//
// This member is required.
Message *string
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A batch delete data table value failure result.
type BatchDeleteDataTableValueSuccessResult ¶
type BatchDeleteDataTableValueSuccessResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's lock version.
//
// This member is required.
LockVersion *DataTableLockVersion
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A batch delete data table value success result.
type BatchDescribeDataTableValueFailureResult ¶
type BatchDescribeDataTableValueFailureResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's message.
//
// This member is required.
Message *string
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A batch describe data table value failure result.
type BatchDescribeDataTableValueSuccessResult ¶
type BatchDescribeDataTableValueSuccessResult struct {
// The result's attribute ID.
//
// This member is required.
AttributeId *string
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's lock version.
//
// This member is required.
LockVersion *DataTableLockVersion
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValueResponse
// The result's record ID.
//
// This member is required.
RecordId *string
// The result's last modified region.
LastModifiedRegion *string
// The result's last modified time.
LastModifiedTime *time.Time
// The result's value.
Value *string
// contains filtered or unexported fields
}
A batch describe data table value success result.
type BatchUpdateDataTableValueFailureResult ¶
type BatchUpdateDataTableValueFailureResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's message.
//
// This member is required.
Message *string
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A batch update data table value failure result.
type BatchUpdateDataTableValueSuccessResult ¶
type BatchUpdateDataTableValueSuccessResult struct {
// The result's attribute name.
//
// This member is required.
AttributeName *string
// The result's lock version.
//
// This member is required.
LockVersion *DataTableLockVersion
// The result's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A batch update data table value success result.
type BehaviorType ¶
type BehaviorType string
const ( BehaviorTypeRouteCurrentChannelOnly BehaviorType = "ROUTE_CURRENT_CHANNEL_ONLY" BehaviorTypeRouteAnyChannel BehaviorType = "ROUTE_ANY_CHANNEL" )
Enum values for BehaviorType
func (BehaviorType) Values ¶
func (BehaviorType) Values() []BehaviorType
Values returns all known values for BehaviorType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type BooleanComparisonType ¶
type BooleanComparisonType string
const ( BooleanComparisonTypeIsTrue BooleanComparisonType = "IS_TRUE" BooleanComparisonTypeIsFalse BooleanComparisonType = "IS_FALSE" )
Enum values for BooleanComparisonType
func (BooleanComparisonType) Values ¶
func (BooleanComparisonType) Values() []BooleanComparisonType
Values returns all known values for BooleanComparisonType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type BooleanCondition ¶
type BooleanCondition struct {
// Boolean property comparison type.
ComparisonType BooleanComparisonType
// A name of the property to be searched.
FieldName *string
// contains filtered or unexported fields
}
A boolean search condition for Search APIs.
type Campaign ¶
type Campaign struct {
// A unique identifier for a campaign.
CampaignId *string
// contains filtered or unexported fields
}
Information associated with a campaign.
type CaseSlaConfiguration ¶
type CaseSlaConfiguration struct {
// Name of an SLA.
//
// This member is required.
Name *string
// Target duration in minutes within which an SLA should be completed.
//
// This member is required.
TargetSlaMinutes *int64
// Type of SLA for Case SlaAssignmentType.
//
// This member is required.
Type SlaType
// Unique identifier of a Case field.
FieldId *string
// Represents a list of target field values for the fieldId specified in
// CaseSlaConfiguration. The SLA is considered met if any one of these target field
// values matches the actual field value.
TargetFieldValues []FieldValueUnion
// contains filtered or unexported fields
}
The SLA configuration for Case SlaAssignmentType.
type Channel ¶
type Channel string
const ( ChannelVoice Channel = "VOICE" ChannelChat Channel = "CHAT" ChannelTask Channel = "TASK" ChannelEmail Channel = "EMAIL" )
Enum values for Channel
func (Channel) Values ¶
Values returns all known values for Channel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ChatContactMetrics ¶
type ChatContactMetrics struct {
// The time for an agent to respond after obtaining a chat contact.
AgentFirstResponseTimeInMillis *int64
// The agent first response timestamp for a chat contact.
AgentFirstResponseTimestamp *time.Time
// The time it took for a contact to end after the last customer message.
ConversationCloseTimeInMillis *int64
// The number of conversation turns in a chat contact, which represents the
// back-and-forth exchanges between customer and other participants.
ConversationTurnCount *int32
// A boolean flag indicating whether multiparty chat or supervisor barge were
// enabled on this contact.
MultiParty *bool
// The total number of characters from bot and automated messages on a chat
// contact.
TotalBotMessageLengthInChars *int32
// The total number of bot and automated messages on a chat contact.
TotalBotMessages *int32
// The number of chat messages on the contact.
TotalMessages *int32
// contains filtered or unexported fields
}
Information about the overall participant interactions at the contact level.
type ChatEvent ¶
type ChatEvent struct {
// Type of chat integration event.
//
// This member is required.
Type ChatEventType
// Content of the message or event. This is required when Type is MESSAGE and for
// certain ContentTypes when Type is EVENT .
//
// - For allowed message content, see the Content parameter in the [SendMessage]topic in the
// Amazon Connect Participant Service API Reference.
//
// - For allowed event content, see the Content parameter in the [SendEvent]topic in the
// Amazon Connect Participant Service API Reference.
//
// [SendEvent]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html
// [SendMessage]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html
Content *string
// Type of content. This is required when Type is MESSAGE or EVENT .
//
// - For allowed message content types, see the ContentType parameter in the [SendMessage]
// topic in the Amazon Connect Participant Service API Reference.
//
// - For allowed event content types, see the ContentType parameter in the [SendEvent]topic
// in the Amazon Connect Participant Service API Reference.
//
// [SendEvent]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html
// [SendMessage]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html
ContentType *string
// contains filtered or unexported fields
}
Chat integration event containing payload to perform different chat actions such as:
Sending a chat message
Sending a chat event, such as typing
Disconnecting from a chat
type ChatEventType ¶
type ChatEventType string
const ( ChatEventTypeDisconnect ChatEventType = "DISCONNECT" ChatEventTypeMessage ChatEventType = "MESSAGE" ChatEventTypeEvent ChatEventType = "EVENT" )
Enum values for ChatEventType
func (ChatEventType) Values ¶
func (ChatEventType) Values() []ChatEventType
Values returns all known values for ChatEventType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ChatMessage ¶
type ChatMessage struct {
// The content of the chat message.
//
// - For text/plain and text/markdown , the Length Constraints are Minimum of 1,
// Maximum of 1024.
//
// - For application/json , the Length Constraints are Minimum of 1, Maximum of
// 12000.
//
// - For application/vnd.amazonaws.connect.message.interactive.response , the
// Length Constraints are Minimum of 1, Maximum of 12288.
//
// This member is required.
Content *string
// The type of the content. Supported types are text/plain , text/markdown ,
// application/json , and
// application/vnd.amazonaws.connect.message.interactive.response .
//
// This member is required.
ContentType *string
// contains filtered or unexported fields
}
A chat message.
type ChatMetrics ¶
type ChatMetrics struct {
// Information about agent interactions in a contact.
AgentMetrics *ParticipantMetrics
// Information about the overall participant interactions at the contact level.
ChatContactMetrics *ChatContactMetrics
// Information about customer interactions in a contact.
CustomerMetrics *ParticipantMetrics
// contains filtered or unexported fields
}
Information about how agent, bot, and customer interact in a chat contact.
type ChatParticipantRoleConfig ¶
type ChatParticipantRoleConfig struct {
// A list of participant timers. You can specify any unique combination of role
// and timer type. Duplicate entries error out the request with a 400.
//
// This member is required.
ParticipantTimerConfigList []ParticipantTimerConfiguration
// contains filtered or unexported fields
}
Configuration information for the chat participant role.
type ChatStreamingConfiguration ¶
type ChatStreamingConfiguration struct {
// The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon
// Resource Name (ARN) of the streaming endpoint that is used to publish real-time
// message streaming for chat conversations.
//
// This member is required.
StreamingEndpointArn *string
// contains filtered or unexported fields
}
The streaming configuration, such as the Amazon SNS streaming endpoint.
type ClaimedPhoneNumberSummary ¶
type ClaimedPhoneNumberSummary struct {
// The identifier of the Amazon Connect instance that phone numbers are claimed
// to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance.
//
// [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
InstanceId *string
// The phone number. Phone numbers are formatted [+] [country code] [subscriber
// number including area code] .
PhoneNumber *string
// The Amazon Resource Name (ARN) of the phone number.
PhoneNumberArn *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The description of the phone number.
PhoneNumberDescription *string
// A unique identifier for the phone number.
PhoneNumberId *string
// The status of the phone number.
//
// - CLAIMED means the previous [ClaimPhoneNumber]or [UpdatePhoneNumber]operation succeeded.
//
// - IN_PROGRESS means a [ClaimPhoneNumber], [UpdatePhoneNumber], or [UpdatePhoneNumberMetadata]operation is still in progress and has not yet
// completed. You can call [DescribePhoneNumber]at a later time to verify if the previous operation
// has completed.
//
// - FAILED indicates that the previous [ClaimPhoneNumber]or [UpdatePhoneNumber]operation has failed. It will include
// a message indicating the failure reason. A common reason for a failure may be
// that the TargetArn value you are claiming or updating a phone number to has
// reached its limit of total claimed numbers. If you received a FAILED status
// from a ClaimPhoneNumber API call, you have one day to retry claiming the phone
// number before the number is released back to the inventory for other customers
// to claim.
//
// You will not be billed for the phone number during the 1-day period if number
// claiming fails.
//
// [UpdatePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
// [UpdatePhoneNumberMetadata]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html
// [ClaimPhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html
// [DescribePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
PhoneNumberStatus *PhoneNumberStatus
// The type of phone number.
PhoneNumberType PhoneNumberType
// The claimed phone number ARN that was previously imported from the external
// service, such as Amazon Web Services End User Messaging. If it is from Amazon
// Web Services End User Messaging, it looks like the ARN of the phone number that
// was imported from Amazon Web Services End User Messaging.
SourcePhoneNumberArn *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
// distribution groups that phone number inbound traffic is routed through.
TargetArn *string
// contains filtered or unexported fields
}
Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
type CommonAttributeAndCondition ¶
type CommonAttributeAndCondition struct {
// A leaf node condition which can be used to specify a tag condition.
TagConditions []TagCondition
// contains filtered or unexported fields
}
A list of conditions which would be applied together with an AND condition.
type Comparison ¶
type Comparison string
const ( ComparisonLt Comparison = "LT" )
Enum values for Comparison
func (Comparison) Values ¶
func (Comparison) Values() []Comparison
Values returns all known values for Comparison. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Condition ¶
type Condition struct {
// A leaf node condition which can be used to specify a numeric condition.
NumberCondition *NumberCondition
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name and value .
StringCondition *StringCondition
// contains filtered or unexported fields
}
A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit.
type ConditionalOperationFailedException ¶
type ConditionalOperationFailedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Request processing failed because dependent condition failed.
func (*ConditionalOperationFailedException) Error ¶
func (e *ConditionalOperationFailedException) Error() string
func (*ConditionalOperationFailedException) ErrorCode ¶
func (e *ConditionalOperationFailedException) ErrorCode() string
func (*ConditionalOperationFailedException) ErrorFault ¶
func (e *ConditionalOperationFailedException) ErrorFault() smithy.ErrorFault
func (*ConditionalOperationFailedException) ErrorMessage ¶
func (e *ConditionalOperationFailedException) ErrorMessage() string
type ConflictException ¶
type ConflictException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type ConnectionData ¶
type ConnectionData struct {
// The attendee information, including attendee ID and join token.
Attendee *Attendee
// A meeting created using the Amazon Chime SDK.
Meeting *Meeting
// contains filtered or unexported fields
}
Information required to join the call.
type Contact ¶
type Contact struct {
// List of additional email addresses for an email contact.
AdditionalEmailRecipients *AdditionalEmailRecipients
// Information about the agent who accepted the contact.
AgentInfo *AgentInfo
// Indicates how an [outbound campaign] call is actually disposed if the contact is connected to
// Amazon Connect.
//
// [outbound campaign]: https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html
AnsweringMachineDetectionStatus AnsweringMachineDetectionStatus
// The Amazon Resource Name (ARN) for the contact.
Arn *string
// The attributes of the contact.
Attributes map[string]string
// Information associated with a campaign.
Campaign *Campaign
// How the contact reached your contact center.
Channel Channel
// Information about how agent, bot, and customer interact in a chat contact.
ChatMetrics *ChatMetrics
// The timestamp when customer endpoint connected to Amazon Connect.
ConnectedToSystemTimestamp *time.Time
// This is the root contactId which is used as a unique identifier for all
// subsequent contacts in a contact tree.
ContactAssociationId *string
// A map of string key/value pairs that contain user-defined attributes which are
// lightly typed within the contact. This object is used only for task contacts.
ContactDetails *ContactDetails
// Information about the contact evaluations where the key is the FormId, which is
// a unique identifier for the form.
ContactEvaluations map[string]ContactEvaluation
// Information about the Customer on the contact.
Customer *Customer
// The customer or external third party participant endpoint.
CustomerEndpoint *EndpointInfo
// The customer's identification number. For example, the CustomerId may be a
// customer number from your CRM. You can create a Lambda function to pull the
// unique customer ID of the caller from your CRM system. If you enable Amazon
// Connect Voice ID capability, this attribute is populated with the
// CustomerSpeakerId of the caller.
CustomerId *string
// Information about customer’s voice activity.
CustomerVoiceActivity *CustomerVoiceActivity
// The description of the contact.
Description *string
// Information about the call disconnect experience.
DisconnectDetails *DisconnectDetails
// The disconnect reason for the contact. For a list and description of all the
// possible disconnect reasons by channel, see DisconnectReason under [ContactTraceRecord]in the
// Amazon Connect Administrator Guide.
//
// [ContactTraceRecord]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
DisconnectReason *string
// The date and time that the customer endpoint disconnected from the current
// contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the
// previous contact indicates the date and time when that contact ended.
DisconnectTimestamp *time.Time
// The identifier for the contact.
Id *string
// If this contact is related to other contacts, this is the ID of the initial
// contact.
InitialContactId *string
// Indicates how the contact was initiated.
InitiationMethod ContactInitiationMethod
// The date and time this contact was initiated, in UTC time. For INBOUND , this is
// when the contact arrived. For OUTBOUND , this is when the agent began dialing.
// For CALLBACK , this is when the callback contact was created. For TRANSFER and
// QUEUE_TRANSFER , this is when the transfer was initiated. For API , this is when
// the request arrived. For EXTERNAL_OUTBOUND , this is when the agent started
// dialing the external participant. For MONITOR , this is when the supervisor
// started listening to a contact.
InitiationTimestamp *time.Time
// The timestamp when the contact was last paused.
LastPausedTimestamp *time.Time
// The timestamp when the contact was last resumed.
LastResumedTimestamp *time.Time
// The timestamp when contact was last updated.
LastUpdateTimestamp *time.Time
// The name of the contact.
Name *string
// List of next contact entries for the contact.
NextContacts []NextContactEntry
// Information about the outbound strategy.
OutboundStrategy *OutboundStrategy
// If this contact is not the first contact, this is the ID of the previous
// contact.
PreviousContactId *string
// Information about the quality of the participant's media connection.
QualityMetrics *QualityMetrics
// If this contact was queued, this contains information about the queue.
QueueInfo *QueueInfo
// An integer that represents the queue priority to be applied to the contact
// (lower priorities are routed preferentially). Cannot be specified if the
// QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be
// larger than zero, and a valid integer value. Default Value is 5.
QueuePriority *int64
// An integer that represents the queue time adjust to be applied to the contact,
// in seconds (longer / larger queue time are routed preferentially). Cannot be
// specified if the QueuePriority is specified. Must be statically defined and a
// valid integer value.
QueueTimeAdjustmentSeconds *int32
// If recording was enabled, this is information about the recordings.
Recordings []RecordingInfo
// The contactId that is [related] to this contact.
//
// [related]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid
RelatedContactId *string
// The timestamp when ringing started for a campaign call.
RingStartTimestamp *time.Time
// Latest routing criteria on the contact.
RoutingCriteria *RoutingCriteria
// The timestamp, in Unix epoch time format, at which to start running the inbound
// flow.
ScheduledTimestamp *time.Time
// A set of system defined key-value pairs stored on individual contact segments
// using an attribute map. The attributes are standard Amazon Connect attributes
// and can be accessed in flows. Attribute keys can include only alphanumeric, -,
// and _ characters. This field can be used to show channel subtype. For example,
// connect:Guide or connect:SMS .
SegmentAttributes map[string]SegmentAttributeValue
// The system endpoint. For INBOUND , this is the phone number or email address
// that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND , this is the
// outbound caller ID number assigned to the outbound queue that is used to dial
// the customer. For callback, this shows up as Softphone for calls handled by
// agents with softphone.
SystemEndpoint *EndpointInfo
// Tags associated with the contact. This contains both Amazon Web Services
// generated and user-defined tags.
Tags map[string]string
// If this contact was created using a task template, this contains information
// about the task template.
TaskTemplateInfo *TaskTemplateInfoV2
// Total pause count for a contact.
TotalPauseCount *int32
// Total pause duration for a contact in seconds.
TotalPauseDurationInSeconds *int32
// Information about Amazon Connect Wisdom.
WisdomInfo *WisdomInfo
// contains filtered or unexported fields
}
Contains information about a contact.
type ContactAnalysis ¶
type ContactAnalysis struct {
// Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
Transcript *Transcript
// contains filtered or unexported fields
}
A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
type ContactConfiguration ¶
type ContactConfiguration struct {
// The identifier of the contact within the Amazon Connect instance.
//
// This member is required.
ContactId *string
// Whether to include raw connect message in the push notification payload.
// Default is False .
IncludeRawMessage bool
// The role of the participant in the chat conversation.
//
// Only CUSTOMER is currently supported. Any other values other than CUSTOMER will
// result in an exception (4xx error).
ParticipantRole ParticipantRole
// contains filtered or unexported fields
}
The contact configuration for push notification registration.
type ContactDataRequest ¶
type ContactDataRequest struct {
// List of attributes to be stored in a contact.
Attributes map[string]string
// Structure to store information associated with a campaign.
Campaign *Campaign
// Endpoint of the customer for which contact will be initiated.
CustomerEndpoint *Endpoint
// Information about the outbound strategy.
OutboundStrategy *OutboundStrategy
// The identifier of the queue associated with the Amazon Connect instance in
// which contacts that are created will be queued.
QueueId *string
// Identifier to uniquely identify individual requests in the batch.
RequestIdentifier *string
// Endpoint associated with the Amazon Connect instance from which outbound
// contact will be initiated for the campaign.
SystemEndpoint *Endpoint
// contains filtered or unexported fields
}
Request object with information to create a contact.
type ContactDetails ¶
type ContactDetails struct {
// Teh description of the contact details.
Description *string
// The name of the contact details.
Name *string
// contains filtered or unexported fields
}
A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
type ContactEvaluation ¶
type ContactEvaluation struct {
// The date and time when the evaluation was deleted, in UTC time.
DeleteTimestamp *time.Time
// The date and time when the evaluation was submitted, in UTC time.
EndTimestamp *time.Time
// The Amazon Resource Name for the evaluation form. It is always present.
EvaluationArn *string
// The path where evaluation was exported.
ExportLocation *string
// The FormId of the contact evaluation.
FormId *string
// The date and time when the evaluation was started, in UTC time.
StartTimestamp *time.Time
// The status of the evaluation.
Status Status
// contains filtered or unexported fields
}
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
type ContactFilter ¶
type ContactFilter struct {
// A list of up to 9 [contact states].
//
// [contact states]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
ContactStates []ContactState
// contains filtered or unexported fields
}
Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
type ContactFlow ¶
type ContactFlow struct {
// The Amazon Resource Name (ARN) of the flow.
Arn *string
// The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language].
//
// Length Constraints: Minimum length of 1. Maximum length of 256000.
//
// [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
Content *string
// The description of the flow.
Description *string
// Indicates the checksum value of the flow content.
FlowContentSha256 *string
// The identifier of the flow.
Id *string
// The region in which the flow was last modified
LastModifiedRegion *string
// The time at which the flow was last modified.
LastModifiedTime *time.Time
// The name of the flow.
Name *string
// The type of flow.
State ContactFlowState
// The status of the flow.
Status ContactFlowStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The type of the flow. For descriptions of the available types, see [Choose a flow type] in the
// Amazon Connect Administrator Guide.
//
// [Choose a flow type]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
Type ContactFlowType
// The identifier of the flow version.
Version *int64
// The description of the flow version.
VersionDescription *string
// contains filtered or unexported fields
}
Contains information about a flow.
type ContactFlowAttributeAndCondition ¶
type ContactFlowAttributeAndCondition struct {
// Contact flow type condition.
ContactFlowTypeCondition *ContactFlowTypeCondition
// Tag-based conditions for contact flow filtering.
TagConditions []TagCondition
// contains filtered or unexported fields
}
A list of conditions which would be applied together with an AND condition.
type ContactFlowAttributeFilter ¶
type ContactFlowAttributeFilter struct {
// A list of conditions which would be applied together with a AND condition.
AndCondition *ContactFlowAttributeAndCondition
// Contact flow type condition within attribute filter.
ContactFlowTypeCondition *ContactFlowTypeCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []ContactFlowAttributeAndCondition
// A leaf node condition which can be used to specify a tag condition, for
// example, HAVE BPO = 123 .
TagCondition *TagCondition
// contains filtered or unexported fields
}
Filter for contact flow attributes with multiple condition types.
type ContactFlowModule ¶
type ContactFlowModule struct {
// The Amazon Resource Name (ARN).
Arn *string
// The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language].
//
// [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
Content *string
// The description of the flow module.
Description *string
// The external invocation configuration for the flow module
ExternalInvocationConfiguration *ExternalInvocationConfiguration
// Hash of the module content for integrity verification.
FlowModuleContentSha256 *string
// The identifier of the flow module.
Id *string
// The name of the flow module.
Name *string
// The configuration settings for the flow module.
Settings *string
// The type of flow module.
State ContactFlowModuleState
// The status of the flow module.
Status ContactFlowModuleStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The version of the flow module.
Version *int64
// Description of the version.
VersionDescription *string
// contains filtered or unexported fields
}
Contains information about a flow module.
type ContactFlowModuleAliasInfo ¶
type ContactFlowModuleAliasInfo struct {
// The identifier of the alias.
AliasId *string
// The Amazon Resource Name (ARN) of the flow module.
ContactFlowModuleArn *string
// The identifier of the flow module.
ContactFlowModuleId *string
// The description of the alias.
Description *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the alias.
Name *string
// The version of the flow module.
Version *int64
// contains filtered or unexported fields
}
Contains information about an alias.
type ContactFlowModuleAliasSummary ¶
type ContactFlowModuleAliasSummary struct {
// The description of the alias.
AliasDescription *string
// The identifier of the alias.
AliasId *string
// The name of the alias.
AliasName *string
// The Amazon Resource Name (ARN) of the flow module alias.
Arn *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The version of the flow module.
Version *int64
// contains filtered or unexported fields
}
Contains information about an alias.
type ContactFlowModuleSearchCriteria ¶
type ContactFlowModuleSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []ContactFlowModuleSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []ContactFlowModuleSearchCriteria
// The state of the flow.
StateCondition ContactFlowModuleState
// The status of the flow.
StatusCondition ContactFlowModuleStatus
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return flow modules.
type ContactFlowModuleSearchFilter ¶
type ContactFlowModuleSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
The search criteria to be used to return flow modules.
type ContactFlowModuleState ¶
type ContactFlowModuleState string
const ( ContactFlowModuleStateActive ContactFlowModuleState = "ACTIVE" ContactFlowModuleStateArchived ContactFlowModuleState = "ARCHIVED" )
Enum values for ContactFlowModuleState
func (ContactFlowModuleState) Values ¶
func (ContactFlowModuleState) Values() []ContactFlowModuleState
Values returns all known values for ContactFlowModuleState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactFlowModuleStatus ¶
type ContactFlowModuleStatus string
const ( ContactFlowModuleStatusPublished ContactFlowModuleStatus = "PUBLISHED" ContactFlowModuleStatusSaved ContactFlowModuleStatus = "SAVED" )
Enum values for ContactFlowModuleStatus
func (ContactFlowModuleStatus) Values ¶
func (ContactFlowModuleStatus) Values() []ContactFlowModuleStatus
Values returns all known values for ContactFlowModuleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactFlowModuleSummary ¶
type ContactFlowModuleSummary struct {
// The Amazon Resource Name (ARN) of the flow module.
Arn *string
// The identifier of the flow module.
Id *string
// The name of the flow module.
Name *string
// The type of flow module.
State ContactFlowModuleState
// contains filtered or unexported fields
}
Contains summary information about a flow.
type ContactFlowModuleVersionSummary ¶
type ContactFlowModuleVersionSummary struct {
// The Amazon Resource Name (ARN) of the flow module version.
Arn *string
// The version of the flow module.
Version *int64
// The description of the flow module version.
VersionDescription *string
// contains filtered or unexported fields
}
Contains information about a version.
type ContactFlowNotPublishedException ¶
type ContactFlowNotPublishedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The flow has not been published.
func (*ContactFlowNotPublishedException) Error ¶
func (e *ContactFlowNotPublishedException) Error() string
func (*ContactFlowNotPublishedException) ErrorCode ¶
func (e *ContactFlowNotPublishedException) ErrorCode() string
func (*ContactFlowNotPublishedException) ErrorFault ¶
func (e *ContactFlowNotPublishedException) ErrorFault() smithy.ErrorFault
func (*ContactFlowNotPublishedException) ErrorMessage ¶
func (e *ContactFlowNotPublishedException) ErrorMessage() string
type ContactFlowSearchCriteria ¶
type ContactFlowSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []ContactFlowSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []ContactFlowSearchCriteria
// The state of the flow.
StateCondition ContactFlowState
// The status of the flow.
StatusCondition ContactFlowStatus
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// The type of flow.
TypeCondition ContactFlowType
// contains filtered or unexported fields
}
The search criteria to be used to return flows.
type ContactFlowSearchFilter ¶
type ContactFlowSearchFilter struct {
// Flow attribute filter for contact flow search operations.
FlowAttributeFilter *ContactFlowAttributeFilter
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type ContactFlowState ¶
type ContactFlowState string
const ( ContactFlowStateActive ContactFlowState = "ACTIVE" ContactFlowStateArchived ContactFlowState = "ARCHIVED" )
Enum values for ContactFlowState
func (ContactFlowState) Values ¶
func (ContactFlowState) Values() []ContactFlowState
Values returns all known values for ContactFlowState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactFlowStatus ¶
type ContactFlowStatus string
const ( ContactFlowStatusPublished ContactFlowStatus = "PUBLISHED" ContactFlowStatusSaved ContactFlowStatus = "SAVED" )
Enum values for ContactFlowStatus
func (ContactFlowStatus) Values ¶
func (ContactFlowStatus) Values() []ContactFlowStatus
Values returns all known values for ContactFlowStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactFlowSummary ¶
type ContactFlowSummary struct {
// The Amazon Resource Name (ARN) of the flow.
Arn *string
// The type of flow.
ContactFlowState ContactFlowState
// The status of the flow.
ContactFlowStatus ContactFlowStatus
// The type of flow.
ContactFlowType ContactFlowType
// The identifier of the flow.
Id *string
// The name of the flow.
Name *string
// contains filtered or unexported fields
}
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
type ContactFlowType ¶
type ContactFlowType string
const ( ContactFlowTypeContactFlow ContactFlowType = "CONTACT_FLOW" ContactFlowTypeCustomerQueue ContactFlowType = "CUSTOMER_QUEUE" ContactFlowTypeCustomerHold ContactFlowType = "CUSTOMER_HOLD" ContactFlowTypeCustomerWhisper ContactFlowType = "CUSTOMER_WHISPER" ContactFlowTypeAgentHold ContactFlowType = "AGENT_HOLD" ContactFlowTypeAgentWhisper ContactFlowType = "AGENT_WHISPER" ContactFlowTypeOutboundWhisper ContactFlowType = "OUTBOUND_WHISPER" ContactFlowTypeAgentTransfer ContactFlowType = "AGENT_TRANSFER" ContactFlowTypeQueueTransfer ContactFlowType = "QUEUE_TRANSFER" ContactFlowTypeCampaign ContactFlowType = "CAMPAIGN" )
Enum values for ContactFlowType
func (ContactFlowType) Values ¶
func (ContactFlowType) Values() []ContactFlowType
Values returns all known values for ContactFlowType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactFlowTypeCondition ¶
type ContactFlowTypeCondition struct {
// Contact flow type of the contact flow type condition.
ContactFlowType ContactFlowType
// contains filtered or unexported fields
}
The contact flow type condition.
type ContactFlowVersionSummary ¶
type ContactFlowVersionSummary struct {
// The Amazon Resource Name (ARN) of the view version.
Arn *string
// The identifier of the flow version.
Version *int64
// The description of the flow version.
VersionDescription *string
// contains filtered or unexported fields
}
A summary of a flow version's metadata.
type ContactInitiationMethod ¶
type ContactInitiationMethod string
const ( ContactInitiationMethodInbound ContactInitiationMethod = "INBOUND" ContactInitiationMethodOutbound ContactInitiationMethod = "OUTBOUND" ContactInitiationMethodTransfer ContactInitiationMethod = "TRANSFER" ContactInitiationMethodQueueTransfer ContactInitiationMethod = "QUEUE_TRANSFER" ContactInitiationMethodCallback ContactInitiationMethod = "CALLBACK" ContactInitiationMethodApi ContactInitiationMethod = "API" ContactInitiationMethodDisconnect ContactInitiationMethod = "DISCONNECT" ContactInitiationMethodMonitor ContactInitiationMethod = "MONITOR" ContactInitiationMethodExternalOutbound ContactInitiationMethod = "EXTERNAL_OUTBOUND" ContactInitiationMethodWebrtcApi ContactInitiationMethod = "WEBRTC_API" ContactInitiationMethodAgentReply ContactInitiationMethod = "AGENT_REPLY" ContactInitiationMethodFlow ContactInitiationMethod = "FLOW" )
Enum values for ContactInitiationMethod
func (ContactInitiationMethod) Values ¶
func (ContactInitiationMethod) Values() []ContactInitiationMethod
Values returns all known values for ContactInitiationMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactInteractionType ¶
type ContactInteractionType string
const ( ContactInteractionTypeAgent ContactInteractionType = "AGENT" ContactInteractionTypeAutomated ContactInteractionType = "AUTOMATED" )
Enum values for ContactInteractionType
func (ContactInteractionType) Values ¶
func (ContactInteractionType) Values() []ContactInteractionType
Values returns all known values for ContactInteractionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactMediaProcessingFailureMode ¶
type ContactMediaProcessingFailureMode string
const ( ContactMediaProcessingFailureModeDeliverUnprocessedMessage ContactMediaProcessingFailureMode = "DELIVER_UNPROCESSED_MESSAGE" ContactMediaProcessingFailureModeDoNotDeliverUnprocessedMessage ContactMediaProcessingFailureMode = "DO_NOT_DELIVER_UNPROCESSED_MESSAGE" )
Enum values for ContactMediaProcessingFailureMode
func (ContactMediaProcessingFailureMode) Values ¶
func (ContactMediaProcessingFailureMode) Values() []ContactMediaProcessingFailureMode
Values returns all known values for ContactMediaProcessingFailureMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactMetricInfo ¶
type ContactMetricInfo struct {
// The name of the metric being retrieved in type String.
//
// This member is required.
Name ContactMetricName
// contains filtered or unexported fields
}
The object that contains information about metric being requested.
type ContactMetricName ¶
type ContactMetricName string
const ( ContactMetricNamePositionInQueue ContactMetricName = "POSITION_IN_QUEUE" )
Enum values for ContactMetricName
func (ContactMetricName) Values ¶
func (ContactMetricName) Values() []ContactMetricName
Values returns all known values for ContactMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactMetricResult ¶
type ContactMetricResult struct {
// The name of the metric being retrieved in type String.
//
// This member is required.
Name ContactMetricName
// Object result associated with the metric received.
//
// This member is required.
Value ContactMetricValue
// contains filtered or unexported fields
}
Object containing information about metric requested for the contact.
type ContactMetricValue ¶
type ContactMetricValue interface {
// contains filtered or unexported methods
}
Object which contains the number.
The following types satisfy this interface:
ContactMetricValueMemberNumber
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.ContactMetricValue
// type switches can be used to check the union value
switch v := union.(type) {
case *types.ContactMetricValueMemberNumber:
_ = v.Value // Value is float64
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type ContactMetricValueMemberNumber ¶
type ContactMetricValueMemberNumber struct {
Value float64
// contains filtered or unexported fields
}
The number of type Double. This number is the contact's position in queue.
type ContactNotFoundException ¶
type ContactNotFoundException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The contact with the specified ID does not exist.
func (*ContactNotFoundException) Error ¶
func (e *ContactNotFoundException) Error() string
func (*ContactNotFoundException) ErrorCode ¶
func (e *ContactNotFoundException) ErrorCode() string
func (*ContactNotFoundException) ErrorFault ¶
func (e *ContactNotFoundException) ErrorFault() smithy.ErrorFault
func (*ContactNotFoundException) ErrorMessage ¶
func (e *ContactNotFoundException) ErrorMessage() string
type ContactParticipantRole ¶
type ContactParticipantRole string
const ( ContactParticipantRoleAgent ContactParticipantRole = "AGENT" ContactParticipantRoleSystem ContactParticipantRole = "SYSTEM" ContactParticipantRoleCustomBot ContactParticipantRole = "CUSTOM_BOT" )
Enum values for ContactParticipantRole
func (ContactParticipantRole) Values ¶
func (ContactParticipantRole) Values() []ContactParticipantRole
Values returns all known values for ContactParticipantRole. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactRecordingType ¶
type ContactRecordingType string
const ( ContactRecordingTypeAgent ContactRecordingType = "AGENT" ContactRecordingTypeIvr ContactRecordingType = "IVR" ContactRecordingTypeScreen ContactRecordingType = "SCREEN" )
Enum values for ContactRecordingType
func (ContactRecordingType) Values ¶
func (ContactRecordingType) Values() []ContactRecordingType
Values returns all known values for ContactRecordingType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ContactSearchSummary ¶
type ContactSearchSummary struct {
// Information about the agent who accepted the contact.
AgentInfo *ContactSearchSummaryAgentInfo
// The Amazon Resource Name (ARN) of the contact.
Arn *string
// How the contact reached your contact center.
Channel Channel
// The timestamp when the customer endpoint disconnected from Amazon Connect.
DisconnectTimestamp *time.Time
// The identifier of the contact summary.
Id *string
// If this contact is related to other contacts, this is the ID of the initial
// contact.
InitialContactId *string
// Indicates how the contact was initiated.
InitiationMethod ContactInitiationMethod
// The date and time this contact was initiated, in UTC time. For INBOUND , this is
// when the contact arrived. For OUTBOUND , this is when the agent began dialing.
// For CALLBACK , this is when the callback contact was created. For TRANSFER and
// QUEUE_TRANSFER , this is when the transfer was initiated. For API, this is when
// the request arrived. For EXTERNAL_OUTBOUND , this is when the agent started
// dialing the external participant. For MONITOR , this is when the supervisor
// started listening to a contact.
InitiationTimestamp *time.Time
// Indicates name of the contact.
Name *string
// If this contact is not the first contact, this is the ID of the previous
// contact.
PreviousContactId *string
// If this contact was queued, this contains information about the queue.
QueueInfo *ContactSearchSummaryQueueInfo
// Latest routing criteria on the contact.
RoutingCriteria *RoutingCriteria
// The timestamp, in Unix epoch time format, at which to start running the inbound
// flow.
ScheduledTimestamp *time.Time
// Set of segment attributes for a contact.
SegmentAttributes map[string]ContactSearchSummarySegmentAttributeValue
// contains filtered or unexported fields
}
Information of returned contact.
type ContactSearchSummaryAgentInfo ¶
type ContactSearchSummaryAgentInfo struct {
// The timestamp when the contact was connected to the agent.
ConnectedToAgentTimestamp *time.Time
// The identifier of the agent who accepted the contact.
Id *string
// contains filtered or unexported fields
}
Information about the agent who accepted the contact.
type ContactSearchSummaryQueueInfo ¶
type ContactSearchSummaryQueueInfo struct {
// The timestamp when the contact was added to the queue.
EnqueueTimestamp *time.Time
// The unique identifier for the queue.
Id *string
// contains filtered or unexported fields
}
If this contact was queued, this contains information about the queue.
type ContactSearchSummarySegmentAttributeValue ¶
type ContactSearchSummarySegmentAttributeValue struct {
// The key and value of a segment attribute.
ValueMap map[string]SegmentAttributeValue
// The value of a segment attribute represented as a string.
ValueString *string
// contains filtered or unexported fields
}
The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.
type ContactState ¶
type ContactState string
const ( ContactStateIncoming ContactState = "INCOMING" ContactStatePending ContactState = "PENDING" ContactStateConnecting ContactState = "CONNECTING" ContactStateConnected ContactState = "CONNECTED" ContactStateConnectedOnhold ContactState = "CONNECTED_ONHOLD" ContactStateMissed ContactState = "MISSED" ContactStateError ContactState = "ERROR" ContactStateEnded ContactState = "ENDED" ContactStateRejected ContactState = "REJECTED" )
Enum values for ContactState
func (ContactState) Values ¶
func (ContactState) Values() []ContactState
Values returns all known values for ContactState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ControlPlaneAttributeFilter ¶
type ControlPlaneAttributeFilter struct {
// A list of conditions which would be applied together with an AND condition.
AndCondition *CommonAttributeAndCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []CommonAttributeAndCondition
// A leaf node condition which can be used to specify a tag condition, for
// example, HAVE BPO = 123 .
TagCondition *TagCondition
// contains filtered or unexported fields
}
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
type ControlPlaneTagFilter ¶
type ControlPlaneTagFilter struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []TagCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions [][]TagCondition
// A leaf node condition which can be used to specify a tag condition.
TagCondition *TagCondition
// contains filtered or unexported fields
}
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
type ControlPlaneUserAttributeFilter ¶
type ControlPlaneUserAttributeFilter struct {
// A list of conditions which would be applied together with an AND condition.
AndCondition *AttributeAndCondition
// A leaf node condition which can be used to specify a hierarchy group condition.
HierarchyGroupCondition *HierarchyGroupCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []AttributeAndCondition
// A leaf node condition which can be used to specify a tag condition, for
// example, HAVE BPO = 123 .
TagCondition *TagCondition
// contains filtered or unexported fields
}
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter .
This accepts an OR of AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator
The inner list specifies conditions that need to be applied with AND operator.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed Hierarchy Group conditions is 20.
type CreateCaseActionDefinition ¶
type CreateCaseActionDefinition struct {
// An array of objects with Field ID and Value data.
//
// This member is required.
Fields []FieldValue
// A unique identifier of a template.
//
// This member is required.
TemplateId *string
// contains filtered or unexported fields
}
The CreateCase action definition.
type CreatedByInfo ¶
type CreatedByInfo interface {
// contains filtered or unexported methods
}
Information on the identity that created the file.
The following types satisfy this interface:
CreatedByInfoMemberAWSIdentityArn CreatedByInfoMemberConnectUserArn
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.CreatedByInfo
// type switches can be used to check the union value
switch v := union.(type) {
case *types.CreatedByInfoMemberAWSIdentityArn:
_ = v.Value // Value is string
case *types.CreatedByInfoMemberConnectUserArn:
_ = v.Value // Value is string
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type CreatedByInfoMemberAWSIdentityArn ¶
type CreatedByInfoMemberAWSIdentityArn struct {
Value string
// contains filtered or unexported fields
}
STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
type CreatedByInfoMemberConnectUserArn ¶
type CreatedByInfoMemberConnectUserArn struct {
Value string
// contains filtered or unexported fields
}
An agent ARN representing a connect user.
type Credentials ¶
type Credentials struct {
// An access token generated for a federated user to access Amazon Connect.
AccessToken *string
// A token generated with an expiration time for the session a user is logged in
// to Amazon Connect.
AccessTokenExpiration *time.Time
// Renews a token generated for a user to access the Amazon Connect instance.
RefreshToken *string
// Renews the expiration timer for a generated token.
RefreshTokenExpiration *time.Time
// contains filtered or unexported fields
}
Contains credentials to use for federation.
type CrossChannelBehavior ¶
type CrossChannelBehavior struct {
// Specifies the other channels that can be routed to an agent handling their
// current channel.
//
// This member is required.
BehaviorType BehaviorType
// contains filtered or unexported fields
}
Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.
type CurrentMetric ¶
type CurrentMetric struct {
// The name of the metric.
Name CurrentMetricName
// The unit for the metric.
Unit Unit
// contains filtered or unexported fields
}
Contains information about a real-time metric. For a description of each metric, see Metrics definitionsin the Amazon Connect Administrator Guide.
type CurrentMetricData ¶
type CurrentMetricData struct {
// Information about the metric.
Metric *CurrentMetric
// The value of the metric.
Value *float64
// contains filtered or unexported fields
}
Contains the data for a real-time metric.
type CurrentMetricName ¶
type CurrentMetricName string
const ( CurrentMetricNameAgentsOnline CurrentMetricName = "AGENTS_ONLINE" CurrentMetricNameAgentsAvailable CurrentMetricName = "AGENTS_AVAILABLE" CurrentMetricNameAgentsOnCall CurrentMetricName = "AGENTS_ON_CALL" CurrentMetricNameAgentsNonProductive CurrentMetricName = "AGENTS_NON_PRODUCTIVE" CurrentMetricNameAgentsAfterContactWork CurrentMetricName = "AGENTS_AFTER_CONTACT_WORK" CurrentMetricNameAgentsError CurrentMetricName = "AGENTS_ERROR" CurrentMetricNameAgentsStaffed CurrentMetricName = "AGENTS_STAFFED" CurrentMetricNameContactsInQueue CurrentMetricName = "CONTACTS_IN_QUEUE" CurrentMetricNameOldestContactAge CurrentMetricName = "OLDEST_CONTACT_AGE" CurrentMetricNameContactsScheduled CurrentMetricName = "CONTACTS_SCHEDULED" CurrentMetricNameAgentsOnContact CurrentMetricName = "AGENTS_ON_CONTACT" CurrentMetricNameSlotsActive CurrentMetricName = "SLOTS_ACTIVE" CurrentMetricNameSlotsAvailable CurrentMetricName = "SLOTS_AVAILABLE" )
Enum values for CurrentMetricName
func (CurrentMetricName) Values ¶
func (CurrentMetricName) Values() []CurrentMetricName
Values returns all known values for CurrentMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CurrentMetricResult ¶
type CurrentMetricResult struct {
// The set of metrics.
Collections []CurrentMetricData
// The dimensions for the metrics.
Dimensions *Dimensions
// contains filtered or unexported fields
}
Contains information about a set of real-time metrics.
type CurrentMetricSortCriteria ¶
type CurrentMetricSortCriteria struct {
// The current metric names.
SortByMetric CurrentMetricName
// The way to sort.
SortOrder SortOrder
// contains filtered or unexported fields
}
The way to sort the resulting response based on metrics. By default resources are sorted based on AGENTS_ONLINE , DESCENDING . The metric collection is sorted based on the input metrics.
type Customer ¶
type Customer struct {
// The configuration for the allowed video and screen sharing capabilities for
// participants present over the call. For more information, see [Set up in-app, web, video calling, and screen sharing capabilities]in the Amazon
// Connect Administrator Guide.
//
// [Set up in-app, web, video calling, and screen sharing capabilities]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
Capabilities *ParticipantCapabilities
// Information regarding Customer’s device.
DeviceInfo *DeviceInfo
// contains filtered or unexported fields
}
Information about the Customer on the contact.
type CustomerQualityMetrics ¶
type CustomerQualityMetrics struct {
// Information about the audio quality of the Customer
Audio *AudioQualityMetricsInfo
// contains filtered or unexported fields
}
Information about the quality of the Customer's media connection
type CustomerVoiceActivity ¶
type CustomerVoiceActivity struct {
// Timestamp that measures the end of the customer greeting from an outbound voice
// call.
GreetingEndTimestamp *time.Time
// Timestamp that measures the beginning of the customer greeting from an outbound
// voice call.
GreetingStartTimestamp *time.Time
// contains filtered or unexported fields
}
Information about customer’s voice activity.
type DataTable ¶
type DataTable struct {
// The Amazon Resource Name (ARN) for the data table. Does not include version
// aliases.
//
// This member is required.
Arn *string
// The unique identifier for the data table. Does not include version aliases.
//
// This member is required.
Id *string
// The timestamp when the data table or any of its properties were last modified.
//
// This member is required.
LastModifiedTime *time.Time
// The human-readable name of the data table. Must be unique within the instance
// and conform to Connect naming standards.
//
// This member is required.
Name *string
// The IANA timezone identifier used when resolving time based dynamic values.
// Required even if no time slices are specified.
//
// This member is required.
TimeZone *string
// The timestamp when the data table was created.
CreatedTime *time.Time
// An optional description of the data table's purpose and contents.
Description *string
// The AWS region where the data table was last modified, used for region
// replication.
LastModifiedRegion *string
// The lock version information used for optimistic locking and table versioning.
// Changes with each update to prevent concurrent modification conflicts.
LockVersion *DataTableLockVersion
// The current status of the data table. One of PUBLISHED or SAVED.
Status DataTableStatus
// Key-value pairs for attribute based access control (TBAC or ABAC) and
// organization.
Tags map[string]string
// The data level that concurrent value edits are locked on. One of DATA_TABLE,
// PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are
// handled when multiple users attempt to modify values simultaneously.
ValueLockLevel DataTableLockLevel
// A unique identifier and alias for customer managed versions (not $LATEST or
// $SAVED).
Version *string
// A description of the customer managed version.
VersionDescription *string
// contains filtered or unexported fields
}
Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and values are dynamically set by customers. Customers can reference table values within call flows, applications, views, and workspaces to pinpoint dynamic configuration that changes their contact center's behavior in a predetermined and safe way.
type DataTableAccessControlConfiguration ¶
type DataTableAccessControlConfiguration struct {
// The configuration's primary attribute access control configuration.
PrimaryAttributeAccessControlConfiguration *PrimaryAttributeAccessControlConfigurationItem
// contains filtered or unexported fields
}
A data table access control configuration.
type DataTableAttribute ¶
type DataTableAttribute struct {
// The human-readable name of the attribute. Must be unique within the data table
// and conform to Connect naming standards.
//
// This member is required.
Name *string
// The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST,
// NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and
// processed.
//
// This member is required.
ValueType DataTableAttributeValueType
// The unique identifier for the attribute within the data table.
AttributeId *string
// The Amazon Resource Name (ARN) of the data table that contains this attribute.
DataTableArn *string
// The unique identifier of the data table that contains this attribute.
DataTableId *string
// An optional description explaining the purpose and usage of this attribute.
Description *string
// The AWS region where this attribute was last modified, used for region
// replication.
LastModifiedRegion *string
// The timestamp when this attribute was last modified.
LastModifiedTime *time.Time
// The lock version for this attribute, used for optimistic locking to prevent
// concurrent modification conflicts.
LockVersion *DataTableLockVersion
// Boolean indicating whether this attribute is used as a primary key for record
// identification. Primary attributes must have unique value combinations and
// cannot contain expressions.
Primary bool
// The validation rules applied to values of this attribute. Based on JSON Schema
// Draft 2020-12 with additional Connect-specific validations for data integrity.
Validation *Validation
// The version identifier for this attribute, used for versioning and change
// tracking.
Version *string
// contains filtered or unexported fields
}
Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a primary key for record identification.
type DataTableAttributeValueType ¶
type DataTableAttributeValueType string
const ( DataTableAttributeValueTypeText DataTableAttributeValueType = "TEXT" DataTableAttributeValueTypeNumber DataTableAttributeValueType = "NUMBER" DataTableAttributeValueTypeBoolean DataTableAttributeValueType = "BOOLEAN" DataTableAttributeValueTypeTextList DataTableAttributeValueType = "TEXT_LIST" DataTableAttributeValueTypeNumberList DataTableAttributeValueType = "NUMBER_LIST" )
Enum values for DataTableAttributeValueType
func (DataTableAttributeValueType) Values ¶
func (DataTableAttributeValueType) Values() []DataTableAttributeValueType
Values returns all known values for DataTableAttributeValueType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DataTableDeleteValueIdentifier ¶
type DataTableDeleteValueIdentifier struct {
// The identifier's attribute name.
//
// This member is required.
AttributeName *string
// The identifier's lock version.
//
// This member is required.
LockVersion *DataTableLockVersion
// The identifier's primary values.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A data table delete value identifier.
type DataTableEvaluatedValue ¶
type DataTableEvaluatedValue struct {
// The value's attribute name.
//
// This member is required.
AttributeName *string
// The value's error.
//
// This member is required.
Error bool
// The value's evaluated value.
//
// This member is required.
EvaluatedValue *string
// The value's found.
//
// This member is required.
Found bool
// The value's primary values.
//
// This member is required.
PrimaryValues []PrimaryValue
// The value's record ID.
//
// This member is required.
RecordId *string
// The value's value type.
//
// This member is required.
ValueType DataTableAttributeValueType
// contains filtered or unexported fields
}
A data table evaluated value.
type DataTableLockLevel ¶
type DataTableLockLevel string
const ( DataTableLockLevelNone DataTableLockLevel = "NONE" DataTableLockLevelDataTable DataTableLockLevel = "DATA_TABLE" DataTableLockLevelPrimaryValue DataTableLockLevel = "PRIMARY_VALUE" DataTableLockLevelAttribute DataTableLockLevel = "ATTRIBUTE" DataTableLockLevelValue DataTableLockLevel = "VALUE" )
Enum values for DataTableLockLevel
func (DataTableLockLevel) Values ¶
func (DataTableLockLevel) Values() []DataTableLockLevel
Values returns all known values for DataTableLockLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DataTableLockVersion ¶
type DataTableLockVersion struct {
// The lock version for a specific attribute. When the ValueLockLevel is
// ATTRIBUTE, this version changes when any value for the attribute changes. For
// other lock levels, it only changes when the attribute's properties are directly
// updated.
Attribute *string
// The lock version for the data table itself. Used for optimistic locking and
// table versioning. Changes with each update to the table's metadata or structure.
DataTable *string
// The lock version for a specific set of primary values (record). This includes
// the default record even if the table does not have any primary attributes. Used
// for record-level locking.
PrimaryValues *string
// The lock version for a specific value. Changes each time the individual value
// is modified. Used for the finest-grained locking control.
Value *string
// contains filtered or unexported fields
}
Contains lock version information for different levels of a data table hierarchy. Used for optimistic locking to prevent concurrent modification conflicts. Each component has its own lock version that changes when that component is modified.
type DataTableSearchCriteria ¶
type DataTableSearchCriteria struct {
// The criteria's and conditions.
AndConditions []DataTableSearchCriteria
// The criteria's or conditions.
OrConditions []DataTableSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
A data table search criteria.
type DataTableSearchFilter ¶
type DataTableSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
A data table search filter.
type DataTableStatus ¶
type DataTableStatus string
const ( DataTableStatusPublished DataTableStatus = "PUBLISHED" )
Enum values for DataTableStatus
func (DataTableStatus) Values ¶
func (DataTableStatus) Values() []DataTableStatus
Values returns all known values for DataTableStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DataTableSummary ¶
type DataTableSummary struct {
// The summary's ARN.
Arn *string
// The summary's ID.
Id *string
// The summary's last modified region.
LastModifiedRegion *string
// The summary's last modified time.
LastModifiedTime *time.Time
// The summary's name.
Name *string
// contains filtered or unexported fields
}
A data table summary.
type DataTableValue ¶
type DataTableValue struct {
// The value's attribute name.
//
// This member is required.
AttributeName *string
// The value's value.
//
// This member is required.
Value *string
// The value's last modified region.
LastModifiedRegion *string
// The value's last modified time.
LastModifiedTime *time.Time
// The value's lock version.
LockVersion *DataTableLockVersion
// The value's primary values.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A data table value.
type DataTableValueEvaluationSet ¶
type DataTableValueEvaluationSet struct {
// The set's attribute names.
//
// This member is required.
AttributeNames []string
// The set's primary values.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A data table value evaluation set.
type DataTableValueIdentifier ¶
type DataTableValueIdentifier struct {
// The identifier's attribute name.
//
// This member is required.
AttributeName *string
// The identifier's primary values.
PrimaryValues []PrimaryValue
// contains filtered or unexported fields
}
A data table value identifier.
type DataTableValueSummary ¶
type DataTableValueSummary struct {
// The summary's attribute name.
//
// This member is required.
AttributeName *string
// The summary's primary values.
//
// This member is required.
PrimaryValues []PrimaryValueResponse
// The summary's value.
//
// This member is required.
Value *string
// The summary's value type.
//
// This member is required.
ValueType DataTableAttributeValueType
// The summary's attribute ID.
AttributeId *string
// The summary's last modified region.
LastModifiedRegion *string
// The summary's last modified time.
LastModifiedTime *time.Time
// The summary's lock version.
LockVersion *DataTableLockVersion
// The summary's record ID.
RecordId *string
// contains filtered or unexported fields
}
A data table value summary.
type DateComparisonType ¶
type DateComparisonType string
const ( DateComparisonTypeGreaterThan DateComparisonType = "GREATER_THAN" DateComparisonTypeLessThan DateComparisonType = "LESS_THAN" DateComparisonTypeGreaterThanOrEqualTo DateComparisonType = "GREATER_THAN_OR_EQUAL_TO" DateComparisonTypeLessThanOrEqualTo DateComparisonType = "LESS_THAN_OR_EQUAL_TO" DateComparisonTypeEqualTo DateComparisonType = "EQUAL_TO" )
Enum values for DateComparisonType
func (DateComparisonType) Values ¶
func (DateComparisonType) Values() []DateComparisonType
Values returns all known values for DateComparisonType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DateCondition ¶
type DateCondition struct {
// An object to specify the hours of operation override date condition
// comparisonType .
ComparisonType DateComparisonType
// An object to specify the hours of operation override date field.
FieldName *string
// An object to specify the hours of operation override date value.
Value *string
// contains filtered or unexported fields
}
An object to specify the hours of operation override date condition.
type DateReference ¶
type DateReference struct {
// Identifier of the date reference.
Name *string
// A valid date.
Value *string
// contains filtered or unexported fields
}
Information about a reference when the referenceType is DATE . Otherwise, null.
type DateTimeComparisonType ¶
type DateTimeComparisonType string
const ( DateTimeComparisonTypeGreaterThan DateTimeComparisonType = "GREATER_THAN" DateTimeComparisonTypeLessThan DateTimeComparisonType = "LESS_THAN" DateTimeComparisonTypeGreaterThanOrEqualTo DateTimeComparisonType = "GREATER_THAN_OR_EQUAL_TO" DateTimeComparisonTypeLessThanOrEqualTo DateTimeComparisonType = "LESS_THAN_OR_EQUAL_TO" DateTimeComparisonTypeEqualTo DateTimeComparisonType = "EQUAL_TO" DateTimeComparisonTypeRange DateTimeComparisonType = "RANGE" )
Enum values for DateTimeComparisonType
func (DateTimeComparisonType) Values ¶
func (DateTimeComparisonType) Values() []DateTimeComparisonType
Values returns all known values for DateTimeComparisonType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DateTimeCondition ¶
type DateTimeCondition struct {
// Datetime property comparison type.
ComparisonType DateTimeComparisonType
// A name of the datetime property to be searched
FieldName *string
// A maximum value of the property.
MaxValue *string
// A minimum value of the property.
MinValue *string
// contains filtered or unexported fields
}
A datetime search condition for Search APIs.
type DecimalComparisonType ¶
type DecimalComparisonType string
const ( DecimalComparisonTypeGreaterOrEqual DecimalComparisonType = "GREATER_OR_EQUAL" DecimalComparisonTypeGreater DecimalComparisonType = "GREATER" DecimalComparisonTypeLesserOrEqual DecimalComparisonType = "LESSER_OR_EQUAL" DecimalComparisonTypeLesser DecimalComparisonType = "LESSER" DecimalComparisonTypeEqual DecimalComparisonType = "EQUAL" DecimalComparisonTypeNotEqual DecimalComparisonType = "NOT_EQUAL" DecimalComparisonTypeRange DecimalComparisonType = "RANGE" )
Enum values for DecimalComparisonType
func (DecimalComparisonType) Values ¶
func (DecimalComparisonType) Values() []DecimalComparisonType
Values returns all known values for DecimalComparisonType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DecimalCondition ¶
type DecimalCondition struct {
// The type of comparison to be made when evaluating the decimal condition.
ComparisonType DecimalComparisonType
// A name of the decimal property to be searched.
FieldName *string
// A maximum value of the decimal property.
MaxValue *float64
// A minimum value of the decimal property.
MinValue *float64
// contains filtered or unexported fields
}
A decimal search condition for Search APIs.
type DefaultVocabulary ¶
type DefaultVocabulary struct {
// The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource
// Name (ARN) of the instance.
//
// [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
//
// This member is required.
InstanceId *string
// The language code of the vocabulary entries. For a list of languages and their
// corresponding language codes, see [What is Amazon Transcribe?]
//
// [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html
//
// This member is required.
LanguageCode VocabularyLanguageCode
// The identifier of the custom vocabulary.
//
// This member is required.
VocabularyId *string
// A unique name of the custom vocabulary.
//
// This member is required.
VocabularyName *string
// contains filtered or unexported fields
}
Contains information about a default vocabulary.
type DestinationNotAllowedException ¶
type DestinationNotAllowedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Outbound calls to the destination number are not allowed.
func (*DestinationNotAllowedException) Error ¶
func (e *DestinationNotAllowedException) Error() string
func (*DestinationNotAllowedException) ErrorCode ¶
func (e *DestinationNotAllowedException) ErrorCode() string
func (*DestinationNotAllowedException) ErrorFault ¶
func (e *DestinationNotAllowedException) ErrorFault() smithy.ErrorFault
func (*DestinationNotAllowedException) ErrorMessage ¶
func (e *DestinationNotAllowedException) ErrorMessage() string
type DeviceInfo ¶
type DeviceInfo struct {
// Operating system that the participant used for the call.
OperatingSystem *string
// Name of the platform that the participant used for the call.
PlatformName *string
// Version of the platform that the participant used for the call.
PlatformVersion *string
// contains filtered or unexported fields
}
Information regarding the device.
type DeviceType ¶
type DeviceType string
const ( DeviceTypeGcm DeviceType = "GCM" DeviceTypeApns DeviceType = "APNS" DeviceTypeApnsSandbox DeviceType = "APNS_SANDBOX" )
Enum values for DeviceType
func (DeviceType) Values ¶
func (DeviceType) Values() []DeviceType
Values returns all known values for DeviceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Dimensions ¶
type Dimensions struct {
// Information about the agent status assigned to the user.
AgentStatus *AgentStatusIdentifier
// The channel used for grouping and filters.
Channel Channel
// Information about the queue for which metrics are returned.
Queue *QueueReference
// Information about the routing profile assigned to the user.
RoutingProfile *RoutingProfileReference
// The expression of a step in a routing criteria.
RoutingStepExpression *string
// contains filtered or unexported fields
}
Contains information about the dimensions for a set of metrics.
type DirectoryType ¶
type DirectoryType string
const ( DirectoryTypeSaml DirectoryType = "SAML" DirectoryTypeConnectManaged DirectoryType = "CONNECT_MANAGED" DirectoryTypeExistingDirectory DirectoryType = "EXISTING_DIRECTORY" )
Enum values for DirectoryType
func (DirectoryType) Values ¶
func (DirectoryType) Values() []DirectoryType
Values returns all known values for DirectoryType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DisconnectDetails ¶
type DisconnectDetails struct {
// Indicates the potential disconnection issues for a call. This field is not
// populated if the service does not detect potential issues.
PotentialDisconnectIssue *string
// contains filtered or unexported fields
}
Information about the call disconnect experience.
type DisconnectReason ¶
type DisconnectReason struct {
// A code that indicates how the contact was terminated.
Code *string
// contains filtered or unexported fields
}
Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
type Distribution ¶
type Distribution struct {
// The percentage of the traffic that is distributed, in increments of 10.
//
// This member is required.
Percentage int32
// The Amazon Web Services Region where the traffic is distributed.
//
// This member is required.
Region *string
// contains filtered or unexported fields
}
Information about a traffic distribution.
type DownloadUrlMetadata ¶
type DownloadUrlMetadata struct {
// A pre-signed URL that should be used to download the attached file.
Url *string
// The expiration time of the URL in ISO timestamp. It's specified in ISO 8601
// format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
UrlExpiry *string
// contains filtered or unexported fields
}
Metadata used to download the attached file.
type DuplicateResourceException ¶
type DuplicateResourceException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A resource with the specified name already exists.
func (*DuplicateResourceException) Error ¶
func (e *DuplicateResourceException) Error() string
func (*DuplicateResourceException) ErrorCode ¶
func (e *DuplicateResourceException) ErrorCode() string
func (*DuplicateResourceException) ErrorFault ¶
func (e *DuplicateResourceException) ErrorFault() smithy.ErrorFault
func (*DuplicateResourceException) ErrorMessage ¶
func (e *DuplicateResourceException) ErrorMessage() string
type EffectiveHoursOfOperations ¶
type EffectiveHoursOfOperations struct {
// The date that the hours of operation or overrides applies to.
Date *string
// Information about the hours of operations with the effective override applied.
OperationalHours []OperationalHour
// contains filtered or unexported fields
}
Information about the hours of operations with the effective override applied.
type EmailAddressInfo ¶
type EmailAddressInfo struct {
// The email address, including the domain.
//
// This member is required.
EmailAddress *string
// The display name of email address.
DisplayName *string
// contains filtered or unexported fields
}
Contains information about a source or destination email address.
type EmailAddressMetadata ¶
type EmailAddressMetadata struct {
// A list of alias configurations for this email address, showing which email
// addresses forward to this primary address. Each configuration contains the email
// address ID of an alias that forwards emails to this address.
AliasConfigurations []AliasConfiguration
// The description of the email address.
Description *string
// The display name of email address.
DisplayName *string
// The email address, including the domain.
EmailAddress *string
// The Amazon Resource Name (ARN) of the email address.
EmailAddressArn *string
// The identifier of the email address.
EmailAddressId *string
// contains filtered or unexported fields
}
Contains information about an email address for a contact center.
type EmailAddressSearchCriteria ¶
type EmailAddressSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []EmailAddressSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []EmailAddressSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return email addresses.
type EmailAddressSearchFilter ¶
type EmailAddressSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type EmailAttachment ¶
type EmailAttachment struct {
// A case-sensitive name of the attached file being uploaded.
//
// This member is required.
FileName *string
// The pre-signed URLs for the S3 bucket where the email attachment is stored.
//
// This member is required.
S3Url *string
// contains filtered or unexported fields
}
Information about the email attachment files.
type EmailHeaderType ¶
type EmailHeaderType string
const ( EmailHeaderTypeReferences EmailHeaderType = "REFERENCES" EmailHeaderTypeMessageId EmailHeaderType = "MESSAGE_ID" EmailHeaderTypeInReplyTo EmailHeaderType = "IN_REPLY_TO" EmailHeaderTypeXSesSpamVerdict EmailHeaderType = "X_SES_SPAM_VERDICT" EmailHeaderTypeXSesVirusVerdict EmailHeaderType = "X_SES_VIRUS_VERDICT" )
Enum values for EmailHeaderType
func (EmailHeaderType) Values ¶
func (EmailHeaderType) Values() []EmailHeaderType
Values returns all known values for EmailHeaderType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EmailMessageReference ¶
type EmailMessageReference struct {
// The Amazon Resource Name (ARN) of the email message reference
Arn *string
// The name of the email message reference
Name *string
// contains filtered or unexported fields
}
Information about the reference when the referenceType is EMAIL_MESSAGE . Otherwise, null.
type EmailRecipient ¶
type EmailRecipient struct {
// Address of the email recipient.
Address *string
// Display name of the email recipient.
DisplayName *string
// contains filtered or unexported fields
}
Information about the email recipient
type EmailReference ¶
type EmailReference struct {
// Identifier of the email reference.
Name *string
// A valid email address.
Value *string
// contains filtered or unexported fields
}
Information about a reference when the referenceType is EMAIL . Otherwise, null.
type EmptyFieldValue ¶
type EmptyFieldValue struct {
// contains filtered or unexported fields
}
An empty value.
type EncryptionConfig ¶
type EncryptionConfig struct {
// The type of encryption.
//
// This member is required.
EncryptionType EncryptionType
// The full ARN of the encryption key.
//
// Be sure to provide the full ARN of the encryption key, not just the ID.
//
// Amazon Connect supports only KMS keys with the default key spec of [SYMMETRIC_DEFAULT]
// SYMMETRIC_DEFAULT .
//
// [SYMMETRIC_DEFAULT]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default
//
// This member is required.
KeyId *string
// contains filtered or unexported fields
}
The encryption configuration.
type EncryptionType ¶
type EncryptionType string
const ( EncryptionTypeKms EncryptionType = "KMS" )
Enum values for EncryptionType
func (EncryptionType) Values ¶
func (EncryptionType) Values() []EncryptionType
Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EndAssociatedTasksActionDefinition ¶
type EndAssociatedTasksActionDefinition struct {
// contains filtered or unexported fields
}
End associated tasks related to a case.
type Endpoint ¶
type Endpoint struct {
// Address of the endpoint.
Address *string
// Type of the endpoint.
Type EndpointType
// contains filtered or unexported fields
}
Information about the endpoint.
type EndpointInfo ¶
type EndpointInfo struct {
// Address of the endpoint.
Address *string
// Display name of the endpoint.
DisplayName *string
// Type of endpoint.
Type EndpointType
// contains filtered or unexported fields
}
Information about the endpoint.
type EndpointType ¶
type EndpointType string
const ( EndpointTypeTelephoneNumber EndpointType = "TELEPHONE_NUMBER" EndpointTypeVoip EndpointType = "VOIP" EndpointTypeContactFlow EndpointType = "CONTACT_FLOW" EndpointTypeConnectPhonenumberArn EndpointType = "CONNECT_PHONENUMBER_ARN" EndpointTypeEmailAddress EndpointType = "EMAIL_ADDRESS" )
Enum values for EndpointType
func (EndpointType) Values ¶
func (EndpointType) Values() []EndpointType
Values returns all known values for EndpointType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EntityType ¶
type EntityType string
const ( EntityTypeUser EntityType = "USER" EntityTypeAiAgent EntityType = "AI_AGENT" )
Enum values for EntityType
func (EntityType) Values ¶
func (EntityType) Values() []EntityType
Values returns all known values for EntityType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ErrorResult ¶
type ErrorResult struct {
// The error code.
ErrorCode *string
// The corresponding error message for the error code.
ErrorMessage *string
// contains filtered or unexported fields
}
This API is in preview release for Amazon Connect and is subject to change.
List of errors for dataset association failures.
type Evaluation ¶
type Evaluation struct {
// A map of question identifiers to answer value.
//
// This member is required.
Answers map[string]EvaluationAnswerOutput
// The timestamp for when the evaluation was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the contact evaluation resource.
//
// This member is required.
EvaluationArn *string
// A unique identifier for the contact evaluation.
//
// This member is required.
EvaluationId *string
// The timestamp for when the evaluation was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// Metadata about the contact evaluation.
//
// This member is required.
Metadata *EvaluationMetadata
// A map of question identifiers to note value.
//
// This member is required.
Notes map[string]EvaluationNote
// The status of the contact evaluation.
//
// This member is required.
Status EvaluationStatus
// Type of the evaluation.
EvaluationType EvaluationType
// A map of item (section or question) identifiers to score value.
Scores map[string]EvaluationScore
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Information about a contact evaluation.
type EvaluationAcknowledgement ¶
type EvaluationAcknowledgement struct {
// The agent who acknowledged the evaluation.
//
// This member is required.
AcknowledgedBy *string
// When the agent acknowledged the evaluation.
//
// This member is required.
AcknowledgedTime *time.Time
// A comment from the agent when they confirmed they acknowledged the evaluation.
AcknowledgerComment *string
// contains filtered or unexported fields
}
Information about the evaluation acknowledgement.
type EvaluationAcknowledgementSummary ¶
type EvaluationAcknowledgementSummary struct {
// The agent who acknowledged the evaluation.
AcknowledgedBy *string
// The time when an agent acknowledged the evaluation.
AcknowledgedTime *time.Time
// A comment from the agent when they confirmed they acknowledged the evaluation.
AcknowledgerComment *string
// contains filtered or unexported fields
}
Summary information about an evaluation acknowledgement.
type EvaluationAnswerData ¶
type EvaluationAnswerData interface {
// contains filtered or unexported methods
}
Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
The following types satisfy this interface:
EvaluationAnswerDataMemberDateTimeValue EvaluationAnswerDataMemberNotApplicable EvaluationAnswerDataMemberNumericValue EvaluationAnswerDataMemberStringValue EvaluationAnswerDataMemberStringValues
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationAnswerData
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationAnswerDataMemberDateTimeValue:
_ = v.Value // Value is string
case *types.EvaluationAnswerDataMemberNotApplicable:
_ = v.Value // Value is bool
case *types.EvaluationAnswerDataMemberNumericValue:
_ = v.Value // Value is float64
case *types.EvaluationAnswerDataMemberStringValue:
_ = v.Value // Value is string
case *types.EvaluationAnswerDataMemberStringValues:
_ = v.Value // Value is []string
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationAnswerDataMemberDateTimeValue ¶
type EvaluationAnswerDataMemberDateTimeValue struct {
Value string
// contains filtered or unexported fields
}
Date and time value provided as an answer to an evaluation question.
type EvaluationAnswerDataMemberNotApplicable ¶
type EvaluationAnswerDataMemberNotApplicable struct {
Value bool
// contains filtered or unexported fields
}
The flag to mark the question as not applicable.
type EvaluationAnswerDataMemberNumericValue ¶
type EvaluationAnswerDataMemberNumericValue struct {
Value float64
// contains filtered or unexported fields
}
The numeric value for an answer in a contact evaluation.
type EvaluationAnswerDataMemberStringValue ¶
type EvaluationAnswerDataMemberStringValue struct {
Value string
// contains filtered or unexported fields
}
The string value for an answer in a contact evaluation.
type EvaluationAnswerDataMemberStringValues ¶
type EvaluationAnswerDataMemberStringValues struct {
Value []string
// contains filtered or unexported fields
}
String values provided as answers to evaluation questions.
type EvaluationAnswerInput ¶
type EvaluationAnswerInput struct {
// The value for an answer in a contact evaluation.
Value EvaluationAnswerData
// contains filtered or unexported fields
}
Information about input answers for a contact evaluation.
type EvaluationAnswerOutput ¶
type EvaluationAnswerOutput struct {
// Automation suggested answers for the questions.
SuggestedAnswers []EvaluationSuggestedAnswer
// The system suggested value for an answer in a contact evaluation.
SystemSuggestedValue EvaluationAnswerData
// The value for an answer in a contact evaluation.
Value EvaluationAnswerData
// contains filtered or unexported fields
}
Information about output answers for a contact evaluation.
type EvaluationAutomationRuleCategory ¶
type EvaluationAutomationRuleCategory struct {
// A category label.
//
// This member is required.
Category *string
// An automation condition for a Contact Lens category.
//
// This member is required.
Condition QuestionRuleCategoryAutomationCondition
// A point of interest in a contact transcript that indicates match of condition.
PointsOfInterest []EvaluationTranscriptPointOfInterest
// contains filtered or unexported fields
}
The Contact Lens category used by evaluation automation.
type EvaluationContactLensAnswerAnalysisDetails ¶
type EvaluationContactLensAnswerAnalysisDetails struct {
// A list of match rule categories.
MatchedRuleCategories []EvaluationAutomationRuleCategory
// contains filtered or unexported fields
}
Analysis details providing explanation for Contact Lens automation decision.
type EvaluationContactParticipant ¶
type EvaluationContactParticipant struct {
// The identifier for the contact participant.
ContactParticipantId *string
// The role of the contact participant.
ContactParticipantRole ContactParticipantRole
// contains filtered or unexported fields
}
Information about a contact participant in the evaluation.
type EvaluationForm ¶
type EvaluationForm struct {
// The Amazon Resource Name (ARN) of the user who created the evaluation form.
//
// This member is required.
CreatedBy *string
// The timestamp for when the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion int32
// Items that are part of the evaluation form. The total number of sections and
// questions must not exceed 100 each. Questions must be contained in a section.
//
// This member is required.
Items []EvaluationFormItem
// The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
//
// This member is required.
LastModifiedBy *string
// The timestamp for when the evaluation form was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The flag indicating whether the evaluation form is locked for changes.
//
// This member is required.
Locked bool
// The status of the evaluation form.
//
// This member is required.
Status EvaluationFormVersionStatus
// A title of the evaluation form.
//
// This member is required.
Title *string
// The automatic evaluation configuration of an evaluation form.
AutoEvaluationConfiguration *EvaluationFormAutoEvaluationConfiguration
// The description of the evaluation form.
Description *string
// Configuration for language settings of this evaluation form.
LanguageConfiguration *EvaluationFormLanguageConfiguration
// A scoring strategy of the evaluation form.
ScoringStrategy *EvaluationFormScoringStrategy
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// Configuration that specifies the target for this evaluation form.
TargetConfiguration *EvaluationFormTargetConfiguration
// contains filtered or unexported fields
}
Information about the evaluation form.
type EvaluationFormAutoEvaluationConfiguration ¶
type EvaluationFormAutoEvaluationConfiguration struct {
// When automated evaluation is enabled.
//
// This member is required.
Enabled bool
// contains filtered or unexported fields
}
The automatic evaluation configuration of an evaluation form.
type EvaluationFormContent ¶
type EvaluationFormContent struct {
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion int32
// Items that are part of the evaluation form. The total number of sections and
// questions must not exceed 100 each. Questions must be contained in a section.
//
// This member is required.
Items []EvaluationFormItem
// A title of the evaluation form.
//
// This member is required.
Title *string
// The configuration of the automated evaluation.
AutoEvaluationConfiguration *EvaluationFormAutoEvaluationConfiguration
// The description of the evaluation form.
Description *string
// Configuration for language settings of this evaluation form content.
LanguageConfiguration *EvaluationFormLanguageConfiguration
// A scoring strategy of the evaluation form.
ScoringStrategy *EvaluationFormScoringStrategy
// Configuration that specifies the target for this evaluation form content.
TargetConfiguration *EvaluationFormTargetConfiguration
// contains filtered or unexported fields
}
Information about an evaluation form used in a contact evaluation.
type EvaluationFormItem ¶
type EvaluationFormItem interface {
// contains filtered or unexported methods
}
Information about an item from an evaluation form. The item must be either a section or a question.
The following types satisfy this interface:
EvaluationFormItemMemberQuestion EvaluationFormItemMemberSection
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationFormItem
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationFormItemMemberQuestion:
_ = v.Value // Value is types.EvaluationFormQuestion
case *types.EvaluationFormItemMemberSection:
_ = v.Value // Value is types.EvaluationFormSection
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationFormItemEnablementAction ¶
type EvaluationFormItemEnablementAction string
const ( EvaluationFormItemEnablementActionDisable EvaluationFormItemEnablementAction = "DISABLE" EvaluationFormItemEnablementActionEnable EvaluationFormItemEnablementAction = "ENABLE" )
Enum values for EvaluationFormItemEnablementAction
func (EvaluationFormItemEnablementAction) Values ¶
func (EvaluationFormItemEnablementAction) Values() []EvaluationFormItemEnablementAction
Values returns all known values for EvaluationFormItemEnablementAction. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormItemEnablementCondition ¶
type EvaluationFormItemEnablementCondition struct {
// Operands of the enablement condition.
//
// This member is required.
Operands []EvaluationFormItemEnablementConditionOperand
// The operator to be used to be applied to operands if more than one provided.
Operator EvaluationFormItemEnablementOperator
// contains filtered or unexported fields
}
A condition for item enablement.
type EvaluationFormItemEnablementConditionOperand ¶
type EvaluationFormItemEnablementConditionOperand interface {
// contains filtered or unexported methods
}
An operand of the enablement condition.
The following types satisfy this interface:
EvaluationFormItemEnablementConditionOperandMemberCondition EvaluationFormItemEnablementConditionOperandMemberExpression
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationFormItemEnablementConditionOperand
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationFormItemEnablementConditionOperandMemberCondition:
_ = v.Value // Value is types.EvaluationFormItemEnablementCondition
case *types.EvaluationFormItemEnablementConditionOperandMemberExpression:
_ = v.Value // Value is types.EvaluationFormItemEnablementExpression
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationFormItemEnablementConditionOperandMemberCondition ¶
type EvaluationFormItemEnablementConditionOperandMemberCondition struct {
Value EvaluationFormItemEnablementCondition
// contains filtered or unexported fields
}
A condition for item enablement.
type EvaluationFormItemEnablementConditionOperandMemberExpression ¶
type EvaluationFormItemEnablementConditionOperandMemberExpression struct {
Value EvaluationFormItemEnablementExpression
// contains filtered or unexported fields
}
An expression of the enablement condition.
type EvaluationFormItemEnablementConfiguration ¶
type EvaluationFormItemEnablementConfiguration struct {
// An enablement action that if condition is satisfied.
//
// This member is required.
Action EvaluationFormItemEnablementAction
// A condition for item enablement configuration.
//
// This member is required.
Condition *EvaluationFormItemEnablementCondition
// An enablement action that if condition is not satisfied.
DefaultAction EvaluationFormItemEnablementAction
// contains filtered or unexported fields
}
An item enablement configuration.
type EvaluationFormItemEnablementExpression ¶
type EvaluationFormItemEnablementExpression struct {
// A comparator to be used against list of values.
//
// This member is required.
Comparator EvaluationFormItemSourceValuesComparator
// A source item of enablement expression.
//
// This member is required.
Source *EvaluationFormItemEnablementSource
// A list of values from source item.
//
// This member is required.
Values []EvaluationFormItemEnablementSourceValue
// contains filtered or unexported fields
}
An expression that defines a basic building block of conditional enablement.
type EvaluationFormItemEnablementOperator ¶
type EvaluationFormItemEnablementOperator string
const ( EvaluationFormItemEnablementOperatorOr EvaluationFormItemEnablementOperator = "OR" EvaluationFormItemEnablementOperatorAnd EvaluationFormItemEnablementOperator = "AND" )
Enum values for EvaluationFormItemEnablementOperator
func (EvaluationFormItemEnablementOperator) Values ¶
func (EvaluationFormItemEnablementOperator) Values() []EvaluationFormItemEnablementOperator
Values returns all known values for EvaluationFormItemEnablementOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormItemEnablementSource ¶
type EvaluationFormItemEnablementSource struct {
// A type of source item.
//
// This member is required.
Type EvaluationFormItemEnablementSourceType
// A referenceId of the source item.
RefId *string
// contains filtered or unexported fields
}
An enablement expression source item.
type EvaluationFormItemEnablementSourceType ¶
type EvaluationFormItemEnablementSourceType string
const ( EvaluationFormItemEnablementSourceTypeQuestionRefId EvaluationFormItemEnablementSourceType = "QUESTION_REF_ID" )
Enum values for EvaluationFormItemEnablementSourceType
func (EvaluationFormItemEnablementSourceType) Values ¶
func (EvaluationFormItemEnablementSourceType) Values() []EvaluationFormItemEnablementSourceType
Values returns all known values for EvaluationFormItemEnablementSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormItemEnablementSourceValue ¶
type EvaluationFormItemEnablementSourceValue struct {
// A type of source item value.
//
// This member is required.
Type EvaluationFormItemEnablementSourceValueType
// A referenceId of the source value.
RefId *string
// contains filtered or unexported fields
}
An enablement expression source value.
type EvaluationFormItemEnablementSourceValueType ¶
type EvaluationFormItemEnablementSourceValueType string
const ( EvaluationFormItemEnablementSourceValueTypeOptionRefId EvaluationFormItemEnablementSourceValueType = "OPTION_REF_ID" )
Enum values for EvaluationFormItemEnablementSourceValueType
func (EvaluationFormItemEnablementSourceValueType) Values ¶
func (EvaluationFormItemEnablementSourceValueType) Values() []EvaluationFormItemEnablementSourceValueType
Values returns all known values for EvaluationFormItemEnablementSourceValueType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormItemMemberQuestion ¶
type EvaluationFormItemMemberQuestion struct {
Value EvaluationFormQuestion
// contains filtered or unexported fields
}
The information of the question.
type EvaluationFormItemMemberSection ¶
type EvaluationFormItemMemberSection struct {
Value EvaluationFormSection
// contains filtered or unexported fields
}
The information of the section.
type EvaluationFormItemSourceValuesComparator ¶
type EvaluationFormItemSourceValuesComparator string
const ( EvaluationFormItemSourceValuesComparatorIn EvaluationFormItemSourceValuesComparator = "IN" EvaluationFormItemSourceValuesComparatorNotIn EvaluationFormItemSourceValuesComparator = "NOT_IN" EvaluationFormItemSourceValuesComparatorAllIn EvaluationFormItemSourceValuesComparator = "ALL_IN" EvaluationFormItemSourceValuesComparatorExact EvaluationFormItemSourceValuesComparator = "EXACT" )
Enum values for EvaluationFormItemSourceValuesComparator
func (EvaluationFormItemSourceValuesComparator) Values ¶
Values returns all known values for EvaluationFormItemSourceValuesComparator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormLanguageCode ¶
type EvaluationFormLanguageCode string
const ( EvaluationFormLanguageCodeDeDe EvaluationFormLanguageCode = "de-DE" EvaluationFormLanguageCodeEnUs EvaluationFormLanguageCode = "en-US" EvaluationFormLanguageCodeEsEs EvaluationFormLanguageCode = "es-ES" EvaluationFormLanguageCodeFrFr EvaluationFormLanguageCode = "fr-FR" EvaluationFormLanguageCodeItIt EvaluationFormLanguageCode = "it-IT" EvaluationFormLanguageCodePtBr EvaluationFormLanguageCode = "pt-BR" )
Enum values for EvaluationFormLanguageCode
func (EvaluationFormLanguageCode) Values ¶
func (EvaluationFormLanguageCode) Values() []EvaluationFormLanguageCode
Values returns all known values for EvaluationFormLanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormLanguageConfiguration ¶
type EvaluationFormLanguageConfiguration struct {
// The language for the evaluation form.
FormLanguage EvaluationFormLanguageCode
// contains filtered or unexported fields
}
Language configuration for an evaluation form.
type EvaluationFormMultiSelectQuestionAutomation ¶
type EvaluationFormMultiSelectQuestionAutomation struct {
// A question automation answer.
AnswerSource *EvaluationFormQuestionAutomationAnswerSource
// Reference IDs of default options.
DefaultOptionRefIds []string
// Automation options for the multi-select question.
Options []EvaluationFormMultiSelectQuestionAutomationOption
// contains filtered or unexported fields
}
Automation configuration for multi-select questions.
type EvaluationFormMultiSelectQuestionAutomationOption ¶
type EvaluationFormMultiSelectQuestionAutomationOption interface {
// contains filtered or unexported methods
}
An automation option for a multi-select question.
The following types satisfy this interface:
EvaluationFormMultiSelectQuestionAutomationOptionMemberRuleCategory
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationFormMultiSelectQuestionAutomationOption
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationFormMultiSelectQuestionAutomationOptionMemberRuleCategory:
_ = v.Value // Value is types.MultiSelectQuestionRuleCategoryAutomation
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationFormMultiSelectQuestionAutomationOptionMemberRuleCategory ¶
type EvaluationFormMultiSelectQuestionAutomationOptionMemberRuleCategory struct {
Value MultiSelectQuestionRuleCategoryAutomation
// contains filtered or unexported fields
}
Rule category configuration for this automation option.
type EvaluationFormMultiSelectQuestionDisplayMode ¶
type EvaluationFormMultiSelectQuestionDisplayMode string
const ( EvaluationFormMultiSelectQuestionDisplayModeDropdown EvaluationFormMultiSelectQuestionDisplayMode = "DROPDOWN" EvaluationFormMultiSelectQuestionDisplayModeCheckbox EvaluationFormMultiSelectQuestionDisplayMode = "CHECKBOX" )
Enum values for EvaluationFormMultiSelectQuestionDisplayMode
func (EvaluationFormMultiSelectQuestionDisplayMode) Values ¶
func (EvaluationFormMultiSelectQuestionDisplayMode) Values() []EvaluationFormMultiSelectQuestionDisplayMode
Values returns all known values for EvaluationFormMultiSelectQuestionDisplayMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormMultiSelectQuestionOption ¶
type EvaluationFormMultiSelectQuestionOption struct {
// Reference identifier for this option.
//
// This member is required.
RefId *string
// Display text for this option.
//
// This member is required.
Text *string
// contains filtered or unexported fields
}
An option for a multi-select question in an evaluation form.
type EvaluationFormMultiSelectQuestionProperties ¶
type EvaluationFormMultiSelectQuestionProperties struct {
// Options available for this multi-select question.
//
// This member is required.
Options []EvaluationFormMultiSelectQuestionOption
// Automation configuration for this multi-select question.
Automation *EvaluationFormMultiSelectQuestionAutomation
// Display format for the multi-select question.
DisplayAs EvaluationFormMultiSelectQuestionDisplayMode
// contains filtered or unexported fields
}
Properties for a multi-select question in an evaluation form.
type EvaluationFormNumericQuestionAutomation ¶
type EvaluationFormNumericQuestionAutomation interface {
// contains filtered or unexported methods
}
Information about the automation configuration in numeric questions.
The following types satisfy this interface:
EvaluationFormNumericQuestionAutomationMemberAnswerSource EvaluationFormNumericQuestionAutomationMemberPropertyValue
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationFormNumericQuestionAutomation
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationFormNumericQuestionAutomationMemberAnswerSource:
_ = v.Value // Value is types.EvaluationFormQuestionAutomationAnswerSource
case *types.EvaluationFormNumericQuestionAutomationMemberPropertyValue:
_ = v.Value // Value is types.NumericQuestionPropertyValueAutomation
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationFormNumericQuestionAutomationMemberAnswerSource ¶
type EvaluationFormNumericQuestionAutomationMemberAnswerSource struct {
Value EvaluationFormQuestionAutomationAnswerSource
// contains filtered or unexported fields
}
A source of automation answer for numeric question.
type EvaluationFormNumericQuestionAutomationMemberPropertyValue ¶
type EvaluationFormNumericQuestionAutomationMemberPropertyValue struct {
Value NumericQuestionPropertyValueAutomation
// contains filtered or unexported fields
}
The property value of the automation.
type EvaluationFormNumericQuestionOption ¶
type EvaluationFormNumericQuestionOption struct {
// The maximum answer value of the range option.
//
// This member is required.
MaxValue int32
// The minimum answer value of the range option.
//
// This member is required.
MinValue int32
// The flag to mark the option as automatic fail. If an automatic fail answer is
// provided, the overall evaluation gets a score of 0.
AutomaticFail bool
// A configuration for automatic fail.
AutomaticFailConfiguration *AutomaticFailConfiguration
// The score assigned to answer values within the range option.
Score int32
// contains filtered or unexported fields
}
Information about the option range used for scoring in numeric questions.
type EvaluationFormNumericQuestionProperties ¶
type EvaluationFormNumericQuestionProperties struct {
// The maximum answer value.
//
// This member is required.
MaxValue int32
// The minimum answer value.
//
// This member is required.
MinValue int32
// The automation properties of the numeric question.
Automation EvaluationFormNumericQuestionAutomation
// The scoring options of the numeric question.
Options []EvaluationFormNumericQuestionOption
// contains filtered or unexported fields
}
Information about properties for a numeric question in an evaluation form.
type EvaluationFormQuestion ¶
type EvaluationFormQuestion struct {
// The type of the question.
//
// This member is required.
QuestionType EvaluationFormQuestionType
// The identifier of the question. An identifier must be unique within the
// evaluation form.
//
// This member is required.
RefId *string
// The title of the question.
//
// This member is required.
Title *string
// A question conditional enablement.
Enablement *EvaluationFormItemEnablementConfiguration
// The instructions of the section.
Instructions *string
// The flag to enable not applicable answers to the question.
NotApplicableEnabled bool
// The properties of the type of question. Text questions do not have to define
// question type properties.
QuestionTypeProperties EvaluationFormQuestionTypeProperties
// The scoring weight of the section.
Weight float64
// contains filtered or unexported fields
}
Information about a question from an evaluation form.
type EvaluationFormQuestionAutomationAnswerSource ¶
type EvaluationFormQuestionAutomationAnswerSource struct {
// The automation answer source type.
//
// This member is required.
SourceType EvaluationFormQuestionAutomationAnswerSourceType
// contains filtered or unexported fields
}
A question automation answer.
type EvaluationFormQuestionAutomationAnswerSourceType ¶
type EvaluationFormQuestionAutomationAnswerSourceType string
const ( EvaluationFormQuestionAutomationAnswerSourceTypeContactLensData EvaluationFormQuestionAutomationAnswerSourceType = "CONTACT_LENS_DATA" EvaluationFormQuestionAutomationAnswerSourceTypeGenAi EvaluationFormQuestionAutomationAnswerSourceType = "GEN_AI" )
Enum values for EvaluationFormQuestionAutomationAnswerSourceType
func (EvaluationFormQuestionAutomationAnswerSourceType) Values ¶
func (EvaluationFormQuestionAutomationAnswerSourceType) Values() []EvaluationFormQuestionAutomationAnswerSourceType
Values returns all known values for EvaluationFormQuestionAutomationAnswerSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormQuestionType ¶
type EvaluationFormQuestionType string
const ( EvaluationFormQuestionTypeText EvaluationFormQuestionType = "TEXT" EvaluationFormQuestionTypeSingleselect EvaluationFormQuestionType = "SINGLESELECT" EvaluationFormQuestionTypeNumeric EvaluationFormQuestionType = "NUMERIC" EvaluationFormQuestionTypeMultiselect EvaluationFormQuestionType = "MULTISELECT" EvaluationFormQuestionTypeDatetime EvaluationFormQuestionType = "DATETIME" )
Enum values for EvaluationFormQuestionType
func (EvaluationFormQuestionType) Values ¶
func (EvaluationFormQuestionType) Values() []EvaluationFormQuestionType
Values returns all known values for EvaluationFormQuestionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormQuestionTypeProperties ¶
type EvaluationFormQuestionTypeProperties interface {
// contains filtered or unexported methods
}
Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.
The following types satisfy this interface:
EvaluationFormQuestionTypePropertiesMemberMultiSelect EvaluationFormQuestionTypePropertiesMemberNumeric EvaluationFormQuestionTypePropertiesMemberSingleSelect EvaluationFormQuestionTypePropertiesMemberText
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationFormQuestionTypeProperties
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationFormQuestionTypePropertiesMemberMultiSelect:
_ = v.Value // Value is types.EvaluationFormMultiSelectQuestionProperties
case *types.EvaluationFormQuestionTypePropertiesMemberNumeric:
_ = v.Value // Value is types.EvaluationFormNumericQuestionProperties
case *types.EvaluationFormQuestionTypePropertiesMemberSingleSelect:
_ = v.Value // Value is types.EvaluationFormSingleSelectQuestionProperties
case *types.EvaluationFormQuestionTypePropertiesMemberText:
_ = v.Value // Value is types.EvaluationFormTextQuestionProperties
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationFormQuestionTypePropertiesMemberMultiSelect ¶
type EvaluationFormQuestionTypePropertiesMemberMultiSelect struct {
Value EvaluationFormMultiSelectQuestionProperties
// contains filtered or unexported fields
}
Properties for multi-select question types.
type EvaluationFormQuestionTypePropertiesMemberNumeric ¶
type EvaluationFormQuestionTypePropertiesMemberNumeric struct {
Value EvaluationFormNumericQuestionProperties
// contains filtered or unexported fields
}
The properties of the numeric question.
type EvaluationFormQuestionTypePropertiesMemberSingleSelect ¶
type EvaluationFormQuestionTypePropertiesMemberSingleSelect struct {
Value EvaluationFormSingleSelectQuestionProperties
// contains filtered or unexported fields
}
The properties of the numeric question.
type EvaluationFormQuestionTypePropertiesMemberText ¶
type EvaluationFormQuestionTypePropertiesMemberText struct {
Value EvaluationFormTextQuestionProperties
// contains filtered or unexported fields
}
The properties of the text question.
type EvaluationFormScoringMode ¶
type EvaluationFormScoringMode string
const ( EvaluationFormScoringModeQuestionOnly EvaluationFormScoringMode = "QUESTION_ONLY" EvaluationFormScoringModeSectionOnly EvaluationFormScoringMode = "SECTION_ONLY" )
Enum values for EvaluationFormScoringMode
func (EvaluationFormScoringMode) Values ¶
func (EvaluationFormScoringMode) Values() []EvaluationFormScoringMode
Values returns all known values for EvaluationFormScoringMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormScoringStatus ¶
type EvaluationFormScoringStatus string
const ( EvaluationFormScoringStatusEnabled EvaluationFormScoringStatus = "ENABLED" EvaluationFormScoringStatusDisabled EvaluationFormScoringStatus = "DISABLED" )
Enum values for EvaluationFormScoringStatus
func (EvaluationFormScoringStatus) Values ¶
func (EvaluationFormScoringStatus) Values() []EvaluationFormScoringStatus
Values returns all known values for EvaluationFormScoringStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormScoringStrategy ¶
type EvaluationFormScoringStrategy struct {
// The scoring mode of the evaluation form.
//
// This member is required.
Mode EvaluationFormScoringMode
// The scoring status of the evaluation form.
//
// This member is required.
Status EvaluationFormScoringStatus
// contains filtered or unexported fields
}
Information about scoring strategy for an evaluation form.
type EvaluationFormSearchCriteria ¶
type EvaluationFormSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []EvaluationFormSearchCriteria
// Boolean search condition.
BooleanCondition *BooleanCondition
// Datetime search condition.
DateTimeCondition *DateTimeCondition
// A leaf node condition which can be used to specify a numeric condition.
//
// The currently supported value for FieldName is limit .
NumberCondition *NumberCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []EvaluationFormSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return evaluation forms.
type EvaluationFormSearchFilter ¶
type EvaluationFormSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type EvaluationFormSearchSummary ¶
type EvaluationFormSearchSummary struct {
// Who created the evaluation form.
//
// This member is required.
CreatedBy *string
// When the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// Who changed the evaluation form.
//
// This member is required.
LastModifiedBy *string
// When the evaluation form was last changed.
//
// This member is required.
LastModifiedTime *time.Time
// Latest version of the evaluation form.
//
// This member is required.
LatestVersion *int32
// The status of the evaluation form.
//
// This member is required.
Status EvaluationFormVersionStatus
// The title of the evaluation form.
//
// This member is required.
Title *string
// Active version of the evaluation form.
ActiveVersion *int32
// Whether automated evaluation is enabled.
AutoEvaluationEnabled bool
// The contact interaction type for this evaluation form.
ContactInteractionType ContactInteractionType
// The description of the evaluation form.
Description *string
// The language of the evaluation form.
EvaluationFormLanguage EvaluationFormLanguageCode
// The ID of user who last activated evaluation form.
LastActivatedBy *string
// When the evaluation format was last activated.
LastActivatedTime *time.Time
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Information about the returned evaluation forms.
type EvaluationFormSection ¶
type EvaluationFormSection struct {
// The items of the section.
//
// This member is required.
Items []EvaluationFormItem
// The identifier of the section. An identifier must be unique within the
// evaluation form.
//
// This member is required.
RefId *string
// The title of the section.
//
// This member is required.
Title *string
// The instructions of the section.
Instructions *string
// The scoring weight of the section.
Weight float64
// contains filtered or unexported fields
}
Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).
type EvaluationFormSingleSelectQuestionAutomation ¶
type EvaluationFormSingleSelectQuestionAutomation struct {
// Automation answer source.
AnswerSource *EvaluationFormQuestionAutomationAnswerSource
// The identifier of the default answer option, when none of the automation
// options match the criteria.
DefaultOptionRefId *string
// The automation options of the single select question.
Options []EvaluationFormSingleSelectQuestionAutomationOption
// contains filtered or unexported fields
}
Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.
type EvaluationFormSingleSelectQuestionAutomationOption ¶
type EvaluationFormSingleSelectQuestionAutomationOption interface {
// contains filtered or unexported methods
}
Information about the automation option of a single select question.
The following types satisfy this interface:
EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationFormSingleSelectQuestionAutomationOption
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory:
_ = v.Value // Value is types.SingleSelectQuestionRuleCategoryAutomation
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory ¶
type EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory struct {
Value SingleSelectQuestionRuleCategoryAutomation
// contains filtered or unexported fields
}
The automation option based on a rule category for the single select question.
type EvaluationFormSingleSelectQuestionDisplayMode ¶
type EvaluationFormSingleSelectQuestionDisplayMode string
const ( EvaluationFormSingleSelectQuestionDisplayModeDropdown EvaluationFormSingleSelectQuestionDisplayMode = "DROPDOWN" EvaluationFormSingleSelectQuestionDisplayModeRadio EvaluationFormSingleSelectQuestionDisplayMode = "RADIO" )
Enum values for EvaluationFormSingleSelectQuestionDisplayMode
func (EvaluationFormSingleSelectQuestionDisplayMode) Values ¶
func (EvaluationFormSingleSelectQuestionDisplayMode) Values() []EvaluationFormSingleSelectQuestionDisplayMode
Values returns all known values for EvaluationFormSingleSelectQuestionDisplayMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormSingleSelectQuestionOption ¶
type EvaluationFormSingleSelectQuestionOption struct {
// The identifier of the answer option. An identifier must be unique within the
// question.
//
// This member is required.
RefId *string
// The title of the answer option.
//
// This member is required.
Text *string
// The flag to mark the option as automatic fail. If an automatic fail answer is
// provided, the overall evaluation gets a score of 0.
AutomaticFail bool
// Whether automatic fail is configured on a single select question.
AutomaticFailConfiguration *AutomaticFailConfiguration
// The score assigned to the answer option.
Score int32
// contains filtered or unexported fields
}
Information about the automation configuration in single select questions.
type EvaluationFormSingleSelectQuestionProperties ¶
type EvaluationFormSingleSelectQuestionProperties struct {
// The answer options of the single select question.
//
// This member is required.
Options []EvaluationFormSingleSelectQuestionOption
// The display mode of the single select question.
Automation *EvaluationFormSingleSelectQuestionAutomation
// The display mode of the single select question.
DisplayAs EvaluationFormSingleSelectQuestionDisplayMode
// contains filtered or unexported fields
}
Information about the options in single select questions.
type EvaluationFormSummary ¶
type EvaluationFormSummary struct {
// The Amazon Resource Name (ARN) of the user who created the evaluation form.
//
// This member is required.
CreatedBy *string
// The timestamp for when the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
//
// This member is required.
LastModifiedBy *string
// The timestamp for when the evaluation form was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The version number of the latest evaluation form version.
//
// This member is required.
LatestVersion int32
// A title of the evaluation form.
//
// This member is required.
Title *string
// The version of the active evaluation form version.
ActiveVersion *int32
// The Amazon Resource Name (ARN) of the user who last activated the evaluation
// form.
LastActivatedBy *string
// The timestamp for when the evaluation form was last activated.
LastActivatedTime *time.Time
// contains filtered or unexported fields
}
Summary information about an evaluation form.
type EvaluationFormTargetConfiguration ¶
type EvaluationFormTargetConfiguration struct {
// The contact interaction type for this evaluation form.
//
// This member is required.
ContactInteractionType ContactInteractionType
// contains filtered or unexported fields
}
Configuration that specifies the target for an evaluation form.
type EvaluationFormTextQuestionAutomation ¶
type EvaluationFormTextQuestionAutomation struct {
// Automation answer source.
AnswerSource *EvaluationFormQuestionAutomationAnswerSource
// contains filtered or unexported fields
}
Information about the automation configuration in text questions.
type EvaluationFormTextQuestionProperties ¶
type EvaluationFormTextQuestionProperties struct {
// The automation properties of the text question.
Automation *EvaluationFormTextQuestionAutomation
// contains filtered or unexported fields
}
Information about properties for a text question in an evaluation form.
type EvaluationFormVersionStatus ¶
type EvaluationFormVersionStatus string
const ( EvaluationFormVersionStatusDraft EvaluationFormVersionStatus = "DRAFT" EvaluationFormVersionStatusActive EvaluationFormVersionStatus = "ACTIVE" )
Enum values for EvaluationFormVersionStatus
func (EvaluationFormVersionStatus) Values ¶
func (EvaluationFormVersionStatus) Values() []EvaluationFormVersionStatus
Values returns all known values for EvaluationFormVersionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFormVersionSummary ¶
type EvaluationFormVersionSummary struct {
// The Amazon Resource Name (ARN) of the user who created the evaluation form.
//
// This member is required.
CreatedBy *string
// The timestamp for when the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion int32
// The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
//
// This member is required.
LastModifiedBy *string
// The timestamp for when the evaluation form was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The flag indicating whether the evaluation form is locked for changes.
//
// This member is required.
Locked bool
// The status of the evaluation form.
//
// This member is required.
Status EvaluationFormVersionStatus
// contains filtered or unexported fields
}
Summary information about an evaluation form.
type EvaluationGenAIAnswerAnalysisDetails ¶
type EvaluationGenAIAnswerAnalysisDetails struct {
// Generative AI automation answer justification.
Justification *string
// Generative AI automation answer analysis points of interest.
PointsOfInterest []EvaluationTranscriptPointOfInterest
// contains filtered or unexported fields
}
An analysis for a generative AI answer to the question.
type EvaluationMetadata ¶
type EvaluationMetadata struct {
// The identifier of the contact in this instance of Amazon Connect.
//
// This member is required.
ContactId *string
// The Amazon Resource Name (ARN) of the user who last updated the evaluation.
//
// This member is required.
EvaluatorArn *string
// Information related to evaluation acknowledgement.
Acknowledgement *EvaluationAcknowledgement
// Information related to automated evaluation.
AutoEvaluation *AutoEvaluationDetails
// The calibration session ID that this evaluation belongs to.
CalibrationSessionId *string
// The identifier of the agent who performed the contact.
ContactAgentId *string
// Information about a contact participant in this evaluation.
ContactParticipant *EvaluationContactParticipant
// Identifier of the sampling job.
SamplingJobId *string
// The overall score of the contact evaluation.
Score *EvaluationScore
// contains filtered or unexported fields
}
Metadata information about a contact evaluation.
type EvaluationNote ¶
type EvaluationNote struct {
// The note for an item (section or question) in a contact evaluation.
//
// Even though a note in an evaluation can have up to 3072 chars, there is also a
// limit on the total number of chars for all the notes in the evaluation combined.
// Assuming there are N questions in the evaluation being submitted, then the max
// char limit for all notes combined is N x 1024.
Value *string
// contains filtered or unexported fields
}
Information about notes for a contact evaluation.
type EvaluationQuestionAnswerAnalysisDetails ¶
type EvaluationQuestionAnswerAnalysisDetails interface {
// contains filtered or unexported methods
}
Detailed analysis results of the automated answer to the evaluation question.
The following types satisfy this interface:
EvaluationQuestionAnswerAnalysisDetailsMemberContactLens EvaluationQuestionAnswerAnalysisDetailsMemberGenAI
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluationQuestionAnswerAnalysisDetails
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluationQuestionAnswerAnalysisDetailsMemberContactLens:
_ = v.Value // Value is types.EvaluationContactLensAnswerAnalysisDetails
case *types.EvaluationQuestionAnswerAnalysisDetailsMemberGenAI:
_ = v.Value // Value is types.EvaluationGenAIAnswerAnalysisDetails
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluationQuestionAnswerAnalysisDetailsMemberContactLens ¶
type EvaluationQuestionAnswerAnalysisDetailsMemberContactLens struct {
Value EvaluationContactLensAnswerAnalysisDetails
// contains filtered or unexported fields
}
Analysis results from the Contact Lens automation for the question.
type EvaluationQuestionAnswerAnalysisDetailsMemberGenAI ¶
type EvaluationQuestionAnswerAnalysisDetailsMemberGenAI struct {
Value EvaluationGenAIAnswerAnalysisDetails
// contains filtered or unexported fields
}
Analysis results from the generative AI automation for the question.
type EvaluationQuestionAnswerAnalysisType ¶
type EvaluationQuestionAnswerAnalysisType string
const ( EvaluationQuestionAnswerAnalysisTypeContactLensData EvaluationQuestionAnswerAnalysisType = "CONTACT_LENS_DATA" EvaluationQuestionAnswerAnalysisTypeGenAi EvaluationQuestionAnswerAnalysisType = "GEN_AI" )
Enum values for EvaluationQuestionAnswerAnalysisType
func (EvaluationQuestionAnswerAnalysisType) Values ¶
func (EvaluationQuestionAnswerAnalysisType) Values() []EvaluationQuestionAnswerAnalysisType
Values returns all known values for EvaluationQuestionAnswerAnalysisType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationQuestionInputDetails ¶
type EvaluationQuestionInputDetails struct {
// Transcript type.
TranscriptType EvaluationTranscriptType
// contains filtered or unexported fields
}
Details of the input data used for automated question processing.
type EvaluationScore ¶
type EvaluationScore struct {
// Weight applied to this evaluation score.
AppliedWeight *float64
// The flag that marks the item as automatic fail. If the item or a child item
// gets an automatic fail answer, this flag will be true.
AutomaticFail bool
// The flag to mark the item as not applicable for scoring.
NotApplicable bool
// The score percentage for an item in a contact evaluation.
Percentage float64
// contains filtered or unexported fields
}
Information about scores of a contact evaluation item (section or question).
type EvaluationSearchCriteria ¶
type EvaluationSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []EvaluationSearchCriteria
// The boolean condition search criteria for searching evaluations.
BooleanCondition *BooleanCondition
// The datetime condition search criteria for searching evaluations.
DateTimeCondition *DateTimeCondition
// The decimal condition search criteria for searching evaluations.
DecimalCondition *DecimalCondition
// A leaf node condition which can be used to specify a numeric condition.
//
// The currently supported value for FieldName is limit .
NumberCondition *NumberCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []EvaluationSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return evaluations.
type EvaluationSearchFilter ¶
type EvaluationSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type EvaluationSearchMetadata ¶
type EvaluationSearchMetadata struct {
// The identifier of the contact in this instance of Amazon Connect.
//
// This member is required.
ContactId *string
// The Amazon Resource Name (ARN) of the person who evaluated the contact.
//
// This member is required.
EvaluatorArn *string
// The agent who acknowledged the evaluation.
AcknowledgedBy *string
// When the evaluation was acknowledged by the agent.
AcknowledgedTime *time.Time
// The comment from the agent when they acknowledged the evaluation.
AcknowledgerComment *string
// Whether auto-evaluation is enabled.
AutoEvaluationEnabled bool
// The status of the contact auto evaluation.
AutoEvaluationStatus AutoEvaluationStatus
// The calibration session ID that this evaluation belongs to.
CalibrationSessionId *string
// The unique ID of the agent who handled the contact.
ContactAgentId *string
// Identifier for a contact participant in the evaluation.
ContactParticipantId *string
// Role of a contact participant in the evaluation.
ContactParticipantRole ContactParticipantRole
// Identifier for the review.
ReviewId *string
// Identifier of the sampling job.
SamplingJobId *string
// The flag that marks the item as automatic fail. If the item or a child item
// gets an automatic fail answer, this flag is true.
ScoreAutomaticFail bool
// The flag to mark the item as not applicable for scoring.
ScoreNotApplicable bool
// The total evaluation score expressed as a percentage.
ScorePercentage float64
// contains filtered or unexported fields
}
Metadata information about an evaluation search.
type EvaluationSearchSummary ¶
type EvaluationSearchSummary struct {
// The date and time when the evaluation was created, in UTC time.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the contact evaluation resource.
//
// This member is required.
EvaluationArn *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion *int32
// A unique identifier for the contact evaluation.
//
// This member is required.
EvaluationId *string
// The date and time when the evaluation was modified last time, in UTC time.
//
// This member is required.
LastModifiedTime *time.Time
// Summary information about the evaluation search.
//
// This member is required.
Metadata *EvaluationSearchMetadata
// The status of the evaluation.
//
// This member is required.
Status EvaluationStatus
// The unique identifier for the evaluation form.
EvaluationFormId *string
// Title of the evaluation form.
EvaluationFormTitle *string
// Type of the evaluation.
EvaluationType EvaluationType
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Summary of evaluation obtained from the search operation.
type EvaluationStatus ¶
type EvaluationStatus string
const ( EvaluationStatusDraft EvaluationStatus = "DRAFT" EvaluationStatusSubmitted EvaluationStatus = "SUBMITTED" )
Enum values for EvaluationStatus
func (EvaluationStatus) Values ¶
func (EvaluationStatus) Values() []EvaluationStatus
Values returns all known values for EvaluationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationSuggestedAnswer ¶
type EvaluationSuggestedAnswer struct {
// Type of analysis used to provide suggested answer.
//
// This member is required.
AnalysisType EvaluationQuestionAnswerAnalysisType
// The status of the suggested answer. D
//
// This member is required.
Status EvaluationSuggestedAnswerStatus
// Detailed analysis results.
AnalysisDetails EvaluationQuestionAnswerAnalysisDetails
// Details about the input used to question automation.
Input *EvaluationQuestionInputDetails
// Information about answer data for a contact evaluation. Answer data must be
// either string, numeric, or not applicable.
Value EvaluationAnswerData
// contains filtered or unexported fields
}
The information about the suggested answer for the question.
type EvaluationSuggestedAnswerStatus ¶
type EvaluationSuggestedAnswerStatus string
const ( EvaluationSuggestedAnswerStatusInProgress EvaluationSuggestedAnswerStatus = "IN_PROGRESS" EvaluationSuggestedAnswerStatusFailed EvaluationSuggestedAnswerStatus = "FAILED" EvaluationSuggestedAnswerStatusSucceeded EvaluationSuggestedAnswerStatus = "SUCCEEDED" )
Enum values for EvaluationSuggestedAnswerStatus
func (EvaluationSuggestedAnswerStatus) Values ¶
func (EvaluationSuggestedAnswerStatus) Values() []EvaluationSuggestedAnswerStatus
Values returns all known values for EvaluationSuggestedAnswerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationSuggestedAnswerTranscriptMillisecondOffsets ¶
type EvaluationSuggestedAnswerTranscriptMillisecondOffsets struct {
// Offset in milliseconds from the beginning of the transcript.
//
// This member is required.
BeginOffsetMillis int32
// contains filtered or unexported fields
}
The milliseconds offset for transcript reference in suggested answer.
type EvaluationSummary ¶
type EvaluationSummary struct {
// The timestamp for when the evaluation was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the contact evaluation resource.
//
// This member is required.
EvaluationArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A title of the evaluation form.
//
// This member is required.
EvaluationFormTitle *string
// A unique identifier for the contact evaluation.
//
// This member is required.
EvaluationId *string
// The Amazon Resource Name (ARN) of the user who last updated the evaluation.
//
// This member is required.
EvaluatorArn *string
// The timestamp for when the evaluation was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The status of the contact evaluation.
//
// This member is required.
Status EvaluationStatus
// Information related to evaluation acknowledgement.
Acknowledgement *EvaluationAcknowledgementSummary
// Whether automated evaluation is enabled.
AutoEvaluationEnabled bool
// The status of the contact auto evaluation.
AutoEvaluationStatus AutoEvaluationStatus
// The calibration session ID that this evaluation belongs to.
CalibrationSessionId *string
// Information about a contact participant in the evaluation.
ContactParticipant *EvaluationContactParticipant
// Type of the evaluation.
EvaluationType EvaluationType
// The overall score of the contact evaluation.
Score *EvaluationScore
// contains filtered or unexported fields
}
Summary information about a contact evaluation.
type EvaluationTranscriptPointOfInterest ¶
type EvaluationTranscriptPointOfInterest struct {
// Offset in milliseconds from the beginning of transcript.
MillisecondOffsets *EvaluationSuggestedAnswerTranscriptMillisecondOffsets
// Segment of transcript.
TranscriptSegment *string
// contains filtered or unexported fields
}
Information about the point of interest in transcript provided to evaluation.
type EvaluationTranscriptType ¶
type EvaluationTranscriptType string
const ( EvaluationTranscriptTypeRaw EvaluationTranscriptType = "RAW" EvaluationTranscriptTypeRedacted EvaluationTranscriptType = "REDACTED" )
Enum values for EvaluationTranscriptType
func (EvaluationTranscriptType) Values ¶
func (EvaluationTranscriptType) Values() []EvaluationTranscriptType
Values returns all known values for EvaluationTranscriptType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationType ¶
type EvaluationType string
const ( EvaluationTypeStandard EvaluationType = "STANDARD" EvaluationTypeCalibration EvaluationType = "CALIBRATION" )
Enum values for EvaluationType
func (EvaluationType) Values ¶
func (EvaluationType) Values() []EvaluationType
Values returns all known values for EvaluationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluatorUserUnion ¶
type EvaluatorUserUnion interface {
// contains filtered or unexported methods
}
Represents the entity that performed the action on the evaluation.
The following types satisfy this interface:
EvaluatorUserUnionMemberConnectUserArn
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.EvaluatorUserUnion
// type switches can be used to check the union value
switch v := union.(type) {
case *types.EvaluatorUserUnionMemberConnectUserArn:
_ = v.Value // Value is string
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type EvaluatorUserUnionMemberConnectUserArn ¶
type EvaluatorUserUnionMemberConnectUserArn struct {
Value string
// contains filtered or unexported fields
}
Represents the Amazon Connect ARN of the user.
type EventBridgeActionDefinition ¶
type EventBridgeActionDefinition struct {
// The name.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
The EventBridge action definition.
type EventSourceName ¶
type EventSourceName string
const ( EventSourceNameOnPostCallAnalysisAvailable EventSourceName = "OnPostCallAnalysisAvailable" EventSourceNameOnRealTimeCallAnalysisAvailable EventSourceName = "OnRealTimeCallAnalysisAvailable" EventSourceNameOnRealTimeChatAnalysisAvailable EventSourceName = "OnRealTimeChatAnalysisAvailable" EventSourceNameOnPostChatAnalysisAvailable EventSourceName = "OnPostChatAnalysisAvailable" EventSourceNameOnZendeskTicketCreate EventSourceName = "OnZendeskTicketCreate" EventSourceNameOnZendeskTicketStatusUpdate EventSourceName = "OnZendeskTicketStatusUpdate" EventSourceNameOnSalesforceCaseCreate EventSourceName = "OnSalesforceCaseCreate" EventSourceNameOnContactEvaluationSubmit EventSourceName = "OnContactEvaluationSubmit" EventSourceNameOnMetricDataUpdate EventSourceName = "OnMetricDataUpdate" EventSourceNameOnCaseCreate EventSourceName = "OnCaseCreate" EventSourceNameOnCaseUpdate EventSourceName = "OnCaseUpdate" EventSourceNameOnSlaBreach EventSourceName = "OnSlaBreach" )
Enum values for EventSourceName
func (EventSourceName) Values ¶
func (EventSourceName) Values() []EventSourceName
Values returns all known values for EventSourceName. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Expiry ¶
type Expiry struct {
// The number of seconds to wait before expiring the routing step.
DurationInSeconds *int32
// The timestamp indicating when the routing step expires.
ExpiryTimestamp *time.Time
// contains filtered or unexported fields
}
An object to specify the expiration of a routing step.
type Expression ¶
type Expression struct {
// List of routing expressions which will be AND-ed together.
AndExpression []Expression
// An object to specify the predefined attribute condition.
AttributeCondition *AttributeCondition
// An object to specify the predefined attribute condition.
NotAttributeCondition *AttributeCondition
// List of routing expressions which will be OR-ed together.
OrExpression []Expression
// contains filtered or unexported fields
}
A tagged union to specify expression for a routing step.
type ExternalInvocationConfiguration ¶
type ExternalInvocationConfiguration struct {
// Enable external invocation.
Enabled bool
// contains filtered or unexported fields
}
The external invocation configuration for the flow module
type FailedBatchAssociationSummary ¶
type FailedBatchAssociationSummary struct {
// The error code indicating why the association failed.
ErrorCode *string
// An error message describing why the association failed.
ErrorMessage *string
// The Amazon Resource Name (ARN) of the resource that failed to be associated.
ResourceArn *string
// contains filtered or unexported fields
}
Contains information about a resource that failed to be associated with a workspace in a batch operation.
type FailedRequest ¶
type FailedRequest struct {
// Reason code for the failure.
FailureReasonCode FailureReasonCode
// Why the request to create a contact failed.
FailureReasonMessage *string
// Request identifier provided in the API call in the ContactDataRequest to create
// a contact.
RequestIdentifier *string
// contains filtered or unexported fields
}
Request for which contact failed to be generated.
type FailureReasonCode ¶
type FailureReasonCode string
const ( FailureReasonCodeInvalidAttributeKey FailureReasonCode = "INVALID_ATTRIBUTE_KEY" FailureReasonCodeInvalidCustomerEndpoint FailureReasonCode = "INVALID_CUSTOMER_ENDPOINT" FailureReasonCodeInvalidSystemEndpoint FailureReasonCode = "INVALID_SYSTEM_ENDPOINT" FailureReasonCodeInvalidQueue FailureReasonCode = "INVALID_QUEUE" FailureReasonCodeInvalidOutboundStrategy FailureReasonCode = "INVALID_OUTBOUND_STRATEGY" FailureReasonCodeMissingCampaign FailureReasonCode = "MISSING_CAMPAIGN" FailureReasonCodeMissingCustomerEndpoint FailureReasonCode = "MISSING_CUSTOMER_ENDPOINT" FailureReasonCodeMissingQueueIdAndSystemEndpoint FailureReasonCode = "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT" FailureReasonCodeRequestThrottled FailureReasonCode = "REQUEST_THROTTLED" FailureReasonCodeIdempotencyException FailureReasonCode = "IDEMPOTENCY_EXCEPTION" FailureReasonCodeInternalError FailureReasonCode = "INTERNAL_ERROR" )
Enum values for FailureReasonCode
func (FailureReasonCode) Values ¶
func (FailureReasonCode) Values() []FailureReasonCode
Values returns all known values for FailureReasonCode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FieldValue ¶
type FieldValue struct {
// Unique identifier of a field.
//
// This member is required.
Id *string
// Union of potential field value types.
//
// This member is required.
Value *FieldValueUnion
// contains filtered or unexported fields
}
Object for case field values.
type FieldValueUnion ¶
type FieldValueUnion struct {
// A Boolean number value type.
BooleanValue bool
// A Double number value type.
DoubleValue *float64
// An empty value.
EmptyValue *EmptyFieldValue
// String value type.
StringValue *string
// contains filtered or unexported fields
}
Object to store union of Field values.
type FileStatusType ¶
type FileStatusType string
const ( FileStatusTypeApproved FileStatusType = "APPROVED" FileStatusTypeRejected FileStatusType = "REJECTED" FileStatusTypeProcessing FileStatusType = "PROCESSING" FileStatusTypeFailed FileStatusType = "FAILED" )
Enum values for FileStatusType
func (FileStatusType) Values ¶
func (FileStatusType) Values() []FileStatusType
Values returns all known values for FileStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FileUseCaseType ¶
type FileUseCaseType string
const ( FileUseCaseTypeEmailMessage FileUseCaseType = "EMAIL_MESSAGE" FileUseCaseTypeAttachment FileUseCaseType = "ATTACHMENT" )
Enum values for FileUseCaseType
func (FileUseCaseType) Values ¶
func (FileUseCaseType) Values() []FileUseCaseType
Values returns all known values for FileUseCaseType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FilterV2 ¶
type FilterV2 struct {
// The key to use for filtering data. For example, QUEUE , ROUTING_PROFILE, AGENT ,
// CHANNEL , AGENT_HIERARCHY_LEVEL_ONE , AGENT_HIERARCHY_LEVEL_TWO ,
// AGENT_HIERARCHY_LEVEL_THREE , AGENT_HIERARCHY_LEVEL_FOUR ,
// AGENT_HIERARCHY_LEVEL_FIVE . There must be at least 1 key and a maximum 5 keys.
FilterKey *string
// The identifiers to use for filtering data. For example, if you have a filter
// key of QUEUE , you would add queue IDs or ARNs in FilterValues .
FilterValues []string
// System defined filtering condition. For example, the NOT_EXISTS
// StringCondition returns documents where the field specified by FilterKey does
// not exist in the document.
//
// When the NOT_EXISTS StringCondition is added to a FilterV2 object, FilterValues
// must be null or empty.
StringCondition *FilterV2StringCondition
// contains filtered or unexported fields
}
Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
type FilterV2StringCondition ¶
type FilterV2StringCondition struct {
// The string condition.
Comparison FilterV2StringConditionComparisonOperator
// contains filtered or unexported fields
}
System defined filtering condition. For example, the NOT_EXISTS
StringCondition returns documents where the field specified by FilterKey does not exist in the document.
When the NOT_EXISTS StringCondition is added to a FilterV2 object, FilterValues must be null or empty.
type FilterV2StringConditionComparisonOperator ¶
type FilterV2StringConditionComparisonOperator string
const ( FilterV2StringConditionComparisonOperatorNotExists FilterV2StringConditionComparisonOperator = "NOT_EXISTS" )
Enum values for FilterV2StringConditionComparisonOperator
func (FilterV2StringConditionComparisonOperator) Values ¶
func (FilterV2StringConditionComparisonOperator) Values() []FilterV2StringConditionComparisonOperator
Values returns all known values for FilterV2StringConditionComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Filters ¶
type Filters struct {
// A list of up to 50 agent status IDs or ARNs.
AgentStatuses []string
// The channel to use to filter the metrics.
Channels []Channel
// The queues to use to filter the metrics. You should specify at least one queue,
// and can specify up to 100 queues per request. The GetCurrentMetricsData API in
// particular requires a queue when you include a Filter in your request.
Queues []string
// A list of up to 100 routing profile IDs or ARNs.
RoutingProfiles []string
// A list of expressions as a filter, in which an expression is an object of a
// step in a routing criteria.
RoutingStepExpressions []string
// contains filtered or unexported fields
}
Contains the filter to apply when retrieving metrics.
type FlowAssociationResourceType ¶
type FlowAssociationResourceType string
const ( FlowAssociationResourceTypeSmsPhoneNumber FlowAssociationResourceType = "SMS_PHONE_NUMBER" FlowAssociationResourceTypeInboundEmail FlowAssociationResourceType = "INBOUND_EMAIL" FlowAssociationResourceTypeOutboundEmail FlowAssociationResourceType = "OUTBOUND_EMAIL" FlowAssociationResourceTypeAnalyticsConnector FlowAssociationResourceType = "ANALYTICS_CONNECTOR" FlowAssociationResourceTypeWhatsappMessagingPhoneNumber FlowAssociationResourceType = "WHATSAPP_MESSAGING_PHONE_NUMBER" )
Enum values for FlowAssociationResourceType
func (FlowAssociationResourceType) Values ¶
func (FlowAssociationResourceType) Values() []FlowAssociationResourceType
Values returns all known values for FlowAssociationResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FlowAssociationSummary ¶
type FlowAssociationSummary struct {
// The identifier of the flow.
FlowId *string
// The identifier of the resource.
ResourceId *string
// The type of resource association.
ResourceType ListFlowAssociationResourceType
// contains filtered or unexported fields
}
Information about flow associations.
type FlowModule ¶
type FlowModule struct {
// If of Flow Modules invocable as tool
FlowModuleId *string
// Only Type we support is MCP.
Type FlowModuleType
// contains filtered or unexported fields
}
A list of Flow Modules an AI Agent can invoke as a tool
type FlowModuleType ¶
type FlowModuleType string
const ( FlowModuleTypeMcp FlowModuleType = "MCP" )
Enum values for FlowModuleType
func (FlowModuleType) Values ¶
func (FlowModuleType) Values() []FlowModuleType
Values returns all known values for FlowModuleType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FlowQuickConnectConfig ¶
type FlowQuickConnectConfig struct {
// The contact flow ID for the quick connect configuration.
//
// This member is required.
ContactFlowId *string
// contains filtered or unexported fields
}
Configuration for quick connect.
type FontFamily ¶
type FontFamily struct {
// The default font family to use in the workspace theme.
Default WorkspaceFontFamily
// contains filtered or unexported fields
}
Contains font family configuration for workspace themes.
type GranularAccessControlConfiguration ¶
type GranularAccessControlConfiguration struct {
// The access control configuration for data tables.
DataTableAccessControlConfiguration *DataTableAccessControlConfiguration
// contains filtered or unexported fields
}
Contains granular access control configuration for security profiles, including data table access permissions.
type Grouping ¶
type Grouping string
const ( GroupingQueue Grouping = "QUEUE" GroupingChannel Grouping = "CHANNEL" GroupingRoutingProfile Grouping = "ROUTING_PROFILE" GroupingRoutingStepExpression Grouping = "ROUTING_STEP_EXPRESSION" GroupingAgentStatus Grouping = "AGENT_STATUS" )
Enum values for Grouping
func (Grouping) Values ¶
Values returns all known values for Grouping. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type HierarchyGroup ¶
type HierarchyGroup struct {
// The Amazon Resource Name (ARN) of the hierarchy group.
Arn *string
// Information about the levels in the hierarchy group.
HierarchyPath *HierarchyPath
// The identifier of the hierarchy group.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The identifier of the level in the hierarchy group.
LevelId *string
// The name of the hierarchy group.
Name *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Contains information about a hierarchy group.
type HierarchyGroupCondition ¶
type HierarchyGroupCondition struct {
// The type of hierarchy group match.
HierarchyGroupMatchType HierarchyGroupMatchType
// The value in the hierarchy group condition.
Value *string
// contains filtered or unexported fields
}
A leaf node condition which can be used to specify a hierarchy group condition.
type HierarchyGroupMatchType ¶
type HierarchyGroupMatchType string
const ( HierarchyGroupMatchTypeExact HierarchyGroupMatchType = "EXACT" HierarchyGroupMatchTypeWithChildGroups HierarchyGroupMatchType = "WITH_CHILD_GROUPS" )
Enum values for HierarchyGroupMatchType
func (HierarchyGroupMatchType) Values ¶
func (HierarchyGroupMatchType) Values() []HierarchyGroupMatchType
Values returns all known values for HierarchyGroupMatchType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type HierarchyGroupSummary ¶
type HierarchyGroupSummary struct {
// The Amazon Resource Name (ARN) of the hierarchy group.
Arn *string
// The identifier of the hierarchy group.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the hierarchy group.
Name *string
// contains filtered or unexported fields
}
Contains summary information about a hierarchy group.
type HierarchyGroupSummaryReference ¶
type HierarchyGroupSummaryReference struct {
// The Amazon Resource Name (ARN) for the hierarchy group.
Arn *string
// The unique identifier for the hierarchy group.
Id *string
// contains filtered or unexported fields
}
Information about the hierarchy group.
type HierarchyGroups ¶
type HierarchyGroups struct {
// The group at level one of the agent hierarchy.
Level1 *AgentHierarchyGroup
// The group at level two of the agent hierarchy.
Level2 *AgentHierarchyGroup
// The group at level three of the agent hierarchy.
Level3 *AgentHierarchyGroup
// The group at level four of the agent hierarchy.
Level4 *AgentHierarchyGroup
// The group at level five of the agent hierarchy.
Level5 *AgentHierarchyGroup
// contains filtered or unexported fields
}
Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
type HierarchyLevel ¶
type HierarchyLevel struct {
// The Amazon Resource Name (ARN) of the hierarchy level.
Arn *string
// The identifier of the hierarchy level.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the hierarchy level.
Name *string
// contains filtered or unexported fields
}
Contains information about a hierarchy level.
type HierarchyLevelUpdate ¶
type HierarchyLevelUpdate struct {
// The name of the user hierarchy level. Must not be more than 50 characters.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
Contains information about the hierarchy level to update.
type HierarchyPath ¶
type HierarchyPath struct {
// Information about level five.
LevelFive *HierarchyGroupSummary
// Information about level four.
LevelFour *HierarchyGroupSummary
// Information about level one.
LevelOne *HierarchyGroupSummary
// Information about level three.
LevelThree *HierarchyGroupSummary
// Information about level two.
LevelTwo *HierarchyGroupSummary
// contains filtered or unexported fields
}
Contains information about the levels of a hierarchy group.
type HierarchyPathReference ¶
type HierarchyPathReference struct {
// Information about level five.
LevelFive *HierarchyGroupSummaryReference
// Information about level four.
LevelFour *HierarchyGroupSummaryReference
// Information about level one.
LevelOne *HierarchyGroupSummaryReference
// Information about level three.
LevelThree *HierarchyGroupSummaryReference
// Information about level two.
LevelTwo *HierarchyGroupSummaryReference
// contains filtered or unexported fields
}
Information about the levels in the hierarchy group.
type HierarchyStructure ¶
type HierarchyStructure struct {
// Information about level five.
LevelFive *HierarchyLevel
// Information about level four.
LevelFour *HierarchyLevel
// Information about level one.
LevelOne *HierarchyLevel
// Information about level three.
LevelThree *HierarchyLevel
// Information about level two.
LevelTwo *HierarchyLevel
// contains filtered or unexported fields
}
Contains information about a hierarchy structure.
type HierarchyStructureUpdate ¶
type HierarchyStructureUpdate struct {
// The update for level five.
LevelFive *HierarchyLevelUpdate
// The update for level four.
LevelFour *HierarchyLevelUpdate
// The update for level one.
LevelOne *HierarchyLevelUpdate
// The update for level three.
LevelThree *HierarchyLevelUpdate
// The update for level two.
LevelTwo *HierarchyLevelUpdate
// contains filtered or unexported fields
}
Contains information about the level hierarchy to update.
type HistoricalMetric ¶
type HistoricalMetric struct {
// The name of the metric. Following is a list of each supported metric mapped to
// the UI name, linked to a detailed description in the Amazon Connect
// Administrator Guide.
//
// ABANDON_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [Average queue abandon time]
//
// AFTER_CONTACT_WORK_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [After contact work time]
//
// API_CONTACTS_HANDLED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [API contacts handled]
//
// AVG_HOLD_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [Average customer hold time]
//
// CALLBACK_CONTACTS_HANDLED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Callback contacts handled]
//
// CONTACTS_ABANDONED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts abandoned]
//
// CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts agent hung up first]
//
// CONTACTS_CONSULTED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts consulted]
//
// CONTACTS_HANDLED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts handled]
//
// CONTACTS_HANDLED_INCOMING Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts handled incoming]
//
// CONTACTS_HANDLED_OUTBOUND Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts handled outbound]
//
// CONTACTS_HOLD_ABANDONS Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts hold disconnect]
//
// CONTACTS_MISSED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [AGENT_NON_RESPONSE]
//
// CONTACTS_QUEUED Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts queued]
//
// CONTACTS_TRANSFERRED_IN Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts transferred in]
//
// CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts transferred out queue]
//
// CONTACTS_TRANSFERRED_OUT Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts transferred out]
//
// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT
//
// Statistic: SUM
//
// UI name: [Contacts transferred out queue]
//
// HANDLE_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [Average handle time]
//
// INTERACTION_AND_HOLD_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [Average agent interaction and customer hold time]
//
// INTERACTION_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [Average agent interaction time]
//
// OCCUPANCY Unit: PERCENT
//
// Statistic: AVG
//
// UI name: [Occupancy]
//
// QUEUE_ANSWER_TIME Unit: SECONDS
//
// Statistic: AVG
//
// UI name: [Average queue answer time]
//
// QUEUED_TIME Unit: SECONDS
//
// Statistic: MAX
//
// UI name: [Minimum flow time]
//
// SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request.
//
// Unit: PERCENT
//
// Statistic: AVG
//
// Threshold: For ThresholdValue , enter any whole number from 1 to 604800
// (inclusive), in seconds. For Comparison , you must enter LT (for "Less than").
//
// UI name: [Service level X]
//
// [AGENT_NON_RESPONSE]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response
// [Contacts agent hung up first]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first
// [Contacts hold disconnect]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect
// [Average queue abandon time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time
// [Contacts consulted]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted
// [API contacts handled]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled
// [Contacts transferred out]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out
// [Average queue answer time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time
// [Average agent interaction and customer hold time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time
// [Contacts handled outbound]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound
// [Average handle time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time
// [Average customer hold time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time
// [Callback contacts handled]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled
// [Service level X]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level
// [Contacts transferred in]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in
// [Contacts abandoned]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned
// [After contact work time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time
// [Contacts queued]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued
// [Occupancy]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy
// [Contacts handled incoming]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming
// [Minimum flow time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time
// [Contacts transferred out queue]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue
// [Contacts handled]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled
// [Average agent interaction time]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time
Name HistoricalMetricName
// The statistic for the metric.
Statistic Statistic
// The threshold for the metric, used with service level metrics.
Threshold *Threshold
// The unit for the metric.
Unit Unit
// contains filtered or unexported fields
}
Contains information about a historical metric.
type HistoricalMetricData ¶
type HistoricalMetricData struct {
// Information about the metric.
Metric *HistoricalMetric
// The value of the metric.
Value *float64
// contains filtered or unexported fields
}
Contains the data for a historical metric.
type HistoricalMetricName ¶
type HistoricalMetricName string
const ( HistoricalMetricNameContactsQueued HistoricalMetricName = "CONTACTS_QUEUED" HistoricalMetricNameContactsHandled HistoricalMetricName = "CONTACTS_HANDLED" HistoricalMetricNameContactsAbandoned HistoricalMetricName = "CONTACTS_ABANDONED" HistoricalMetricNameContactsConsulted HistoricalMetricName = "CONTACTS_CONSULTED" HistoricalMetricNameContactsAgentHungUpFirst HistoricalMetricName = "CONTACTS_AGENT_HUNG_UP_FIRST" HistoricalMetricNameContactsHandledIncoming HistoricalMetricName = "CONTACTS_HANDLED_INCOMING" HistoricalMetricNameContactsHandledOutbound HistoricalMetricName = "CONTACTS_HANDLED_OUTBOUND" HistoricalMetricNameContactsHoldAbandons HistoricalMetricName = "CONTACTS_HOLD_ABANDONS" HistoricalMetricNameContactsTransferredIn HistoricalMetricName = "CONTACTS_TRANSFERRED_IN" HistoricalMetricNameContactsTransferredOut HistoricalMetricName = "CONTACTS_TRANSFERRED_OUT" HistoricalMetricNameContactsTransferredInFromQueue HistoricalMetricName = "CONTACTS_TRANSFERRED_IN_FROM_QUEUE" HistoricalMetricNameContactsTransferredOutFromQueue HistoricalMetricName = "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE" HistoricalMetricNameContactsMissed HistoricalMetricName = "CONTACTS_MISSED" HistoricalMetricNameCallbackContactsHandled HistoricalMetricName = "CALLBACK_CONTACTS_HANDLED" HistoricalMetricNameApiContactsHandled HistoricalMetricName = "API_CONTACTS_HANDLED" HistoricalMetricNameOccupancy HistoricalMetricName = "OCCUPANCY" HistoricalMetricNameHandleTime HistoricalMetricName = "HANDLE_TIME" HistoricalMetricNameAfterContactWorkTime HistoricalMetricName = "AFTER_CONTACT_WORK_TIME" HistoricalMetricNameQueuedTime HistoricalMetricName = "QUEUED_TIME" HistoricalMetricNameAbandonTime HistoricalMetricName = "ABANDON_TIME" HistoricalMetricNameQueueAnswerTime HistoricalMetricName = "QUEUE_ANSWER_TIME" HistoricalMetricNameHoldTime HistoricalMetricName = "HOLD_TIME" HistoricalMetricNameInteractionTime HistoricalMetricName = "INTERACTION_TIME" HistoricalMetricNameInteractionAndHoldTime HistoricalMetricName = "INTERACTION_AND_HOLD_TIME" HistoricalMetricNameServiceLevel HistoricalMetricName = "SERVICE_LEVEL" )
Enum values for HistoricalMetricName
func (HistoricalMetricName) Values ¶
func (HistoricalMetricName) Values() []HistoricalMetricName
Values returns all known values for HistoricalMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type HistoricalMetricResult ¶
type HistoricalMetricResult struct {
// The set of metrics.
Collections []HistoricalMetricData
// The dimension for the metrics.
Dimensions *Dimensions
// contains filtered or unexported fields
}
Contains information about the historical metrics retrieved.
type HoursOfOperation ¶
type HoursOfOperation struct {
// Configuration information for the hours of operation.
Config []HoursOfOperationConfig
// The description for the hours of operation.
Description *string
// The Amazon Resource Name (ARN) for the hours of operation.
HoursOfOperationArn *string
// The identifier for the hours of operation.
HoursOfOperationId *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name for the hours of operation.
Name *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The time zone for the hours of operation.
TimeZone *string
// contains filtered or unexported fields
}
Information about of the hours of operation.
type HoursOfOperationConfig ¶
type HoursOfOperationConfig struct {
// The day that the hours of operation applies to.
//
// This member is required.
Day HoursOfOperationDays
// The end time that your contact center closes.
//
// This member is required.
EndTime *HoursOfOperationTimeSlice
// The start time that your contact center opens.
//
// This member is required.
StartTime *HoursOfOperationTimeSlice
// contains filtered or unexported fields
}
Contains information about the hours of operation.
type HoursOfOperationDays ¶
type HoursOfOperationDays string
const ( HoursOfOperationDaysSunday HoursOfOperationDays = "SUNDAY" HoursOfOperationDaysMonday HoursOfOperationDays = "MONDAY" HoursOfOperationDaysTuesday HoursOfOperationDays = "TUESDAY" HoursOfOperationDaysWednesday HoursOfOperationDays = "WEDNESDAY" HoursOfOperationDaysThursday HoursOfOperationDays = "THURSDAY" HoursOfOperationDaysFriday HoursOfOperationDays = "FRIDAY" HoursOfOperationDaysSaturday HoursOfOperationDays = "SATURDAY" )
Enum values for HoursOfOperationDays
func (HoursOfOperationDays) Values ¶
func (HoursOfOperationDays) Values() []HoursOfOperationDays
Values returns all known values for HoursOfOperationDays. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type HoursOfOperationOverride ¶
type HoursOfOperationOverride struct {
// Configuration information for the hours of operation override: day, start time,
// and end time.
Config []HoursOfOperationOverrideConfig
// The description of the hours of operation override.
Description *string
// The date from which the hours of operation override would be effective.
EffectiveFrom *string
// The date until the hours of operation override is effective.
EffectiveTill *string
// The Amazon Resource Name (ARN) for the hours of operation.
HoursOfOperationArn *string
// The identifier for the hours of operation.
HoursOfOperationId *string
// The identifier for the hours of operation override.
HoursOfOperationOverrideId *string
// The name of the hours of operation override.
Name *string
// contains filtered or unexported fields
}
Information about the hours of operations override.
type HoursOfOperationOverrideConfig ¶
type HoursOfOperationOverrideConfig struct {
// The day that the hours of operation override applies to.
Day OverrideDays
// The end time that your contact center closes if overrides are applied.
EndTime *OverrideTimeSlice
// The start time when your contact center opens if overrides are applied.
StartTime *OverrideTimeSlice
// contains filtered or unexported fields
}
Information about the hours of operation override config: day, start time, and end time.
type HoursOfOperationOverrideSearchCriteria ¶
type HoursOfOperationOverrideSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []HoursOfOperationOverrideSearchCriteria
// A leaf node condition which can be used to specify a date condition.
DateCondition *DateCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []HoursOfOperationOverrideSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return hours of operations overrides.
type HoursOfOperationSearchCriteria ¶
type HoursOfOperationSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []HoursOfOperationSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []HoursOfOperationSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , description , timezone ,
// and resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return hours of operations.
type HoursOfOperationSearchFilter ¶
type HoursOfOperationSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type HoursOfOperationSummary ¶
type HoursOfOperationSummary struct {
// The Amazon Resource Name (ARN) of the hours of operation.
Arn *string
// The identifier of the hours of operation.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the hours of operation.
Name *string
// contains filtered or unexported fields
}
Contains summary information about hours of operation for a contact center.
type HoursOfOperationTimeSlice ¶
type HoursOfOperationTimeSlice struct {
// The hours.
//
// This member is required.
Hours *int32
// The minutes.
//
// This member is required.
Minutes *int32
// contains filtered or unexported fields
}
The start time or end time for an hours of operation.
type IdempotencyException ¶
type IdempotencyException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
An entity with the same name already exists.
func (*IdempotencyException) Error ¶
func (e *IdempotencyException) Error() string
func (*IdempotencyException) ErrorCode ¶
func (e *IdempotencyException) ErrorCode() string
func (*IdempotencyException) ErrorFault ¶
func (e *IdempotencyException) ErrorFault() smithy.ErrorFault
func (*IdempotencyException) ErrorMessage ¶
func (e *IdempotencyException) ErrorMessage() string
type ImagesLogo ¶
type ImagesLogo struct {
// The default logo image displayed in the workspace.
Default *string
// The favicon image displayed in the browser tab.
Favicon *string
// contains filtered or unexported fields
}
Contains logo image configuration for workspace themes.
type InboundAdditionalRecipients ¶
type InboundAdditionalRecipients struct {
// The additional recipients information present in cc list. You must have 1
// required recipient ( DestinationEmailAddress ). You can then specify up to 49
// additional recipients (across ToAddresses and CcAddresses ), for a total of 50
// recipients.
CcAddresses []EmailAddressInfo
// The additional recipients information present in to list. You must have 1
// required recipient ( DestinationEmailAddress ). You can then specify up to 49
// additional recipients (across ToAddresses and CcAddresses ), for a total of 50
// recipients.
ToAddresses []EmailAddressInfo
// contains filtered or unexported fields
}
Information about the additional TO and CC recipients of an inbound email contact.
You can include up to 50 email addresses in total, distributed across DestinationEmailAddress, ToAddresses , and CcAddresses . This total must include one required DestinationEmailAddress . You can then specify up to 49 addresses allocated across ToAddresses and CcAddresses as needed.
type InboundEmailContent ¶
type InboundEmailContent struct {
// The message source type, that is, RAW .
//
// This member is required.
MessageSourceType InboundMessageSourceType
// The raw email body content.
RawMessage *InboundRawMessage
// contains filtered or unexported fields
}
Information about email body content.
type InboundMessageSourceType ¶
type InboundMessageSourceType string
const ( InboundMessageSourceTypeRaw InboundMessageSourceType = "RAW" )
Enum values for InboundMessageSourceType
func (InboundMessageSourceType) Values ¶
func (InboundMessageSourceType) Values() []InboundMessageSourceType
Values returns all known values for InboundMessageSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InboundRawMessage ¶
type InboundRawMessage struct {
// The email message body.
//
// This member is required.
Body *string
// Type of content, that is, text/plain or text/html .
//
// This member is required.
ContentType *string
// The email subject.
//
// This member is required.
Subject *string
// Headers present in inbound email.
Headers map[string]string
// contains filtered or unexported fields
}
Information about the raw email body content.
type InitiateAs ¶
type InitiateAs string
const ( InitiateAsConnectedToUser InitiateAs = "CONNECTED_TO_USER" InitiateAsCompleted InitiateAs = "COMPLETED" )
Enum values for InitiateAs
func (InitiateAs) Values ¶
func (InitiateAs) Values() []InitiateAs
Values returns all known values for InitiateAs. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InputPredefinedAttributeConfiguration ¶
type InputPredefinedAttributeConfiguration struct {
// When this parameter is set to true, Amazon Connect enforces strict validation
// on the specific values, if the values are predefined in attributes. The contact
// will store only valid and predefined values for the predefined attribute key.
EnableValueValidationOnAssociation bool
// contains filtered or unexported fields
}
Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
type Instance ¶
type Instance struct {
// The Amazon Resource Name (ARN) of the instance.
Arn *string
// When the instance was created.
CreatedTime *time.Time
// The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource
// Name (ARN) of the instance.
//
// [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
Id *string
// The identity management type.
IdentityManagementType DirectoryType
// Whether inbound calls are enabled.
InboundCallsEnabled *bool
// This URL allows contact center users to access the Amazon Connect admin website.
InstanceAccessUrl *string
// The alias of instance.
InstanceAlias *string
// The state of the instance.
InstanceStatus InstanceStatus
// Whether outbound calls are enabled.
OutboundCallsEnabled *bool
// The service role of the instance.
ServiceRole *string
// Relevant details why the instance was not successfully created.
StatusReason *InstanceStatusReason
// The tags of an instance.
Tags map[string]string
// contains filtered or unexported fields
}
The Amazon Connect instance.
type InstanceAttributeType ¶
type InstanceAttributeType string
const ( InstanceAttributeTypeInboundCalls InstanceAttributeType = "INBOUND_CALLS" InstanceAttributeTypeOutboundCalls InstanceAttributeType = "OUTBOUND_CALLS" InstanceAttributeTypeContactflowLogs InstanceAttributeType = "CONTACTFLOW_LOGS" InstanceAttributeTypeContactLens InstanceAttributeType = "CONTACT_LENS" InstanceAttributeTypeAutoResolveBestVoices InstanceAttributeType = "AUTO_RESOLVE_BEST_VOICES" InstanceAttributeTypeUseCustomTtsVoices InstanceAttributeType = "USE_CUSTOM_TTS_VOICES" InstanceAttributeTypeEarlyMedia InstanceAttributeType = "EARLY_MEDIA" InstanceAttributeTypeMultiPartyConference InstanceAttributeType = "MULTI_PARTY_CONFERENCE" InstanceAttributeTypeHighVolumeOutbound InstanceAttributeType = "HIGH_VOLUME_OUTBOUND" InstanceAttributeTypeEnhancedContactMonitoring InstanceAttributeType = "ENHANCED_CONTACT_MONITORING" InstanceAttributeTypeEnhancedChatMonitoring InstanceAttributeType = "ENHANCED_CHAT_MONITORING" InstanceAttributeTypeMultiPartyChatConference InstanceAttributeType = "MULTI_PARTY_CHAT_CONFERENCE" InstanceAttributeTypeMessageStreaming InstanceAttributeType = "MESSAGE_STREAMING" )
Enum values for InstanceAttributeType
func (InstanceAttributeType) Values ¶
func (InstanceAttributeType) Values() []InstanceAttributeType
Values returns all known values for InstanceAttributeType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InstanceReplicationStatus ¶
type InstanceReplicationStatus string
const ( InstanceReplicationStatusInstanceReplicationComplete InstanceReplicationStatus = "INSTANCE_REPLICATION_COMPLETE" InstanceReplicationStatusInstanceReplicationInProgress InstanceReplicationStatus = "INSTANCE_REPLICATION_IN_PROGRESS" InstanceReplicationStatusInstanceReplicationFailed InstanceReplicationStatus = "INSTANCE_REPLICATION_FAILED" InstanceReplicationStatusInstanceReplicaDeleting InstanceReplicationStatus = "INSTANCE_REPLICA_DELETING" InstanceReplicationStatusInstanceReplicationDeletionFailed InstanceReplicationStatus = "INSTANCE_REPLICATION_DELETION_FAILED" InstanceReplicationStatusResourceReplicationNotStarted InstanceReplicationStatus = "RESOURCE_REPLICATION_NOT_STARTED" )
Enum values for InstanceReplicationStatus
func (InstanceReplicationStatus) Values ¶
func (InstanceReplicationStatus) Values() []InstanceReplicationStatus
Values returns all known values for InstanceReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InstanceStatus ¶
type InstanceStatus string
const ( InstanceStatusCreationInProgress InstanceStatus = "CREATION_IN_PROGRESS" InstanceStatusActive InstanceStatus = "ACTIVE" InstanceStatusCreationFailed InstanceStatus = "CREATION_FAILED" )
Enum values for InstanceStatus
func (InstanceStatus) Values ¶
func (InstanceStatus) Values() []InstanceStatus
Values returns all known values for InstanceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InstanceStatusReason ¶
type InstanceStatusReason struct {
// The message.
Message *string
// contains filtered or unexported fields
}
Relevant details why the instance was not successfully created.
type InstanceStorageConfig ¶
type InstanceStorageConfig struct {
// A valid storage type.
//
// This member is required.
StorageType StorageType
// The existing association identifier that uniquely identifies the resource type
// and storage config for the given instance ID.
AssociationId *string
// The configuration of the Kinesis Firehose delivery stream.
KinesisFirehoseConfig *KinesisFirehoseConfig
// The configuration of the Kinesis data stream.
KinesisStreamConfig *KinesisStreamConfig
// The configuration of the Kinesis video stream.
KinesisVideoStreamConfig *KinesisVideoStreamConfig
// The S3 bucket configuration.
S3Config *S3Config
// contains filtered or unexported fields
}
The storage configuration for the instance.
type InstanceStorageResourceType ¶
type InstanceStorageResourceType string
const ( InstanceStorageResourceTypeChatTranscripts InstanceStorageResourceType = "CHAT_TRANSCRIPTS" InstanceStorageResourceTypeCallRecordings InstanceStorageResourceType = "CALL_RECORDINGS" InstanceStorageResourceTypeScheduledReports InstanceStorageResourceType = "SCHEDULED_REPORTS" InstanceStorageResourceTypeMediaStreams InstanceStorageResourceType = "MEDIA_STREAMS" InstanceStorageResourceTypeContactTraceRecords InstanceStorageResourceType = "CONTACT_TRACE_RECORDS" InstanceStorageResourceTypeAgentEvents InstanceStorageResourceType = "AGENT_EVENTS" InstanceStorageResourceTypeRealTimeContactAnalysisSegments InstanceStorageResourceType = "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" InstanceStorageResourceTypeAttachments InstanceStorageResourceType = "ATTACHMENTS" InstanceStorageResourceTypeContactEvaluations InstanceStorageResourceType = "CONTACT_EVALUATIONS" InstanceStorageResourceTypeScreenRecordings InstanceStorageResourceType = "SCREEN_RECORDINGS" InstanceStorageResourceTypeRealTimeContactAnalysisChatSegments InstanceStorageResourceType = "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" InstanceStorageResourceTypeRealTimeContactAnalysisVoiceSegments InstanceStorageResourceType = "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS" InstanceStorageResourceTypeEmailMessages InstanceStorageResourceType = "EMAIL_MESSAGES" )
Enum values for InstanceStorageResourceType
func (InstanceStorageResourceType) Values ¶
func (InstanceStorageResourceType) Values() []InstanceStorageResourceType
Values returns all known values for InstanceStorageResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InstanceSummary ¶
type InstanceSummary struct {
// The Amazon Resource Name (ARN) of the instance.
Arn *string
// When the instance was created.
CreatedTime *time.Time
// The identifier of the instance.
Id *string
// The identity management type of the instance.
IdentityManagementType DirectoryType
// Whether inbound calls are enabled.
InboundCallsEnabled *bool
// This URL allows contact center users to access the Amazon Connect admin website.
InstanceAccessUrl *string
// The alias of the instance.
InstanceAlias *string
// The state of the instance.
InstanceStatus InstanceStatus
// Whether outbound calls are enabled.
OutboundCallsEnabled *bool
// The service role of the instance.
ServiceRole *string
// contains filtered or unexported fields
}
Information about the instance.
type IntegrationAssociationSummary ¶
type IntegrationAssociationSummary struct {
// The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource
// Name (ARN) of the instance.
//
// [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
InstanceId *string
// The Amazon Resource Name (ARN) for the AppIntegration.
IntegrationArn *string
// The Amazon Resource Name (ARN) for the AppIntegration association.
IntegrationAssociationArn *string
// The identifier for the AppIntegration association.
IntegrationAssociationId *string
// The integration type.
IntegrationType IntegrationType
// The user-provided, friendly name for the external application.
SourceApplicationName *string
// The URL for the external application.
SourceApplicationUrl *string
// The name of the source.
SourceType SourceType
// contains filtered or unexported fields
}
Contains summary information about the associated AppIntegrations.
type IntegrationType ¶
type IntegrationType string
const ( IntegrationTypeEvent IntegrationType = "EVENT" IntegrationTypeVoiceId IntegrationType = "VOICE_ID" IntegrationTypePinpointApp IntegrationType = "PINPOINT_APP" IntegrationTypeWisdomAssistant IntegrationType = "WISDOM_ASSISTANT" IntegrationTypeWisdomKnowledgeBase IntegrationType = "WISDOM_KNOWLEDGE_BASE" IntegrationTypeWisdomQuickResponses IntegrationType = "WISDOM_QUICK_RESPONSES" IntegrationTypeQMessageTemplates IntegrationType = "Q_MESSAGE_TEMPLATES" IntegrationTypeCasesDomain IntegrationType = "CASES_DOMAIN" IntegrationTypeApplication IntegrationType = "APPLICATION" IntegrationTypeFileScanner IntegrationType = "FILE_SCANNER" IntegrationTypeSesIdentity IntegrationType = "SES_IDENTITY" IntegrationTypeAnalyticsConnector IntegrationType = "ANALYTICS_CONNECTOR" IntegrationTypeCallTransferConnector IntegrationType = "CALL_TRANSFER_CONNECTOR" IntegrationTypeCognitoUserPool IntegrationType = "COGNITO_USER_POOL" IntegrationTypeMessageProcessor IntegrationType = "MESSAGE_PROCESSOR" )
Enum values for IntegrationType
func (IntegrationType) Values ¶
func (IntegrationType) Values() []IntegrationType
Values returns all known values for IntegrationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InternalServiceException ¶
type InternalServiceException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Request processing failed because of an error or failure with the service.
func (*InternalServiceException) Error ¶
func (e *InternalServiceException) Error() string
func (*InternalServiceException) ErrorCode ¶
func (e *InternalServiceException) ErrorCode() string
func (*InternalServiceException) ErrorFault ¶
func (e *InternalServiceException) ErrorFault() smithy.ErrorFault
func (*InternalServiceException) ErrorMessage ¶
func (e *InternalServiceException) ErrorMessage() string
type IntervalDetails ¶
type IntervalDetails struct {
// IntervalPeriod : An aggregated grouping applied to request metrics. Valid
// IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL
// .
//
// For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and EndTime
// differs by 1 day, then Amazon Connect returns 48 results in the response. Each
// result is aggregated by the THIRTY_MIN period. By default Amazon Connect
// aggregates results based on the TOTAL interval period.
//
// The following list describes restrictions on StartTime and EndTime based on
// what IntervalPeriod is requested.
//
// - FIFTEEN_MIN : The difference between StartTime and EndTime must be less than
// 3 days.
//
// - THIRTY_MIN : The difference between StartTime and EndTime must be less than
// 3 days.
//
// - HOUR : The difference between StartTime and EndTime must be less than 3 days.
//
// - DAY : The difference between StartTime and EndTime must be less than 35 days.
//
// - WEEK : The difference between StartTime and EndTime must be less than 35
// days.
//
// - TOTAL : The difference between StartTime and EndTime must be less than 35
// days.
IntervalPeriod IntervalPeriod
// The timezone applied to requested metrics.
TimeZone *string
// contains filtered or unexported fields
}
Information about the interval period to use for returning results.
type IntervalPeriod ¶
type IntervalPeriod string
const ( IntervalPeriodFifteenMin IntervalPeriod = "FIFTEEN_MIN" IntervalPeriodThirtyMin IntervalPeriod = "THIRTY_MIN" IntervalPeriodHour IntervalPeriod = "HOUR" IntervalPeriodDay IntervalPeriod = "DAY" IntervalPeriodWeek IntervalPeriod = "WEEK" IntervalPeriodTotal IntervalPeriod = "TOTAL" )
Enum values for IntervalPeriod
func (IntervalPeriod) Values ¶
func (IntervalPeriod) Values() []IntervalPeriod
Values returns all known values for IntervalPeriod. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InvalidContactFlowException ¶
type InvalidContactFlowException struct {
Message *string
ErrorCodeOverride *string
Problems []ProblemDetail
// contains filtered or unexported fields
}
The flow is not valid.
func (*InvalidContactFlowException) Error ¶
func (e *InvalidContactFlowException) Error() string
func (*InvalidContactFlowException) ErrorCode ¶
func (e *InvalidContactFlowException) ErrorCode() string
func (*InvalidContactFlowException) ErrorFault ¶
func (e *InvalidContactFlowException) ErrorFault() smithy.ErrorFault
func (*InvalidContactFlowException) ErrorMessage ¶
func (e *InvalidContactFlowException) ErrorMessage() string
type InvalidContactFlowModuleException ¶
type InvalidContactFlowModuleException struct {
Message *string
ErrorCodeOverride *string
Problems []ProblemDetail
// contains filtered or unexported fields
}
The problems with the module. Please fix before trying again.
func (*InvalidContactFlowModuleException) Error ¶
func (e *InvalidContactFlowModuleException) Error() string
func (*InvalidContactFlowModuleException) ErrorCode ¶
func (e *InvalidContactFlowModuleException) ErrorCode() string
func (*InvalidContactFlowModuleException) ErrorFault ¶
func (e *InvalidContactFlowModuleException) ErrorFault() smithy.ErrorFault
func (*InvalidContactFlowModuleException) ErrorMessage ¶
func (e *InvalidContactFlowModuleException) ErrorMessage() string
type InvalidParameterException ¶
type InvalidParameterException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
One or more of the specified parameters are not valid.
func (*InvalidParameterException) Error ¶
func (e *InvalidParameterException) Error() string
func (*InvalidParameterException) ErrorCode ¶
func (e *InvalidParameterException) ErrorCode() string
func (*InvalidParameterException) ErrorFault ¶
func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault
func (*InvalidParameterException) ErrorMessage ¶
func (e *InvalidParameterException) ErrorMessage() string
type InvalidRequestException ¶
type InvalidRequestException struct {
Message *string
ErrorCodeOverride *string
Reason InvalidRequestExceptionReason
// contains filtered or unexported fields
}
The request is not valid.
func (*InvalidRequestException) Error ¶
func (e *InvalidRequestException) Error() string
func (*InvalidRequestException) ErrorCode ¶
func (e *InvalidRequestException) ErrorCode() string
func (*InvalidRequestException) ErrorFault ¶
func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
func (*InvalidRequestException) ErrorMessage ¶
func (e *InvalidRequestException) ErrorMessage() string
type InvalidRequestExceptionReason ¶
type InvalidRequestExceptionReason interface {
// contains filtered or unexported methods
}
Reason why the request was invalid.
The following types satisfy this interface:
InvalidRequestExceptionReasonMemberAttachedFileInvalidRequestExceptionReason
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.InvalidRequestExceptionReason
// type switches can be used to check the union value
switch v := union.(type) {
case *types.InvalidRequestExceptionReasonMemberAttachedFileInvalidRequestExceptionReason:
_ = v.Value // Value is types.AttachedFileInvalidRequestExceptionReason
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type InvalidRequestExceptionReasonMemberAttachedFileInvalidRequestExceptionReason ¶
type InvalidRequestExceptionReasonMemberAttachedFileInvalidRequestExceptionReason struct {
Value AttachedFileInvalidRequestExceptionReason
// contains filtered or unexported fields
}
Reason why the StartAttachedFiledUpload request was invalid.
type InvisibleFieldInfo ¶
type InvisibleFieldInfo struct {
// Identifier of the invisible field.
Id *TaskTemplateFieldIdentifier
// contains filtered or unexported fields
}
A field that is invisible to an agent.
type IvrRecordingTrack ¶
type IvrRecordingTrack string
const ( IvrRecordingTrackAll IvrRecordingTrack = "ALL" )
Enum values for IvrRecordingTrack
func (IvrRecordingTrack) Values ¶
func (IvrRecordingTrack) Values() []IvrRecordingTrack
Values returns all known values for IvrRecordingTrack. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type KinesisFirehoseConfig ¶
type KinesisFirehoseConfig struct {
// The Amazon Resource Name (ARN) of the delivery stream.
//
// This member is required.
FirehoseArn *string
// contains filtered or unexported fields
}
Configuration information of a Kinesis Data Firehose delivery stream.
type KinesisStreamConfig ¶
type KinesisStreamConfig struct {
// The Amazon Resource Name (ARN) of the data stream.
//
// This member is required.
StreamArn *string
// contains filtered or unexported fields
}
Configuration information of a Kinesis data stream.
type KinesisVideoStreamConfig ¶
type KinesisVideoStreamConfig struct {
// The encryption configuration.
//
// This member is required.
EncryptionConfig *EncryptionConfig
// The prefix of the video stream.
//
// This member is required.
Prefix *string
// The number of hours data is retained in the stream. Kinesis Video Streams
// retains the data in a data store that is associated with the stream.
//
// The default value is 0, indicating that the stream does not persist data.
//
// This member is required.
RetentionPeriodHours int32
// contains filtered or unexported fields
}
Configuration information of a Kinesis video stream.
type LexBot ¶
type LexBot struct {
// The Amazon Web Services Region where the Amazon Lex bot was created.
//
// This member is required.
LexRegion *string
// The name of the Amazon Lex bot.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
Configuration information of an Amazon Lex bot.
type LexBotConfig ¶
type LexBotConfig struct {
// Configuration information of an Amazon Lex bot.
LexBot *LexBot
// Configuration information of an Amazon Lex V2 bot.
LexV2Bot *LexV2Bot
// contains filtered or unexported fields
}
Configuration information of an Amazon Lex or Amazon Lex V2 bot.
type LexV2Bot ¶
type LexV2Bot struct {
// The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
AliasArn *string
// contains filtered or unexported fields
}
Configuration information of an Amazon Lex V2 bot.
type LexVersion ¶
type LexVersion string
const ( LexVersionV1 LexVersion = "V1" LexVersionV2 LexVersion = "V2" )
Enum values for LexVersion
func (LexVersion) Values ¶
func (LexVersion) Values() []LexVersion
Values returns all known values for LexVersion. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type LimitExceededException ¶
type LimitExceededException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The allowed limit for the resource has been exceeded.
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
type ListCondition ¶
type ListCondition struct {
// A list of Condition objects which would be applied together with an AND
// condition.
Conditions []Condition
// The type of target list that will be used to filter the users.
TargetListType TargetListType
// contains filtered or unexported fields
}
A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
type ListFlowAssociationResourceType ¶
type ListFlowAssociationResourceType string
const ( ListFlowAssociationResourceTypeWhatsappMessagingPhoneNumber ListFlowAssociationResourceType = "WHATSAPP_MESSAGING_PHONE_NUMBER" ListFlowAssociationResourceTypeVoicePhoneNumber ListFlowAssociationResourceType = "VOICE_PHONE_NUMBER" ListFlowAssociationResourceTypeInboundEmail ListFlowAssociationResourceType = "INBOUND_EMAIL" ListFlowAssociationResourceTypeOutboundEmail ListFlowAssociationResourceType = "OUTBOUND_EMAIL" ListFlowAssociationResourceTypeAnalyticsConnector ListFlowAssociationResourceType = "ANALYTICS_CONNECTOR" )
Enum values for ListFlowAssociationResourceType
func (ListFlowAssociationResourceType) Values ¶
func (ListFlowAssociationResourceType) Values() []ListFlowAssociationResourceType
Values returns all known values for ListFlowAssociationResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ListPhoneNumbersSummary ¶
type ListPhoneNumbersSummary struct {
// The identifier of the Amazon Connect instance that phone numbers are claimed
// to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance.
//
// [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
InstanceId *string
// The phone number. Phone numbers are formatted [+] [country code] [subscriber
// number including area code] .
PhoneNumber *string
// The Amazon Resource Name (ARN) of the phone number.
PhoneNumberArn *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The description of the phone number.
PhoneNumberDescription *string
// A unique identifier for the phone number.
PhoneNumberId *string
// The type of phone number.
PhoneNumberType PhoneNumberType
// The claimed phone number ARN that was previously imported from the external
// service, such as Amazon Web Services End User Messaging. If it is from Amazon
// Web Services End User Messaging, it looks like the ARN of the phone number that
// was imported from Amazon Web Services End User Messaging.
SourcePhoneNumberArn *string
// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
// distribution groups that phone number inbound traffic is routed through.
TargetArn *string
// contains filtered or unexported fields
}
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
type MatchCriteria ¶
type MatchCriteria struct {
// An object to define agentIds.
AgentsCriteria *AgentsCriteria
// contains filtered or unexported fields
}
An object to define AgentsCriteria.
type MaximumResultReturnedException ¶
type MaximumResultReturnedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
func (*MaximumResultReturnedException) Error ¶
func (e *MaximumResultReturnedException) Error() string
func (*MaximumResultReturnedException) ErrorCode ¶
func (e *MaximumResultReturnedException) ErrorCode() string
func (*MaximumResultReturnedException) ErrorFault ¶
func (e *MaximumResultReturnedException) ErrorFault() smithy.ErrorFault
func (*MaximumResultReturnedException) ErrorMessage ¶
func (e *MaximumResultReturnedException) ErrorMessage() string
type MediaConcurrency ¶
type MediaConcurrency struct {
// The channels that agents can handle in the Contact Control Panel (CCP).
//
// This member is required.
Channel Channel
// The number of contacts an agent can have on a channel simultaneously.
//
// Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
//
// Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
//
// Valid Range for TASK : Minimum value of 1. Maximum value of 10.
//
// This member is required.
Concurrency *int32
// Defines the cross-channel routing behavior for each channel that is enabled for
// this Routing Profile. For example, this allows you to offer an agent a different
// contact from another channel when they are currently working with a contact from
// a Voice channel.
CrossChannelBehavior *CrossChannelBehavior
// contains filtered or unexported fields
}
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
type MediaItem ¶
type MediaItem struct {
// The source URL or data for the media asset.
Source *string
// The type of media. Valid values are: IMAGE_LOGO_FAVICON and
// IMAGE_LOGO_HORIZONTAL .
Type MediaType
// contains filtered or unexported fields
}
Contains information about a media asset used in a workspace.
type MediaPlacement ¶
type MediaPlacement struct {
// The audio fallback URL.
AudioFallbackUrl *string
// The audio host URL.
AudioHostUrl *string
// The event ingestion URL to which you send client meeting events.
EventIngestionUrl *string
// The signaling URL.
SignalingUrl *string
// The turn control URL.
TurnControlUrl *string
// contains filtered or unexported fields
}
A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
type MediaStreamType ¶
type MediaStreamType string
const ( MediaStreamTypeAudio MediaStreamType = "AUDIO" MediaStreamTypeVideo MediaStreamType = "VIDEO" )
Enum values for MediaStreamType
func (MediaStreamType) Values ¶
func (MediaStreamType) Values() []MediaStreamType
Values returns all known values for MediaStreamType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MediaType ¶
type MediaType string
const ( MediaTypeImageLogoLightFavicon MediaType = "IMAGE_LOGO_LIGHT_FAVICON" MediaTypeImageLogoDarkFavicon MediaType = "IMAGE_LOGO_DARK_FAVICON" MediaTypeImageLogoLightHorizontal MediaType = "IMAGE_LOGO_LIGHT_HORIZONTAL" MediaTypeImageLogoDarkHorizontal MediaType = "IMAGE_LOGO_DARK_HORIZONTAL" )
Enum values for MediaType
func (MediaType) Values ¶
Values returns all known values for MediaType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Meeting ¶
type Meeting struct {
// The media placement for the meeting.
MediaPlacement *MediaPlacement
// The Amazon Web Services Region in which you create the meeting.
MediaRegion *string
// The configuration settings of the features available to a meeting.
MeetingFeatures *MeetingFeaturesConfiguration
// The Amazon Chime SDK meeting ID.
MeetingId *string
// contains filtered or unexported fields
}
A meeting created using the Amazon Chime SDK.
type MeetingFeatureStatus ¶
type MeetingFeatureStatus string
const ( MeetingFeatureStatusAvailable MeetingFeatureStatus = "AVAILABLE" MeetingFeatureStatus = "UNAVAILABLE" )
Enum values for MeetingFeatureStatus
func (MeetingFeatureStatus) Values ¶
func (MeetingFeatureStatus) Values() []MeetingFeatureStatus
Values returns all known values for MeetingFeatureStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MeetingFeaturesConfiguration ¶
type MeetingFeaturesConfiguration struct {
// The configuration settings for the audio features available to a meeting.
Audio *AudioFeatures
// contains filtered or unexported fields
}
The configuration settings of the features available to a meeting.
type MetricDataV2 ¶
type MetricDataV2 struct {
// The metric name or metricId, thresholds, and metric filters of the returned
// metric.
Metric *MetricV2
// The corresponding value of the metric returned in the response.
Value *float64
// contains filtered or unexported fields
}
Contains the name, thresholds, and metric filters.
type MetricFilterV2 ¶
type MetricFilterV2 struct {
// The key to use for filtering data.
//
// Valid metric filter keys:
//
// - ANSWERING_MACHINE_DETECTION_STATUS
//
// - CASE_STATUS
//
// - DISCONNECT_REASON
//
// - FLOWS_ACTION_IDENTIFIER
//
// - FLOWS_NEXT_ACTION_IDENTIFIER
//
// - FLOWS_OUTCOME_TYPE
//
// - FLOWS_RESOURCE_TYPE
//
// - INITIATION_METHOD
MetricFilterKey *string
// The values to use for filtering data. Values for metric-level filters can be
// either a fixed set of values or a customized list, depending on the use case.
//
// For valid values of metric-level filters INITIATION_METHOD , DISCONNECT_REASON ,
// and ANSWERING_MACHINE_DETECTION_STATUS , see [ContactTraceRecord] in the Amazon Connect
// Administrator Guide.
//
// For valid values of the metric-level filter FLOWS_OUTCOME_TYPE , see the
// description for the [Flow outcome]metric in the Amazon Connect Administrator Guide.
//
// For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE , see
// the description for the [Bot conversations completed]in the Amazon Connect Administrator Guide.
//
// For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE , see the
// description for the [Bot intents completed]metric in the Amazon Connect Administrator Guide.
//
// [Bot intents completed]: https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric
// [ContactTraceRecord]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
// [Flow outcome]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome
// [Bot conversations completed]: https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric
MetricFilterValues []string
// If set to true , the API response contains results that filter out the results
// matched by the metric-level filters condition. By default, Negate is set to
// false .
Negate bool
// contains filtered or unexported fields
}
Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME , CONTACTS_CREATED , CONTACTS_HANDLED , SUM_CONTACTS_DISCONNECTED .
type MetricInterval ¶
type MetricInterval struct {
// The timestamp, in UNIX Epoch time format. End time is based on the interval
// period selected. For example, If IntervalPeriod is selected THIRTY_MIN ,
// StartTime and EndTime in the API request differs by 1 day, then 48 results are
// returned in the response. Each result is aggregated by the 30 minutes period,
// with each StartTime and EndTime differing by 30 minutes.
EndTime *time.Time
// The interval period provided in the API request.
Interval IntervalPeriod
// The timestamp, in UNIX Epoch time format. Start time is based on the interval
// period selected.
StartTime *time.Time
// contains filtered or unexported fields
}
The interval period with the start and end time for the metrics.
type MetricResultV2 ¶
type MetricResultV2 struct {
// The set of metrics.
Collections []MetricDataV2
// The dimension for the metrics.
Dimensions map[string]string
// The interval period with the start and end time for the metrics.
MetricInterval *MetricInterval
// contains filtered or unexported fields
}
Contains information about the metric results.
type MetricV2 ¶
type MetricV2 struct {
// Contains the filters to be used when returning data.
MetricFilters []MetricFilterV2
// Historical metrics or custom metrics can be referenced via this field. This
// field is a valid Amazon Connect Arn or a UUID
MetricId *string
// The name of the metric.
Name *string
// Contains information about the threshold for service level metrics.
Threshold []ThresholdV2
// contains filtered or unexported fields
}
Contains information about the metric.
Only one of either the Name or MetricId is required.
type MonitorCapability ¶
type MonitorCapability string
const ( MonitorCapabilitySilentMonitor MonitorCapability = "SILENT_MONITOR" MonitorCapabilityBarge MonitorCapability = "BARGE" )
Enum values for MonitorCapability
func (MonitorCapability) Values ¶
func (MonitorCapability) Values() []MonitorCapability
Values returns all known values for MonitorCapability. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MultiSelectQuestionRuleCategoryAutomation ¶
type MultiSelectQuestionRuleCategoryAutomation struct {
// The category name for this automation rule.
//
// This member is required.
Category *string
// The condition for this automation rule.
//
// This member is required.
Condition MultiSelectQuestionRuleCategoryAutomationCondition
// Reference IDs of options for this automation rule.
//
// This member is required.
OptionRefIds []string
// contains filtered or unexported fields
}
Automation rule for multi-select questions based on rule categories.
type MultiSelectQuestionRuleCategoryAutomationCondition ¶
type MultiSelectQuestionRuleCategoryAutomationCondition string
const ( MultiSelectQuestionRuleCategoryAutomationConditionPresent MultiSelectQuestionRuleCategoryAutomationCondition = "PRESENT" MultiSelectQuestionRuleCategoryAutomationConditionNotPresent MultiSelectQuestionRuleCategoryAutomationCondition = "NOT_PRESENT" )
Enum values for MultiSelectQuestionRuleCategoryAutomationCondition
func (MultiSelectQuestionRuleCategoryAutomationCondition) Values ¶
func (MultiSelectQuestionRuleCategoryAutomationCondition) Values() []MultiSelectQuestionRuleCategoryAutomationCondition
Values returns all known values for MultiSelectQuestionRuleCategoryAutomationCondition. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NameCriteria ¶
type NameCriteria struct {
// The match type combining name search criteria using multiple search texts in a
// name criteria.
//
// This member is required.
MatchType SearchContactsMatchType
// The words or phrases used to match the contact name.
//
// This member is required.
SearchText []string
// contains filtered or unexported fields
}
The search criteria based on the contact name
type NewSessionDetails ¶
type NewSessionDetails struct {
// A custom key-value pair using an attribute map. The attributes are standard
// Amazon Connect attributes. They can be accessed in flows just like any other
// contact attributes.
//
// There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact.
// Attribute keys can include only alphanumeric, dash, and underscore characters.
Attributes map[string]string
// The customer's details.
ParticipantDetails *ParticipantDetails
// The streaming configuration, such as the Amazon SNS streaming endpoint.
StreamingConfiguration *ChatStreamingConfiguration
// The supported chat message content types. Supported types are text/plain ,
// text/markdown , application/json ,
// application/vnd.amazonaws.connect.message.interactive , and
// application/vnd.amazonaws.connect.message.interactive.response .
//
// Content types must always contain text/plain . You can then put any other
// supported type in the list. For example, all the following lists are valid
// because they contain text/plain : [text/plain, text/markdown, application/json]
// , [text/markdown, text/plain] , [text/plain, application/json,
// application/vnd.amazonaws.connect.message.interactive.response] .
SupportedMessagingContentTypes []string
// contains filtered or unexported fields
}
Payload of chat properties to apply when starting a new contact.
type NextContactEntry ¶
type NextContactEntry struct {
// Metadata for the next contact entry.
NextContactMetadata NextContactMetadata
// The type of the next contact entry.
Type NextContactType
// contains filtered or unexported fields
}
Entry representing the next contact in a sequence.
type NextContactMetadata ¶
type NextContactMetadata interface {
// contains filtered or unexported methods
}
Metadata information for next contact.
The following types satisfy this interface:
NextContactMetadataMemberQuickConnectContactData
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.NextContactMetadata
// type switches can be used to check the union value
switch v := union.(type) {
case *types.NextContactMetadataMemberQuickConnectContactData:
_ = v.Value // Value is types.QuickConnectContactData
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type NextContactMetadataMemberQuickConnectContactData ¶
type NextContactMetadataMemberQuickConnectContactData struct {
Value QuickConnectContactData
// contains filtered or unexported fields
}
Quick connect contact data for the next contact metadata.
type NextContactType ¶
type NextContactType string
const ( NextContactTypeQuickConnect NextContactType = "QUICK_CONNECT" )
Enum values for NextContactType
func (NextContactType) Values ¶
func (NextContactType) Values() []NextContactType
Values returns all known values for NextContactType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NotificationContentType ¶
type NotificationContentType string
const ( NotificationContentTypePlainText NotificationContentType = "PLAIN_TEXT" )
Enum values for NotificationContentType
func (NotificationContentType) Values ¶
func (NotificationContentType) Values() []NotificationContentType
Values returns all known values for NotificationContentType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NotificationDeliveryType ¶
type NotificationDeliveryType string
const ( NotificationDeliveryTypeEmail NotificationDeliveryType = "EMAIL" )
Enum values for NotificationDeliveryType
func (NotificationDeliveryType) Values ¶
func (NotificationDeliveryType) Values() []NotificationDeliveryType
Values returns all known values for NotificationDeliveryType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NotificationRecipientType ¶
type NotificationRecipientType struct {
// A list of user IDs. Supports variable injection of
// $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit
// event source.
UserIds []string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users
// with the specified tags will be notified.
UserTags map[string]string
// contains filtered or unexported fields
}
The type of notification recipient.
type NumberComparisonType ¶
type NumberComparisonType string
const ( NumberComparisonTypeGreaterOrEqual NumberComparisonType = "GREATER_OR_EQUAL" NumberComparisonTypeGreater NumberComparisonType = "GREATER" NumberComparisonTypeLesserOrEqual NumberComparisonType = "LESSER_OR_EQUAL" NumberComparisonTypeLesser NumberComparisonType = "LESSER" NumberComparisonTypeEqual NumberComparisonType = "EQUAL" NumberComparisonTypeNotEqual NumberComparisonType = "NOT_EQUAL" NumberComparisonTypeRange NumberComparisonType = "RANGE" )
Enum values for NumberComparisonType
func (NumberComparisonType) Values ¶
func (NumberComparisonType) Values() []NumberComparisonType
Values returns all known values for NumberComparisonType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NumberCondition ¶
type NumberCondition struct {
// The type of comparison to be made when evaluating the number condition.
ComparisonType NumberComparisonType
// The name of the field in the number condition.
FieldName *string
// The maxValue to be used while evaluating the number condition.
MaxValue *int32
// The minValue to be used while evaluating the number condition.
MinValue *int32
// contains filtered or unexported fields
}
A leaf node condition which can be used to specify a numeric condition.
The currently supported value for FieldName is limit .
type NumberReference ¶
type NumberReference struct {
// Identifier of the number reference.
Name *string
// A valid number.
Value *string
// contains filtered or unexported fields
}
Information about a reference when the referenceType is NUMBER . Otherwise, null.
type NumericQuestionPropertyAutomationLabel ¶
type NumericQuestionPropertyAutomationLabel string
const ( NumericQuestionPropertyAutomationLabelOverallCustomerSentimentScore NumericQuestionPropertyAutomationLabel = "OVERALL_CUSTOMER_SENTIMENT_SCORE" NumericQuestionPropertyAutomationLabelOverallAgentSentimentScore NumericQuestionPropertyAutomationLabel = "OVERALL_AGENT_SENTIMENT_SCORE" NumericQuestionPropertyAutomationLabelCustomerSentimentScoreWithoutAgent NumericQuestionPropertyAutomationLabel = "CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT" NumericQuestionPropertyAutomationLabelCustomerSentimentScoreWithAgent NumericQuestionPropertyAutomationLabel = "CUSTOMER_SENTIMENT_SCORE_WITH_AGENT" NumericQuestionPropertyAutomationLabelNonTalkTime NumericQuestionPropertyAutomationLabel = "NON_TALK_TIME" NumericQuestionPropertyAutomationLabelNonTalkTimePercentage NumericQuestionPropertyAutomationLabel = "NON_TALK_TIME_PERCENTAGE" NumericQuestionPropertyAutomationLabelNumberOfInterruptions NumericQuestionPropertyAutomationLabel = "NUMBER_OF_INTERRUPTIONS" NumericQuestionPropertyAutomationLabelContactDuration NumericQuestionPropertyAutomationLabel = "CONTACT_DURATION" NumericQuestionPropertyAutomationLabelAgentInteractionDuration NumericQuestionPropertyAutomationLabel = "AGENT_INTERACTION_DURATION" NumericQuestionPropertyAutomationLabelCustomerHoldTime NumericQuestionPropertyAutomationLabel = "CUSTOMER_HOLD_TIME" NumericQuestionPropertyAutomationLabelLongestHoldDuration NumericQuestionPropertyAutomationLabel = "LONGEST_HOLD_DURATION" NumericQuestionPropertyAutomationLabelNumberOfHolds NumericQuestionPropertyAutomationLabel = "NUMBER_OF_HOLDS" NumericQuestionPropertyAutomationLabelAgentInteractionAndHoldDuration NumericQuestionPropertyAutomationLabel = "AGENT_INTERACTION_AND_HOLD_DURATION" )
Enum values for NumericQuestionPropertyAutomationLabel
func (NumericQuestionPropertyAutomationLabel) Values ¶
func (NumericQuestionPropertyAutomationLabel) Values() []NumericQuestionPropertyAutomationLabel
Values returns all known values for NumericQuestionPropertyAutomationLabel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NumericQuestionPropertyValueAutomation ¶
type NumericQuestionPropertyValueAutomation struct {
// The property label of the automation.
//
// This member is required.
Label NumericQuestionPropertyAutomationLabel
// contains filtered or unexported fields
}
Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME , CONTACT_DURATION , AGENT_INTERACTION_DURATION , CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 63072000.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
type OperationalHour ¶
type OperationalHour struct {
// The end time that your contact center closes.
End *OverrideTimeSlice
// The start time that your contact center opens.
Start *OverrideTimeSlice
// contains filtered or unexported fields
}
Information about the hours of operations with the effective override applied.
type OutboundAdditionalRecipients ¶
type OutboundAdditionalRecipients struct {
// Information about the additional CC email address recipients. Email recipients
// are limited to 50 total addresses: 1 required recipient in the [DestinationEmailAddress]field and up to
// 49 recipients in the 'CcEmailAddresses' field.
//
// [DestinationEmailAddress]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SendOutboundEmail.html#API_SendOutboundEmail_RequestBody
CcEmailAddresses []EmailAddressInfo
// contains filtered or unexported fields
}
Information about the additional recipients of outbound email.
type OutboundCallerConfig ¶
type OutboundCallerConfig struct {
// The caller ID name.
OutboundCallerIdName *string
// The caller ID number.
OutboundCallerIdNumberId *string
// The outbound whisper flow to be used during an outbound call.
OutboundFlowId *string
// contains filtered or unexported fields
}
The outbound caller ID name, number, and outbound whisper flow.
type OutboundContactNotPermittedException ¶
type OutboundContactNotPermittedException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The contact is not permitted.
func (*OutboundContactNotPermittedException) Error ¶
func (e *OutboundContactNotPermittedException) Error() string
func (*OutboundContactNotPermittedException) ErrorCode ¶
func (e *OutboundContactNotPermittedException) ErrorCode() string
func (*OutboundContactNotPermittedException) ErrorFault ¶
func (e *OutboundContactNotPermittedException) ErrorFault() smithy.ErrorFault
func (*OutboundContactNotPermittedException) ErrorMessage ¶
func (e *OutboundContactNotPermittedException) ErrorMessage() string
type OutboundEmailConfig ¶
type OutboundEmailConfig struct {
// The identifier of the email address.
OutboundEmailAddressId *string
// contains filtered or unexported fields
}
The outbound email address ID.
type OutboundEmailContent ¶
type OutboundEmailContent struct {
// The message source type, that is, RAW or TEMPLATE .
//
// This member is required.
MessageSourceType OutboundMessageSourceType
// The raw email body content.
RawMessage *OutboundRawMessage
// Information about template message configuration.
TemplatedMessageConfig *TemplatedMessageConfig
// contains filtered or unexported fields
}
Information about email body content.
type OutboundMessageSourceType ¶
type OutboundMessageSourceType string
const ( OutboundMessageSourceTypeTemplate OutboundMessageSourceType = "TEMPLATE" OutboundMessageSourceTypeRaw OutboundMessageSourceType = "RAW" )
Enum values for OutboundMessageSourceType
func (OutboundMessageSourceType) Values ¶
func (OutboundMessageSourceType) Values() []OutboundMessageSourceType
Values returns all known values for OutboundMessageSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OutboundRawMessage ¶
type OutboundRawMessage struct {
// The email message body.
//
// This member is required.
Body *string
// Type of content, that is, text/plain or text/html .
//
// This member is required.
ContentType *string
// The email subject.
//
// This member is required.
Subject *string
// contains filtered or unexported fields
}
Information about the raw email body content.
type OutboundStrategy ¶
type OutboundStrategy struct {
// Type of the outbound strategy.
//
// This member is required.
Type OutboundStrategyType
// Config of the outbound strategy.
Config *OutboundStrategyConfig
// contains filtered or unexported fields
}
Information about the outbound strategy.
type OutboundStrategyConfig ¶
type OutboundStrategyConfig struct {
// The config of agent first outbound strategy.
AgentFirst *AgentFirst
// contains filtered or unexported fields
}
The config of the outbound strategy.
type OutboundStrategyType ¶
type OutboundStrategyType string
const ( OutboundStrategyTypeAgentFirst OutboundStrategyType = "AGENT_FIRST" )
Enum values for OutboundStrategyType
func (OutboundStrategyType) Values ¶
func (OutboundStrategyType) Values() []OutboundStrategyType
Values returns all known values for OutboundStrategyType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OutputTypeNotFoundException ¶
type OutputTypeNotFoundException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.
func (*OutputTypeNotFoundException) Error ¶
func (e *OutputTypeNotFoundException) Error() string
func (*OutputTypeNotFoundException) ErrorCode ¶
func (e *OutputTypeNotFoundException) ErrorCode() string
func (*OutputTypeNotFoundException) ErrorFault ¶
func (e *OutputTypeNotFoundException) ErrorFault() smithy.ErrorFault
func (*OutputTypeNotFoundException) ErrorMessage ¶
func (e *OutputTypeNotFoundException) ErrorMessage() string
type OverrideDays ¶
type OverrideDays string
const ( OverrideDaysSunday OverrideDays = "SUNDAY" OverrideDaysMonday OverrideDays = "MONDAY" OverrideDaysTuesday OverrideDays = "TUESDAY" OverrideDaysWednesday OverrideDays = "WEDNESDAY" OverrideDaysThursday OverrideDays = "THURSDAY" OverrideDaysFriday OverrideDays = "FRIDAY" OverrideDaysSaturday OverrideDays = "SATURDAY" )
Enum values for OverrideDays
func (OverrideDays) Values ¶
func (OverrideDays) Values() []OverrideDays
Values returns all known values for OverrideDays. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OverrideTimeSlice ¶
type OverrideTimeSlice struct {
// The hours.
//
// This member is required.
Hours *int32
// The minutes.
//
// This member is required.
Minutes *int32
// contains filtered or unexported fields
}
The start time or end time for an hours of operation override.
type PaletteCanvas ¶
type PaletteCanvas struct {
// The background color for active elements.
ActiveBackground *string
// The background color for container elements.
ContainerBackground *string
// The background color for page elements.
PageBackground *string
// contains filtered or unexported fields
}
Contains color configuration for canvas elements in a workspace theme.
type PaletteHeader ¶
type PaletteHeader struct {
// The background color of the header.
Background *string
// Whether to invert the colors of action buttons in the header.
InvertActionsColors bool
// The text color in the header.
Text *string
// The text color when hovering over header elements.
TextHover *string
// contains filtered or unexported fields
}
Contains color configuration for header elements in a workspace theme.
type PaletteNavigation ¶
type PaletteNavigation struct {
// The background color of the navigation area.
*string
// Whether to invert the colors of action buttons in the navigation area.
bool
// The text color in the navigation area.
*string
// The text color for active navigation items.
*string
// The background color for active navigation items.
*string
// The background color when hovering over navigation text.
*string
// The text color when hovering over navigation items.
*string
// contains filtered or unexported fields
}
Contains color configuration for navigation elements in a workspace theme.
type PalettePrimary ¶
type PalettePrimary struct {
// The primary color used for active states.
Active *string
// The text color that contrasts with the primary color for readability.
ContrastText *string
// The default primary color used throughout the workspace.
Default *string
// contains filtered or unexported fields
}
Contains primary color configuration for a workspace theme.
type ParticipantCapabilities ¶
type ParticipantCapabilities struct {
// The screen sharing capability that is enabled for the participant. SEND
// indicates the participant can share their screen.
ScreenShareCapability
// The configuration having the video and screen sharing capabilities for
// participants over the call.
Video VideoCapability
// contains filtered or unexported fields
}
The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilitiesin the Amazon Connect Administrator Guide.
type ParticipantConfiguration ¶
type ParticipantConfiguration struct {
// The mode in which responses should be sent to the participant.
ResponseMode ResponseMode
// contains filtered or unexported fields
}
The configuration of the participant.
type ParticipantDetails ¶
type ParticipantDetails struct {
// Display name of the participant.
//
// This member is required.
DisplayName *string
// contains filtered or unexported fields
}
The customer's details.
type ParticipantDetailsToAdd ¶
type ParticipantDetailsToAdd struct {
// The display name of the participant.
DisplayName *string
// The configuration for the allowed video and screen sharing capabilities for
// participants present over the call. For more information, see [Set up in-app, web, video calling, and screen sharing capabilities]in the Amazon
// Connect Administrator Guide.
//
// [Set up in-app, web, video calling, and screen sharing capabilities]: https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html
ParticipantCapabilities *ParticipantCapabilities
// The role of the participant being added.
ParticipantRole ParticipantRole
// contains filtered or unexported fields
}
The details to add for the participant.
type ParticipantMetrics ¶
type ParticipantMetrics struct {
// A boolean flag indicating whether the chat conversation was abandoned by a
// Participant.
ConversationAbandon *bool
// Timestamp of last chat message by Participant.
LastMessageTimestamp *time.Time
// Maximum chat response time by Participant.
MaxResponseTimeInMillis *int64
// Number of chat characters sent by Participant.
MessageLengthInChars *int32
// Number of chat messages sent by Participant.
MessagesSent *int32
// Number of chat messages sent by Participant.
NumResponses *int32
// The Participant's ID.
ParticipantId *string
// Information about the conversation participant. Following are the participant
// types: [Agent, Customer, Supervisor].
ParticipantType ParticipantType
// Total chat response time by Participant.
TotalResponseTimeInMillis *int64
// contains filtered or unexported fields
}
Information about a participant's interactions in a contact.
type ParticipantRole ¶
type ParticipantRole string
const ( ParticipantRoleAgent ParticipantRole = "AGENT" ParticipantRoleCustomer ParticipantRole = "CUSTOMER" ParticipantRoleSystem ParticipantRole = "SYSTEM" ParticipantRoleCustomBot ParticipantRole = "CUSTOM_BOT" ParticipantRoleSupervisor ParticipantRole = "SUPERVISOR" )
Enum values for ParticipantRole
func (ParticipantRole) Values ¶
func (ParticipantRole) Values() []ParticipantRole
Values returns all known values for ParticipantRole. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ParticipantState ¶
type ParticipantState string
const ( ParticipantStateInitial ParticipantState = "INITIAL" ParticipantStateConnected ParticipantState = "CONNECTED" ParticipantStateDisconnected ParticipantState = "DISCONNECTED" ParticipantStateMissed ParticipantState = "MISSED" )
Enum values for ParticipantState
func (ParticipantState) Values ¶
func (ParticipantState) Values() []ParticipantState
Values returns all known values for ParticipantState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ParticipantTimerAction ¶
type ParticipantTimerAction string
const ( ParticipantTimerActionUnset ParticipantTimerAction = "Unset" )
Enum values for ParticipantTimerAction
func (ParticipantTimerAction) Values ¶
func (ParticipantTimerAction) Values() []ParticipantTimerAction
Values returns all known values for ParticipantTimerAction. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ParticipantTimerConfiguration ¶
type ParticipantTimerConfiguration struct {
// The role of the participant in the chat conversation.
//
// This member is required.
ParticipantRole TimerEligibleParticipantRoles
// The type of timer. IDLE indicates the timer applies for considering a human
// chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to
// automatically disconnecting a chat participant due to idleness.
//
// This member is required.
TimerType ParticipantTimerType
// The value of the timer. Either the timer action (Unset to delete the timer), or
// the duration of the timer in minutes. Only one value can be set.
//
// This member is required.
TimerValue ParticipantTimerValue
// contains filtered or unexported fields
}
Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
type ParticipantTimerType ¶
type ParticipantTimerType string
const ( ParticipantTimerTypeIdle ParticipantTimerType = "IDLE" ParticipantTimerTypeDisconnectNoncustomer ParticipantTimerType = "DISCONNECT_NONCUSTOMER" )
Enum values for ParticipantTimerType
func (ParticipantTimerType) Values ¶
func (ParticipantTimerType) Values() []ParticipantTimerType
Values returns all known values for ParticipantTimerType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ParticipantTimerValue ¶
type ParticipantTimerValue interface {
// contains filtered or unexported methods
}
The value of the timer. Either the timer action ( Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
The following types satisfy this interface:
ParticipantTimerValueMemberParticipantTimerAction ParticipantTimerValueMemberParticipantTimerDurationInMinutes
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.ParticipantTimerValue
// type switches can be used to check the union value
switch v := union.(type) {
case *types.ParticipantTimerValueMemberParticipantTimerAction:
_ = v.Value // Value is types.ParticipantTimerAction
case *types.ParticipantTimerValueMemberParticipantTimerDurationInMinutes:
_ = v.Value // Value is int32
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type ParticipantTimerValueMemberParticipantTimerAction ¶
type ParticipantTimerValueMemberParticipantTimerAction struct {
Value ParticipantTimerAction
// contains filtered or unexported fields
}
The timer action. Currently only one value is allowed: Unset . It deletes a timer.
type ParticipantTimerValueMemberParticipantTimerDurationInMinutes ¶
type ParticipantTimerValueMemberParticipantTimerDurationInMinutes struct {
Value int32
// contains filtered or unexported fields
}
The duration of a timer, in minutes.
type ParticipantTokenCredentials ¶
type ParticipantTokenCredentials struct {
// The expiration of the token. It's specified in ISO 8601 format:
// yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Expiry *string
// The token used by the chat participant to call [CreateParticipantConnection]. The participant token is valid
// for the lifetime of a chat participant.
//
// [CreateParticipantConnection]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
ParticipantToken *string
// contains filtered or unexported fields
}
The credentials used by the participant.
type ParticipantType ¶
type ParticipantType string
const ( ParticipantTypeAll ParticipantType = "ALL" ParticipantTypeManager ParticipantType = "MANAGER" ParticipantTypeAgent ParticipantType = "AGENT" ParticipantTypeCustomer ParticipantType = "CUSTOMER" ParticipantTypeThirdparty ParticipantType = "THIRDPARTY" )
Enum values for ParticipantType
func (ParticipantType) Values ¶
func (ParticipantType) Values() []ParticipantType
Values returns all known values for ParticipantType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PersistentChat ¶
type PersistentChat struct {
// The contactId that is used for rehydration depends on the rehydration type.
// RehydrationType is required for persistent chat.
//
// - ENTIRE_PAST_SESSION : Rehydrates a chat from the most recently terminated
// past chat contact of the specified past ended chat session. To use this type,
// provide the initialContactId of the past ended chat session in the
// sourceContactId field. In this type, Amazon Connect determines the most recent
// chat contact on the specified chat session that has ended, and uses it to start
// a persistent chat.
//
// - FROM_SEGMENT : Rehydrates a chat from the past chat contact that is
// specified in the sourceContactId field.
//
// The actual contactId used for rehydration is provided in the response of this
// API.
RehydrationType RehydrationType
// The contactId from which a persistent chat session must be started.
SourceContactId *string
// contains filtered or unexported fields
}
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
type PhoneNumberCountryCode ¶
type PhoneNumberCountryCode string
const ( PhoneNumberCountryCodeAf PhoneNumberCountryCode = "AF" PhoneNumberCountryCodeAl PhoneNumberCountryCode = "AL" PhoneNumberCountryCodeDz PhoneNumberCountryCode = "DZ" PhoneNumberCountryCodeAs PhoneNumberCountryCode = "AS" PhoneNumberCountryCodeAd PhoneNumberCountryCode = "AD" PhoneNumberCountryCodeAo PhoneNumberCountryCode = "AO" PhoneNumberCountryCodeAi PhoneNumberCountryCode = "AI" PhoneNumberCountryCodeAq PhoneNumberCountryCode = "AQ" PhoneNumberCountryCodeAg PhoneNumberCountryCode = "AG" PhoneNumberCountryCodeAr PhoneNumberCountryCode = "AR" PhoneNumberCountryCodeAm PhoneNumberCountryCode = "AM" PhoneNumberCountryCodeAw PhoneNumberCountryCode = "AW" PhoneNumberCountryCodeAu PhoneNumberCountryCode = "AU" PhoneNumberCountryCodeAt PhoneNumberCountryCode = "AT" PhoneNumberCountryCodeAz PhoneNumberCountryCode = "AZ" PhoneNumberCountryCodeBs PhoneNumberCountryCode = "BS" PhoneNumberCountryCodeBh PhoneNumberCountryCode = "BH" PhoneNumberCountryCodeBd PhoneNumberCountryCode = "BD" PhoneNumberCountryCodeBb PhoneNumberCountryCode = "BB" PhoneNumberCountryCodeBy PhoneNumberCountryCode = "BY" PhoneNumberCountryCodeBe PhoneNumberCountryCode = "BE" PhoneNumberCountryCodeBz PhoneNumberCountryCode = "BZ" PhoneNumberCountryCodeBj PhoneNumberCountryCode = "BJ" PhoneNumberCountryCodeBm PhoneNumberCountryCode = "BM" PhoneNumberCountryCodeBt PhoneNumberCountryCode = "BT" PhoneNumberCountryCodeBo PhoneNumberCountryCode = "BO" PhoneNumberCountryCodeBa PhoneNumberCountryCode = "BA" PhoneNumberCountryCodeBw PhoneNumberCountryCode = "BW" PhoneNumberCountryCodeBr PhoneNumberCountryCode = "BR" PhoneNumberCountryCodeIo PhoneNumberCountryCode = "IO" PhoneNumberCountryCodeVg PhoneNumberCountryCode = "VG" PhoneNumberCountryCodeBn PhoneNumberCountryCode = "BN" PhoneNumberCountryCodeBg PhoneNumberCountryCode = "BG" PhoneNumberCountryCodeBf PhoneNumberCountryCode = "BF" PhoneNumberCountryCodeBi PhoneNumberCountryCode = "BI" PhoneNumberCountryCodeKh PhoneNumberCountryCode = "KH" PhoneNumberCountryCodeCm PhoneNumberCountryCode = "CM" PhoneNumberCountryCodeCa PhoneNumberCountryCode = "CA" PhoneNumberCountryCodeCv PhoneNumberCountryCode = "CV" PhoneNumberCountryCodeKy PhoneNumberCountryCode = "KY" PhoneNumberCountryCodeCf PhoneNumberCountryCode = "CF" PhoneNumberCountryCodeTd PhoneNumberCountryCode = "TD" PhoneNumberCountryCodeCl PhoneNumberCountryCode = "CL" PhoneNumberCountryCodeCn PhoneNumberCountryCode = "CN" PhoneNumberCountryCodeCx PhoneNumberCountryCode = "CX" PhoneNumberCountryCodeCc PhoneNumberCountryCode = "CC" PhoneNumberCountryCodeCo PhoneNumberCountryCode = "CO" PhoneNumberCountryCodeKm PhoneNumberCountryCode = "KM" PhoneNumberCountryCodeCk PhoneNumberCountryCode = "CK" PhoneNumberCountryCodeCr PhoneNumberCountryCode = "CR" PhoneNumberCountryCodeHr PhoneNumberCountryCode = "HR" PhoneNumberCountryCodeCu PhoneNumberCountryCode = "CU" PhoneNumberCountryCodeCw PhoneNumberCountryCode = "CW" PhoneNumberCountryCodeCy PhoneNumberCountryCode = "CY" PhoneNumberCountryCodeCz PhoneNumberCountryCode = "CZ" PhoneNumberCountryCodeCd PhoneNumberCountryCode = "CD" PhoneNumberCountryCodeDk PhoneNumberCountryCode = "DK" PhoneNumberCountryCodeDj PhoneNumberCountryCode = "DJ" PhoneNumberCountryCodeDm PhoneNumberCountryCode = "DM" PhoneNumberCountryCodeDo PhoneNumberCountryCode = "DO" PhoneNumberCountryCodeTl PhoneNumberCountryCode = "TL" PhoneNumberCountryCodeEc PhoneNumberCountryCode = "EC" PhoneNumberCountryCodeEg PhoneNumberCountryCode = "EG" PhoneNumberCountryCodeSv PhoneNumberCountryCode = "SV" PhoneNumberCountryCodeGq PhoneNumberCountryCode = "GQ" PhoneNumberCountryCodeEr PhoneNumberCountryCode = "ER" PhoneNumberCountryCodeEe PhoneNumberCountryCode = "EE" PhoneNumberCountryCodeEt PhoneNumberCountryCode = "ET" PhoneNumberCountryCodeFk PhoneNumberCountryCode = "FK" PhoneNumberCountryCodeFo PhoneNumberCountryCode = "FO" PhoneNumberCountryCodeFj PhoneNumberCountryCode = "FJ" PhoneNumberCountryCodeFi PhoneNumberCountryCode = "FI" PhoneNumberCountryCodeFr PhoneNumberCountryCode = "FR" PhoneNumberCountryCodePf PhoneNumberCountryCode = "PF" PhoneNumberCountryCodeGa PhoneNumberCountryCode = "GA" PhoneNumberCountryCodeGm PhoneNumberCountryCode = "GM" PhoneNumberCountryCodeGe PhoneNumberCountryCode = "GE" PhoneNumberCountryCodeDe PhoneNumberCountryCode = "DE" PhoneNumberCountryCodeGh PhoneNumberCountryCode = "GH" PhoneNumberCountryCodeGi PhoneNumberCountryCode = "GI" PhoneNumberCountryCodeGr PhoneNumberCountryCode = "GR" PhoneNumberCountryCodeGl PhoneNumberCountryCode = "GL" PhoneNumberCountryCodeGd PhoneNumberCountryCode = "GD" PhoneNumberCountryCodeGu PhoneNumberCountryCode = "GU" PhoneNumberCountryCodeGt PhoneNumberCountryCode = "GT" PhoneNumberCountryCodeGg PhoneNumberCountryCode = "GG" PhoneNumberCountryCodeGn PhoneNumberCountryCode = "GN" PhoneNumberCountryCodeGw PhoneNumberCountryCode = "GW" PhoneNumberCountryCodeGy PhoneNumberCountryCode = "GY" PhoneNumberCountryCodeHt PhoneNumberCountryCode = "HT" PhoneNumberCountryCodeHn PhoneNumberCountryCode = "HN" PhoneNumberCountryCodeHk PhoneNumberCountryCode = "HK" PhoneNumberCountryCodeHu PhoneNumberCountryCode = "HU" PhoneNumberCountryCodeIs PhoneNumberCountryCode = "IS" PhoneNumberCountryCodeIn PhoneNumberCountryCode = "IN" PhoneNumberCountryCodeId PhoneNumberCountryCode = "ID" PhoneNumberCountryCodeIr PhoneNumberCountryCode = "IR" PhoneNumberCountryCodeIq PhoneNumberCountryCode = "IQ" PhoneNumberCountryCodeIe PhoneNumberCountryCode = "IE" PhoneNumberCountryCodeIm PhoneNumberCountryCode = "IM" PhoneNumberCountryCodeIl PhoneNumberCountryCode = "IL" PhoneNumberCountryCodeIt PhoneNumberCountryCode = "IT" PhoneNumberCountryCodeCi PhoneNumberCountryCode = "CI" PhoneNumberCountryCodeJm PhoneNumberCountryCode = "JM" PhoneNumberCountryCodeJp PhoneNumberCountryCode = "JP" PhoneNumberCountryCodeJe PhoneNumberCountryCode = "JE" PhoneNumberCountryCodeJo PhoneNumberCountryCode = "JO" PhoneNumberCountryCodeKz PhoneNumberCountryCode = "KZ" PhoneNumberCountryCodeKe PhoneNumberCountryCode = "KE" PhoneNumberCountryCodeKi PhoneNumberCountryCode = "KI" PhoneNumberCountryCodeKw PhoneNumberCountryCode = "KW" PhoneNumberCountryCodeKg PhoneNumberCountryCode = "KG" PhoneNumberCountryCodeLa PhoneNumberCountryCode = "LA" PhoneNumberCountryCodeLv PhoneNumberCountryCode = "LV" PhoneNumberCountryCodeLb PhoneNumberCountryCode = "LB" PhoneNumberCountryCodeLs PhoneNumberCountryCode = "LS" PhoneNumberCountryCodeLr PhoneNumberCountryCode = "LR" PhoneNumberCountryCodeLy PhoneNumberCountryCode = "LY" PhoneNumberCountryCodeLi PhoneNumberCountryCode = "LI" PhoneNumberCountryCodeLt PhoneNumberCountryCode = "LT" PhoneNumberCountryCodeLu PhoneNumberCountryCode = "LU" PhoneNumberCountryCodeMo PhoneNumberCountryCode = "MO" PhoneNumberCountryCodeMk PhoneNumberCountryCode = "MK" PhoneNumberCountryCodeMg PhoneNumberCountryCode = "MG" PhoneNumberCountryCodeMw PhoneNumberCountryCode = "MW" PhoneNumberCountryCodeMy PhoneNumberCountryCode = "MY" PhoneNumberCountryCodeMv PhoneNumberCountryCode = "MV" PhoneNumberCountryCodeMl PhoneNumberCountryCode = "ML" PhoneNumberCountryCodeMt PhoneNumberCountryCode = "MT" PhoneNumberCountryCodeMh PhoneNumberCountryCode = "MH" PhoneNumberCountryCodeMr PhoneNumberCountryCode = "MR" PhoneNumberCountryCodeMu PhoneNumberCountryCode = "MU" PhoneNumberCountryCodeYt PhoneNumberCountryCode = "YT" PhoneNumberCountryCodeMx PhoneNumberCountryCode = "MX" PhoneNumberCountryCodeFm PhoneNumberCountryCode = "FM" PhoneNumberCountryCodeMd PhoneNumberCountryCode = "MD" PhoneNumberCountryCodeMc PhoneNumberCountryCode = "MC" PhoneNumberCountryCodeMn PhoneNumberCountryCode = "MN" PhoneNumberCountryCodeMe PhoneNumberCountryCode = "ME" PhoneNumberCountryCodeMs PhoneNumberCountryCode = "MS" PhoneNumberCountryCodeMa PhoneNumberCountryCode = "MA" PhoneNumberCountryCodeMz PhoneNumberCountryCode = "MZ" PhoneNumberCountryCodeMm PhoneNumberCountryCode = "MM" PhoneNumberCountryCodeNa PhoneNumberCountryCode = "NA" PhoneNumberCountryCodeNr PhoneNumberCountryCode = "NR" PhoneNumberCountryCodeNp PhoneNumberCountryCode = "NP" PhoneNumberCountryCodeNl PhoneNumberCountryCode = "NL" PhoneNumberCountryCodeAn PhoneNumberCountryCode = "AN" PhoneNumberCountryCodeNc PhoneNumberCountryCode = "NC" PhoneNumberCountryCodeNz PhoneNumberCountryCode = "NZ" PhoneNumberCountryCodeNi PhoneNumberCountryCode = "NI" PhoneNumberCountryCodeNe PhoneNumberCountryCode = "NE" PhoneNumberCountryCodeNg PhoneNumberCountryCode = "NG" PhoneNumberCountryCodeNu PhoneNumberCountryCode = "NU" PhoneNumberCountryCodeKp PhoneNumberCountryCode = "KP" PhoneNumberCountryCodeMp PhoneNumberCountryCode = "MP" PhoneNumberCountryCodeNo PhoneNumberCountryCode = "NO" PhoneNumberCountryCodeOm PhoneNumberCountryCode = "OM" PhoneNumberCountryCodePk PhoneNumberCountryCode = "PK" PhoneNumberCountryCodePw PhoneNumberCountryCode = "PW" PhoneNumberCountryCodePa PhoneNumberCountryCode = "PA" PhoneNumberCountryCodePg PhoneNumberCountryCode = "PG" PhoneNumberCountryCodePy PhoneNumberCountryCode = "PY" PhoneNumberCountryCodePe PhoneNumberCountryCode = "PE" PhoneNumberCountryCodePh PhoneNumberCountryCode = "PH" PhoneNumberCountryCodePn PhoneNumberCountryCode = "PN" PhoneNumberCountryCodePl PhoneNumberCountryCode = "PL" PhoneNumberCountryCodePt PhoneNumberCountryCode = "PT" PhoneNumberCountryCodePr PhoneNumberCountryCode = "PR" PhoneNumberCountryCodeQa PhoneNumberCountryCode = "QA" PhoneNumberCountryCodeCg PhoneNumberCountryCode = "CG" PhoneNumberCountryCodeRe PhoneNumberCountryCode = "RE" PhoneNumberCountryCodeRo PhoneNumberCountryCode = "RO" PhoneNumberCountryCodeRu PhoneNumberCountryCode = "RU" PhoneNumberCountryCodeRw PhoneNumberCountryCode = "RW" PhoneNumberCountryCodeBl PhoneNumberCountryCode = "BL" PhoneNumberCountryCodeSh PhoneNumberCountryCode = "SH" PhoneNumberCountryCodeKn PhoneNumberCountryCode = "KN" PhoneNumberCountryCodeLc PhoneNumberCountryCode = "LC" PhoneNumberCountryCodeMf PhoneNumberCountryCode = "MF" PhoneNumberCountryCodePm PhoneNumberCountryCode = "PM" PhoneNumberCountryCodeVc PhoneNumberCountryCode = "VC" PhoneNumberCountryCodeWs PhoneNumberCountryCode = "WS" PhoneNumberCountryCodeSm PhoneNumberCountryCode = "SM" PhoneNumberCountryCodeSt PhoneNumberCountryCode = "ST" PhoneNumberCountryCodeSa PhoneNumberCountryCode = "SA" PhoneNumberCountryCodeSn PhoneNumberCountryCode = "SN" PhoneNumberCountryCodeRs PhoneNumberCountryCode = "RS" PhoneNumberCountryCodeSc PhoneNumberCountryCode = "SC" PhoneNumberCountryCodeSl PhoneNumberCountryCode = "SL" PhoneNumberCountryCodeSg PhoneNumberCountryCode = "SG" PhoneNumberCountryCodeSx PhoneNumberCountryCode = "SX" PhoneNumberCountryCodeSk PhoneNumberCountryCode = "SK" PhoneNumberCountryCodeSi PhoneNumberCountryCode = "SI" PhoneNumberCountryCodeSb PhoneNumberCountryCode = "SB" PhoneNumberCountryCodeSo PhoneNumberCountryCode = "SO" PhoneNumberCountryCodeZa PhoneNumberCountryCode = "ZA" PhoneNumberCountryCodeKr PhoneNumberCountryCode = "KR" PhoneNumberCountryCodeEs PhoneNumberCountryCode = "ES" PhoneNumberCountryCodeLk PhoneNumberCountryCode = "LK" PhoneNumberCountryCodeSd PhoneNumberCountryCode = "SD" PhoneNumberCountryCodeSr PhoneNumberCountryCode = "SR" PhoneNumberCountryCodeSj PhoneNumberCountryCode = "SJ" PhoneNumberCountryCodeSz PhoneNumberCountryCode = "SZ" PhoneNumberCountryCodeSe PhoneNumberCountryCode = "SE" PhoneNumberCountryCodeCh PhoneNumberCountryCode = "CH" PhoneNumberCountryCodeSy PhoneNumberCountryCode = "SY" PhoneNumberCountryCodeTw PhoneNumberCountryCode = "TW" PhoneNumberCountryCodeTj PhoneNumberCountryCode = "TJ" PhoneNumberCountryCodeTz PhoneNumberCountryCode = "TZ" PhoneNumberCountryCodeTh PhoneNumberCountryCode = "TH" PhoneNumberCountryCodeTg PhoneNumberCountryCode = "TG" PhoneNumberCountryCodeTk PhoneNumberCountryCode = "TK" PhoneNumberCountryCodeTo PhoneNumberCountryCode = "TO" PhoneNumberCountryCodeTt PhoneNumberCountryCode = "TT" PhoneNumberCountryCodeTn PhoneNumberCountryCode = "TN" PhoneNumberCountryCodeTr PhoneNumberCountryCode = "TR" PhoneNumberCountryCodeTm PhoneNumberCountryCode = "TM" PhoneNumberCountryCodeTc PhoneNumberCountryCode = "TC" PhoneNumberCountryCodeTv PhoneNumberCountryCode = "TV" PhoneNumberCountryCodeVi PhoneNumberCountryCode = "VI" PhoneNumberCountryCodeUg PhoneNumberCountryCode = "UG" PhoneNumberCountryCodeUa PhoneNumberCountryCode = "UA" PhoneNumberCountryCodeAe PhoneNumberCountryCode = "AE" PhoneNumberCountryCodeGb PhoneNumberCountryCode = "GB" PhoneNumberCountryCodeUs PhoneNumberCountryCode = "US" PhoneNumberCountryCodeUy PhoneNumberCountryCode = "UY" PhoneNumberCountryCodeUz PhoneNumberCountryCode = "UZ" PhoneNumberCountryCodeVu PhoneNumberCountryCode = "VU" PhoneNumberCountryCodeVa PhoneNumberCountryCode = "VA" PhoneNumberCountryCodeVe PhoneNumberCountryCode = "VE" PhoneNumberCountryCodeVn PhoneNumberCountryCode = "VN" PhoneNumberCountryCodeWf PhoneNumberCountryCode = "WF" PhoneNumberCountryCodeEh PhoneNumberCountryCode = "EH" PhoneNumberCountryCodeYe PhoneNumberCountryCode = "YE" PhoneNumberCountryCodeZm PhoneNumberCountryCode = "ZM" PhoneNumberCountryCodeZw PhoneNumberCountryCode = "ZW" )
Enum values for PhoneNumberCountryCode
func (PhoneNumberCountryCode) Values ¶
func (PhoneNumberCountryCode) Values() []PhoneNumberCountryCode
Values returns all known values for PhoneNumberCountryCode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PhoneNumberQuickConnectConfig ¶
type PhoneNumberQuickConnectConfig struct {
// The phone number in E.164 format.
//
// This member is required.
PhoneNumber *string
// contains filtered or unexported fields
}
Contains information about a phone number for a quick connect.
type PhoneNumberStatus ¶
type PhoneNumberStatus struct {
// The status message.
Message *string
// The status.
Status PhoneNumberWorkflowStatus
// contains filtered or unexported fields
}
The status of the phone number.
CLAIMED means the previous ClaimPhoneNumberor UpdatePhoneNumberoperation succeeded.
IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadataoperation is still in progress and has not yet completed. You can call DescribePhoneNumberat a later time to verify if the previous operation has completed.
FAILED indicates that the previous ClaimPhoneNumberor UpdatePhoneNumberoperation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
type PhoneNumberSummary ¶
type PhoneNumberSummary struct {
// The Amazon Resource Name (ARN) of the phone number.
Arn *string
// The identifier of the phone number.
Id *string
// The phone number.
PhoneNumber *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The type of phone number.
PhoneNumberType PhoneNumberType
// contains filtered or unexported fields
}
Contains summary information about a phone number for a contact center.
type PhoneNumberType ¶
type PhoneNumberType string
const ( PhoneNumberTypeTollFree PhoneNumberType = "TOLL_FREE" PhoneNumberTypeDid PhoneNumberType = "DID" PhoneNumberTypeUifn PhoneNumberType = "UIFN" PhoneNumberType = "SHARED" PhoneNumberTypeThirdPartyTf PhoneNumberType = "THIRD_PARTY_TF" PhoneNumberTypeThirdPartyDid PhoneNumberType = "THIRD_PARTY_DID" PhoneNumberTypeShortCode PhoneNumberType = "SHORT_CODE" )
Enum values for PhoneNumberType
func (PhoneNumberType) Values ¶
func (PhoneNumberType) Values() []PhoneNumberType
Values returns all known values for PhoneNumberType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PhoneNumberWorkflowStatus ¶
type PhoneNumberWorkflowStatus string
const ( PhoneNumberWorkflowStatusClaimed PhoneNumberWorkflowStatus = "CLAIMED" PhoneNumberWorkflowStatusInProgress PhoneNumberWorkflowStatus = "IN_PROGRESS" PhoneNumberWorkflowStatusFailed PhoneNumberWorkflowStatus = "FAILED" )
Enum values for PhoneNumberWorkflowStatus
func (PhoneNumberWorkflowStatus) Values ¶
func (PhoneNumberWorkflowStatus) Values() []PhoneNumberWorkflowStatus
Values returns all known values for PhoneNumberWorkflowStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PhoneType ¶
type PhoneType string
Enum values for PhoneType
func (PhoneType) Values ¶
Values returns all known values for PhoneType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PostAcceptTimeoutConfig ¶
type PostAcceptTimeoutConfig struct {
// Duration in seconds for the countdown timer after the agent accepted the
// contact.
//
// This member is required.
DurationInSeconds *int32
// contains filtered or unexported fields
}
Countdown timer configuration after the agent accepted the contact.
type PredefinedAttribute ¶
type PredefinedAttribute struct {
// Custom metadata that is associated to predefined attributes to control behavior
// in upstream services, such as controlling how a predefined attribute should be
// displayed in the Amazon Connect admin website.
AttributeConfiguration *PredefinedAttributeConfiguration
// Last modified region.
LastModifiedRegion *string
// Last modified time.
LastModifiedTime *time.Time
// The name of the predefined attribute.
Name *string
// Values that enable you to categorize your predefined attributes. You can use
// them in custom UI elements across the Amazon Connect admin website.
Purposes []string
// The values of the predefined attribute.
Values PredefinedAttributeValues
// contains filtered or unexported fields
}
Information about a predefined attribute.
type PredefinedAttributeConfiguration ¶
type PredefinedAttributeConfiguration struct {
// When this parameter is set to true, Amazon Connect enforces strict validation
// on the specific values, if the values are predefined in attributes. The contact
// will store only valid and predefined values for teh predefined attribute key.
EnableValueValidationOnAssociation bool
// A boolean flag used to indicate whether a predefined attribute should be
// displayed in the Amazon Connect admin website.
IsReadOnly bool
// contains filtered or unexported fields
}
Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
type PredefinedAttributeSearchCriteria ¶
type PredefinedAttributeSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []PredefinedAttributeSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []PredefinedAttributeSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return predefined attributes.
type PredefinedAttributeSummary ¶
type PredefinedAttributeSummary struct {
// Last modified region.
LastModifiedRegion *string
// Last modified time.
LastModifiedTime *time.Time
// The name of the predefined attribute.
Name *string
// contains filtered or unexported fields
}
Summary of a predefined attribute.
type PredefinedAttributeValues ¶
type PredefinedAttributeValues interface {
// contains filtered or unexported methods
}
Information about values of a predefined attribute.
The following types satisfy this interface:
PredefinedAttributeValuesMemberStringList
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.PredefinedAttributeValues
// type switches can be used to check the union value
switch v := union.(type) {
case *types.PredefinedAttributeValuesMemberStringList:
_ = v.Value // Value is []string
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type PredefinedAttributeValuesMemberStringList ¶
type PredefinedAttributeValuesMemberStringList struct {
Value []string
// contains filtered or unexported fields
}
Predefined attribute values of type string list.
type Preview ¶
type Preview struct {
// The actions the agent can perform after accepting the preview outbound contact.
//
// This member is required.
AllowedUserActions []AllowedUserAction
// Countdown timer configuration after the agent accepted the preview outbound
// contact.
//
// This member is required.
PostAcceptTimeoutConfig *PostAcceptTimeoutConfig
// contains filtered or unexported fields
}
Information about agent-first preview mode outbound strategy configuration.
type PrimaryAttributeAccessControlConfigurationItem ¶
type PrimaryAttributeAccessControlConfigurationItem struct {
// The item's primary attribute values.
PrimaryAttributeValues []PrimaryAttributeValue
// contains filtered or unexported fields
}
A primary attribute access control configuration item.
type PrimaryAttributeValue ¶
type PrimaryAttributeValue struct {
// The value's access type.
AccessType AccessType
// The value's attribute name.
AttributeName *string
// The value's values.
Values []string
// contains filtered or unexported fields
}
A primary attribute value.
type PrimaryAttributeValueFilter ¶
type PrimaryAttributeValueFilter struct {
// The filter's attribute name.
//
// This member is required.
AttributeName *string
// The filter's values.
//
// This member is required.
Values []string
// contains filtered or unexported fields
}
A primary attribute value filter.
type PrimaryValue ¶
type PrimaryValue struct {
// The name of the primary attribute that this value belongs to.
//
// This member is required.
AttributeName *string
// The actual value for the primary attribute. Must be provided as a string
// regardless of the attribute's value type. Primary values cannot be expressions
// and must be explicitly specified.
//
// This member is required.
Value *string
// contains filtered or unexported fields
}
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
type PrimaryValueResponse ¶
type PrimaryValueResponse struct {
// The value's attribute ID.
AttributeId *string
// The value's attribute name.
AttributeName *string
// The value's value.
Value *string
// contains filtered or unexported fields
}
A primary value response.
type ProblemDetail ¶
type ProblemDetail struct {
// The problem detail's message.
Message *string
// contains filtered or unexported fields
}
Information about a problem detail.
type Prompt ¶
type Prompt struct {
// The description of the prompt.
Description *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the prompt.
Name *string
// The Amazon Resource Name (ARN) of the prompt.
PromptARN *string
// A unique identifier for the prompt.
PromptId *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Information about a prompt.
type PromptSearchCriteria ¶
type PromptSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []PromptSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []PromptSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , description , and
// resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return prompts.
type PromptSearchFilter ¶
type PromptSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type PromptSummary ¶
type PromptSummary struct {
// The Amazon Resource Name (ARN) of the prompt.
Arn *string
// The identifier of the prompt.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the prompt.
Name *string
// contains filtered or unexported fields
}
Contains information about the prompt.
type PropertyValidationException ¶
type PropertyValidationException struct {
Message *string
ErrorCodeOverride *string
PropertyList []PropertyValidationExceptionProperty
// contains filtered or unexported fields
}
The property is not valid.
func (*PropertyValidationException) Error ¶
func (e *PropertyValidationException) Error() string
func (*PropertyValidationException) ErrorCode ¶
func (e *PropertyValidationException) ErrorCode() string
func (*PropertyValidationException) ErrorFault ¶
func (e *PropertyValidationException) ErrorFault() smithy.ErrorFault
func (*PropertyValidationException) ErrorMessage ¶
func (e *PropertyValidationException) ErrorMessage() string
type PropertyValidationExceptionProperty ¶
type PropertyValidationExceptionProperty struct {
// A message describing why the property is not valid.
//
// This member is required.
Message *string
// The full property path.
//
// This member is required.
PropertyPath *string
// Why the property is not valid.
//
// This member is required.
Reason PropertyValidationExceptionReason
// contains filtered or unexported fields
}
Contains information about why a property is not valid.
type PropertyValidationExceptionReason ¶
type PropertyValidationExceptionReason string
const ( PropertyValidationExceptionReasonInvalidFormat PropertyValidationExceptionReason = "INVALID_FORMAT" PropertyValidationExceptionReasonUniqueConstraintViolated PropertyValidationExceptionReason = "UNIQUE_CONSTRAINT_VIOLATED" PropertyValidationExceptionReasonReferencedResourceNotFound PropertyValidationExceptionReason = "REFERENCED_RESOURCE_NOT_FOUND" PropertyValidationExceptionReasonResourceNameAlreadyExists PropertyValidationExceptionReason = "RESOURCE_NAME_ALREADY_EXISTS" PropertyValidationExceptionReasonRequiredPropertyMissing PropertyValidationExceptionReason = "REQUIRED_PROPERTY_MISSING" PropertyValidationExceptionReasonNotSupported PropertyValidationExceptionReason = "NOT_SUPPORTED" )
Enum values for PropertyValidationExceptionReason
func (PropertyValidationExceptionReason) Values ¶
func (PropertyValidationExceptionReason) Values() []PropertyValidationExceptionReason
Values returns all known values for PropertyValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QualityMetrics ¶
type QualityMetrics struct {
// Information about the quality of Agent media connection.
Agent *AgentQualityMetrics
// Information about the quality of Customer media connection.
Customer *CustomerQualityMetrics
// contains filtered or unexported fields
}
Information about the quality of the participant's media connection.
type QuestionRuleCategoryAutomationCondition ¶
type QuestionRuleCategoryAutomationCondition string
const ( QuestionRuleCategoryAutomationConditionPresent QuestionRuleCategoryAutomationCondition = "PRESENT" QuestionRuleCategoryAutomationConditionNotPresent QuestionRuleCategoryAutomationCondition = "NOT_PRESENT" )
Enum values for QuestionRuleCategoryAutomationCondition
func (QuestionRuleCategoryAutomationCondition) Values ¶
Values returns all known values for QuestionRuleCategoryAutomationCondition. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Queue ¶
type Queue struct {
// The description of the queue.
Description *string
// The identifier for the hours of operation.
HoursOfOperationId *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The maximum number of contacts that can be in the queue before it is considered
// full.
MaxContacts *int32
// The name of the queue.
Name *string
// The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerConfig *OutboundCallerConfig
// The outbound email address ID for a specified queue.
OutboundEmailConfig *OutboundEmailConfig
// The Amazon Resource Name (ARN) for the queue.
QueueArn *string
// The identifier for the queue.
QueueId *string
// The status of the queue.
Status QueueStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Contains information about a queue.
type QueueInfo ¶
type QueueInfo struct {
// The timestamp when the contact was added to the queue.
EnqueueTimestamp *time.Time
// The unique identifier for the queue.
Id *string
// contains filtered or unexported fields
}
If this contact was queued, this contains information about the queue.
type QueueInfoInput ¶
type QueueInfoInput struct {
// The identifier of the queue.
Id *string
// contains filtered or unexported fields
}
Information about a queue.
type QueueQuickConnectConfig ¶
type QueueQuickConnectConfig struct {
// The identifier of the flow.
//
// This member is required.
ContactFlowId *string
// The identifier for the queue.
//
// This member is required.
QueueId *string
// contains filtered or unexported fields
}
Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
type QueueReference ¶
type QueueReference struct {
// The Amazon Resource Name (ARN) of the queue.
Arn *string
// The identifier of the queue.
Id *string
// contains filtered or unexported fields
}
Contains information about a queue resource for which metrics are returned.
type QueueSearchCriteria ¶
type QueueSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []QueueSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []QueueSearchCriteria
// The type of queue.
QueueTypeCondition SearchableQueueType
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , description , and
// resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return queues.
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
type QueueSearchFilter ¶
type QueueSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type QueueStatus ¶
type QueueStatus string
const ( QueueStatusEnabled QueueStatus = "ENABLED" QueueStatusDisabled QueueStatus = "DISABLED" )
Enum values for QueueStatus
func (QueueStatus) Values ¶
func (QueueStatus) Values() []QueueStatus
Values returns all known values for QueueStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QueueSummary ¶
type QueueSummary struct {
// The Amazon Resource Name (ARN) of the queue.
Arn *string
// The identifier of the queue.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the queue.
Name *string
// The type of queue.
QueueType QueueType
// contains filtered or unexported fields
}
Contains summary information about a queue.
type QueueType ¶
type QueueType string
Enum values for QueueType
func (QueueType) Values ¶
Values returns all known values for QueueType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QuickConnect ¶
type QuickConnect struct {
// The description.
Description *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the quick connect.
Name *string
// The Amazon Resource Name (ARN) of the quick connect.
QuickConnectARN *string
// Contains information about the quick connect.
QuickConnectConfig *QuickConnectConfig
// The identifier for the quick connect.
QuickConnectId *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Contains information about a quick connect.
type QuickConnectConfig ¶
type QuickConnectConfig struct {
// The type of quick connect. In the Amazon Connect admin website, when you create
// a quick connect, you are prompted to assign one of the following types: Agent
// (USER), External (PHONE_NUMBER), or Queue (QUEUE).
//
// This member is required.
QuickConnectType QuickConnectType
// Flow configuration for quick connect setup.
FlowConfig *FlowQuickConnectConfig
// The phone configuration. This is required only if QuickConnectType is
// PHONE_NUMBER.
PhoneConfig *PhoneNumberQuickConnectConfig
// The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueConfig *QueueQuickConnectConfig
// The user configuration. This is required only if QuickConnectType is USER.
UserConfig *UserQuickConnectConfig
// contains filtered or unexported fields
}
Contains configuration settings for a quick connect.
type QuickConnectContactData ¶
type QuickConnectContactData struct {
// The contact ID for quick connect contact data.
ContactId *string
// Timestamp when the quick connect contact was initiated.
InitiationTimestamp *time.Time
// The quick connect ID.
QuickConnectId *string
// The name of the quick connect.
QuickConnectName *string
// The type of the quick connect.
QuickConnectType QuickConnectType
// contains filtered or unexported fields
}
Contact data associated with quick connect operations.
type QuickConnectSearchCriteria ¶
type QuickConnectSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []QuickConnectSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []QuickConnectSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , description , and
// resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return quick connects.
type QuickConnectSearchFilter ¶
type QuickConnectSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type QuickConnectSummary ¶
type QuickConnectSummary struct {
// The Amazon Resource Name (ARN) of the quick connect.
Arn *string
// The identifier for the quick connect.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the quick connect.
Name *string
// The type of quick connect. In the Amazon Connect admin website, when you create
// a quick connect, you are prompted to assign one of the following types: Agent
// (USER), External (PHONE_NUMBER), or Queue (QUEUE).
QuickConnectType QuickConnectType
// contains filtered or unexported fields
}
Contains summary information about a quick connect.
type QuickConnectType ¶
type QuickConnectType string
const ( QuickConnectTypeUser QuickConnectType = "USER" QuickConnectTypeQueue QuickConnectType = "QUEUE" QuickConnectTypePhoneNumber QuickConnectType = "PHONE_NUMBER" QuickConnectTypeFlow QuickConnectType = "FLOW" )
Enum values for QuickConnectType
func (QuickConnectType) Values ¶
func (QuickConnectType) Values() []QuickConnectType
Values returns all known values for QuickConnectType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Range ¶
type Range struct {
// The maximum proficiency level of the range.
MaxProficiencyLevel *float32
// The minimum proficiency level of the range.
MinProficiencyLevel *float32
// contains filtered or unexported fields
}
An Object to define the minimum and maximum proficiency levels.
type ReadOnlyFieldInfo ¶
type ReadOnlyFieldInfo struct {
// Identifier of the read-only field.
Id *TaskTemplateFieldIdentifier
// contains filtered or unexported fields
}
Indicates a field that is read-only to an agent.
type RealTimeContactAnalysisAttachment ¶
type RealTimeContactAnalysisAttachment struct {
// A unique identifier for the attachment.
//
// This member is required.
AttachmentId *string
// A case-sensitive name of the attachment being uploaded. Can be redacted.
//
// This member is required.
AttachmentName *string
// Describes the MIME file type of the attachment. For a list of supported file
// types, see [Feature specifications]in the Amazon Connect Administrator Guide.
//
// [Feature specifications]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html
ContentType *string
// Status of the attachment.
Status ArtifactStatus
// contains filtered or unexported fields
}
Object that describes attached file.
type RealTimeContactAnalysisCategoryDetails ¶
type RealTimeContactAnalysisCategoryDetails struct {
// List of PointOfInterest - objects describing a single match of a rule.
//
// This member is required.
PointsOfInterest []RealTimeContactAnalysisPointOfInterest
// contains filtered or unexported fields
}
Provides information about the category rule that was matched.
type RealTimeContactAnalysisCharacterInterval ¶
type RealTimeContactAnalysisCharacterInterval struct {
// The beginning of the character interval.
//
// This member is required.
BeginOffsetChar int32
// The end of the character interval.
//
// This member is required.
EndOffsetChar int32
// contains filtered or unexported fields
}
Begin and end offsets for a part of text.
type RealTimeContactAnalysisIssueDetected ¶
type RealTimeContactAnalysisIssueDetected struct {
// List of the transcript items (segments) that are associated with a given issue.
//
// This member is required.
TranscriptItems []RealTimeContactAnalysisTranscriptItemWithContent
// contains filtered or unexported fields
}
Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
type RealTimeContactAnalysisOutputType ¶
type RealTimeContactAnalysisOutputType string
const ( RealTimeContactAnalysisOutputTypeRaw RealTimeContactAnalysisOutputType = "Raw" RealTimeContactAnalysisOutputTypeRedacted RealTimeContactAnalysisOutputType = "Redacted" )
Enum values for RealTimeContactAnalysisOutputType
func (RealTimeContactAnalysisOutputType) Values ¶
func (RealTimeContactAnalysisOutputType) Values() []RealTimeContactAnalysisOutputType
Values returns all known values for RealTimeContactAnalysisOutputType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisPointOfInterest ¶
type RealTimeContactAnalysisPointOfInterest struct {
// List of the transcript items (segments) that are associated with a given point
// of interest.
TranscriptItems []RealTimeContactAnalysisTranscriptItemWithCharacterOffsets
// contains filtered or unexported fields
}
The section of the contact transcript segment that category rule was detected.
type RealTimeContactAnalysisPostContactSummaryFailureCode ¶
type RealTimeContactAnalysisPostContactSummaryFailureCode string
const ( RealTimeContactAnalysisPostContactSummaryFailureCodeQuotaExceeded RealTimeContactAnalysisPostContactSummaryFailureCode = "QUOTA_EXCEEDED" RealTimeContactAnalysisPostContactSummaryFailureCodeInsufficientConversationContent RealTimeContactAnalysisPostContactSummaryFailureCode = "INSUFFICIENT_CONVERSATION_CONTENT" RealTimeContactAnalysisPostContactSummaryFailureCodeFailedSafetyGuidelines RealTimeContactAnalysisPostContactSummaryFailureCode = "FAILED_SAFETY_GUIDELINES" RealTimeContactAnalysisPostContactSummaryFailureCodeInvalidAnalysisConfiguration RealTimeContactAnalysisPostContactSummaryFailureCode = "INVALID_ANALYSIS_CONFIGURATION" RealTimeContactAnalysisPostContactSummaryFailureCodeInternalError RealTimeContactAnalysisPostContactSummaryFailureCode = "INTERNAL_ERROR" )
Enum values for RealTimeContactAnalysisPostContactSummaryFailureCode
func (RealTimeContactAnalysisPostContactSummaryFailureCode) Values ¶
func (RealTimeContactAnalysisPostContactSummaryFailureCode) Values() []RealTimeContactAnalysisPostContactSummaryFailureCode
Values returns all known values for RealTimeContactAnalysisPostContactSummaryFailureCode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisPostContactSummaryStatus ¶
type RealTimeContactAnalysisPostContactSummaryStatus string
const ( RealTimeContactAnalysisPostContactSummaryStatusFailed RealTimeContactAnalysisPostContactSummaryStatus = "FAILED" RealTimeContactAnalysisPostContactSummaryStatusCompleted RealTimeContactAnalysisPostContactSummaryStatus = "COMPLETED" )
Enum values for RealTimeContactAnalysisPostContactSummaryStatus
func (RealTimeContactAnalysisPostContactSummaryStatus) Values ¶
func (RealTimeContactAnalysisPostContactSummaryStatus) Values() []RealTimeContactAnalysisPostContactSummaryStatus
Values returns all known values for RealTimeContactAnalysisPostContactSummaryStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisSegmentAttachments ¶
type RealTimeContactAnalysisSegmentAttachments struct {
// List of objects describing an individual attachment.
//
// This member is required.
Attachments []RealTimeContactAnalysisAttachment
// The identifier of the segment.
//
// This member is required.
Id *string
// The identifier of the participant.
//
// This member is required.
ParticipantId *string
// The role of the participant. For example, is it a customer, agent, or system.
//
// This member is required.
ParticipantRole ParticipantRole
// Field describing the time of the event. It can have different representations
// of time.
//
// This member is required.
Time RealTimeContactAnalysisTimeData
// The display name of the participant. Can be redacted.
DisplayName *string
// contains filtered or unexported fields
}
Segment containing list of attachments.
type RealTimeContactAnalysisSegmentCategories ¶
type RealTimeContactAnalysisSegmentCategories struct {
// Map between the name of the matched rule and
// RealTimeContactAnalysisCategoryDetails.
//
// This member is required.
MatchedDetails map[string]RealTimeContactAnalysisCategoryDetails
// contains filtered or unexported fields
}
The matched category rules.
type RealTimeContactAnalysisSegmentEvent ¶
type RealTimeContactAnalysisSegmentEvent struct {
// Type of the event. For example,
// application/vnd.amazonaws.connect.event.participant.left .
//
// This member is required.
EventType *string
// The identifier of the contact event.
//
// This member is required.
Id *string
// Field describing the time of the event. It can have different representations
// of time.
//
// This member is required.
Time RealTimeContactAnalysisTimeData
// The display name of the participant. Can be redacted.
DisplayName *string
// The identifier of the participant.
ParticipantId *string
// The role of the participant. For example, is it a customer, agent, or system.
ParticipantRole ParticipantRole
// contains filtered or unexported fields
}
Segment type describing a contact event.
type RealTimeContactAnalysisSegmentIssues ¶
type RealTimeContactAnalysisSegmentIssues struct {
// List of the issues detected.
//
// This member is required.
IssuesDetected []RealTimeContactAnalysisIssueDetected
// contains filtered or unexported fields
}
Segment type containing a list of detected issues.
type RealTimeContactAnalysisSegmentPostContactSummary ¶
type RealTimeContactAnalysisSegmentPostContactSummary struct {
// Whether the summary was successfully COMPLETED or FAILED to be generated.
//
// This member is required.
Status RealTimeContactAnalysisPostContactSummaryStatus
// The content of the summary.
Content *string
// If the summary failed to be generated, one of the following failure codes
// occurs:
//
// - QUOTA_EXCEEDED : The number of concurrent analytics jobs reached your
// service quota.
//
// - INSUFFICIENT_CONVERSATION_CONTENT : The conversation needs to have at least
// one turn from both the participants in order to generate the summary.
//
// - FAILED_SAFETY_GUIDELINES : The generated summary cannot be provided because
// it failed to meet system safety guidelines.
//
// - INVALID_ANALYSIS_CONFIGURATION : This code occurs when, for example, you're
// using a [language]that isn't supported by generative AI-powered post-contact summaries.
//
// - INTERNAL_ERROR : Internal system error.
//
// [language]: https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens
FailureCode RealTimeContactAnalysisPostContactSummaryFailureCode
// contains filtered or unexported fields
}
Information about the post-contact summary for a real-time contact segment.
type RealTimeContactAnalysisSegmentTranscript ¶
type RealTimeContactAnalysisSegmentTranscript struct {
// The content of the transcript. Can be redacted.
//
// This member is required.
Content *string
// The identifier of the transcript.
//
// This member is required.
Id *string
// The identifier of the participant.
//
// This member is required.
ParticipantId *string
// The role of the participant. For example, is it a customer, agent, or system.
//
// This member is required.
ParticipantRole ParticipantRole
// Field describing the time of the event. It can have different representations
// of time.
//
// This member is required.
Time RealTimeContactAnalysisTimeData
// The type of content of the item. For example, text/plain .
ContentType *string
// The display name of the participant.
DisplayName *string
// Object describing redaction that was applied to the transcript. If transcript
// has the field it means part of the transcript was redacted.
Redaction *RealTimeContactAnalysisTranscriptItemRedaction
// The sentiment detected for this piece of transcript.
Sentiment RealTimeContactAnalysisSentimentLabel
// contains filtered or unexported fields
}
The analyzed transcript segment.
type RealTimeContactAnalysisSegmentType ¶
type RealTimeContactAnalysisSegmentType string
const ( RealTimeContactAnalysisSegmentTypeTranscript RealTimeContactAnalysisSegmentType = "Transcript" RealTimeContactAnalysisSegmentTypeCategories RealTimeContactAnalysisSegmentType = "Categories" RealTimeContactAnalysisSegmentTypeIssues RealTimeContactAnalysisSegmentType = "Issues" RealTimeContactAnalysisSegmentTypeEvent RealTimeContactAnalysisSegmentType = "Event" RealTimeContactAnalysisSegmentTypeAttachments RealTimeContactAnalysisSegmentType = "Attachments" RealTimeContactAnalysisSegmentTypePostContactSummary RealTimeContactAnalysisSegmentType = "PostContactSummary" )
Enum values for RealTimeContactAnalysisSegmentType
func (RealTimeContactAnalysisSegmentType) Values ¶
func (RealTimeContactAnalysisSegmentType) Values() []RealTimeContactAnalysisSegmentType
Values returns all known values for RealTimeContactAnalysisSegmentType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisSentimentLabel ¶
type RealTimeContactAnalysisSentimentLabel string
const ( RealTimeContactAnalysisSentimentLabelPositive RealTimeContactAnalysisSentimentLabel = "POSITIVE" RealTimeContactAnalysisSentimentLabelNegative RealTimeContactAnalysisSentimentLabel = "NEGATIVE" RealTimeContactAnalysisSentimentLabelNeutral RealTimeContactAnalysisSentimentLabel = "NEUTRAL" )
Enum values for RealTimeContactAnalysisSentimentLabel
func (RealTimeContactAnalysisSentimentLabel) Values ¶
func (RealTimeContactAnalysisSentimentLabel) Values() []RealTimeContactAnalysisSentimentLabel
Values returns all known values for RealTimeContactAnalysisSentimentLabel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisStatus ¶
type RealTimeContactAnalysisStatus string
const ( RealTimeContactAnalysisStatusInProgress RealTimeContactAnalysisStatus = "IN_PROGRESS" RealTimeContactAnalysisStatusFailed RealTimeContactAnalysisStatus = "FAILED" RealTimeContactAnalysisStatusCompleted RealTimeContactAnalysisStatus = "COMPLETED" )
Enum values for RealTimeContactAnalysisStatus
func (RealTimeContactAnalysisStatus) Values ¶
func (RealTimeContactAnalysisStatus) Values() []RealTimeContactAnalysisStatus
Values returns all known values for RealTimeContactAnalysisStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisSupportedChannel ¶
type RealTimeContactAnalysisSupportedChannel string
const ( RealTimeContactAnalysisSupportedChannelVoice RealTimeContactAnalysisSupportedChannel = "VOICE" RealTimeContactAnalysisSupportedChannelChat RealTimeContactAnalysisSupportedChannel = "CHAT" )
Enum values for RealTimeContactAnalysisSupportedChannel
func (RealTimeContactAnalysisSupportedChannel) Values ¶
Values returns all known values for RealTimeContactAnalysisSupportedChannel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RealTimeContactAnalysisTimeData ¶
type RealTimeContactAnalysisTimeData interface {
// contains filtered or unexported methods
}
Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
The following types satisfy this interface:
RealTimeContactAnalysisTimeDataMemberAbsoluteTime
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.RealTimeContactAnalysisTimeData
// type switches can be used to check the union value
switch v := union.(type) {
case *types.RealTimeContactAnalysisTimeDataMemberAbsoluteTime:
_ = v.Value // Value is time.Time
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type RealTimeContactAnalysisTimeDataMemberAbsoluteTime ¶
type RealTimeContactAnalysisTimeDataMemberAbsoluteTime struct {
Value time.Time
// contains filtered or unexported fields
}
Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
type RealTimeContactAnalysisTranscriptItemRedaction ¶
type RealTimeContactAnalysisTranscriptItemRedaction struct {
// List of character intervals each describing a part of the text that was
// redacted. For OutputType.Raw , part of the original text that contains data that
// can be redacted. For OutputType.Redacted , part of the string with redaction tag.
CharacterOffsets []RealTimeContactAnalysisCharacterInterval
// contains filtered or unexported fields
}
Object describing redaction applied to the segment.
type RealTimeContactAnalysisTranscriptItemWithCharacterOffsets ¶
type RealTimeContactAnalysisTranscriptItemWithCharacterOffsets struct {
// Transcript identifier. Matches the identifier from one of the
// TranscriptSegments.
//
// This member is required.
Id *string
// List of character intervals within transcript content/text.
CharacterOffsets *RealTimeContactAnalysisCharacterInterval
// contains filtered or unexported fields
}
Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest in Category.MatchedDetails would have character interval describing part of the text that matched category.
type RealTimeContactAnalysisTranscriptItemWithContent ¶
type RealTimeContactAnalysisTranscriptItemWithContent struct {
// Transcript identifier. Matches the identifier from one of the
// TranscriptSegments.
//
// This member is required.
Id *string
// Begin and end offsets for a part of text.
CharacterOffsets *RealTimeContactAnalysisCharacterInterval
// Part of the transcript content that contains identified issue. Can be redacted
Content *string
// contains filtered or unexported fields
}
Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.
type RealtimeContactAnalysisSegment ¶
type RealtimeContactAnalysisSegment interface {
// contains filtered or unexported methods
}
An analyzed segment for a real-time analysis session.
The following types satisfy this interface:
RealtimeContactAnalysisSegmentMemberAttachments RealtimeContactAnalysisSegmentMemberCategories RealtimeContactAnalysisSegmentMemberEvent RealtimeContactAnalysisSegmentMemberIssues RealtimeContactAnalysisSegmentMemberPostContactSummary RealtimeContactAnalysisSegmentMemberTranscript
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.RealtimeContactAnalysisSegment
// type switches can be used to check the union value
switch v := union.(type) {
case *types.RealtimeContactAnalysisSegmentMemberAttachments:
_ = v.Value // Value is types.RealTimeContactAnalysisSegmentAttachments
case *types.RealtimeContactAnalysisSegmentMemberCategories:
_ = v.Value // Value is types.RealTimeContactAnalysisSegmentCategories
case *types.RealtimeContactAnalysisSegmentMemberEvent:
_ = v.Value // Value is types.RealTimeContactAnalysisSegmentEvent
case *types.RealtimeContactAnalysisSegmentMemberIssues:
_ = v.Value // Value is types.RealTimeContactAnalysisSegmentIssues
case *types.RealtimeContactAnalysisSegmentMemberPostContactSummary:
_ = v.Value // Value is types.RealTimeContactAnalysisSegmentPostContactSummary
case *types.RealtimeContactAnalysisSegmentMemberTranscript:
_ = v.Value // Value is types.RealTimeContactAnalysisSegmentTranscript
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type RealtimeContactAnalysisSegmentMemberAttachments ¶
type RealtimeContactAnalysisSegmentMemberAttachments struct {
Value RealTimeContactAnalysisSegmentAttachments
// contains filtered or unexported fields
}
The analyzed attachments.
type RealtimeContactAnalysisSegmentMemberCategories ¶
type RealtimeContactAnalysisSegmentMemberCategories struct {
Value RealTimeContactAnalysisSegmentCategories
// contains filtered or unexported fields
}
The matched category rules.
type RealtimeContactAnalysisSegmentMemberEvent ¶
type RealtimeContactAnalysisSegmentMemberEvent struct {
Value RealTimeContactAnalysisSegmentEvent
// contains filtered or unexported fields
}
Segment type describing a contact event.
type RealtimeContactAnalysisSegmentMemberIssues ¶
type RealtimeContactAnalysisSegmentMemberIssues struct {
Value RealTimeContactAnalysisSegmentIssues
// contains filtered or unexported fields
}
Segment type containing a list of detected issues.
type RealtimeContactAnalysisSegmentMemberPostContactSummary ¶
type RealtimeContactAnalysisSegmentMemberPostContactSummary struct {
Value RealTimeContactAnalysisSegmentPostContactSummary
// contains filtered or unexported fields
}
Information about the post-contact summary.
type RealtimeContactAnalysisSegmentMemberTranscript ¶
type RealtimeContactAnalysisSegmentMemberTranscript struct {
Value RealTimeContactAnalysisSegmentTranscript
// contains filtered or unexported fields
}
The analyzed transcript segment.
type RecordPrimaryValue ¶
type RecordPrimaryValue struct {
// The value's last modified region.
LastModifiedRegion *string
// The value's last modified time.
LastModifiedTime *time.Time
// The value's primary values.
PrimaryValues []PrimaryValueResponse
// The value's record ID.
RecordId *string
// contains filtered or unexported fields
}
A record primary value.
type RecordingInfo ¶
type RecordingInfo struct {
// If the recording/transcript was deleted, this is the reason entered for the
// deletion.
DeletionReason *string
// The number that identifies the Kinesis Video Streams fragment where the
// customer audio stream started.
FragmentStartNumber *string
// The number that identifies the Kinesis Video Streams fragment where the
// customer audio stream stopped.
FragmentStopNumber *string
// The location, in Amazon S3, for the recording/transcript.
Location *string
// Information about the media stream used during the conversation.
MediaStreamType MediaStreamType
// Information about the conversation participant, whether they are an agent or
// contact. The participant types are as follows:
//
// - All
//
// - Manager
//
// - Agent
//
// - Customer
//
// - Thirdparty
//
// - Supervisor
ParticipantType ParticipantType
// When the conversation of the last leg of the recording started in UTC time.
StartTimestamp *time.Time
// The status of the recording/transcript.
Status RecordingStatus
// When the conversation of the last leg of recording stopped in UTC time.
StopTimestamp *time.Time
// Where the recording/transcript is stored.
StorageType StorageType
// The location, in Amazon S3, for the unprocessed transcript if any media
// processing was performed.
UnprocessedTranscriptLocation *string
// contains filtered or unexported fields
}
Information about a voice recording, chat transcript, or screen recording.
type RecordingStatus ¶
type RecordingStatus string
const ( RecordingStatusAvailable RecordingStatus = "AVAILABLE" RecordingStatusDeleted RecordingStatus = "DELETED" )
Enum values for RecordingStatus
func (RecordingStatus) Values ¶
func (RecordingStatus) Values() []RecordingStatus
Values returns all known values for RecordingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Reference ¶
type Reference struct {
// The type of the reference. DATE must be of type Epoch timestamp.
//
// This member is required.
Type ReferenceType
// The Amazon Resource Name (ARN) of the reference
Arn *string
// Status of the attachment reference type.
Status ReferenceStatus
// Relevant details why the reference was not successfully created.
StatusReason *string
// A valid value for the reference. For example, for a URL reference, a formatted
// URL that is displayed to an agent in the Contact Control Panel (CCP).
Value *string
// contains filtered or unexported fields
}
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
type ReferenceStatus ¶
type ReferenceStatus string
const ( ReferenceStatusAvailable ReferenceStatus = "AVAILABLE" ReferenceStatusDeleted ReferenceStatus = "DELETED" ReferenceStatusApproved ReferenceStatus = "APPROVED" ReferenceStatusRejected ReferenceStatus = "REJECTED" ReferenceStatusProcessing ReferenceStatus = "PROCESSING" ReferenceStatusFailed ReferenceStatus = "FAILED" )
Enum values for ReferenceStatus
func (ReferenceStatus) Values ¶
func (ReferenceStatus) Values() []ReferenceStatus
Values returns all known values for ReferenceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ReferenceSummary ¶
type ReferenceSummary interface {
// contains filtered or unexported methods
}
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
The following types satisfy this interface:
ReferenceSummaryMemberAttachment ReferenceSummaryMemberDate ReferenceSummaryMemberEmail ReferenceSummaryMemberEmailMessage ReferenceSummaryMemberEmailMessagePlainText ReferenceSummaryMemberNumber ReferenceSummaryMemberString ReferenceSummaryMemberUrl
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.ReferenceSummary
// type switches can be used to check the union value
switch v := union.(type) {
case *types.ReferenceSummaryMemberAttachment:
_ = v.Value // Value is types.AttachmentReference
case *types.ReferenceSummaryMemberDate:
_ = v.Value // Value is types.DateReference
case *types.ReferenceSummaryMemberEmail:
_ = v.Value // Value is types.EmailReference
case *types.ReferenceSummaryMemberEmailMessage:
_ = v.Value // Value is types.EmailMessageReference
case *types.ReferenceSummaryMemberEmailMessagePlainText:
_ = v.Value // Value is types.EmailMessageReference
case *types.ReferenceSummaryMemberNumber:
_ = v.Value // Value is types.NumberReference
case *types.ReferenceSummaryMemberString:
_ = v.Value // Value is types.StringReference
case *types.ReferenceSummaryMemberUrl:
_ = v.Value // Value is types.UrlReference
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type ReferenceSummaryMemberAttachment ¶
type ReferenceSummaryMemberAttachment struct {
Value AttachmentReference
// contains filtered or unexported fields
}
Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.
type ReferenceSummaryMemberDate ¶
type ReferenceSummaryMemberDate struct {
Value DateReference
// contains filtered or unexported fields
}
Information about a reference when the referenceType is DATE . Otherwise, null.
type ReferenceSummaryMemberEmail ¶
type ReferenceSummaryMemberEmail struct {
Value EmailReference
// contains filtered or unexported fields
}
Information about a reference when the referenceType is EMAIL . Otherwise, null.
type ReferenceSummaryMemberEmailMessage ¶
type ReferenceSummaryMemberEmailMessage struct {
Value EmailMessageReference
// contains filtered or unexported fields
}
Information about the reference when the referenceType is EMAIL_MESSAGE . Otherwise, null.
type ReferenceSummaryMemberEmailMessagePlainText ¶
type ReferenceSummaryMemberEmailMessagePlainText struct {
Value EmailMessageReference
// contains filtered or unexported fields
}
Information about the reference when the referenceType is EMAIL_MESSAGE . Otherwise, null.
type ReferenceSummaryMemberNumber ¶
type ReferenceSummaryMemberNumber struct {
Value NumberReference
// contains filtered or unexported fields
}
Information about a reference when the referenceType is NUMBER . Otherwise, null.
type ReferenceSummaryMemberString ¶
type ReferenceSummaryMemberString struct {
Value StringReference
// contains filtered or unexported fields
}
Information about a reference when the referenceType is STRING . Otherwise, null.
type ReferenceSummaryMemberUrl ¶
type ReferenceSummaryMemberUrl struct {
Value UrlReference
// contains filtered or unexported fields
}
Information about the reference when the referenceType is URL . Otherwise, null.
type ReferenceType ¶
type ReferenceType string
const ( ReferenceTypeUrl ReferenceType = "URL" ReferenceTypeAttachment ReferenceType = "ATTACHMENT" ReferenceTypeContactAnalysis ReferenceType = "CONTACT_ANALYSIS" ReferenceTypeNumber ReferenceType = "NUMBER" ReferenceTypeString ReferenceType = "STRING" ReferenceTypeDate ReferenceType = "DATE" ReferenceTypeEmail ReferenceType = "EMAIL" ReferenceTypeEmailMessage ReferenceType = "EMAIL_MESSAGE" ReferenceTypeEmailMessagePlainText ReferenceType = "EMAIL_MESSAGE_PLAIN_TEXT" )
Enum values for ReferenceType
func (ReferenceType) Values ¶
func (ReferenceType) Values() []ReferenceType
Values returns all known values for ReferenceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RehydrationType ¶
type RehydrationType string
const ( RehydrationTypeEntirePastSession RehydrationType = "ENTIRE_PAST_SESSION" RehydrationTypeFromSegment RehydrationType = "FROM_SEGMENT" )
Enum values for RehydrationType
func (RehydrationType) Values ¶
func (RehydrationType) Values() []RehydrationType
Values returns all known values for RehydrationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ReplicationConfiguration ¶
type ReplicationConfiguration struct {
// The URL that is used to sign-in to your Amazon Connect instance according to
// your traffic distribution group configuration. For more information about
// sign-in and traffic distribution groups, see [Important things to know]in the Create traffic distribution
// groups topic in the Amazon Connect Administrator Guide.
//
// [Important things to know]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html
GlobalSignInEndpoint *string
// A list of replication status summaries. The summaries contain details about the
// replication of configuration information for Amazon Connect resources, for each
// Amazon Web Services Region.
ReplicationStatusSummaryList []ReplicationStatusSummary
// The Amazon Web Services Region where the source Amazon Connect instance was
// created. This is the Region where the [ReplicateInstance]API was called to start the replication
// process.
//
// [ReplicateInstance]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html
SourceRegion *string
// contains filtered or unexported fields
}
Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call failsin the Create a replica of your existing Amazon Connect instance topic in the Amazon Connect Administrator Guide.
type ReplicationStatusSummary ¶
type ReplicationStatusSummary struct {
// The Amazon Web Services Region. This can be either the source or the replica
// Region, depending where it appears in the summary list.
Region *string
// The state of the replication.
ReplicationStatus InstanceReplicationStatus
// A description of the replication status. Use this information to resolve any
// issues that are preventing the successful replication of your Amazon Connect
// instance to another Region.
ReplicationStatusReason *string
// contains filtered or unexported fields
}
Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see Set up Amazon Connect Global Resiliencyin the Amazon Connect Administrator Guide.
type RequiredFieldInfo ¶
type RequiredFieldInfo struct {
// The unique identifier for the field.
Id *TaskTemplateFieldIdentifier
// contains filtered or unexported fields
}
Information about a required field.
type ResourceConflictException ¶
type ResourceConflictException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
A resource already has that name.
func (*ResourceConflictException) Error ¶
func (e *ResourceConflictException) Error() string
func (*ResourceConflictException) ErrorCode ¶
func (e *ResourceConflictException) ErrorCode() string
func (*ResourceConflictException) ErrorFault ¶
func (e *ResourceConflictException) ErrorFault() smithy.ErrorFault
func (*ResourceConflictException) ErrorMessage ¶
func (e *ResourceConflictException) ErrorMessage() string
type ResourceInUseException ¶
type ResourceInUseException struct {
Message *string
ErrorCodeOverride *string
ResourceType ResourceType
ResourceId *string
// contains filtered or unexported fields
}
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.
func (*ResourceInUseException) Error ¶
func (e *ResourceInUseException) Error() string
func (*ResourceInUseException) ErrorCode ¶
func (e *ResourceInUseException) ErrorCode() string
func (*ResourceInUseException) ErrorFault ¶
func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault
func (*ResourceInUseException) ErrorMessage ¶
func (e *ResourceInUseException) ErrorMessage() string
type ResourceNotFoundException ¶
type ResourceNotFoundException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The specified resource was not found.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ResourceNotReadyException ¶
type ResourceNotReadyException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The resource is not ready.
func (*ResourceNotReadyException) Error ¶
func (e *ResourceNotReadyException) Error() string
func (*ResourceNotReadyException) ErrorCode ¶
func (e *ResourceNotReadyException) ErrorCode() string
func (*ResourceNotReadyException) ErrorFault ¶
func (e *ResourceNotReadyException) ErrorFault() smithy.ErrorFault
func (*ResourceNotReadyException) ErrorMessage ¶
func (e *ResourceNotReadyException) ErrorMessage() string
type ResourceTagsSearchCriteria ¶
type ResourceTagsSearchCriteria struct {
// The search criteria to be used to return tags.
TagSearchCondition *TagSearchCondition
// contains filtered or unexported fields
}
The search criteria to be used to search tags.
type ResourceType ¶
type ResourceType string
const ( ResourceTypeContact ResourceType = "CONTACT" ResourceTypeContactFlow ResourceType = "CONTACT_FLOW" ResourceTypeInstance ResourceType = "INSTANCE" ResourceTypeParticipant ResourceType = "PARTICIPANT" ResourceTypeHierarchyLevel ResourceType = "HIERARCHY_LEVEL" ResourceTypeHierarchyGroup ResourceType = "HIERARCHY_GROUP" ResourceTypeUser ResourceType = "USER" ResourceTypePhoneNumber ResourceType = "PHONE_NUMBER" )
Enum values for ResourceType
func (ResourceType) Values ¶
func (ResourceType) Values() []ResourceType
Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ResponseMode ¶
type ResponseMode string
const ( ResponseModeIncremental ResponseMode = "INCREMENTAL" ResponseModeComplete ResponseMode = "COMPLETE" )
Enum values for ResponseMode
func (ResponseMode) Values ¶
func (ResponseMode) Values() []ResponseMode
Values returns all known values for ResponseMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RoutingCriteria ¶
type RoutingCriteria struct {
// The timestamp indicating when the routing criteria is set to active. A routing
// criteria is activated when contact is transferred to a queue.
// ActivationTimestamp will be set on routing criteria for contacts in agent queue
// even though Routing criteria is never activated for contacts in agent queue.
ActivationTimestamp *time.Time
// Information about the index of the routing criteria.
Index *int32
// List of routing steps. When Amazon Connect does not find an available agent
// meeting the requirements in a step for a given step duration, the routing
// criteria will move on to the next step sequentially until a join is completed
// with an agent. When all steps are exhausted, the contact will be offered to any
// agent in the queue.
Steps []Step
// contains filtered or unexported fields
}
Latest routing criteria on the contact.
type RoutingCriteriaInput ¶
type RoutingCriteriaInput struct {
// When Amazon Connect does not find an available agent meeting the requirements
// in a step for a given step duration, the routing criteria will move on to the
// next step sequentially until a join is completed with an agent. When all steps
// are exhausted, the contact will be offered to any agent in the queue.
Steps []RoutingCriteriaInputStep
// contains filtered or unexported fields
}
An object to define the RoutingCriteria.
type RoutingCriteriaInputStep ¶
type RoutingCriteriaInputStep struct {
// An object to specify the expiration of a routing step.
Expiry *RoutingCriteriaInputStepExpiry
// A tagged union to specify expression for a routing step.
Expression *Expression
// contains filtered or unexported fields
}
Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.
type RoutingCriteriaInputStepExpiry ¶
type RoutingCriteriaInputStepExpiry struct {
// The number of seconds that the contact will be routed only to agents matching
// this routing step, if expiry was configured for this routing step.
DurationInSeconds *int32
// contains filtered or unexported fields
}
Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never expire.
type RoutingCriteriaStepStatus ¶
type RoutingCriteriaStepStatus string
const ( RoutingCriteriaStepStatusActive RoutingCriteriaStepStatus = "ACTIVE" RoutingCriteriaStepStatusInactive RoutingCriteriaStepStatus = "INACTIVE" RoutingCriteriaStepStatusJoined RoutingCriteriaStepStatus = "JOINED" RoutingCriteriaStepStatusExpired RoutingCriteriaStepStatus = "EXPIRED" )
Enum values for RoutingCriteriaStepStatus
func (RoutingCriteriaStepStatus) Values ¶
func (RoutingCriteriaStepStatus) Values() []RoutingCriteriaStepStatus
Values returns all known values for RoutingCriteriaStepStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RoutingProfile ¶
type RoutingProfile struct {
// Whether agents with this routing profile will have their routing order
// calculated based on time since their last inbound contact or longest idle time.
AgentAvailabilityTimer AgentAvailabilityTimer
// The IDs of the associated manual assignment queues.
AssociatedManualAssignmentQueueIds []string
// The IDs of the associated queue.
AssociatedQueueIds []string
// The identifier of the default outbound queue for this routing profile.
DefaultOutboundQueueId *string
// The description of the routing profile.
Description *string
// The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource
// Name (ARN) of the instance.
//
// [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
InstanceId *string
// Whether this a default routing profile.
IsDefault bool
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The channels agents can handle in the Contact Control Panel (CCP) for this
// routing profile.
MediaConcurrencies []MediaConcurrency
// The name of the routing profile.
Name *string
// The number of associated manual assignment queues in routing profile.
NumberOfAssociatedManualAssignmentQueues *int64
// The number of associated queues in routing profile.
NumberOfAssociatedQueues *int64
// The number of associated users in routing profile.
NumberOfAssociatedUsers *int64
// The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileArn *string
// The identifier of the routing profile.
RoutingProfileId *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Contains information about a routing profile.
type RoutingProfileManualAssignmentQueueConfig ¶
type RoutingProfileManualAssignmentQueueConfig struct {
// Contains the channel and queue identifier for a routing profile.
//
// This member is required.
QueueReference *RoutingProfileQueueReference
// contains filtered or unexported fields
}
Contains information about the queue and channel for manual assignment behaviour can be enabled.
type RoutingProfileManualAssignmentQueueConfigSummary ¶
type RoutingProfileManualAssignmentQueueConfigSummary struct {
// The channels this queue supports. Valid Values: CHAT | TASK | EMAIL
//
// VOICE is not supported. The information shown below is incorrect. We're working
// to correct it.
//
// This member is required.
Channel Channel
// The Amazon Resource Name (ARN) of the queue.
//
// This member is required.
QueueArn *string
// The identifier for the queue.
//
// This member is required.
QueueId *string
// The name of the queue.
//
// This member is required.
QueueName *string
// contains filtered or unexported fields
}
Contains summary information about a routing profile manual assignment queue.
type RoutingProfileQueueConfig ¶
type RoutingProfileQueueConfig struct {
// The delay, in seconds, a contact should be in the queue before they are routed
// to an available agent. For more information, see [Queues: priority and delay]in the Amazon Connect
// Administrator Guide.
//
// [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
//
// This member is required.
Delay *int32
// The order in which contacts are to be handled for the queue. For more
// information, see [Queues: priority and delay].
//
// [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
//
// This member is required.
Priority *int32
// Contains information about a queue resource.
//
// This member is required.
QueueReference *RoutingProfileQueueReference
// contains filtered or unexported fields
}
Contains information about the queue and channel for which priority and delay can be set.
type RoutingProfileQueueConfigSummary ¶
type RoutingProfileQueueConfigSummary struct {
// The channels this queue supports.
//
// This member is required.
Channel Channel
// The delay, in seconds, that a contact should be in the queue before they are
// routed to an available agent. For more information, see [Queues: priority and delay]in the Amazon Connect
// Administrator Guide.
//
// [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
//
// This member is required.
Delay int32
// The order in which contacts are to be handled for the queue. For more
// information, see [Queues: priority and delay].
//
// [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html
//
// This member is required.
Priority *int32
// The Amazon Resource Name (ARN) of the queue.
//
// This member is required.
QueueArn *string
// The identifier for the queue.
//
// This member is required.
QueueId *string
// The name of the queue.
//
// This member is required.
QueueName *string
// contains filtered or unexported fields
}
Contains summary information about a routing profile queue.
type RoutingProfileQueueReference ¶
type RoutingProfileQueueReference struct {
// The channels agents can handle in the Contact Control Panel (CCP) for this
// routing profile.
//
// This member is required.
Channel Channel
// The identifier for the queue.
//
// This member is required.
QueueId *string
// contains filtered or unexported fields
}
Contains the channel and queue identifier for a routing profile.
type RoutingProfileReference ¶
type RoutingProfileReference struct {
// The Amazon Resource Name (ARN) of the routing profile.
Arn *string
// The identifier of the routing profile.
Id *string
// contains filtered or unexported fields
}
Information about the routing profile assigned to the user.
type RoutingProfileSearchCriteria ¶
type RoutingProfileSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []RoutingProfileSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []RoutingProfileSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are associatedQueueIds , name ,
// description , and resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return routing profiles.
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
type RoutingProfileSearchFilter ¶
type RoutingProfileSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type RoutingProfileSummary ¶
type RoutingProfileSummary struct {
// The Amazon Resource Name (ARN) of the routing profile.
Arn *string
// The identifier of the routing profile.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the routing profile.
Name *string
// contains filtered or unexported fields
}
Contains summary information about a routing profile.
type Rule ¶
type Rule struct {
// A list of actions to be run when the rule is triggered.
//
// This member is required.
Actions []RuleAction
// The timestamp for when the rule was created.
//
// This member is required.
CreatedTime *time.Time
// The conditions of the rule.
//
// This member is required.
Function *string
// The Amazon Resource Name (ARN) of the user who last updated the rule.
//
// This member is required.
LastUpdatedBy *string
// The timestamp for the when the rule was last updated.
//
// This member is required.
LastUpdatedTime *time.Time
// The name of the rule.
//
// This member is required.
Name *string
// The publish status of the rule.
//
// This member is required.
PublishStatus RulePublishStatus
// The Amazon Resource Name (ARN) of the rule.
//
// This member is required.
RuleArn *string
// A unique identifier for the rule.
//
// This member is required.
RuleId *string
// The event source to trigger the rule.
//
// This member is required.
TriggerEventSource *RuleTriggerEventSource
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Information about a rule.
type RuleAction ¶
type RuleAction struct {
// The type of action that creates a rule.
//
// This member is required.
ActionType ActionType
// Information about the contact category action.
//
// Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
// OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
// OnPostChatAnalysisAvailable | OnZendeskTicketCreate |
// OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
AssignContactCategoryAction *AssignContactCategoryActionDefinition
// Information about the assign SLA action.
AssignSlaAction *AssignSlaActionDefinition
// Information about the create case action.
//
// Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
// OnPostChatAnalysisAvailable .
CreateCaseAction *CreateCaseActionDefinition
// Information about the end associated tasks action.
//
// Supported only for TriggerEventSource values: OnCaseUpdate .
EndAssociatedTasksAction *EndAssociatedTasksActionDefinition
// Information about the EventBridge action.
//
// Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
// OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
// OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
EventBridgeAction *EventBridgeActionDefinition
// Information about the send notification action.
//
// Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable |
// OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
// OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
SendNotificationAction *SendNotificationActionDefinition
// Information about the submit automated evaluation action.
SubmitAutoEvaluationAction *SubmitAutoEvaluationActionDefinition
// Information about the task action. This field is required if TriggerEventSource
// is one of the following values: OnZendeskTicketCreate |
// OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
TaskAction *TaskActionDefinition
// Information about the update case action.
//
// Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate .
UpdateCaseAction *UpdateCaseActionDefinition
// contains filtered or unexported fields
}
Information about the action to be performed when a rule is triggered.
type RulePublishStatus ¶
type RulePublishStatus string
const ( RulePublishStatusDraft RulePublishStatus = "DRAFT" RulePublishStatusPublished RulePublishStatus = "PUBLISHED" )
Enum values for RulePublishStatus
func (RulePublishStatus) Values ¶
func (RulePublishStatus) Values() []RulePublishStatus
Values returns all known values for RulePublishStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RuleSummary ¶
type RuleSummary struct {
// A list of ActionTypes associated with a rule.
//
// This member is required.
ActionSummaries []ActionSummary
// The timestamp for when the rule was created.
//
// This member is required.
CreatedTime *time.Time
// The name of the event source.
//
// This member is required.
EventSourceName EventSourceName
// The timestamp for when the rule was last updated.
//
// This member is required.
LastUpdatedTime *time.Time
// The name of the rule.
//
// This member is required.
Name *string
// The publish status of the rule.
//
// This member is required.
PublishStatus RulePublishStatus
// The Amazon Resource Name (ARN) of the rule.
//
// This member is required.
RuleArn *string
// A unique identifier for the rule.
//
// This member is required.
RuleId *string
// contains filtered or unexported fields
}
A list of ActionTypes associated with a rule.
type RuleTriggerEventSource ¶
type RuleTriggerEventSource struct {
// The name of the event source.
//
// This member is required.
EventSourceName EventSourceName
// The identifier for the integration association.
IntegrationAssociationId *string
// contains filtered or unexported fields
}
The name of the event source. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate .
type S3Config ¶
type S3Config struct {
// The S3 bucket name.
//
// This member is required.
BucketName *string
// The S3 bucket prefix.
//
// This member is required.
BucketPrefix *string
// The Amazon S3 encryption configuration.
EncryptionConfig *EncryptionConfig
// contains filtered or unexported fields
}
Information about the Amazon Simple Storage Service (Amazon S3) storage type.
type ScreenShareCapability ¶
type ScreenShareCapability string
const ( ScreenShareCapability = "SEND" )
Enum values for ScreenShareCapability
func (ScreenShareCapability) Values ¶
func (ScreenShareCapability) Values() []ScreenShareCapability
Values returns all known values for ScreenShareCapability. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SearchContactsAdditionalTimeRange ¶
type SearchContactsAdditionalTimeRange struct {
// List of criteria of the time range to additionally filter on.
//
// This member is required.
Criteria []SearchContactsAdditionalTimeRangeCriteria
// The match type combining multiple time range filters.
//
// This member is required.
MatchType SearchContactsMatchType
// contains filtered or unexported fields
}
Time range that you additionally want to filter on.
This is different from the SearchContactsTimeRange data type.
type SearchContactsAdditionalTimeRangeCriteria ¶
type SearchContactsAdditionalTimeRangeCriteria struct {
// A structure of time range that you want to search results.
TimeRange *SearchContactsTimeRange
// List of the timestamp conditions.
TimestampCondition *SearchContactsTimestampCondition
// contains filtered or unexported fields
}
The criteria of the time range to additionally filter on.
type SearchContactsMatchType ¶
type SearchContactsMatchType string
const ( SearchContactsMatchTypeMatchAll SearchContactsMatchType = "MATCH_ALL" SearchContactsMatchTypeMatchAny SearchContactsMatchType = "MATCH_ANY" SearchContactsMatchTypeMatchExact SearchContactsMatchType = "MATCH_EXACT" SearchContactsMatchTypeMatchNone SearchContactsMatchType = "MATCH_NONE" )
Enum values for SearchContactsMatchType
func (SearchContactsMatchType) Values ¶
func (SearchContactsMatchType) Values() []SearchContactsMatchType
Values returns all known values for SearchContactsMatchType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SearchContactsTimeRange ¶
type SearchContactsTimeRange struct {
// The end time of the time range.
//
// This member is required.
EndTime *time.Time
// The start time of the time range.
//
// This member is required.
StartTime *time.Time
// The type of timestamp to search.
//
// This member is required.
Type SearchContactsTimeRangeType
// contains filtered or unexported fields
}
A structure of time range that you want to search results.
type SearchContactsTimeRangeConditionType ¶
type SearchContactsTimeRangeConditionType string
const ( SearchContactsTimeRangeConditionTypeNotExists SearchContactsTimeRangeConditionType = "NOT_EXISTS" )
Enum values for SearchContactsTimeRangeConditionType
func (SearchContactsTimeRangeConditionType) Values ¶
func (SearchContactsTimeRangeConditionType) Values() []SearchContactsTimeRangeConditionType
Values returns all known values for SearchContactsTimeRangeConditionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SearchContactsTimeRangeType ¶
type SearchContactsTimeRangeType string
const ( SearchContactsTimeRangeTypeInitiationTimestamp SearchContactsTimeRangeType = "INITIATION_TIMESTAMP" SearchContactsTimeRangeTypeScheduledTimestamp SearchContactsTimeRangeType = "SCHEDULED_TIMESTAMP" SearchContactsTimeRangeTypeConnectedToAgentTimestamp SearchContactsTimeRangeType = "CONNECTED_TO_AGENT_TIMESTAMP" SearchContactsTimeRangeTypeDisconnectTimestamp SearchContactsTimeRangeType = "DISCONNECT_TIMESTAMP" SearchContactsTimeRangeTypeEnqueueTimestamp SearchContactsTimeRangeType = "ENQUEUE_TIMESTAMP" )
Enum values for SearchContactsTimeRangeType
func (SearchContactsTimeRangeType) Values ¶
func (SearchContactsTimeRangeType) Values() []SearchContactsTimeRangeType
Values returns all known values for SearchContactsTimeRangeType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SearchContactsTimestampCondition ¶
type SearchContactsTimestampCondition struct {
// Condition of the timestamp on the contact.
//
// This member is required.
ConditionType SearchContactsTimeRangeConditionType
// Type of the timestamps to use for the filter.
//
// This member is required.
Type SearchContactsTimeRangeType
// contains filtered or unexported fields
}
The timestamp condition indicating which contact timestamp should be used and how it should be filtered. It is not an actual timestamp value.
type SearchCriteria ¶
type SearchCriteria struct {
// Additional TimeRange used to filter contacts.
AdditionalTimeRange *SearchContactsAdditionalTimeRange
// The agent hierarchy groups of the agent at the time of handling the contact.
AgentHierarchyGroups *AgentHierarchyGroups
// The identifiers of agents who handled the contacts.
AgentIds []string
// The list of channels associated with contacts.
Channels []Channel
// Search criteria based on analysis outputs from Amazon Connect Contact Lens.
ContactAnalysis *ContactAnalysis
// The list of initiation methods associated with contacts.
InitiationMethods []ContactInitiationMethod
// Name of the contact.
Name *NameCriteria
// The list of queue IDs associated with contacts.
QueueIds []string
// Routing criteria for the contact.
RoutingCriteria *SearchableRoutingCriteria
// The search criteria based on user-defined contact attributes that have been
// configured for contact search. For more information, see [Search by custom contact attributes]in the Amazon Connect
// Administrator Guide.
//
// To use SearchableContactAttributes in a search request, the GetContactAttributes
// action is required to perform an API request. For more information, see [https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions]Actions
// defined by Amazon Connect.
//
// [https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions
// [Search by custom contact attributes]: https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html
SearchableContactAttributes *SearchableContactAttributes
// The search criteria based on searchable segment attributes of a contact.
SearchableSegmentAttributes *SearchableSegmentAttributes
// contains filtered or unexported fields
}
A structure of search criteria to be used to return contacts.
type SearchableAgentCriteriaStep ¶
type SearchableAgentCriteriaStep struct {
// The identifiers of agents used in preferred agents matching.
AgentIds []string
// The match type combining multiple agent criteria steps.
MatchType SearchContactsMatchType
// contains filtered or unexported fields
}
The agent criteria to search for preferred agents on the routing criteria.
type SearchableContactAttributes ¶
type SearchableContactAttributes struct {
// The list of criteria based on user-defined contact attributes that are
// configured for contact search.
//
// This member is required.
Criteria []SearchableContactAttributesCriteria
// The match type combining search criteria using multiple searchable contact
// attributes.
MatchType SearchContactsMatchType
// contains filtered or unexported fields
}
A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
type SearchableContactAttributesCriteria ¶
type SearchableContactAttributesCriteria struct {
// The key containing a searchable user-defined contact attribute.
//
// This member is required.
Key *string
// The list of values to search for within a user-defined contact attribute.
//
// This member is required.
Values []string
// contains filtered or unexported fields
}
The search criteria based on user-defined contact attribute key and values to search on.
type SearchableQueueType ¶
type SearchableQueueType string
const ( SearchableQueueTypeStandard SearchableQueueType = "STANDARD" )
Enum values for SearchableQueueType
func (SearchableQueueType) Values ¶
func (SearchableQueueType) Values() []SearchableQueueType
Values returns all known values for SearchableQueueType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SearchableRoutingCriteria ¶
type SearchableRoutingCriteria struct {
// The list of Routing criteria steps of the contact routing.
Steps []SearchableRoutingCriteriaStep
// contains filtered or unexported fields
}
Routing criteria of the contact to match on.
type SearchableRoutingCriteriaStep ¶
type SearchableRoutingCriteriaStep struct {
// Agent matching the routing step of the routing criteria
AgentCriteria *SearchableAgentCriteriaStep
// contains filtered or unexported fields
}
Routing criteria of the contact to match on.
type SearchableSegmentAttributes ¶
type SearchableSegmentAttributes struct {
// The list of criteria based on searchable segment attributes.
//
// This member is required.
Criteria []SearchableSegmentAttributesCriteria
// The match type combining search criteria using multiple searchable segment
// attributes.
MatchType SearchContactsMatchType
// contains filtered or unexported fields
}
The search criteria based on searchable segment attributes of a contact
type SearchableSegmentAttributesCriteria ¶
type SearchableSegmentAttributesCriteria struct {
// The key containing a searchable segment attribute.
//
// This member is required.
Key *string
// The list of values to search for within a searchable segment attribute.
//
// This member is required.
Values []string
// contains filtered or unexported fields
}
The search criteria based on searchable segment attribute key and values to search on.
type SecurityKey ¶
type SecurityKey struct {
// The existing association identifier that uniquely identifies the resource type
// and storage config for the given instance ID.
AssociationId *string
// When the security key was created.
CreationTime *time.Time
// The key of the security key.
Key *string
// contains filtered or unexported fields
}
Configuration information of the security key.
type SecurityProfile ¶
type SecurityProfile struct {
// The identifier of the hierarchy group that a security profile uses to restrict
// access to resources in Amazon Connect.
AllowedAccessControlHierarchyGroupId *string
// The list of tags that a security profile uses to restrict access to resources
// in Amazon Connect.
AllowedAccessControlTags map[string]string
// The Amazon Resource Name (ARN) for the security profile.
Arn *string
// The description of the security profile.
Description *string
// The granular access control configuration for the security profile, including
// data table permissions.
GranularAccessControlConfiguration *GranularAccessControlConfiguration
// The list of resources that a security profile applies hierarchy restrictions to
// in Amazon Connect. Following are acceptable ResourceNames: User .
HierarchyRestrictedResources []string
// The identifier for the security profile.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The organization resource identifier for the security profile.
OrganizationResourceId *string
// The name for the security profile.
SecurityProfileName *string
// The list of resources that a security profile applies tag restrictions to in
// Amazon Connect.
TagRestrictedResources []string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Contains information about a security profile.
type SecurityProfileItem ¶
type SecurityProfileItem struct {
// Id of a security profile item.
Id *string
// contains filtered or unexported fields
}
Security profile items.
type SecurityProfileSearchCriteria ¶
type SecurityProfileSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []SecurityProfileSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []SecurityProfileSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return security profiles.
The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
type SecurityProfileSearchSummary ¶
type SecurityProfileSearchSummary struct {
// The Amazon Resource Name (ARN) of the security profile.
Arn *string
// The description of the security profile.
Description *string
// The identifier of the security profile.
Id *string
// The organization resource identifier.
OrganizationResourceId *string
// The name of the security profile.
SecurityProfileName *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Information about the returned security profiles.
type SecurityProfileSummary ¶
type SecurityProfileSummary struct {
// The Amazon Resource Name (ARN) of the security profile.
Arn *string
// The identifier of the security profile.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the security profile.
Name *string
// contains filtered or unexported fields
}
Contains information about a security profile.
type SecurityProfilesSearchFilter ¶
type SecurityProfilesSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type SegmentAttributeValue ¶
type SegmentAttributeValue struct {
// The value of a segment attribute that has to be a valid ARN. This is only
// supported for system-defined attributes, not for user-defined attributes.
ValueArn *string
// The value of a segment attribute.
ValueInteger *int32
// The value of a segment attribute. This is only supported for system-defined
// attributes, not for user-defined attributes.
ValueList []SegmentAttributeValue
// The value of a segment attribute.
ValueMap map[string]SegmentAttributeValue
// The value of a segment attribute.
ValueString *string
// contains filtered or unexported fields
}
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
type SendNotificationActionDefinition ¶
type SendNotificationActionDefinition struct {
// Notification content. Supports variable injection. For more information, see [JSONPath reference]
// in the Amazon Connect Administrators Guide.
//
// [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
//
// This member is required.
Content *string
// Content type format.
//
// This member is required.
ContentType NotificationContentType
// Notification delivery method.
//
// This member is required.
DeliveryMethod NotificationDeliveryType
// Notification recipient.
//
// This member is required.
Recipient *NotificationRecipientType
// Recipients to exclude from notification.
Exclusion *NotificationRecipientType
// The subject of the email if the delivery method is EMAIL . Supports variable
// injection. For more information, see [JSONPath reference]in the Amazon Connect Administrators Guide.
//
// [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
Subject *string
// contains filtered or unexported fields
}
Information about the send notification action.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct {
Message *string
ErrorCodeOverride *string
Reason ServiceQuotaExceededExceptionReason
// contains filtered or unexported fields
}
The service quota has been exceeded.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type ServiceQuotaExceededExceptionReason ¶
type ServiceQuotaExceededExceptionReason interface {
// contains filtered or unexported methods
}
The reason for the exception.
The following types satisfy this interface:
ServiceQuotaExceededExceptionReasonMemberAttachedFileServiceQuotaExceededExceptionReason
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.ServiceQuotaExceededExceptionReason
// type switches can be used to check the union value
switch v := union.(type) {
case *types.ServiceQuotaExceededExceptionReasonMemberAttachedFileServiceQuotaExceededExceptionReason:
_ = v.Value // Value is types.AttachedFileServiceQuotaExceededExceptionReason
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type ServiceQuotaExceededExceptionReasonMemberAttachedFileServiceQuotaExceededExceptionReason ¶
type ServiceQuotaExceededExceptionReasonMemberAttachedFileServiceQuotaExceededExceptionReason struct {
Value AttachedFileServiceQuotaExceededExceptionReason
// contains filtered or unexported fields
}
Total file size of all files or total number of files exceeds the service quota
type SignInConfig ¶
type SignInConfig struct {
// Information about traffic distributions.
//
// This member is required.
Distributions []SignInDistribution
// contains filtered or unexported fields
}
The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
type SignInDistribution ¶
type SignInDistribution struct {
// Whether sign in distribution is enabled.
//
// This member is required.
Enabled bool
// The Amazon Web Services Region of the sign in distribution.
//
// This member is required.
Region *string
// contains filtered or unexported fields
}
The distribution of sign in traffic between the instance and its replica(s).
type SingleSelectQuestionRuleCategoryAutomation ¶
type SingleSelectQuestionRuleCategoryAutomation struct {
// The category name, as defined in Rules.
//
// This member is required.
Category *string
// The condition to apply for the automation option. If the condition is PRESENT ,
// then the option is applied when the contact data includes the category.
// Similarly, if the condition is NOT_PRESENT , then the option is applied when the
// contact data does not include the category.
//
// This member is required.
Condition SingleSelectQuestionRuleCategoryAutomationCondition
// The identifier of the answer option.
//
// This member is required.
OptionRefId *string
// contains filtered or unexported fields
}
Information about the automation option based on a rule category for a single select question.
type SingleSelectQuestionRuleCategoryAutomationCondition ¶
type SingleSelectQuestionRuleCategoryAutomationCondition string
const ( SingleSelectQuestionRuleCategoryAutomationConditionPresent SingleSelectQuestionRuleCategoryAutomationCondition = "PRESENT" SingleSelectQuestionRuleCategoryAutomationConditionNotPresent SingleSelectQuestionRuleCategoryAutomationCondition = "NOT_PRESENT" )
Enum values for SingleSelectQuestionRuleCategoryAutomationCondition
func (SingleSelectQuestionRuleCategoryAutomationCondition) Values ¶
func (SingleSelectQuestionRuleCategoryAutomationCondition) Values() []SingleSelectQuestionRuleCategoryAutomationCondition
Values returns all known values for SingleSelectQuestionRuleCategoryAutomationCondition. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SlaAssignmentType ¶
type SlaAssignmentType string
const ( SlaAssignmentTypeCases SlaAssignmentType = "CASES" )
Enum values for SlaAssignmentType
func (SlaAssignmentType) Values ¶
func (SlaAssignmentType) Values() []SlaAssignmentType
Values returns all known values for SlaAssignmentType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SlaType ¶
type SlaType string
const ( SlaTypeCaseField SlaType = "CaseField" )
Enum values for SlaType
func (SlaType) Values ¶
Values returns all known values for SlaType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Sort ¶
type Sort struct {
// The name of the field on which to sort.
//
// This member is required.
FieldName SortableFieldName
// An ascending or descending sort.
//
// This member is required.
Order SortOrder
// contains filtered or unexported fields
}
A structure that defines the field name to sort by and a sort order.
type SortOrder ¶
type SortOrder string
Enum values for SortOrder
func (SortOrder) Values ¶
Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SortableFieldName ¶
type SortableFieldName string
const ( SortableFieldNameInitiationTimestamp SortableFieldName = "INITIATION_TIMESTAMP" SortableFieldNameScheduledTimestamp SortableFieldName = "SCHEDULED_TIMESTAMP" SortableFieldNameConnectedToAgentTimestamp SortableFieldName = "CONNECTED_TO_AGENT_TIMESTAMP" SortableFieldNameDisconnectTimestamp SortableFieldName = "DISCONNECT_TIMESTAMP" SortableFieldNameInitiationMethod SortableFieldName = "INITIATION_METHOD" SortableFieldNameChannel SortableFieldName = "CHANNEL" SortableFieldNameExpiryTimestamp SortableFieldName = "EXPIRY_TIMESTAMP" )
Enum values for SortableFieldName
func (SortableFieldName) Values ¶
func (SortableFieldName) Values() []SortableFieldName
Values returns all known values for SortableFieldName. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SourceCampaign ¶
type SourceCampaign struct {
// A unique identifier for a campaign.
CampaignId *string
// A unique identifier for a each request part of same campaign.
OutboundRequestId *string
// contains filtered or unexported fields
}
Information about the campaign.
type SourceType ¶
type SourceType string
const ( SourceTypeSalesforce SourceType = "SALESFORCE" SourceTypeZendesk SourceType = "ZENDESK" SourceTypeCases SourceType = "CASES" )
Enum values for SourceType
func (SourceType) Values ¶
func (SourceType) Values() []SourceType
Values returns all known values for SourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type StateTransition ¶
type StateTransition struct {
// The state of the transition.
State ParticipantState
// The date and time when the state ended in UTC time.
StateEndTimestamp *time.Time
// The date and time when the state started in UTC time.
StateStartTimestamp *time.Time
// contains filtered or unexported fields
}
Information about the state transition of a supervisor.
type Statistic ¶
type Statistic string
const ( StatisticSum Statistic = "SUM" StatisticMax Statistic = "MAX" StatisticAvg Statistic = "AVG" )
Enum values for Statistic
func (Statistic) Values ¶
Values returns all known values for Statistic. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Status ¶
type Status string
const ( StatusComplete Status = "COMPLETE" StatusInProgress Status = "IN_PROGRESS" StatusDeleted Status = "DELETED" )
Enum values for Status
func (Status) Values ¶
Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Step ¶
type Step struct {
// An object to specify the expiration of a routing step.
Expiry *Expiry
// A tagged union to specify expression for a routing step.
Expression *Expression
// Represents status of the Routing step.
Status RoutingCriteriaStepStatus
// contains filtered or unexported fields
}
Step signifies the criteria to be used for routing to an agent
type StorageType ¶
type StorageType string
const ( StorageTypeS3 StorageType = "S3" StorageTypeKinesisVideoStream StorageType = "KINESIS_VIDEO_STREAM" StorageTypeKinesisStream StorageType = "KINESIS_STREAM" StorageTypeKinesisFirehose StorageType = "KINESIS_FIREHOSE" )
Enum values for StorageType
func (StorageType) Values ¶
func (StorageType) Values() []StorageType
Values returns all known values for StorageType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type StringComparisonType ¶
type StringComparisonType string
const ( StringComparisonTypeStartsWith StringComparisonType = "STARTS_WITH" StringComparisonTypeContains StringComparisonType = "CONTAINS" StringComparisonTypeExact StringComparisonType = "EXACT" )
Enum values for StringComparisonType
func (StringComparisonType) Values ¶
func (StringComparisonType) Values() []StringComparisonType
Values returns all known values for StringComparisonType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type StringCondition ¶
type StringCondition struct {
// The type of comparison to be made when evaluating the string condition.
ComparisonType StringComparisonType
// The name of the field in the string condition.
FieldName *string
// The value of the string.
Value *string
// contains filtered or unexported fields
}
A leaf node condition which can be used to specify a string condition.
type StringReference ¶
type StringReference struct {
// Identifier of the string reference.
Name *string
// A valid string.
Value *string
// contains filtered or unexported fields
}
Information about a reference when the referenceType is STRING . Otherwise, null.
type SubmitAutoEvaluationActionDefinition ¶
type SubmitAutoEvaluationActionDefinition struct {
// The identifier of the auto-evaluation enabled form.
//
// This member is required.
EvaluationFormId *string
// contains filtered or unexported fields
}
Information about the submit automated evaluation action.
type SuccessfulBatchAssociationSummary ¶
type SuccessfulBatchAssociationSummary struct {
// The Amazon Resource Name (ARN) of the resource that was successfully associated.
ResourceArn *string
// contains filtered or unexported fields
}
Contains information about a resource that was successfully associated with a workspace in a batch operation.
type SuccessfulRequest ¶
type SuccessfulRequest struct {
// The contactId of the contact that was created successfully.
ContactId *string
// Request identifier provided in the API call in the ContactDataRequest to create
// a contact.
RequestIdentifier *string
// contains filtered or unexported fields
}
Request for which contact was successfully created.
type TagCondition ¶
type TagCondition struct {
// The tag key in the tag condition.
TagKey *string
// The tag value in the tag condition.
TagValue *string
// contains filtered or unexported fields
}
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
type TagSearchCondition ¶
type TagSearchCondition struct {
// The tag key used in the tag search condition.
TagKey *string
// The type of comparison to be made when evaluating the tag key in tag search
// condition.
TagKeyComparisonType StringComparisonType
// The tag value used in the tag search condition.
TagValue *string
// The type of comparison to be made when evaluating the tag value in tag search
// condition.
TagValueComparisonType StringComparisonType
// contains filtered or unexported fields
}
The search criteria to be used to return tags.
type TagSet ¶
type TagSet struct {
// The tag key in the TagSet.
Key *string
// The tag value in the tagSet.
Value *string
// contains filtered or unexported fields
}
A tag set contains tag key and tag value.
type TargetListType ¶
type TargetListType string
const ( TargetListTypeProficiencies TargetListType = "PROFICIENCIES" )
Enum values for TargetListType
func (TargetListType) Values ¶
func (TargetListType) Values() []TargetListType
Values returns all known values for TargetListType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TaskActionDefinition ¶
type TaskActionDefinition struct {
// The identifier of the flow.
//
// This member is required.
ContactFlowId *string
// The name. Supports variable injection. For more information, see [JSONPath reference] in the Amazon
// Connect Administrators Guide.
//
// [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
//
// This member is required.
Name *string
// The description. Supports variable injection. For more information, see [JSONPath reference] in the
// Amazon Connect Administrators Guide.
//
// [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html
Description *string
// Information about the reference when the referenceType is URL . Otherwise, null.
// (Supports variable injection in the Value field.)
References map[string]Reference
// contains filtered or unexported fields
}
Information about the task action.
type TaskTemplateConstraints ¶
type TaskTemplateConstraints struct {
// Lists the fields that are invisible to agents.
InvisibleFields []InvisibleFieldInfo
// Lists the fields that are read-only to agents, and cannot be edited.
ReadOnlyFields []ReadOnlyFieldInfo
// Lists the fields that are required to be filled by agents.
RequiredFields []RequiredFieldInfo
// contains filtered or unexported fields
}
Describes constraints that apply to the template fields.
type TaskTemplateDefaultFieldValue ¶
type TaskTemplateDefaultFieldValue struct {
// Default value for the field.
DefaultValue *string
// Identifier of a field.
Id *TaskTemplateFieldIdentifier
// contains filtered or unexported fields
}
Describes a default field and its corresponding value.
type TaskTemplateDefaults ¶
type TaskTemplateDefaults struct {
// Default value for the field.
DefaultFieldValues []TaskTemplateDefaultFieldValue
// contains filtered or unexported fields
}
Describes default values for fields on a template.
type TaskTemplateField ¶
type TaskTemplateField struct {
// The unique identifier for the field.
//
// This member is required.
Id *TaskTemplateFieldIdentifier
// The description of the field.
Description *string
// A list of options for a single select field.
SingleSelectOptions []string
// Indicates the type of field.
Type TaskTemplateFieldType
// contains filtered or unexported fields
}
Describes a single task template field.
type TaskTemplateFieldIdentifier ¶
type TaskTemplateFieldIdentifier struct {
// The name of the task template field.
Name *string
// contains filtered or unexported fields
}
The identifier of the task template field.
type TaskTemplateFieldType ¶
type TaskTemplateFieldType string
const ( TaskTemplateFieldTypeName TaskTemplateFieldType = "NAME" TaskTemplateFieldTypeDescription TaskTemplateFieldType = "DESCRIPTION" TaskTemplateFieldTypeScheduledTime TaskTemplateFieldType = "SCHEDULED_TIME" TaskTemplateFieldTypeQuickConnect TaskTemplateFieldType = "QUICK_CONNECT" TaskTemplateFieldTypeUrl TaskTemplateFieldType = "URL" TaskTemplateFieldTypeNumber TaskTemplateFieldType = "NUMBER" TaskTemplateFieldTypeText TaskTemplateFieldType = "TEXT" TaskTemplateFieldTypeTextArea TaskTemplateFieldType = "TEXT_AREA" TaskTemplateFieldTypeDateTime TaskTemplateFieldType = "DATE_TIME" TaskTemplateFieldTypeBoolean TaskTemplateFieldType = "BOOLEAN" TaskTemplateFieldTypeSingleSelect TaskTemplateFieldType = "SINGLE_SELECT" TaskTemplateFieldTypeEmail TaskTemplateFieldType = "EMAIL" TaskTemplateFieldTypeSelfAssign TaskTemplateFieldType = "SELF_ASSIGN" TaskTemplateFieldTypeExpiryDuration TaskTemplateFieldType = "EXPIRY_DURATION" )
Enum values for TaskTemplateFieldType
func (TaskTemplateFieldType) Values ¶
func (TaskTemplateFieldType) Values() []TaskTemplateFieldType
Values returns all known values for TaskTemplateFieldType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TaskTemplateInfoV2 ¶
type TaskTemplateInfoV2 struct {
// The Amazon Resource Name (ARN) of the task template used to create this contact.
Arn *string
// The name of the task template used to create this contact.
Name *string
// contains filtered or unexported fields
}
Information about the task template used to create this contact.
type TaskTemplateMetadata ¶
type TaskTemplateMetadata struct {
// The Amazon Resource Name (ARN) of the task template.
Arn *string
// The timestamp when the task template was created.
CreatedTime *time.Time
// The description of the task template.
Description *string
// A unique identifier for the task template.
Id *string
// The timestamp when the task template was last modified.
LastModifiedTime *time.Time
// The name of the task template.
Name *string
// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
// then a task that refers to this template cannot be created.
Status TaskTemplateStatus
// contains filtered or unexported fields
}
Contains summary information about the task template.
type TaskTemplateStatus ¶
type TaskTemplateStatus string
const ( TaskTemplateStatusActive TaskTemplateStatus = "ACTIVE" TaskTemplateStatusInactive TaskTemplateStatus = "INACTIVE" )
Enum values for TaskTemplateStatus
func (TaskTemplateStatus) Values ¶
func (TaskTemplateStatus) Values() []TaskTemplateStatus
Values returns all known values for TaskTemplateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TelephonyConfig ¶
type TelephonyConfig struct {
// Information about traffic distributions.
//
// This member is required.
Distributions []Distribution
// contains filtered or unexported fields
}
The distribution of traffic between the instance and its replicas.
type TemplateAttributes ¶
type TemplateAttributes struct {
// An object that specifies the custom attributes values to use for variables in
// the message template. This object contains different categories of key-value
// pairs. Each key defines a variable or placeholder in the message template.
CustomAttributes map[string]string
// An object that specifies the customer profile attributes values to use for
// variables in the message template. This object contains different categories of
// key-value pairs. Each key defines a variable or placeholder in the message
// template.
CustomerProfileAttributes *string
// contains filtered or unexported fields
}
Information about the template attributes.
type TemplatedMessageConfig ¶
type TemplatedMessageConfig struct {
// The identifier of the knowledge base. Can be either the ID or the ARN. URLs
// cannot contain the ARN.
//
// This member is required.
KnowledgeBaseId *string
// The identifier of the message template Id.
//
// This member is required.
MessageTemplateId *string
// Information about template attributes, that is, CustomAttributes or
// CustomerProfileAttributes.
//
// This member is required.
TemplateAttributes *TemplateAttributes
// contains filtered or unexported fields
}
Information about template message configuration.
type Threshold ¶
type Threshold struct {
// The type of comparison. Only "less than" (LT) comparisons are supported.
Comparison Comparison
// The threshold value to compare.
ThresholdValue *float64
// contains filtered or unexported fields
}
Contains information about the threshold for service level metrics.
type ThresholdV2 ¶
type ThresholdV2 struct {
// The type of comparison. Currently, "less than" (LT), "less than equal" (LTE),
// and "greater than" (GT) comparisons are supported.
Comparison *string
// The threshold value to compare.
ThresholdValue *float64
// contains filtered or unexported fields
}
Contains information about the threshold for service level metrics.
type ThrottlingException ¶
type ThrottlingException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
The throttling limit has been exceeded.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TimerEligibleParticipantRoles ¶
type TimerEligibleParticipantRoles string
const ( TimerEligibleParticipantRolesCustomer TimerEligibleParticipantRoles = "CUSTOMER" TimerEligibleParticipantRolesAgent TimerEligibleParticipantRoles = "AGENT" )
Enum values for TimerEligibleParticipantRoles
func (TimerEligibleParticipantRoles) Values ¶
func (TimerEligibleParticipantRoles) Values() []TimerEligibleParticipantRoles
Values returns all known values for TimerEligibleParticipantRoles. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TooManyRequestsException ¶
type TooManyRequestsException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
Displayed when rate-related API limits are exceeded.
func (*TooManyRequestsException) Error ¶
func (e *TooManyRequestsException) Error() string
func (*TooManyRequestsException) ErrorCode ¶
func (e *TooManyRequestsException) ErrorCode() string
func (*TooManyRequestsException) ErrorFault ¶
func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault
func (*TooManyRequestsException) ErrorMessage ¶
func (e *TooManyRequestsException) ErrorMessage() string
type TrafficDistributionGroup ¶
type TrafficDistributionGroup struct {
// The Amazon Resource Name (ARN) of the traffic distribution group.
Arn *string
// The description of the traffic distribution group.
Description *string
// The identifier of the traffic distribution group. This can be the ID or the ARN
// if the API is being called in the Region where the traffic distribution group
// was created. The ARN must be provided if the call is from the replicated Region.
Id *string
// The Amazon Resource Name (ARN).
InstanceArn *string
// Whether this is the default traffic distribution group created during instance
// replication. The default traffic distribution group cannot be deleted by the
// DeleteTrafficDistributionGroup API. The default traffic distribution group is
// deleted as part of the process for deleting a replica.
//
// The SignInConfig distribution is available only on a default
// TrafficDistributionGroup (see the IsDefault parameter in the [TrafficDistributionGroup] data type). If
// you call UpdateTrafficDistribution with a modified SignInConfig and a
// non-default TrafficDistributionGroup , an InvalidRequestException is returned.
//
// [TrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html
IsDefault bool
// The name of the traffic distribution group.
Name *string
// The status of the traffic distribution group.
//
// - CREATION_IN_PROGRESS means the previous [CreateTrafficDistributionGroup]operation is still in progress and
// has not yet completed.
//
// - ACTIVE means the previous [CreateTrafficDistributionGroup]operation has succeeded.
//
// - CREATION_FAILED indicates that the previous [CreateTrafficDistributionGroup]operation has failed.
//
// - PENDING_DELETION means the previous [DeleteTrafficDistributionGroup]operation is still in progress and has
// not yet completed.
//
// - DELETION_FAILED means the previous [DeleteTrafficDistributionGroup]operation has failed.
//
// - UPDATE_IN_PROGRESS means the previous [UpdateTrafficDistribution]operation is still in progress and
// has not yet completed.
//
// [UpdateTrafficDistribution]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html
// [DeleteTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html
// [CreateTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html
Status TrafficDistributionGroupStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Information about a traffic distribution group.
type TrafficDistributionGroupStatus ¶
type TrafficDistributionGroupStatus string
const ( TrafficDistributionGroupStatusCreationInProgress TrafficDistributionGroupStatus = "CREATION_IN_PROGRESS" TrafficDistributionGroupStatusActive TrafficDistributionGroupStatus = "ACTIVE" TrafficDistributionGroupStatusCreationFailed TrafficDistributionGroupStatus = "CREATION_FAILED" TrafficDistributionGroupStatusPendingDeletion TrafficDistributionGroupStatus = "PENDING_DELETION" TrafficDistributionGroupStatusDeletionFailed TrafficDistributionGroupStatus = "DELETION_FAILED" TrafficDistributionGroupStatusUpdateInProgress TrafficDistributionGroupStatus = "UPDATE_IN_PROGRESS" )
Enum values for TrafficDistributionGroupStatus
func (TrafficDistributionGroupStatus) Values ¶
func (TrafficDistributionGroupStatus) Values() []TrafficDistributionGroupStatus
Values returns all known values for TrafficDistributionGroupStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TrafficDistributionGroupSummary ¶
type TrafficDistributionGroupSummary struct {
// The Amazon Resource Name (ARN) of the traffic distribution group.
Arn *string
// The identifier of the traffic distribution group. This can be the ID or the ARN
// if the API is being called in the Region where the traffic distribution group
// was created. The ARN must be provided if the call is from the replicated Region.
Id *string
// The Amazon Resource Name (ARN) of the traffic distribution group.
InstanceArn *string
// Whether this is the default traffic distribution group created during instance
// replication. The default traffic distribution group cannot be deleted by the
// DeleteTrafficDistributionGroup API. The default traffic distribution group is
// deleted as part of the process for deleting a replica.
IsDefault bool
// The name of the traffic distribution group.
Name *string
// The status of the traffic distribution group.
//
// - CREATION_IN_PROGRESS means the previous [CreateTrafficDistributionGroup]operation is still in progress and
// has not yet completed.
//
// - ACTIVE means the previous [CreateTrafficDistributionGroup]operation has succeeded.
//
// - CREATION_FAILED indicates that the previous [CreateTrafficDistributionGroup]operation has failed.
//
// - PENDING_DELETION means the previous [DeleteTrafficDistributionGroup]operation is still in progress and has
// not yet completed.
//
// - DELETION_FAILED means the previous [DeleteTrafficDistributionGroup]operation has failed.
//
// - UPDATE_IN_PROGRESS means the previous [UpdateTrafficDistributionGroup]operation is still in progress and
// has not yet completed.
//
// [DeleteTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html
// [CreateTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html
// [UpdateTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html
Status TrafficDistributionGroupStatus
// contains filtered or unexported fields
}
Information about traffic distribution groups.
type TrafficDistributionGroupUserSummary ¶
type TrafficDistributionGroupUserSummary struct {
// The identifier for the user. This can be the ID or the ARN of the user.
UserId *string
// contains filtered or unexported fields
}
Summary information about a traffic distribution group user.
type TrafficType ¶
type TrafficType string
const ( TrafficTypeGeneral TrafficType = "GENERAL" TrafficTypeCampaign TrafficType = "CAMPAIGN" )
Enum values for TrafficType
func (TrafficType) Values ¶
func (TrafficType) Values() []TrafficType
Values returns all known values for TrafficType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Transcript ¶
type Transcript struct {
// The list of search criteria based on Contact Lens conversational analytics
// transcript.
//
// This member is required.
Criteria []TranscriptCriteria
// The match type combining search criteria using multiple transcript criteria.
MatchType SearchContactsMatchType
// contains filtered or unexported fields
}
A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
type TranscriptCriteria ¶
type TranscriptCriteria struct {
// The match type combining search criteria using multiple search texts in a
// transcript criteria.
//
// This member is required.
MatchType SearchContactsMatchType
// The participant role in a transcript
//
// This member is required.
ParticipantRole ParticipantRole
// The words or phrases used to search within a transcript.
//
// This member is required.
SearchText []string
// contains filtered or unexported fields
}
A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
type Unit ¶
type Unit string
Enum values for Unit
func (Unit) Values ¶
Values returns all known values for Unit. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type UnknownUnionMember ¶
type UnknownUnionMember struct {
Tag string
Value []byte
// contains filtered or unexported fields
}
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type UpdateCaseActionDefinition ¶
type UpdateCaseActionDefinition struct {
// An array of objects with Field ID and Value data.
//
// This member is required.
Fields []FieldValue
// contains filtered or unexported fields
}
The UpdateCase action definition.
type UpdateParticipantRoleConfigChannelInfo ¶
type UpdateParticipantRoleConfigChannelInfo interface {
// contains filtered or unexported methods
}
Configuration information for the chat participant role.
The following types satisfy this interface:
UpdateParticipantRoleConfigChannelInfoMemberChat
Example (OutputUsage)¶
Code:play
package main
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
)
func main() {
var union types.UpdateParticipantRoleConfigChannelInfo
// type switches can be used to check the union value
switch v := union.(type) {
case *types.UpdateParticipantRoleConfigChannelInfoMemberChat:
_ = v.Value // Value is types.ChatParticipantRoleConfig
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
type UpdateParticipantRoleConfigChannelInfoMemberChat ¶
type UpdateParticipantRoleConfigChannelInfoMemberChat struct {
Value ChatParticipantRoleConfig
// contains filtered or unexported fields
}
Configuration information for the chat participant role.
type UploadUrlMetadata ¶
type UploadUrlMetadata struct {
// A map of headers that should be provided when uploading the attached file.
HeadersToInclude map[string]string
// A pre-signed S3 URL that should be used for uploading the attached file.
Url *string
// The expiration time of the URL in ISO timestamp. It's specified in ISO 8601
// format: yyyy-MM-ddThh:mm:ss.SSSZ . For example, 2019-11-08T02:41:28.172Z .
UrlExpiry *string
// contains filtered or unexported fields
}
Fields required when uploading an attached file.
type UrlReference ¶
type UrlReference struct {
// Identifier of the URL reference.
Name *string
// A valid URL.
Value *string
// contains filtered or unexported fields
}
The URL reference.
type UseCase ¶
type UseCase struct {
// The Amazon Resource Name (ARN) for the use case.
UseCaseArn *string
// The identifier for the use case.
UseCaseId *string
// The type of use case to associate to the integration association. Each
// integration association can have only one of each use case type.
UseCaseType UseCaseType
// contains filtered or unexported fields
}
Contains the use case.
type UseCaseType ¶
type UseCaseType string
const ( UseCaseTypeRulesEvaluation UseCaseType = "RULES_EVALUATION" UseCaseTypeConnectCampaigns UseCaseType = "CONNECT_CAMPAIGNS" )
Enum values for UseCaseType
func (UseCaseType) Values ¶
func (UseCaseType) Values() []UseCaseType
Values returns all known values for UseCaseType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type User ¶
type User struct {
// The Amazon Resource Name (ARN) of the user account.
Arn *string
// The identifier of the user account in the directory used for identity
// management.
DirectoryUserId *string
// The identifier of the hierarchy group for the user.
HierarchyGroupId *string
// The identifier of the user account.
Id *string
// Information about the user identity.
IdentityInfo *UserIdentityInfo
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// Information about the phone configuration for the user.
PhoneConfig *UserPhoneConfig
// The identifier of the routing profile for the user.
RoutingProfileId *string
// The identifiers of the security profiles for the user.
SecurityProfileIds []string
// The tags.
Tags map[string]string
// The user name assigned to the user account.
Username *string
// contains filtered or unexported fields
}
Contains information about a user account for an Amazon Connect instance.
type UserData ¶
type UserData struct {
// A map of active slots by channel. The key is a channel name. The value is an
// integer: the number of active slots.
ActiveSlotsByChannel map[string]int32
// A map of available slots by channel. The key is a channel name. The value is an
// integer: the available number of slots.
AvailableSlotsByChannel map[string]int32
// A list of contact reference information.
Contacts []AgentContactReference
// Contains information about the levels of a hierarchy group assigned to a user.
HierarchyPath *HierarchyPathReference
// A map of maximum slots by channel. The key is a channel name. The value is an
// integer: the maximum number of slots. This is calculated from [MediaConcurrency]of the
// RoutingProfile assigned to the agent.
//
// [MediaConcurrency]: https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html
MaxSlotsByChannel map[string]int32
// The Next status of the agent.
NextStatus *string
// Information about the routing profile that is assigned to the user.
RoutingProfile *RoutingProfileReference
// The status of the agent that they manually set in their Contact Control Panel
// (CCP), or that the supervisor manually changes in the real-time metrics report.
Status *AgentStatusReference
// Information about the user for the data that is returned. It contains the
// resourceId and ARN of the user.
User *UserReference
// contains filtered or unexported fields
}
Data for a user.
type UserDataFilters ¶
type UserDataFilters struct {
// A list of up to 100 agent IDs or ARNs.
Agents []string
// A filter for the user data based on the contact information that is associated
// to the user. It contains a list of contact states.
ContactFilter *ContactFilter
// A list of up to 100 queues or ARNs.
Queues []string
// A list of up to 100 routing profile IDs or ARNs.
RoutingProfiles []string
// A UserHierarchyGroup ID or ARN.
UserHierarchyGroups []string
// contains filtered or unexported fields
}
A filter for the user data.
type UserHierarchyGroupSearchCriteria ¶
type UserHierarchyGroupSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []UserHierarchyGroupSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []UserHierarchyGroupSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are name , parentId , levelId , and
// resourceID .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return userHierarchyGroup.
type UserHierarchyGroupSearchFilter ¶
type UserHierarchyGroupSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter.
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type UserIdentityInfo ¶
type UserIdentityInfo struct {
// The email address. If you are using SAML for identity management and include
// this parameter, an error is returned.
Email *string
// The first name. This is required if you are using Amazon Connect or SAML for
// identity management. Inputs must be in Unicode Normalization Form C (NFC). Text
// containing characters in a non-NFC form (for example, decomposed characters or
// combining marks) are not accepted.
FirstName *string
// The last name. This is required if you are using Amazon Connect or SAML for
// identity management. Inputs must be in Unicode Normalization Form C (NFC). Text
// containing characters in a non-NFC form (for example, decomposed characters or
// combining marks) are not accepted.
LastName *string
// The user's mobile number.
Mobile *string
// The user's secondary email address. If you provide a secondary email, the user
// receives email notifications - other than password reset notifications - to this
// email address instead of to their primary email address.
//
// Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
SecondaryEmail *string
// contains filtered or unexported fields
}
Contains information about the identity of a user.
For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName , LastName , and Email cannot be updated from within Amazon Connect because they are managed by the directory.
The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName , and 1-256 for LastName .
type UserIdentityInfoLite ¶
type UserIdentityInfoLite struct {
// The user's first name.
FirstName *string
// The user's last name.
LastName *string
// contains filtered or unexported fields
}
The user's first name and last name.
type UserInfo ¶
type UserInfo struct {
// The user identifier for the contact.
UserId *string
// contains filtered or unexported fields
}
The user details for the contact.
type UserNotFoundException ¶
type UserNotFoundException struct {
Message *string
ErrorCodeOverride *string
// contains filtered or unexported fields
}
No user with the specified credentials was found in the Amazon Connect instance.
func (*UserNotFoundException) Error ¶
func (e *UserNotFoundException) Error() string
func (*UserNotFoundException) ErrorCode ¶
func (e *UserNotFoundException) ErrorCode() string
func (*UserNotFoundException) ErrorFault ¶
func (e *UserNotFoundException) ErrorFault() smithy.ErrorFault
func (*UserNotFoundException) ErrorMessage ¶
func (e *UserNotFoundException) ErrorMessage() string
type UserPhoneConfig ¶
type UserPhoneConfig struct {
// The phone type.
//
// This member is required.
PhoneType PhoneType
// The After Call Work (ACW) timeout setting, in seconds. This parameter has a
// minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0
// if you don't want to allocate a specific amount of ACW time. It essentially
// means an indefinite amount of time. When the conversation ends, ACW starts; the
// agent must choose Close contact to end ACW.
//
// When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in
// milliseconds.
AfterContactWorkTimeLimit int32
// The Auto accept setting.
AutoAccept bool
// The phone number for the user's desk phone.
DeskPhoneNumber *string
// The persistent connection setting for the user.
PersistentConnection *bool
// contains filtered or unexported fields
}
Contains information about the phone configuration settings for a user.
type UserProficiency ¶
type UserProficiency struct {
// The name of user's proficiency. You must use name of predefined attribute
// present in the Amazon Connect instance.
//
// This member is required.
AttributeName *string
// The value of user's proficiency. You must use value of predefined attribute
// present in the Amazon Connect instance.
//
// This member is required.
AttributeValue *string
// The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
//
// This member is required.
Level *float32
// contains filtered or unexported fields
}
Information about proficiency of a user.
type UserProficiencyDisassociate ¶
type UserProficiencyDisassociate struct {
// The name of user's proficiency.
//
// This member is required.
AttributeName *string
// The value of user's proficiency.
//
// This member is required.
AttributeValue *string
// contains filtered or unexported fields
}
Information about proficiency to be disassociated from the user.
type UserQuickConnectConfig ¶
type UserQuickConnectConfig struct {
// The identifier of the flow.
//
// This member is required.
ContactFlowId *string
// The identifier of the user.
//
// This member is required.
UserId *string
// contains filtered or unexported fields
}
Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
type UserReference ¶
type UserReference struct {
// The Amazon Resource Name (ARN) for the user.
Arn *string
// The unique identifier for the user.
Id *string
// contains filtered or unexported fields
}
Information about the user.
type UserSearchCriteria ¶
type UserSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []UserSearchCriteria
// A leaf node condition which can be used to specify a hierarchy group condition.
HierarchyGroupCondition *HierarchyGroupCondition
// A leaf node condition which can be used to specify a List condition to search
// users with attributes included in Lists like Proficiencies.
ListCondition *ListCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []UserSearchCriteria
// A leaf node condition which can be used to specify a string condition.
//
// The currently supported values for FieldName are Username , FirstName , LastName
// , RoutingProfileId , SecurityProfileId , resourceId .
StringCondition *StringCondition
// contains filtered or unexported fields
}
The search criteria to be used to return users.
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
type UserSearchFilter ¶
type UserSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
//
// - Top level list specifies conditions that need to be applied with OR operator
//
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
// An object that can be used to specify Tag conditions or Hierarchy Group
// conditions inside the SearchFilter.
//
// This accepts an OR of AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
//
// Only one field can be populated. This object can’t be used along with
// TagFilter. Request can either contain TagFilter or UserAttributeFilter if
// SearchFilter is specified, combination of both is not supported and such request
// will throw AccessDeniedException.
UserAttributeFilter *ControlPlaneUserAttributeFilter
// contains filtered or unexported fields
}
Filters to be applied to search results.
type UserSearchSummary ¶
type UserSearchSummary struct {
// The Amazon Resource Name (ARN) of the user.
Arn *string
// The directory identifier of the user.
DirectoryUserId *string
// The identifier of the user's hierarchy group.
HierarchyGroupId *string
// The identifier of the user's summary.
Id *string
// The user's first name and last name.
IdentityInfo *UserIdentityInfoLite
// Contains information about the phone configuration settings for a user.
PhoneConfig *UserPhoneConfig
// The identifier of the user's routing profile.
RoutingProfileId *string
// The identifiers of the user's security profiles.
SecurityProfileIds []string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The name of the user.
Username *string
// contains filtered or unexported fields
}
Information about the returned users.
type UserSummary ¶
type UserSummary struct {
// The Amazon Resource Name (ARN) of the user account.
Arn *string
// The identifier of the user account.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The Amazon Connect user name of the user account.
Username *string
// contains filtered or unexported fields
}
Contains summary information about a user.
type Validation ¶
type Validation struct {
// Defines enumeration constraints for attribute values. Can specify a list of
// allowed values and whether custom values are permitted beyond the enumerated
// list.
Enum *ValidationEnum
// The largest exclusive numeric value for NUMBER value type. Can be provided
// alongside Maximum where both operate independently. Must be greater than
// ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMaximum float64
// The smallest exclusive numeric value for NUMBER value type. Can be provided
// alongside Minimum where both operate independently. Must be less than
// ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMinimum float64
// Boolean that defaults to false. Applies to text lists and text primary
// attributes. When true, enforces case-insensitive uniqueness for primary
// attributes and allows case-insensitive lookups.
IgnoreCase bool
// The maximum number of characters a text value can contain. Applies to TEXT
// value type and values within a TEXT_LIST. Must be greater than or equal to
// MinLength.
MaxLength int32
// The maximum number of values in a list. Must be an integer greater than or
// equal to 0 and greater than or equal to MinValues. Applies to all list types.
MaxValues int32
// The largest inclusive numeric value for NUMBER value type. Can be provided
// alongside ExclusiveMaximum where both operate independently. Must be greater
// than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER
// and values within NUMBER_LIST.
Maximum float64
// The minimum number of characters a text value can contain. Applies to TEXT
// value type and values within a TEXT_LIST. Must be less than or equal to
// MaxLength.
MinLength int32
// The minimum number of values in a list. Must be an integer greater than or
// equal to 0 and less than or equal to MaxValues. Applies to all list types.
MinValues int32
// The smallest inclusive numeric value for NUMBER value type. Cannot be provided
// when ExclusiveMinimum is also provided. Must be less than or equal to Maximum
// and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.
Minimum float64
// Specifies that numeric values must be multiples of this number. Must be greater
// than 0. The result of dividing a value by this multiple must result in an
// integer. Applies to NUMBER and values within NUMBER_LIST.
MultipleOf float64
// contains filtered or unexported fields
}
Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.
type ValidationEnum ¶
type ValidationEnum struct {
// Boolean that defaults to false. When true, only values specified in the enum
// list are allowed. When false, custom values beyond the enumerated list are
// permitted.
Strict bool
// A list of predefined values that are allowed for this attribute. These values
// are always permitted regardless of the Strict setting.
Values []string
// contains filtered or unexported fields
}
Defines enumeration validation for attribute values. Allows specifying a list of permitted values and whether custom values beyond the enumerated list are allowed.
type VideoCapability ¶
type VideoCapability string
const ( VideoCapabilitySend VideoCapability = "SEND" )
Enum values for VideoCapability
func (VideoCapability) Values ¶
func (VideoCapability) Values() []VideoCapability
Values returns all known values for VideoCapability. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type View ¶
type View struct {
// The Amazon Resource Name (ARN) of the view.
Arn *string
// View content containing all content necessary to render a view except for
// runtime input data.
Content *ViewContent
// The timestamp of when the view was created.
CreatedTime *time.Time
// The description of the view.
Description *string
// The identifier of the view.
Id *string
// Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
LastModifiedTime *time.Time
// The name of the view.
Name *string
// Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status
// will initiate validation on the content.
Status ViewStatus
// The tags associated with the view resource (not specific to view version).
Tags map[string]string
// The type of the view - CUSTOMER_MANAGED .
Type ViewType
// Current version of the view.
Version int32
// The description of the version.
VersionDescription *string
// Indicates the checksum value of the latest published view content.
ViewContentSha256 *string
// contains filtered or unexported fields
}
A view resource object. Contains metadata and content necessary to render the view.
type ViewContent ¶
type ViewContent struct {
// A list of possible actions from the view.
Actions []string
// The data schema matching data that the view template must be provided to render.
InputSchema *string
// The view template representing the structure of the view.
Template *string
// contains filtered or unexported fields
}
View content containing all content necessary to render a view except for runtime input data.
type ViewInputContent ¶
type ViewInputContent struct {
// A list of possible actions from the view.
Actions []string
// The view template representing the structure of the view.
Template *string
// contains filtered or unexported fields
}
View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.
type ViewSearchCriteria ¶
type ViewSearchCriteria struct {
// A list of conditions that must all be satisfied.
AndConditions []ViewSearchCriteria
// A list of conditions to be met, where at least one condition must be satisfied.
OrConditions []ViewSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// A condition that filters views by their status.
ViewStatusCondition ViewStatus
// A condition that filters views by their type.
ViewTypeCondition ViewType
// contains filtered or unexported fields
}
Defines the search criteria for filtering views.
type ViewSearchFilter ¶
type ViewSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Defines filters to apply when searching for views, such as tag-based filters.
type ViewStatus ¶
type ViewStatus string
const ( ViewStatusPublished ViewStatus = "PUBLISHED" ViewStatusSaved ViewStatus = "SAVED" )
Enum values for ViewStatus
func (ViewStatus) Values ¶
func (ViewStatus) Values() []ViewStatus
Values returns all known values for ViewStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ViewSummary ¶
type ViewSummary struct {
// The Amazon Resource Name (ARN) of the view.
Arn *string
// The description of the view.
Description *string
// The identifier of the view.
Id *string
// The name of the view.
Name *string
// Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status
// will initiate validation on the content.
Status ViewStatus
// The type of the view.
Type ViewType
// contains filtered or unexported fields
}
A summary of a view's metadata.
type ViewType ¶
type ViewType string
const ( ViewTypeCustomerManaged ViewType = "CUSTOMER_MANAGED" ViewTypeAwsManaged ViewType = "AWS_MANAGED" )
Enum values for ViewType
func (ViewType) Values ¶
Values returns all known values for ViewType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ViewVersionSummary ¶
type ViewVersionSummary struct {
// The Amazon Resource Name (ARN) of the view version.
Arn *string
// The description of the view version.
Description *string
// The identifier of the view version.
Id *string
// The name of the view version.
Name *string
// The type of the view version.
Type ViewType
// The sequentially incremented version of the view version.
Version int32
// The description of the view version.
VersionDescription *string
// contains filtered or unexported fields
}
A summary of a view version's metadata.
type Visibility ¶
type Visibility string
const ( VisibilityAll Visibility = "ALL" VisibilityAssigned Visibility = "ASSIGNED" VisibilityNone Visibility = "NONE" )
Enum values for Visibility
func (Visibility) Values ¶
func (Visibility) Values() []Visibility
Values returns all known values for Visibility. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Vocabulary ¶
type Vocabulary struct {
// The Amazon Resource Name (ARN) of the custom vocabulary.
//
// This member is required.
Arn *string
// The identifier of the custom vocabulary.
//
// This member is required.
Id *string
// The language code of the vocabulary entries. For a list of languages and their
// corresponding language codes, see [What is Amazon Transcribe?]
//
// [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html
//
// This member is required.
LanguageCode VocabularyLanguageCode
// The timestamp when the custom vocabulary was last modified.
//
// This member is required.
LastModifiedTime *time.Time
// A unique name of the custom vocabulary.
//
// This member is required.
Name *string
// The current state of the custom vocabulary.
//
// This member is required.
State VocabularyState
// The content of the custom vocabulary in plain-text format with a table of
// values. Each row in the table represents a word or a phrase, described with
// Phrase , IPA , SoundsLike , and DisplayAs fields. Separate the fields with TAB
// characters. For more information, see [Create a custom vocabulary using a table].
//
// [Create a custom vocabulary using a table]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table
Content *string
// The reason why the custom vocabulary was not created.
FailureReason *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// contains filtered or unexported fields
}
Contains information about a custom vocabulary.
type VocabularyLanguageCode ¶
type VocabularyLanguageCode string
const ( VocabularyLanguageCodeArAe VocabularyLanguageCode = "ar-AE" VocabularyLanguageCodeDeCh VocabularyLanguageCode = "de-CH" VocabularyLanguageCodeDeDe VocabularyLanguageCode = "de-DE" VocabularyLanguageCodeEnAb VocabularyLanguageCode = "en-AB" VocabularyLanguageCodeEnAu VocabularyLanguageCode = "en-AU" VocabularyLanguageCodeEnGb VocabularyLanguageCode = "en-GB" VocabularyLanguageCodeEnIe VocabularyLanguageCode = "en-IE" VocabularyLanguageCodeEnIn VocabularyLanguageCode = "en-IN" VocabularyLanguageCodeEnUs VocabularyLanguageCode = "en-US" VocabularyLanguageCodeEnWl VocabularyLanguageCode = "en-WL" VocabularyLanguageCodeEsEs VocabularyLanguageCode = "es-ES" VocabularyLanguageCodeEsUs VocabularyLanguageCode = "es-US" VocabularyLanguageCodeFrCa VocabularyLanguageCode = "fr-CA" VocabularyLanguageCodeFrFr VocabularyLanguageCode = "fr-FR" VocabularyLanguageCodeHiIn VocabularyLanguageCode = "hi-IN" VocabularyLanguageCodeItIt VocabularyLanguageCode = "it-IT" VocabularyLanguageCodeJaJp VocabularyLanguageCode = "ja-JP" VocabularyLanguageCodeKoKr VocabularyLanguageCode = "ko-KR" VocabularyLanguageCodePtBr VocabularyLanguageCode = "pt-BR" VocabularyLanguageCodePtPt VocabularyLanguageCode = "pt-PT" VocabularyLanguageCodeZhCn VocabularyLanguageCode = "zh-CN" VocabularyLanguageCodeEnNz VocabularyLanguageCode = "en-NZ" VocabularyLanguageCodeEnZa VocabularyLanguageCode = "en-ZA" VocabularyLanguageCodeCaEs VocabularyLanguageCode = "ca-ES" VocabularyLanguageCodeDaDk VocabularyLanguageCode = "da-DK" VocabularyLanguageCodeFiFi VocabularyLanguageCode = "fi-FI" VocabularyLanguageCodeIdId VocabularyLanguageCode = "id-ID" VocabularyLanguageCodeMsMy VocabularyLanguageCode = "ms-MY" VocabularyLanguageCodeNlNl VocabularyLanguageCode = "nl-NL" VocabularyLanguageCodeNoNo VocabularyLanguageCode = "no-NO" VocabularyLanguageCodePlPl VocabularyLanguageCode = "pl-PL" VocabularyLanguageCodeSvSe VocabularyLanguageCode = "sv-SE" VocabularyLanguageCodeTlPh VocabularyLanguageCode = "tl-PH" )
Enum values for VocabularyLanguageCode
func (VocabularyLanguageCode) Values ¶
func (VocabularyLanguageCode) Values() []VocabularyLanguageCode
Values returns all known values for VocabularyLanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type VocabularyState ¶
type VocabularyState string
const ( VocabularyStateCreationInProgress VocabularyState = "CREATION_IN_PROGRESS" VocabularyStateActive VocabularyState = "ACTIVE" VocabularyStateCreationFailed VocabularyState = "CREATION_FAILED" VocabularyStateDeleteInProgress VocabularyState = "DELETE_IN_PROGRESS" )
Enum values for VocabularyState
func (VocabularyState) Values ¶
func (VocabularyState) Values() []VocabularyState
Values returns all known values for VocabularyState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type VocabularySummary ¶
type VocabularySummary struct {
// The Amazon Resource Name (ARN) of the custom vocabulary.
//
// This member is required.
Arn *string
// The identifier of the custom vocabulary.
//
// This member is required.
Id *string
// The language code of the vocabulary entries. For a list of languages and their
// corresponding language codes, see [What is Amazon Transcribe?]
//
// [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html
//
// This member is required.
LanguageCode VocabularyLanguageCode
// The timestamp when the custom vocabulary was last modified.
//
// This member is required.
LastModifiedTime *time.Time
// A unique name of the custom vocabulary.
//
// This member is required.
Name *string
// The current state of the custom vocabulary.
//
// This member is required.
State VocabularyState
// The reason why the custom vocabulary was not created.
FailureReason *string
// contains filtered or unexported fields
}
Contains summary information about the custom vocabulary.
type VoiceRecordingConfiguration ¶
type VoiceRecordingConfiguration struct {
// Identifies which IVR track is being recorded.
//
// One and only one of the track configurations should be presented in the request.
IvrRecordingTrack IvrRecordingTrack
// Identifies which track is being recorded.
VoiceRecordingTrack VoiceRecordingTrack
// contains filtered or unexported fields
}
Contains information about the recording configuration settings.
type VoiceRecordingTrack ¶
type VoiceRecordingTrack string
const ( VoiceRecordingTrackFromAgent VoiceRecordingTrack = "FROM_AGENT" VoiceRecordingTrackToAgent VoiceRecordingTrack = "TO_AGENT" VoiceRecordingTrackAll VoiceRecordingTrack = "ALL" )
Enum values for VoiceRecordingTrack
func (VoiceRecordingTrack) Values ¶
func (VoiceRecordingTrack) Values() []VoiceRecordingTrack
Values returns all known values for VoiceRecordingTrack. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type WisdomInfo ¶
type WisdomInfo struct {
// The array of AI agents involved in the contact.
AiAgents []AiAgentInfo
// The Amazon Resource Name (ARN) of the Wisdom session.
SessionArn *string
// contains filtered or unexported fields
}
Information about Amazon Connect Wisdom.
type Workspace ¶
type Workspace struct {
// The Amazon Resource Name (ARN) of the workspace.
//
// This member is required.
Arn *string
// The unique identifier of the workspace.
//
// This member is required.
Id *string
// The timestamp when the workspace was last modified.
//
// This member is required.
LastModifiedTime *time.Time
// The name of the workspace.
//
// This member is required.
Name *string
// The description of the workspace.
Description *string
// The AWS Region where the workspace was last modified.
LastModifiedRegion *string
// The tags used to organize, track, or control access for the workspace.
Tags map[string]string
// The theme configuration for the workspace, including colors and styling.
Theme *WorkspaceTheme
// The title displayed for the workspace.
Title *string
// Controls who can access the workspace. Valid values are: ALL (all users),
// ASSIGNED (only assigned users and routing profiles), and NONE (not visible).
Visibility Visibility
// contains filtered or unexported fields
}
Contains information about a workspace, which defines the user experience by mapping views to pages.
type WorkspaceAssociationSearchCriteria ¶
type WorkspaceAssociationSearchCriteria struct {
// A list of conditions that must all be satisfied.
AndConditions []WorkspaceAssociationSearchCriteria
// A list of conditions to be met, where at least one condition must be satisfied.
OrConditions []WorkspaceAssociationSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
Defines the search criteria for filtering workspace associations.
type WorkspaceAssociationSearchFilter ¶
type WorkspaceAssociationSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Defines filters to apply when searching for workspace associations, such as tag-based filters.
type WorkspaceAssociationSearchSummary ¶
type WorkspaceAssociationSearchSummary struct {
// The Amazon Resource Name (ARN) of the associated resource.
ResourceArn *string
// The identifier of the associated resource (user or routing profile).
ResourceId *string
// The name of the associated resource.
ResourceName *string
// The type of resource associated with the workspace. Valid values are: USER and
// ROUTING_PROFILE .
ResourceType *string
// The Amazon Resource Name (ARN) of the workspace.
WorkspaceArn *string
// The identifier of the workspace.
WorkspaceId *string
// contains filtered or unexported fields
}
Contains summary information about a workspace association with a user or routing profile.
type WorkspaceFontFamily ¶
type WorkspaceFontFamily string
const ( WorkspaceFontFamilyArial WorkspaceFontFamily = "Arial" WorkspaceFontFamilyCourierNew WorkspaceFontFamily = "Courier New" WorkspaceFontFamilyGeorgia WorkspaceFontFamily = "Georgia" WorkspaceFontFamilyTimesNewRoman WorkspaceFontFamily = "Times New Roman" WorkspaceFontFamilyTrebuchet WorkspaceFontFamily = "Trebuchet" WorkspaceFontFamilyVerdana WorkspaceFontFamily = "Verdana" )
Enum values for WorkspaceFontFamily
func (WorkspaceFontFamily) Values ¶
func (WorkspaceFontFamily) Values() []WorkspaceFontFamily
Values returns all known values for WorkspaceFontFamily. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type WorkspacePage ¶
type WorkspacePage struct {
// A JSON string containing input parameters passed to the view when the page is
// rendered.
InputData *string
// The page identifier. System pages include HOME and AGENT_EXPERIENCE .
Page *string
// The Amazon Resource Name (ARN) of the view associated with this page.
ResourceArn *string
// The URL-friendly identifier for the page.
Slug *string
// contains filtered or unexported fields
}
Contains information about a page configuration in a workspace, including the view assigned to the page.
type WorkspaceSearchCriteria ¶
type WorkspaceSearchCriteria struct {
// A list of conditions that must all be satisfied.
AndConditions []WorkspaceSearchCriteria
// A list of conditions to be met, where at least one condition must be satisfied.
OrConditions []WorkspaceSearchCriteria
// A leaf node condition which can be used to specify a string condition.
StringCondition *StringCondition
// contains filtered or unexported fields
}
Defines the search criteria for filtering workspaces.
type WorkspaceSearchFilter ¶
type WorkspaceSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR or AND (List of List) input where:
//
// - The top level list specifies conditions that need to be applied with OR
// operator.
//
// - The inner list specifies conditions that need to be applied with AND
// operator.
AttributeFilter *ControlPlaneAttributeFilter
// contains filtered or unexported fields
}
Defines filters to apply when searching for workspaces, such as tag-based filters.
type WorkspaceSearchSummary ¶
type WorkspaceSearchSummary struct {
// The Amazon Resource Name (ARN) of the workspace.
Arn *string
// The timestamp when the workspace was created.
CreatedAt *time.Time
// The description of the workspace.
Description *string
// The unique identifier of the workspace.
Id *string
// The name of the workspace.
Name *string
// The tags associated with the workspace.
Tags map[string]string
// The title displayed for the workspace.
Title *string
// The visibility setting of the workspace.
Visibility Visibility
// contains filtered or unexported fields
}
Contains summary information about a workspace returned from a search operation.
type WorkspaceSummary ¶
type WorkspaceSummary struct {
// The Amazon Resource Name (ARN) of the workspace.
Arn *string
// The unique identifier of the workspace.
Id *string
// The AWS Region where the workspace was last modified.
LastModifiedRegion *string
// The timestamp when the workspace was last modified.
LastModifiedTime *time.Time
// The name of the workspace.
Name *string
// contains filtered or unexported fields
}
Contains summary information about a workspace.
type WorkspaceTheme ¶
type WorkspaceTheme struct {
// The theme configuration for dark mode.
Dark *WorkspaceThemeConfig
// The theme configuration for light mode.
Light *WorkspaceThemeConfig
// contains filtered or unexported fields
}
Contains theme configuration for a workspace, supporting both light and dark modes.
type WorkspaceThemeConfig ¶
type WorkspaceThemeConfig struct {
// The image assets used in the workspace theme.
Images *WorkspaceThemeImages
// The color palette configuration for the workspace theme.
Palette *WorkspaceThemePalette
// The typography configuration for the workspace theme.
Typography *WorkspaceThemeTypography
// contains filtered or unexported fields
}
Contains detailed theme configuration for a workspace, including colors, images, and typography.
type WorkspaceThemeImages ¶
type WorkspaceThemeImages struct {
// The logo images used in the workspace.
Logo *ImagesLogo
// contains filtered or unexported fields
}
Contains image configuration for a workspace theme.
type WorkspaceThemePalette ¶
type WorkspaceThemePalette struct {
// The color configuration for the canvas area.
Canvas *PaletteCanvas
// The color configuration for the header area.
Header *PaletteHeader
// The color configuration for the navigation area.
*PaletteNavigation
// The primary color configuration used throughout the workspace.
Primary *PalettePrimary
// contains filtered or unexported fields
}
Contains color palette configuration for different areas of a workspace.
type WorkspaceThemeTypography ¶
type WorkspaceThemeTypography struct {
// The font family configuration for text in the workspace.
FontFamily *FontFamily
// contains filtered or unexported fields
}
Contains typography configuration for a workspace theme.
Source Files ¶
- Version
- v1.149.0
- Published
- Dec 1, 2025
- Platform
- js/wasm
- Imports
- 4 packages
- Last checked
- 14 minutes ago –
Tools for package owners.