types

package
v1.60.1 Latest Latest
Warning

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

 Go to latest Published: Jul 5, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException added in v1.11.0 

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 added in v1.11.0 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode added in v1.11.0 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault added in v1.11.0 

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

func (*AccessDeniedException) ErrorMessage added in v1.11.0 

func (e *AccessDeniedException) ErrorMessage() string

type ActionSummary added in v1.39.0 

type ActionSummary struct {

	// The action type.
	//
	// This member is required.
	ActionType ActionType
	// contains filtered or unexported fields
}

Information about an action.

type ActionType added in v1.39.0 

type ActionType string
const (
	ActionTypeCreateTask               ActionType = "CREATE_TASK"
	ActionTypeAssignContactCategory    ActionType = "ASSIGN_CONTACT_CATEGORY"
	ActionTypeGenerateEventbridgeEvent ActionType = "GENERATE_EVENTBRIDGE_EVENT"
	ActionTypeSendNotification         ActionType = "SEND_NOTIFICATION"
)

Enum values for ActionType

func (ActionType) Values added in v1.39.0 

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 AgentContactReference added in v1.26.0 

type AgentContactReference struct {

	// The 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 (https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html) associated to the user.

type AgentInfo added in v1.12.0 

type AgentInfo 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 AgentStatus added in v1.6.0 

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 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 AgentStatusReference added in v1.26.0 

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 AgentStatusState added in v1.6.0 

type AgentStatusState string
const (
	AgentStatusStateEnabled  AgentStatusState = "ENABLED"
	AgentStatusStateDisabled AgentStatusState = "DISABLED"
)

Enum values for AgentStatusState

func (AgentStatusState) Values added in v1.6.0 

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 added in v1.6.0 

type AgentStatusSummary struct {

	// The Amazon Resource Name (ARN) for the agent status.
	Arn *string

	// The identifier for an agent status.
	Id *string

	// 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 added in v1.6.0 

type AgentStatusType string
const (
	AgentStatusTypeRoutable AgentStatusType = "ROUTABLE"
	AgentStatusTypeCustom   AgentStatusType = "CUSTOM"
	AgentStatusTypeOffline  AgentStatusType = "OFFLINE"
)

Enum values for AgentStatusType

func (AgentStatusType) Values added in v1.6.0 

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 AnswerMachineDetectionConfig added in v1.8.0 

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 AssignContactCategoryActionDefinition added in v1.39.0 

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

This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable . Contact is categorized using the rule name. RuleName is used as ContactCategory .

type AttachmentReference added in v1.12.0 

type AttachmentReference struct {

	// 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 Attribute added in v0.30.0 

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 AvailableNumberSummary added in v1.22.0 

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 BehaviorType added in v1.51.0 

type BehaviorType string
const (
	BehaviorTypeRouteCurrentChannelOnly BehaviorType = "ROUTE_CURRENT_CHANNEL_ONLY"
	BehaviorTypeRouteAnyChannel         BehaviorType = "ROUTE_ANY_CHANNEL"
)

Enum values for BehaviorType

func (BehaviorType) Values added in v1.51.0 

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 Channel 

type Channel string
const (
	ChannelVoice Channel = "VOICE"
	ChannelChat  Channel = "CHAT"
	ChannelTask  Channel = "TASK"
)

Enum values for Channel

func (Channel) Values added in v0.29.0 

func (Channel) Values() []Channel

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 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 ChatParticipantRoleConfig added in v1.41.0 

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 added in v1.10.0 

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 added in v1.22.0 

type ClaimedPhoneNumberSummary struct {

	// 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 ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html)
	//   or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
	//   operation succeeded.
	//   - IN_PROGRESS means a ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html)
	//   or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
	//   operation is still in progress and has not yet completed. You can call
	//   DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html)
	//   at a later time to verify if the previous operation has completed.
	//   - FAILED indicates that the previous ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html)
	//   or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
	//   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.
	PhoneNumberStatus *PhoneNumberStatus

	// The type of phone number.
	PhoneNumberType PhoneNumberType

	// 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 numbers are claimed to.
	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 Comparison 

type Comparison string
const (
	ComparisonLt Comparison = "LT"
)

Enum values for Comparison

func (Comparison) Values added in v0.29.0 

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 Contact added in v1.12.0 

type Contact struct {

	// Information about the agent who accepted the contact.
	AgentInfo *AgentInfo

	// The Amazon Resource Name (ARN) for the contact.
	Arn *string

	// How the contact reached your contact center.
	Channel Channel

	// The description of the contact.
	Description *string

	// The timestamp when the customer endpoint disconnected from Amazon Connect.
	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 contact was last updated.
	LastUpdateTimestamp *time.Time

	// The 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 *QueueInfo

	// The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid)
	// to this contact.
	RelatedContactId *string

	// The timestamp, in Unix epoch time format, at which to start running the inbound
	// flow.
	ScheduledTimestamp *time.Time

	// Information about Amazon Connect Wisdom.
	WisdomInfo *WisdomInfo
	// contains filtered or unexported fields
}

Contains information about a contact.

type ContactFilter added in v1.26.0 

type ContactFilter struct {

	// A list of up to 9 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 (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) .

type ContactFlow added in v0.29.0 

type ContactFlow struct {

	// The Amazon Resource Name (ARN) of the flow.
	Arn *string

	// The content of the flow.
	Content *string

	// The description of the flow.
	Description *string

	// The identifier of the flow.
	Id *string

	// The name of the flow.
	Name *string

	// The type of flow.
	State ContactFlowState

	// 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 (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types)
	// in the Amazon Connect Administrator Guide.
	Type ContactFlowType
	// contains filtered or unexported fields
}

Contains information about a flow.

type ContactFlowModule added in v1.13.0 

type ContactFlowModule struct {

	// The Amazon Resource Name (ARN).
	Arn *string

	// The content of the flow module.
	Content *string

	// The description of the flow module.
	Description *string

	// The identifier of the flow module.
	Id *string

	// The name of the flow module.
	Name *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
	// contains filtered or unexported fields
}

Contains information about a flow module.

type ContactFlowModuleState added in v1.13.0 

type ContactFlowModuleState string
const (
	ContactFlowModuleStateActive   ContactFlowModuleState = "ACTIVE"
	ContactFlowModuleStateArchived ContactFlowModuleState = "ARCHIVED"
)

Enum values for ContactFlowModuleState

func (ContactFlowModuleState) Values added in v1.13.0 

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 added in v1.13.0 

type ContactFlowModuleStatus string
const (
	ContactFlowModuleStatusPublished ContactFlowModuleStatus = "PUBLISHED"
	ContactFlowModuleStatusSaved     ContactFlowModuleStatus = "SAVED"
)

Enum values for ContactFlowModuleStatus

func (ContactFlowModuleStatus) Values added in v1.13.0 

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 added in v1.13.0 

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 ContactFlowNotPublishedException added in v0.29.0 

type ContactFlowNotPublishedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The flow has not been published.

func (*ContactFlowNotPublishedException) Error added in v0.29.0 

func (e *ContactFlowNotPublishedException) Error() string

func (*ContactFlowNotPublishedException) ErrorCode added in v0.29.0 

func (e *ContactFlowNotPublishedException) ErrorCode() string

func (*ContactFlowNotPublishedException) ErrorFault added in v0.29.0 

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

func (*ContactFlowNotPublishedException) ErrorMessage added in v0.29.0 

func (e *ContactFlowNotPublishedException) ErrorMessage() string

type ContactFlowState added in v1.13.0 

type ContactFlowState string
const (
	ContactFlowStateActive   ContactFlowState = "ACTIVE"
	ContactFlowStateArchived ContactFlowState = "ARCHIVED"
)

Enum values for ContactFlowState

func (ContactFlowState) Values added in v1.13.0 

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 ContactFlowSummary 

type ContactFlowSummary struct {

	// The Amazon Resource Name (ARN) of the flow.
	Arn *string

	// The type of flow.
	ContactFlowState ContactFlowState

	// 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 (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) .

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

Enum values for ContactFlowType

func (ContactFlowType) Values added in v0.29.0 

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 ContactInitiationMethod added in v1.12.0 

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

Enum values for ContactInitiationMethod

func (ContactInitiationMethod) Values added in v1.12.0 

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 ContactNotFoundException 

type ContactNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat, Task, or Voice Callback.

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 ContactState added in v1.26.0 

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 added in v1.26.0 

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 ControlPlaneTagFilter added in v1.23.0 

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 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 added in v1.51.0 

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 Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) in 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 added in v0.29.0 

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 added in v1.42.0 

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 DateReference added in v1.25.0 

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 DefaultVocabulary added in v1.17.0 

type DefaultVocabulary struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	//
	// 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? (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 Dimensions 

type Dimensions struct {

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

Contains information about the dimensions for a set of metrics.

type DirectoryType added in v0.30.0 

type DirectoryType string
const (
	DirectoryTypeSaml              DirectoryType = "SAML"
	DirectoryTypeConnectManaged    DirectoryType = "CONNECT_MANAGED"
	DirectoryTypeExistingDirectory DirectoryType = "EXISTING_DIRECTORY"
)

Enum values for DirectoryType

func (DirectoryType) Values added in v0.30.0 

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 Distribution added in v1.33.0 

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 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 EmailReference added in v1.25.0 

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 EncryptionConfig added in v0.30.0 

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 (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 added in v0.30.0 

type EncryptionType string
const (
	EncryptionTypeKms EncryptionType = "KMS"
)

Enum values for EncryptionType

func (EncryptionType) Values added in v0.30.0 

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 Evaluation added in v1.53.0 

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

	// 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 EvaluationAnswerData added in v1.53.0 

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: 

EvaluationAnswerDataMemberNotApplicable
EvaluationAnswerDataMemberNumericValue
EvaluationAnswerDataMemberStringValue
Example (OutputUsage) 
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.EvaluationAnswerDataMemberNotApplicable:
		_ = v.Value // Value is bool

	case *types.EvaluationAnswerDataMemberNumericValue:
		_ = v.Value // Value is float64

	case *types.EvaluationAnswerDataMemberStringValue:
		_ = v.Value // Value is string

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

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

	}
}

Output:

type EvaluationAnswerDataMemberNotApplicable added in v1.53.0 

type EvaluationAnswerDataMemberNotApplicable struct {
	Value bool
	// contains filtered or unexported fields
}

The flag to mark the question as not applicable.

type EvaluationAnswerDataMemberNumericValue added in v1.53.0 

type EvaluationAnswerDataMemberNumericValue struct {
	Value float64
	// contains filtered or unexported fields
}

The numeric value for an answer in a contact evaluation.

type EvaluationAnswerDataMemberStringValue added in v1.53.0 

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

The string value for an answer in a contact evaluation.

type EvaluationAnswerInput added in v1.53.0 

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 added in v1.53.0 

type EvaluationAnswerOutput struct {

	// 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 EvaluationForm added in v1.53.0 

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 description of the evaluation form.
	Description *string

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

Information about the evaluation form.

type EvaluationFormContent added in v1.53.0 

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 description of the evaluation form.
	Description *string

	// A scoring strategy of the evaluation form.
	ScoringStrategy *EvaluationFormScoringStrategy
	// contains filtered or unexported fields
}

Information about an evaluation form used in a contact evaluation.

type EvaluationFormItem added in v1.53.0 

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

	}
}

Output:

type EvaluationFormItemMemberQuestion added in v1.53.0 

type EvaluationFormItemMemberQuestion struct {
	Value EvaluationFormQuestion
	// contains filtered or unexported fields
}

The information of the question.

type EvaluationFormItemMemberSection added in v1.53.0 

type EvaluationFormItemMemberSection struct {
	Value EvaluationFormSection
	// contains filtered or unexported fields
}

The information of the section.

type EvaluationFormNumericQuestionAutomation added in v1.53.0 

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

Information about the automation configuration in numeric questions.

The following types satisfy this interface: 

EvaluationFormNumericQuestionAutomationMemberPropertyValue
Example (OutputUsage) 
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.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")

	}
}

Output:

type EvaluationFormNumericQuestionAutomationMemberPropertyValue added in v1.53.0 

type EvaluationFormNumericQuestionAutomationMemberPropertyValue struct {
	Value NumericQuestionPropertyValueAutomation
	// contains filtered or unexported fields
}

The property value of the automation.

type EvaluationFormNumericQuestionOption added in v1.53.0 

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

	// 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 added in v1.53.0 

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 added in v1.53.0 

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

	// 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 EvaluationFormQuestionType added in v1.53.0 

type EvaluationFormQuestionType string
const (
	EvaluationFormQuestionTypeText         EvaluationFormQuestionType = "TEXT"
	EvaluationFormQuestionTypeSingleselect EvaluationFormQuestionType = "SINGLESELECT"
	EvaluationFormQuestionTypeNumeric      EvaluationFormQuestionType = "NUMERIC"
)

Enum values for EvaluationFormQuestionType

func (EvaluationFormQuestionType) Values added in v1.53.0 

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 added in v1.53.0 

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: 

EvaluationFormQuestionTypePropertiesMemberNumeric
EvaluationFormQuestionTypePropertiesMemberSingleSelect
Example (OutputUsage) 
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.EvaluationFormQuestionTypePropertiesMemberNumeric:
		_ = v.Value // Value is types.EvaluationFormNumericQuestionProperties

	case *types.EvaluationFormQuestionTypePropertiesMemberSingleSelect:
		_ = v.Value // Value is types.EvaluationFormSingleSelectQuestionProperties

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

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

	}
}

