data class EvaluationFormSection(val instructions: String? = null, val items: List<EvaluationFormItem>? = null, val refId: String, val title: String, val weight: Double? = null)

The evaluation form section.

EvaluationFormSingleSelectQuestionAutomation

data class EvaluationFormSingleSelectQuestionAutomation(val defaultOptionRefId: String? = null, val options: List<EvaluationFormSingleSelectQuestionAutomationOption>)

The automation properties for the single-select question.

EvaluationFormSingleSelectQuestionAutomationOption

data class EvaluationFormSingleSelectQuestionAutomationOption(val ruleCategory: EvaluationFormSingleSelectQuestionRuleCategoryAutomation)

The automation option for the single-select question.

EvaluationFormSingleSelectQuestionOption

data class EvaluationFormSingleSelectQuestionOption(val automaticFail: Boolean? = null, val refId: String, val score: Int? = null, val text: String)

The option for a question.

EvaluationFormSingleSelectQuestionProperties

data class EvaluationFormSingleSelectQuestionProperties(val automation: EvaluationFormSingleSelectQuestionAutomation? = null, val displayAs: EvaluationFormSingleSelectQuestionPropertiesDisplayAs? = null, val options: List<EvaluationFormSingleSelectQuestionOption>)

The properties of the single-select question.

EvaluationFormSingleSelectQuestionRuleCategoryAutomation

data class EvaluationFormSingleSelectQuestionRuleCategoryAutomation(val category: String, val condition: EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition, val optionRefId: String)

The automation option based on Rules categories.

EvaluationFormTag

data class EvaluationFormTag(val key: String, val value: String)

A key-value pair to associate with a resource.

GetContactFlowModuleResult

data class GetContactFlowModuleResult(val contactFlowModuleArn: String? = null, val content: String? = null, val description: String? = null, val instanceArn: String? = null, val name: String? = null, val state: String? = null, val status: String? = null, val tags: List<ContactFlowModuleTag>? = null)

GetContactFlowResult

data class GetContactFlowResult(val contactFlowArn: String? = null, val content: String? = null, val description: String? = null, val instanceArn: String? = null, val name: String? = null, val state: ContactFlowState? = null, val tags: List<ContactFlowTag>? = null)

GetEvaluationFormResult

data class GetEvaluationFormResult(val description: String? = null, val evaluationFormArn: String? = null, val instanceArn: String? = null, val items: List<EvaluationFormBaseItem>? = null, val scoringStrategy: EvaluationFormScoringStrategy? = null, val status: EvaluationFormStatus? = null, val tags: List<EvaluationFormTag>? = null, val title: String? = null)

GetHoursOfOperationResult

data class GetHoursOfOperationResult(val config: List<HoursOfOperationConfig>? = null, val description: String? = null, val hoursOfOperationArn: String? = null, val instanceArn: String? = null, val name: String? = null, val tags: List<HoursOfOperationTag>? = null, val timeZone: String? = null)

GetInstanceResult

data class GetInstanceResult(val arn: String? = null, val attributes: InstanceAttributes? = null, val createdTime: String? = null, val id: String? = null, val instanceStatus: InstanceStatus? = null, val serviceRole: String? = null)

GetInstanceStorageConfigResult

data class GetInstanceStorageConfigResult(val associationId: String? = null, val kinesisFirehoseConfig: InstanceStorageConfigKinesisFirehoseConfig? = null, val kinesisStreamConfig: InstanceStorageConfigKinesisStreamConfig? = null, val kinesisVideoStreamConfig: InstanceStorageConfigKinesisVideoStreamConfig? = null, val s3Config: InstanceStorageConfigS3Config? = null, val storageType: InstanceStorageConfigStorageType? = null)

GetIntegrationAssociationResult

data class GetIntegrationAssociationResult(val integrationAssociationId: String? = null)

GetPhoneNumberResult

data class GetPhoneNumberResult(val address: String? = null, val phoneNumberArn: String? = null, val tags: List<PhoneNumberTag>? = null, val targetArn: String? = null)