Output:

type EvaluationFormQuestionTypePropertiesMemberNumeric added in v1.53.0 

type EvaluationFormQuestionTypePropertiesMemberNumeric struct {
	Value EvaluationFormNumericQuestionProperties
	// contains filtered or unexported fields
}

The properties of the numeric question.

type EvaluationFormQuestionTypePropertiesMemberSingleSelect added in v1.53.0 

type EvaluationFormQuestionTypePropertiesMemberSingleSelect struct {
	Value EvaluationFormSingleSelectQuestionProperties
	// contains filtered or unexported fields
}

The properties of the numeric question.

type EvaluationFormScoringMode added in v1.53.0 

type EvaluationFormScoringMode string
const (
	EvaluationFormScoringModeQuestionOnly EvaluationFormScoringMode = "QUESTION_ONLY"
	EvaluationFormScoringModeSectionOnly  EvaluationFormScoringMode = "SECTION_ONLY"
)

Enum values for EvaluationFormScoringMode

func (EvaluationFormScoringMode) Values added in v1.53.0 

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 added in v1.53.0 

type EvaluationFormScoringStatus string
const (
	EvaluationFormScoringStatusEnabled  EvaluationFormScoringStatus = "ENABLED"
	EvaluationFormScoringStatusDisabled EvaluationFormScoringStatus = "DISABLED"
)

Enum values for EvaluationFormScoringStatus

func (EvaluationFormScoringStatus) Values added in v1.53.0 

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 added in v1.53.0 

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 EvaluationFormSection added in v1.53.0 

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 added in v1.53.0 

type EvaluationFormSingleSelectQuestionAutomation struct {

	// The automation options of the single select question.
	//
	// This member is required.
	Options []EvaluationFormSingleSelectQuestionAutomationOption

	// The identifier of the default answer option, when none of the automation
	// options match the criteria.
	DefaultOptionRefId *string
	// 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 added in v1.53.0 

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

	}
}

Output:

type EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory added in v1.53.0 

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 added in v1.53.0 

type EvaluationFormSingleSelectQuestionDisplayMode string
const (
	EvaluationFormSingleSelectQuestionDisplayModeDropdown EvaluationFormSingleSelectQuestionDisplayMode = "DROPDOWN"
	EvaluationFormSingleSelectQuestionDisplayModeRadio    EvaluationFormSingleSelectQuestionDisplayMode = "RADIO"
)

Enum values for EvaluationFormSingleSelectQuestionDisplayMode

func (EvaluationFormSingleSelectQuestionDisplayMode) Values added in v1.53.0 

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 added in v1.53.0 

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

	// 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 added in v1.53.0 

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 added in v1.53.0 

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 EvaluationFormVersionStatus added in v1.53.0 

type EvaluationFormVersionStatus string
const (
	EvaluationFormVersionStatusDraft  EvaluationFormVersionStatus = "DRAFT"
	EvaluationFormVersionStatusActive EvaluationFormVersionStatus = "ACTIVE"
)

Enum values for EvaluationFormVersionStatus

func (EvaluationFormVersionStatus) Values added in v1.53.0 

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 added in v1.53.0 

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 EvaluationMetadata added in v1.53.0 

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

	// The identifier of the agent who performed the contact.
	ContactAgentId *string

	// The overall score of the contact evaluation.
	Score *EvaluationScore
	// contains filtered or unexported fields
}

Metadata information about a contact evaluation.

type EvaluationNote added in v1.53.0 

type EvaluationNote struct {

	// The note for an item (section or question) in a contact evaluation.
	Value *string
	// contains filtered or unexported fields
}

Information about notes for a contact evaluation.

type EvaluationScore added in v1.53.0 

type EvaluationScore struct {

	// 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 EvaluationStatus added in v1.53.0 

type EvaluationStatus string
const (
	EvaluationStatusDraft     EvaluationStatus = "DRAFT"
	EvaluationStatusSubmitted EvaluationStatus = "SUBMITTED"
)

Enum values for EvaluationStatus

func (EvaluationStatus) Values added in v1.53.0 

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 EvaluationSummary added in v1.53.0 

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

	// The overall score of the contact evaluation.
	Score *EvaluationScore
	// contains filtered or unexported fields
}

Summary information about a contact evaluation.

type EventBridgeActionDefinition added in v1.39.0 