GetPromptResult

data class GetPromptResult(val description: String? = null, val instanceArn: String? = null, val name: String? = null, val promptArn: String? = null, val tags: List<PromptTag>? = null)

GetQueueResult

data class GetQueueResult(val description: String? = null, val hoursOfOperationArn: String? = null, val instanceArn: String? = null, val maxContacts: Int? = null, val name: String? = null, val outboundCallerConfig: QueueOutboundCallerConfig? = null, val queueArn: String? = null, val quickConnectArns: List<String>? = null, val status: QueueStatus? = null, val tags: List<QueueTag>? = null, val type: QueueType? = null)

GetQuickConnectResult

data class GetQuickConnectResult(val description: String? = null, val instanceArn: String? = null, val name: String? = null, val quickConnectArn: String? = null, val quickConnectConfig: QuickConnectConfig? = null, val quickConnectType: QuickConnectType? = null, val tags: List<QuickConnectTag>? = null)

GetRoutingProfileResult

data class GetRoutingProfileResult(val agentAvailabilityTimer: RoutingProfileAgentAvailabilityTimer? = null, val defaultOutboundQueueArn: String? = null, val description: String? = null, val instanceArn: String? = null, val mediaConcurrencies: List<RoutingProfileMediaConcurrency>? = null, val name: String? = null, val queueConfigs: List<RoutingProfileQueueConfig>? = null, val routingProfileArn: String? = null, val tags: List<RoutingProfileTag>? = null)

GetRuleResult

data class GetRuleResult(val actions: RuleActions? = null, val function: String? = null, val name: String? = null, val publishStatus: RulePublishStatus? = null, val ruleArn: String? = null, val tags: List<RuleTag>? = null)

GetSecurityKeyResult

data class GetSecurityKeyResult(val associationId: String? = null)

GetSecurityProfileResult

data class GetSecurityProfileResult(val allowedAccessControlTags: List<SecurityProfileTag>? = null, val description: String? = null, val permissions: List<String>? = null, val securityProfileArn: String? = null, val tagRestrictedResources: List<String>? = null, val tags: List<SecurityProfileTag>? = null)

GetTaskTemplateResult

data class GetTaskTemplateResult(val arn: String? = null, val clientToken: String? = null, val constraints: ConstraintsProperties? = null, val contactFlowArn: String? = null, val defaults: List<TaskTemplateDefaultFieldValue>? = null, val description: String? = null, val fields: List<TaskTemplateField>? = null, val instanceArn: String? = null, val name: String? = null, val status: TaskTemplateStatus? = null, val tags: List<TaskTemplateTag>? = null)

GetTrafficDistributionGroupResult

data class GetTrafficDistributionGroupResult(val instanceArn: String? = null, val isDefault: Boolean? = null, val status: TrafficDistributionGroupStatus? = null, val tags: List<TrafficDistributionGroupTag>? = null, val trafficDistributionGroupArn: String? = null)

GetUserHierarchyGroupResult

data class GetUserHierarchyGroupResult(val instanceArn: String? = null, val name: String? = null, val tags: List<UserHierarchyGroupTag>? = null, val userHierarchyGroupArn: String? = null)

GetUserResult

data class GetUserResult(val directoryUserId: String? = null, val hierarchyGroupArn: String? = null, val identityInfo: UserIdentityInfo? = null, val instanceArn: String? = null, val phoneConfig: UserPhoneConfig? = null, val routingProfileArn: String? = null, val securityProfileArns: List<String>? = null, val tags: List<UserTag>? = null, val userArn: String? = null, val username: String? = null)

GetViewResult

data class GetViewResult(val actions: List<String>? = null, val description: String? = null, val instanceArn: String? = null, val name: String? = null, val tags: List<ViewTag>? = null, val template: Any? = null, val viewArn: String? = null, val viewContentSha256: String? = null, val viewId: String? = null)

GetViewVersionResult

data class GetViewVersionResult(val version: Int? = null, val viewVersionArn: String? = null)

HoursOfOperationConfig