type EventBridgeActionDefinition struct {

	// The name.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The EventBridge action definition.

type EventSourceName added in v1.39.0 

type EventSourceName string
const (
	EventSourceNameOnPostCallAnalysisAvailable     EventSourceName = "OnPostCallAnalysisAvailable"
	EventSourceNameOnRealTimeCallAnalysisAvailable EventSourceName = "OnRealTimeCallAnalysisAvailable"
	EventSourceNameOnPostChatAnalysisAvailable     EventSourceName = "OnPostChatAnalysisAvailable"
	EventSourceNameOnZendeskTicketCreate           EventSourceName = "OnZendeskTicketCreate"
	EventSourceNameOnZendeskTicketStatusUpdate     EventSourceName = "OnZendeskTicketStatusUpdate"
	EventSourceNameOnSalesforceCaseCreate          EventSourceName = "OnSalesforceCaseCreate"
	EventSourceNameOnContactEvaluationSubmit       EventSourceName = "OnContactEvaluationSubmit"
)

Enum values for EventSourceName

func (EventSourceName) Values added in v1.39.0 

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 FilterV2 added in v1.49.0 

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

Contains the filter to apply when retrieving metrics with the GetMetricDataV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API.

type Filters 

type Filters struct {

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

Contains the filter to apply when retrieving metrics.

type Grouping 

type Grouping string
const (
	GroupingQueue          Grouping = "QUEUE"
	GroupingChannel        Grouping = "CHANNEL"
	GroupingRoutingProfile Grouping = "ROUTING_PROFILE"
)

Enum values for Grouping

func (Grouping) Values added in v0.29.0 

func (Grouping) Values() []Grouping

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 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 added in v1.23.0 

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 added in v1.23.0 

type HierarchyGroupMatchType string
const (
	HierarchyGroupMatchTypeExact           HierarchyGroupMatchType = "EXACT"
	HierarchyGroupMatchTypeWithChildGroups HierarchyGroupMatchType = "WITH_CHILD_GROUPS"
)

Enum values for HierarchyGroupMatchType

func (HierarchyGroupMatchType) Values added in v1.23.0 

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 name of the hierarchy group.
	Name *string
	// contains filtered or unexported fields
}

Contains summary information about a hierarchy group.

type HierarchyGroupSummaryReference added in v1.26.0 

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 HierarchyLevel 

type HierarchyLevel struct {

	// The Amazon Resource Name (ARN) of the hierarchy level.
	Arn *string

	// The identifier of the hierarchy level.
	Id *string

	// The name of the hierarchy level.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a hierarchy level.

type HierarchyLevelUpdate added in v0.30.0 

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 added in v1.26.0 

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 added in v0.30.0 

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.
	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. For a description of each metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) in the Amazon Connect Administrator Guide.

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 added in v0.29.0 

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 added in v1.2.0 

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 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 added in v1.2.0 

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 added in v1.2.0 

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 added in v1.2.0 

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 HoursOfOperationSearchCriteria added in v1.58.0 

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 added in v1.58.0 

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 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 added in v1.2.0 

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 added in v1.13.0 

type IdempotencyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An entity with the same name already exists.

func (*IdempotencyException) Error added in v1.13.0 

func (e *IdempotencyException) Error() string

func (*IdempotencyException) ErrorCode added in v1.13.0 

func (e *IdempotencyException) ErrorCode() string

func (*IdempotencyException) ErrorFault added in v1.13.0 

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

func (*IdempotencyException) ErrorMessage added in v1.13.0 

func (e *IdempotencyException) ErrorMessage() string

type Instance added in v0.30.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	Id *string

	// The identity management type.
	IdentityManagementType DirectoryType

	// Whether inbound calls are enabled.
	InboundCallsEnabled *bool

	// This URL allows contact center users to access 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
	// contains filtered or unexported fields
}

The Amazon Connect instance.

type InstanceAttributeType added in v0.30.0 

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

Enum values for InstanceAttributeType

func (InstanceAttributeType) Values added in v0.30.0 

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 InstanceStatus added in v0.30.0 

type InstanceStatus string
const (
	InstanceStatusCreationInProgress InstanceStatus = "CREATION_IN_PROGRESS"
	InstanceStatusActive             InstanceStatus = "ACTIVE"
	InstanceStatusCreationFailed     InstanceStatus = "CREATION_FAILED"
)

Enum values for InstanceStatus

func (InstanceStatus) Values added in v0.30.0 

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 added in v0.30.0 

type InstanceStatusReason struct {

	// The message.
	Message *string
	// contains filtered or unexported fields
}

Relevant details why the instance was not successfully created.

type InstanceStorageConfig added in v0.30.0 

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 added in v0.30.0 

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

Enum values for InstanceStorageResourceType

func (InstanceStorageResourceType) Values added in v0.30.0 

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 added in v0.30.0 

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 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 added in v0.31.0 

type IntegrationAssociationSummary struct {

	// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	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 added in v0.31.0 

type IntegrationType string
const (
	IntegrationTypeEvent               IntegrationType = "EVENT"
	IntegrationTypeVoiceId             IntegrationType = "VOICE_ID"
	IntegrationTypePinpointApp         IntegrationType = "PINPOINT_APP"
	IntegrationTypeWisdomAssistant     IntegrationType = "WISDOM_ASSISTANT"
	IntegrationTypeWisdomKnowledgeBase IntegrationType = "WISDOM_KNOWLEDGE_BASE"
	IntegrationTypeCasesDomain         IntegrationType = "CASES_DOMAIN"
)

Enum values for IntegrationType

func (IntegrationType) Values added in v0.31.0 

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 InvalidContactFlowException added in v0.29.0 

type InvalidContactFlowException struct {
	Message *string

	ErrorCodeOverride *string

	Problems []ProblemDetail
	// contains filtered or unexported fields
}

The flow is not valid.

func (*InvalidContactFlowException) Error added in v0.29.0 

func (e *InvalidContactFlowException) Error() string

func (*InvalidContactFlowException) ErrorCode added in v0.29.0 

func (e *InvalidContactFlowException) ErrorCode() string

func (*InvalidContactFlowException) ErrorFault added in v0.29.0 

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

func (*InvalidContactFlowException) ErrorMessage added in v0.29.0 

func (e *InvalidContactFlowException) ErrorMessage() string

type InvalidContactFlowModuleException added in v1.13.0 

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 added in v1.13.0 

func (e *InvalidContactFlowModuleException) Error() string

func (*InvalidContactFlowModuleException) ErrorCode added in v1.13.0 

func (e *InvalidContactFlowModuleException) ErrorCode() string

func (*InvalidContactFlowModuleException) ErrorFault added in v1.13.0 

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

func (*InvalidContactFlowModuleException) ErrorMessage added in v1.13.0 

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
	// 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 InvisibleFieldInfo added in v1.25.0 

type InvisibleFieldInfo struct {

	// Identifier of the invisible field.
	Id *TaskTemplateFieldIdentifier
	// contains filtered or unexported fields
}

A field that is invisible to an agent.

type KinesisFirehoseConfig added in v0.30.0 

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 added in v0.30.0 

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 added in v0.30.0 

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 added in v0.30.0 

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 added in v1.5.0 

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 added in v1.5.0 

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 added in v1.5.0 

type LexVersion string
const (
	LexVersionV1 LexVersion = "V1"
	LexVersionV2 LexVersion = "V2"
)

Enum values for LexVersion

func (LexVersion) Values added in v1.5.0 

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 ListPhoneNumbersSummary added in v1.22.0 

type ListPhoneNumbersSummary struct {

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

	// A unique identifier for the phone number.
	PhoneNumberId *string

	// The type of phone number.
	PhoneNumberType PhoneNumberType

	// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
	// distribution groups that phone numbers are claimed to.
	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 MaximumResultReturnedException added in v1.60.0 

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 added in v1.60.0 

func (e *MaximumResultReturnedException) Error() string

func (*MaximumResultReturnedException) ErrorCode added in v1.60.0 

func (e *MaximumResultReturnedException) ErrorCode() string

func (*MaximumResultReturnedException) ErrorFault added in v1.60.0 

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

func (*MaximumResultReturnedException) ErrorMessage added in v1.60.0 

func (e *MaximumResultReturnedException) ErrorMessage() string

type MediaConcurrency added in v0.29.0 

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 MetricDataV2 added in v1.49.0 

type MetricDataV2 struct {

	// The metric name, 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 added in v1.49.0 

type MetricFilterV2 struct {

	// The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD ,
	// DISCONNECT_REASON . These are the same values as the InitiationMethod and
	// DisconnectReason in the contact record. For more information, see
	// ContactTraceRecord (https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord)
	// in the Amazon Connect Administrator's Guide.
	MetricFilterKey *string

	// The values to use for filtering data. Valid metric filter values for
	// INITIATION_METHOD : INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK |
	// API Valid metric filter values for DISCONNECT_REASON : CUSTOMER_DISCONNECT |
	// AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED |
	// CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API
	MetricFilterValues []string
	// 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 MetricResultV2 added in v1.49.0 

type MetricResultV2 struct {

	// The set of metrics.
	Collections []MetricDataV2

	// The dimension for the metrics.
	Dimensions map[string]string
	// contains filtered or unexported fields
}

Contains information about the metric results.

type MetricV2 added in v1.49.0 

type MetricV2 struct {

	// Contains the filters to be used when returning data.
	MetricFilters []MetricFilterV2

	// The name of the metric. This parameter is required. The following Required = No
	// is incorrect.
	Name *string

	// Contains information about the threshold for service level metrics.
	Threshold []ThresholdV2
	// contains filtered or unexported fields
}

Contains information about the metric.

type MonitorCapability added in v1.37.0 

type MonitorCapability string
const (
	MonitorCapabilitySilentMonitor MonitorCapability = "SILENT_MONITOR"
	MonitorCapabilityBarge         MonitorCapability = "BARGE"
)

Enum values for MonitorCapability

func (MonitorCapability) Values added in v1.37.0 

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 NotificationContentType added in v1.39.0 

type NotificationContentType string
const (
	NotificationContentTypePlainText NotificationContentType = "PLAIN_TEXT"
)

Enum values for NotificationContentType

func (NotificationContentType) Values added in v1.39.0 

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 added in v1.39.0 

type NotificationDeliveryType string
const (
	NotificationDeliveryTypeEmail NotificationDeliveryType = "EMAIL"
)

Enum values for NotificationDeliveryType

func (NotificationDeliveryType) Values added in v1.39.0 

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 added in v1.39.0 

type NotificationRecipientType struct {

	// A list of user IDs.
	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 NumberReference added in v1.25.0 

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 added in v1.53.0 

type NumericQuestionPropertyAutomationLabel string
const (
	NumericQuestionPropertyAutomationLabelOverallCustomerSentimentScore NumericQuestionPropertyAutomationLabel = "OVERALL_CUSTOMER_SENTIMENT_SCORE"
	NumericQuestionPropertyAutomationLabelOverallAgentSentimentScore    NumericQuestionPropertyAutomationLabel = "OVERALL_AGENT_SENTIMENT_SCORE"
	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"
)

Enum values for NumericQuestionPropertyAutomationLabel

func (NumericQuestionPropertyAutomationLabel) Values added in v1.53.0 

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 added in v1.53.0 

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 28800.
  • 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 OutboundCallerConfig added in v1.2.0 

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 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 added in v1.52.0 

type ParticipantDetailsToAdd struct {

	// The display name of the participant.
	DisplayName *string

	// The role of the participant being added.
	ParticipantRole ParticipantRole
	// contains filtered or unexported fields
}

The details to add for the participant.

type ParticipantRole added in v1.52.0 

type ParticipantRole string
const (
	ParticipantRoleAgent     ParticipantRole = "AGENT"
	ParticipantRoleCustomer  ParticipantRole = "CUSTOMER"
	ParticipantRoleSystem    ParticipantRole = "SYSTEM"
	ParticipantRoleCustomBot ParticipantRole = "CUSTOM_BOT"
)

Enum values for ParticipantRole

func (ParticipantRole) Values added in v1.52.0 

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 ParticipantTimerAction added in v1.41.0 

type ParticipantTimerAction string
const (
	ParticipantTimerActionUnset ParticipantTimerAction = "Unset"
)

Enum values for ParticipantTimerAction

func (ParticipantTimerAction) Values added in v1.41.0 

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 added in v1.41.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html) .

type ParticipantTimerType added in v1.41.0 

type ParticipantTimerType string
const (
	ParticipantTimerTypeIdle                  ParticipantTimerType = "IDLE"
	ParticipantTimerTypeDisconnectNoncustomer ParticipantTimerType = "DISCONNECT_NONCUSTOMER"
)

Enum values for ParticipantTimerType

func (ParticipantTimerType) Values added in v1.41.0 

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 added in v1.41.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html) .

The following types satisfy this interface: 

ParticipantTimerValueMemberParticipantTimerAction
ParticipantTimerValueMemberParticipantTimerDurationInMinutes
Example (OutputUsage) 
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")

	}
}

Output:

type ParticipantTimerValueMemberParticipantTimerAction added in v1.41.0 

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 added in v1.41.0 

type ParticipantTimerValueMemberParticipantTimerDurationInMinutes struct {
	Value int32
	// contains filtered or unexported fields
}

The duration of a timer, in minutes.

type ParticipantTokenCredentials added in v1.52.0 

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 (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
	// . The participant token is valid for the lifetime of a chat participant.
	ParticipantToken *string
	// contains filtered or unexported fields
}

The credentials used by the participant.

type PersistentChat added in v1.45.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) .

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 added in v0.29.0 

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 added in v0.31.0 

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 added in v1.22.0 

type PhoneNumberStatus struct {

	// The status message.
	Message *string

	// The status.
	Status PhoneNumberWorkflowStatus
	// contains filtered or unexported fields
}

The status of the phone number.

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

Enum values for PhoneNumberType

func (PhoneNumberType) Values added in v0.29.0 

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 added in v1.22.0 

type PhoneNumberWorkflowStatus string
const (
	PhoneNumberWorkflowStatusClaimed    PhoneNumberWorkflowStatus = "CLAIMED"
	PhoneNumberWorkflowStatusInProgress PhoneNumberWorkflowStatus = "IN_PROGRESS"
	PhoneNumberWorkflowStatusFailed     PhoneNumberWorkflowStatus = "FAILED"
)

Enum values for PhoneNumberWorkflowStatus