data class HoursOfOperationConfig(val day: HoursOfOperationConfigDay, val endTime: HoursOfOperationTimeSlice, val startTime: HoursOfOperationTimeSlice)

Contains information about the hours of operation.

HoursOfOperationTag

data class HoursOfOperationTag(val key: String, val value: String)

A key-value pair to associate with a resource.

HoursOfOperationTimeSlice

data class HoursOfOperationTimeSlice(val hours: Int, val minutes: Int)

The start time or end time for an hours of operation.

InstanceAttributes

data class InstanceAttributes(val autoResolveBestVoices: Boolean? = null, val contactLens: Boolean? = null, val contactflowLogs: Boolean? = null, val earlyMedia: Boolean? = null, val inboundCalls: Boolean, val outboundCalls: Boolean, val useCustomTtsVoices: Boolean? = null)

InstanceStorageConfigEncryptionConfig

data class InstanceStorageConfigEncryptionConfig(val encryptionType: InstanceStorageConfigEncryptionType, val keyId: String)

InstanceStorageConfigKinesisFirehoseConfig

data class InstanceStorageConfigKinesisFirehoseConfig(val firehoseArn: String)

InstanceStorageConfigKinesisStreamConfig

data class InstanceStorageConfigKinesisStreamConfig(val streamArn: String)

InstanceStorageConfigKinesisVideoStreamConfig

data class InstanceStorageConfigKinesisVideoStreamConfig(val encryptionConfig: InstanceStorageConfigEncryptionConfig? = null, val prefix: String, val retentionPeriodHours: Double)

InstanceStorageConfigS3Config

data class InstanceStorageConfigS3Config(val bucketName: String, val bucketPrefix: String, val encryptionConfig: InstanceStorageConfigEncryptionConfig? = null)

PhoneNumberTag

data class PhoneNumberTag(val key: String, val value: String)

A key-value pair to associate with a resource.

PromptTag

data class PromptTag(val key: String, val value: String)

A key-value pair to associate with a resource.

QueueOutboundCallerConfig

data class QueueOutboundCallerConfig(val outboundCallerIdName: String? = null, val outboundCallerIdNumberArn: String? = null, val outboundFlowArn: String? = null)

The outbound caller ID name, number, and outbound whisper flow.

QueueTag

data class QueueTag(val key: String, val value: String)

A key-value pair to associate with a resource.

QuickConnectConfig

data class QuickConnectConfig(val phoneConfig: QuickConnectPhoneNumberQuickConnectConfig? = null, val queueConfig: QuickConnectQueueQuickConnectConfig? = null, val quickConnectType: QuickConnectType, val userConfig: QuickConnectUserQuickConnectConfig? = null)

Configuration settings for the quick connect.

QuickConnectPhoneNumberQuickConnectConfig

data class QuickConnectPhoneNumberQuickConnectConfig(val phoneNumber: String)

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

QuickConnectQueueQuickConnectConfig

data class QuickConnectQueueQuickConnectConfig(val contactFlowArn: String, val queueArn: String)

The queue configuration. This is required only if QuickConnectType is QUEUE.

QuickConnectTag

data class QuickConnectTag(val key: String, val value: String)

A key-value pair to associate with a resource.

QuickConnectUserQuickConnectConfig

data class QuickConnectUserQuickConnectConfig(val contactFlowArn: String, val userArn: String)

The user configuration. This is required only if QuickConnectType is USER.

RoutingProfileCrossChannelBehavior

data class RoutingProfileCrossChannelBehavior(val behaviorType: RoutingProfileBehaviorType)

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.

RoutingProfileMediaConcurrency

data class RoutingProfileMediaConcurrency(val channel: RoutingProfileChannel, val concurrency: Int, val crossChannelBehavior: RoutingProfileCrossChannelBehavior? = null)

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

RoutingProfileQueueConfig

data class RoutingProfileQueueConfig(val delay: Int, val priority: Int, val queueReference: RoutingProfileQueueReference)

Contains information about the queue and channel for which priority and delay can be set.

RoutingProfileQueueReference