func (PhoneNumberWorkflowStatus) Values added in v1.22.0 

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
const (
	PhoneTypeSoftPhone PhoneType = "SOFT_PHONE"
	PhoneTypeDeskPhone PhoneType = "DESK_PHONE"
)

Enum values for PhoneType

func (PhoneType) Values added in v0.29.0 

func (PhoneType) Values() []PhoneType

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 ProblemDetail added in v0.29.0 

type ProblemDetail struct {

	// The problem detail's message.
	Message *string
	// contains filtered or unexported fields
}

Information about a problem detail.

type Prompt added in v1.55.0 

type Prompt struct {

	// The description of the prompt.
	Description *string

	// 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 added in v1.58.0 

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 added in v1.58.0 

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 added in v0.29.0 

type PromptSummary struct {

	// The Amazon Resource Name (ARN) of the prompt.
	Arn *string

	// The identifier of the prompt.
	Id *string

	// The name of the prompt.
	Name *string
	// contains filtered or unexported fields
}

Contains information about the prompt.

type PropertyValidationException added in v1.25.0 

type PropertyValidationException struct {
	Message *string

	ErrorCodeOverride *string

	PropertyList []PropertyValidationExceptionProperty
	// contains filtered or unexported fields
}

The property is not valid.

func (*PropertyValidationException) Error added in v1.25.0 

func (e *PropertyValidationException) Error() string

func (*PropertyValidationException) ErrorCode added in v1.25.0 

func (e *PropertyValidationException) ErrorCode() string

func (*PropertyValidationException) ErrorFault added in v1.25.0 

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

func (*PropertyValidationException) ErrorMessage added in v1.25.0 

func (e *PropertyValidationException) ErrorMessage() string

type PropertyValidationExceptionProperty added in v1.25.0 

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 added in v1.25.0 

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 added in v1.25.0 

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 Queue added in v1.2.0 

type Queue struct {

	// The description of the queue.
	Description *string

	// The identifier for the hours of operation.
	HoursOfOperationId *string

	// 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 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 added in v1.12.0 

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 QueueQuickConnectConfig added in v0.31.0 

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 added in v1.29.0 

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 added in v1.29.0 

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 added in v1.2.0 

type QueueStatus string
const (
	QueueStatusEnabled  QueueStatus = "ENABLED"
	QueueStatusDisabled QueueStatus = "DISABLED"
)

Enum values for QueueStatus

func (QueueStatus) Values added in v1.2.0 

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 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
const (
	QueueTypeStandard QueueType = "STANDARD"
	QueueTypeAgent    QueueType = "AGENT"
)

Enum values for QueueType

func (QueueType) Values added in v0.29.0 

func (QueueType) Values() []QueueType

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 added in v0.31.0 

type QuickConnect struct {

	// The description.
	Description *string

	// 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 added in v0.31.0 

type QuickConnectConfig struct {

	// The type of quick connect. In the Amazon Connect console, 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

	// 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 QuickConnectSearchCriteria added in v1.58.0 

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 added in v1.58.0 

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 added in v0.31.0 

type QuickConnectSummary struct {

	// The Amazon Resource Name (ARN) of the quick connect.
	Arn *string

	// The identifier for the quick connect.
	Id *string

	// The name of the quick connect.
	Name *string

	// The type of quick connect. In the Amazon Connect console, 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 added in v0.31.0 

type QuickConnectType string
const (
	QuickConnectTypeUser        QuickConnectType = "USER"
	QuickConnectTypeQueue       QuickConnectType = "QUEUE"
	QuickConnectTypePhoneNumber QuickConnectType = "PHONE_NUMBER"
)

Enum values for QuickConnectType

func (QuickConnectType) Values added in v0.31.0 

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 ReadOnlyFieldInfo added in v1.25.0 

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 Reference added in v0.31.0 

type Reference struct {

	// The type of the reference. DATE must be of type Epoch timestamp.
	//
	// This member is required.
	Type ReferenceType

	// 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).
	//
	// This member is required.
	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 added in v1.12.0 

type ReferenceStatus string
const (
	ReferenceStatusApproved ReferenceStatus = "APPROVED"
	ReferenceStatusRejected ReferenceStatus = "REJECTED"
)

Enum values for ReferenceStatus

func (ReferenceStatus) Values added in v1.12.0 

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 added in v1.12.0 

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
ReferenceSummaryMemberNumber
ReferenceSummaryMemberString
ReferenceSummaryMemberUrl
Example (OutputUsage) 
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.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")

	}
}

Output:

type ReferenceSummaryMemberAttachment added in v1.12.0 

type ReferenceSummaryMemberAttachment struct {
	Value AttachmentReference
	// contains filtered or unexported fields
}

Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.

type ReferenceSummaryMemberDate added in v1.25.0 

type ReferenceSummaryMemberDate struct {
	Value DateReference
	// contains filtered or unexported fields
}

Information about a reference when the referenceType is DATE . Otherwise, null.

type ReferenceSummaryMemberEmail added in v1.25.0 

type ReferenceSummaryMemberEmail struct {
	Value EmailReference
	// contains filtered or unexported fields
}

Information about a reference when the referenceType is EMAIL . Otherwise, null.

type ReferenceSummaryMemberNumber added in v1.25.0 

type ReferenceSummaryMemberNumber struct {
	Value NumberReference
	// contains filtered or unexported fields
}

Information about a reference when the referenceType is NUMBER . Otherwise, null.

type ReferenceSummaryMemberString added in v1.25.0 

type ReferenceSummaryMemberString struct {
	Value StringReference
	// contains filtered or unexported fields
}

Information about a reference when the referenceType is STRING . Otherwise, null.

type ReferenceSummaryMemberUrl added in v1.12.0 

type ReferenceSummaryMemberUrl struct {
	Value UrlReference
	// contains filtered or unexported fields
}

Information about the reference when the referenceType is URL . Otherwise, null.

type ReferenceType added in v0.31.0 

type ReferenceType string
const (
	ReferenceTypeUrl        ReferenceType = "URL"
	ReferenceTypeAttachment ReferenceType = "ATTACHMENT"
	ReferenceTypeNumber     ReferenceType = "NUMBER"
	ReferenceTypeString     ReferenceType = "STRING"
	ReferenceTypeDate       ReferenceType = "DATE"
	ReferenceTypeEmail      ReferenceType = "EMAIL"
)

Enum values for ReferenceType

func (ReferenceType) Values added in v0.31.0 

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 added in v1.45.0 

type RehydrationType string
const (
	RehydrationTypeEntirePastSession RehydrationType = "ENTIRE_PAST_SESSION"
	RehydrationTypeFromSegment       RehydrationType = "FROM_SEGMENT"
)

Enum values for RehydrationType

func (RehydrationType) Values added in v1.45.0 

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 RequiredFieldInfo added in v1.25.0 

type RequiredFieldInfo struct {

	// The unique identifier for the field.
	Id *TaskTemplateFieldIdentifier
	// contains filtered or unexported fields
}

Information about a required field.

type ResourceConflictException added in v0.30.0 

type ResourceConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource already has that name.

func (*ResourceConflictException) Error added in v0.30.0 

func (e *ResourceConflictException) Error() string

func (*ResourceConflictException) ErrorCode added in v0.30.0 

func (e *ResourceConflictException) ErrorCode() string

func (*ResourceConflictException) ErrorFault added in v0.30.0 

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

func (*ResourceConflictException) ErrorMessage added in v0.30.0 

func (e *ResourceConflictException) ErrorMessage() string

type ResourceInUseException added in v0.30.0 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType ResourceType
	ResourceId   *string
	// contains filtered or unexported fields
}

That resource is already in use. Please try another.

func (*ResourceInUseException) Error added in v0.30.0 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode added in v0.30.0 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault added in v0.30.0 

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

func (*ResourceInUseException) ErrorMessage added in v0.30.0 

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 added in v1.33.0 

type ResourceNotReadyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource is not ready.

func (*ResourceNotReadyException) Error added in v1.33.0 

func (e *ResourceNotReadyException) Error() string

func (*ResourceNotReadyException) ErrorCode added in v1.33.0 

func (e *ResourceNotReadyException) ErrorCode() string

func (*ResourceNotReadyException) ErrorFault added in v1.33.0 

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

func (*ResourceNotReadyException) ErrorMessage added in v1.33.0 

func (e *ResourceNotReadyException) ErrorMessage() string

type ResourceTagsSearchCriteria added in v1.60.0 

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 added in v0.30.0 

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

Enum values for ResourceType

func (ResourceType) Values added in v0.30.0 

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 RoutingProfile added in v0.29.0 

type RoutingProfile struct {

	// 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 (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
	// in the Amazon Resource Name (ARN) of the instance.
	InstanceId *string

	// 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 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 RoutingProfileQueueConfig added in v0.29.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html)
	// in the Amazon Connect Administrator Guide.
	//
	// 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 (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 added in v0.29.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html)
	// in the Amazon Connect Administrator Guide.
	//
	// 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 (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 added in v0.29.0 

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 added in v1.26.0 

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 added in v1.29.0 

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 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 added in v1.29.0 

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 name of the routing profile.
	Name *string
	// contains filtered or unexported fields
}

Contains summary information about a routing profile.

type Rule added in v1.39.0 

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 added in v1.39.0 

type RuleAction struct {

	// The type of action that creates a rule.
	//
	// This member is required.
	ActionType ActionType

	// Information about the contact category action.
	AssignContactCategoryAction *AssignContactCategoryActionDefinition

	// Information about the EventBridge action.
	EventBridgeAction *EventBridgeActionDefinition

	// Information about the send notification action.
	SendNotificationAction *SendNotificationActionDefinition

	// Information about the task action. This field is required if TriggerEventSource
	// is one of the following values: OnZendeskTicketCreate |
	// OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
	TaskAction *TaskActionDefinition
	// contains filtered or unexported fields
}

Information about the action to be performed when a rule is triggered.

type RulePublishStatus added in v1.39.0 

type RulePublishStatus string
const (
	RulePublishStatusDraft     RulePublishStatus = "DRAFT"
	RulePublishStatusPublished RulePublishStatus = "PUBLISHED"
)

Enum values for RulePublishStatus

func (RulePublishStatus) Values added in v1.39.0 

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 added in v1.39.0 

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 added in v1.39.0 

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

type S3Config added in v0.30.0 

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 SearchableQueueType added in v1.29.0 

type SearchableQueueType string
const (
	SearchableQueueTypeStandard SearchableQueueType = "STANDARD"
)

Enum values for SearchableQueueType

func (SearchableQueueType) Values added in v1.29.0 

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 SecurityKey added in v0.30.0 

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 added in v1.11.0 

type SecurityProfile struct {

	// 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 secruity profile.
	Arn *string

	// The description of the security profile.
	Description *string

	// The identifier for the security profile.
	Id *string

	// 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 SecurityProfileSearchCriteria added in v1.28.0 

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 added in v1.28.0 

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 name of the security profile.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a security profile.

type SecurityProfilesSearchFilter added in v1.28.0 

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 SendNotificationActionDefinition added in v1.39.0 

type SendNotificationActionDefinition struct {

	// Notification content. Supports variable injection. For more information, see
	// JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
	// in the Amazon Connect Administrators Guide.
	//
	// 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

	// The subject of the email if the delivery method is EMAIL . Supports variable
	// injection. For more information, see JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
	// in the Amazon Connect Administrators Guide.
	Subject *string
	// contains filtered or unexported fields
}

Information about the send notification action.

type ServiceQuotaExceededException added in v0.30.0 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service quota has been exceeded.

func (*ServiceQuotaExceededException) Error added in v0.30.0 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode added in v0.30.0 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault added in v0.30.0 

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

func (*ServiceQuotaExceededException) ErrorMessage added in v0.30.0 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SingleSelectQuestionRuleCategoryAutomation added in v1.53.0 

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 added in v1.53.0 

type SingleSelectQuestionRuleCategoryAutomationCondition string
const (
	SingleSelectQuestionRuleCategoryAutomationConditionPresent    SingleSelectQuestionRuleCategoryAutomationCondition = "PRESENT"
	SingleSelectQuestionRuleCategoryAutomationConditionNotPresent SingleSelectQuestionRuleCategoryAutomationCondition = "NOT_PRESENT"
)

Enum values for SingleSelectQuestionRuleCategoryAutomationCondition

func (SingleSelectQuestionRuleCategoryAutomationCondition) Values added in v1.53.0 

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 SortOrder added in v1.42.0 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values added in v1.42.0 

func (SortOrder) Values() []SortOrder

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 SourceType added in v0.31.0 

type SourceType string
const (
	SourceTypeSalesforce SourceType = "SALESFORCE"
	SourceTypeZendesk    SourceType = "ZENDESK"
)

Enum values for SourceType

func (SourceType) Values added in v0.31.0 

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 Statistic 

type Statistic string
const (
	StatisticSum Statistic = "SUM"
	StatisticMax Statistic = "MAX"
	StatisticAvg Statistic = "AVG"
)

Enum values for Statistic

func (Statistic) Values added in v0.29.0 

func (Statistic) Values() []Statistic

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 StorageType added in v0.30.0 

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 added in v0.30.0 

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 added in v1.23.0 

type StringComparisonType string
const (
	StringComparisonTypeStartsWith StringComparisonType = "STARTS_WITH"
	StringComparisonTypeContains   StringComparisonType = "CONTAINS"
	StringComparisonTypeExact      StringComparisonType = "EXACT"
)

Enum values for StringComparisonType

func (StringComparisonType) Values added in v1.23.0 

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 added in v1.23.0 

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 added in v1.25.0 

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 TagCondition added in v1.23.0 

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 added in v1.60.0 

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 added in v1.60.0 

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 TaskActionDefinition added in v1.39.0 

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 (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
	// in the Amazon Connect Administrators Guide.
	//
	// This member is required.
	Name *string

	// The description. Supports variable injection. For more information, see
	// JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
	// in the Amazon Connect Administrators Guide.
	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 added in v1.25.0 

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 added in v1.25.0 

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 added in v1.25.0 

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 added in v1.25.0 

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 added in v1.25.0 

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 added in v1.25.0 

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

Enum values for TaskTemplateFieldType

func (TaskTemplateFieldType) Values added in v1.25.0 

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 TaskTemplateMetadata added in v1.25.0 

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 added in v1.25.0 

type TaskTemplateStatus string
const (
	TaskTemplateStatusActive   TaskTemplateStatus = "ACTIVE"
	TaskTemplateStatusInactive TaskTemplateStatus = "INACTIVE"
)

Enum values for TaskTemplateStatus

func (TaskTemplateStatus) Values added in v1.25.0 

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 added in v1.33.0 

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 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 added in v1.49.0 

type ThresholdV2 struct {

	// The type of comparison. Only "less than" (LT) 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 added in v1.41.0 

type TimerEligibleParticipantRoles string
const (
	TimerEligibleParticipantRolesCustomer TimerEligibleParticipantRoles = "CUSTOMER"
	TimerEligibleParticipantRolesAgent    TimerEligibleParticipantRoles = "AGENT"
)

Enum values for TimerEligibleParticipantRoles

func (TimerEligibleParticipantRoles) Values added in v1.41.0 

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 TrafficDistributionGroup added in v1.33.0 

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

	// The name of the traffic distribution group.
	Name *string

	// The status of the traffic distribution group.
	//   - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
	//   operation is still in progress and has not yet completed.
	//   - ACTIVE means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
	//   operation has succeeded.
	//   - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
	//   operation has failed.
	//   - PENDING_DELETION means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
	//   operation is still in progress and has not yet completed.
	//   - DELETION_FAILED means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
	//   operation has failed.
	//   - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html)
	//   operation is still in progress and has not yet completed.
	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 added in v1.33.0 

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 added in v1.33.0 

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 added in v1.33.0 

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

	// The name of the traffic distribution group.
	Name *string

	// The status of the traffic distribution group.
	//   - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
	//   operation is still in progress and has not yet completed.
	//   - ACTIVE means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
	//   operation has succeeded.
	//   - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
	//   operation has failed.
	//   - PENDING_DELETION means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
	//   operation is still in progress and has not yet completed.
	//   - DELETION_FAILED means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
	//   operation has failed.
	//   - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html)
	//   operation is still in progress and has not yet completed.
	Status TrafficDistributionGroupStatus
	// contains filtered or unexported fields
}

Information about traffic distribution groups.

type TrafficType added in v1.8.0 

type TrafficType string
const (
	TrafficTypeGeneral  TrafficType = "GENERAL"
	TrafficTypeCampaign TrafficType = "CAMPAIGN"
)

Enum values for TrafficType

func (TrafficType) Values added in v1.8.0 

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 Unit 

type Unit string
const (
	UnitSeconds Unit = "SECONDS"
	UnitCount   Unit = "COUNT"
	UnitPercent Unit = "PERCENT"
)

Enum values for Unit

func (Unit) Values added in v0.29.0 

func (Unit) Values() []Unit

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 added in v1.12.0 

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 UpdateParticipantRoleConfigChannelInfo added in v1.41.0 

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

Configuration information for the chat participant role.

The following types satisfy this interface: 

UpdateParticipantRoleConfigChannelInfoMemberChat
Example (OutputUsage) 
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")

	}
}

Output:

type UpdateParticipantRoleConfigChannelInfoMemberChat added in v1.41.0 

type UpdateParticipantRoleConfigChannelInfoMemberChat struct {
	Value ChatParticipantRoleConfig
	// contains filtered or unexported fields
}

Configuration information for the chat participant role.

type UrlReference added in v1.12.0 

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 added in v0.31.0 

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 added in v0.31.0 

type UseCaseType string
const (
	UseCaseTypeRulesEvaluation  UseCaseType = "RULES_EVALUATION"
	UseCaseTypeConnectCampaigns UseCaseType = "CONNECT_CAMPAIGNS"
)

Enum values for UseCaseType

func (UseCaseType) Values added in v0.31.0 

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

	// 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 added in v1.26.0 

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 (https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html)
	// of the RoutingProfile assigned to the agent.
	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 added in v1.26.0 

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 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.
	FirstName *string

	// The last name. This is required if you are using Amazon Connect or SAML for
	// identity management.
	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.

type UserIdentityInfoLite added in v1.23.0 

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

Contains information about the phone configuration settings for a user.

type UserQuickConnectConfig added in v0.31.0 

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 added in v1.26.0 

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 added in v1.23.0 

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 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 name , description , and 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 added in v1.23.0 

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

Filters to be applied to search results.

type UserSearchSummary added in v1.23.0 

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 Connect user name of the user account.
	Username *string
	// contains filtered or unexported fields
}

Contains summary information about a user.

type Vocabulary added in v1.17.0 

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? (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 (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 added in v1.17.0 

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

Enum values for VocabularyLanguageCode

func (VocabularyLanguageCode) Values added in v1.17.0 

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 added in v1.17.0 

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 added in v1.17.0 

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 added in v1.17.0 

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? (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 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 added in v0.29.0 

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 added in v1.46.0 

type WisdomInfo struct {

	// The Amazon Resource Name (ARN) of the Wisdom session.
	SessionArn *string
	// contains filtered or unexported fields
}

Information about Amazon Connect Wisdom.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.