data class RoutingProfileQueueReference(val channel: RoutingProfileChannel, val queueArn: String)

Contains the channel and queue identifier for a routing profile.

RoutingProfileTag

data class RoutingProfileTag(val key: String, val value: String)

A key-value pair to associate with a resource.

RuleActions

data class RuleActions(val assignContactCategoryActions: List<RuleAssignContactCategoryAction>? = null, val eventBridgeActions: List<RuleEventBridgeAction>? = null, val sendNotificationActions: List<RuleSendNotificationAction>? = null, val taskActions: List<RuleTaskAction>? = null)

The list of actions that will be executed when a rule is triggered.

RuleAssignContactCategoryAction

class RuleAssignContactCategoryAction

The definition for assigning contact category action.

RuleEventBridgeAction

data class RuleEventBridgeAction(val name: String)

The definition for event bridge action.

RuleNotificationRecipientType

data class RuleNotificationRecipientType(val userArns: List<String>? = null, val userTags: Any? = null)

The type of notification recipient.

RuleSendNotificationAction

data class RuleSendNotificationAction(val content: String, val contentType: RuleSendNotificationActionContentType, val deliveryMethod: RuleSendNotificationActionDeliveryMethod, val recipient: RuleNotificationRecipientType, val subject: String? = null)

The definition for sending notification action.

RuleTag

data class RuleTag(val key: String, val value: String)

A key-value pair to associate with a resource.

RuleTaskAction

data class RuleTaskAction(val contactFlowArn: String, val description: String? = null, val name: String, val references: Any? = null)

The definition of task action.

RuleTriggerEventSource

data class RuleTriggerEventSource(val eventSourceName: RuleTriggerEventSourceEventSourceName, val integrationAssociationArn: String? = null)

The event source that will trigger the rule.

SecurityProfileTag

data class SecurityProfileTag(val key: String, val value: String)

A key-value pair to associate with a resource.

TaskTemplateDefaultFieldValue

data class TaskTemplateDefaultFieldValue(val defaultValue: String, val id: TaskTemplateFieldIdentifier)

the default value for the task template's field

TaskTemplateField

data class TaskTemplateField(val description: String? = null, val id: TaskTemplateFieldIdentifier, val singleSelectOptions: List<String>? = null, val type: TaskTemplateFieldType)

A task template field object.

TaskTemplateFieldIdentifier

data class TaskTemplateFieldIdentifier(val name: String)

the identifier (name) for the task template field

TaskTemplateInvisibleFieldInfo

data class TaskTemplateInvisibleFieldInfo(val id: TaskTemplateFieldIdentifier)

Invisible field info

TaskTemplateReadOnlyFieldInfo

data class TaskTemplateReadOnlyFieldInfo(val id: TaskTemplateFieldIdentifier)

ReadOnly field info

TaskTemplateRequiredFieldInfo

data class TaskTemplateRequiredFieldInfo(val id: TaskTemplateFieldIdentifier)

Required field info

TaskTemplateTag

data class TaskTemplateTag(val key: String, val value: String)

A key-value pair to associate with a resource.

TrafficDistributionGroupTag

data class TrafficDistributionGroupTag(val key: String, val value: String)

A key-value pair to associate with a resource.

UserHierarchyGroupTag

data class UserHierarchyGroupTag(val key: String, val value: String)

A key-value pair to associate with a resource.

UserIdentityInfo

data class UserIdentityInfo(val email: String? = null, val firstName: String? = null, val lastName: String? = null, val mobile: String? = null, val secondaryEmail: String? = null)

Contains information about the identity of a user.

UserPhoneConfig

data class UserPhoneConfig(val afterContactWorkTimeLimit: Int? = null, val autoAccept: Boolean? = null, val deskPhoneNumber: String? = null, val phoneType: UserPhoneType)

Contains information about the phone configuration settings for a user.

UserTag

data class UserTag(val key: String, val value: String)

A key-value pair to associate with a resource.

ViewTag

data class ViewTag(val key: String, val value: String)

A key-value pair to associate with a resource.