pulumi-aws-native-kotlin/com.pulumi.awsnative.connect.kotlin.outputs

Package-level declarations

Types

data class ConstraintsProperties(val invisibleFields: List<TaskTemplateInvisibleFieldInfo>? = null, val readOnlyFields: List<TaskTemplateReadOnlyFieldInfo>? = null, val requiredFields: List<TaskTemplateRequiredFieldInfo>? = null)

The constraints for the task template

EvaluationFormBaseItem

data class EvaluationFormBaseItem(val section: EvaluationFormSection)

An item at the root level. All items must be sections.

EvaluationFormItem

data class EvaluationFormItem(val question: EvaluationFormQuestion? = null, val section: EvaluationFormSection? = null)

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.

EvaluationFormNumericQuestionAutomation

data class EvaluationFormNumericQuestionAutomation(val propertyValue: EvaluationFormNumericQuestionPropertyValueAutomation)

Information about the automation configuration in numeric questions.

EvaluationFormNumericQuestionOption

data class EvaluationFormNumericQuestionOption(val automaticFail: Boolean? = null, val maxValue: Int, val minValue: Int, val score: Int? = null)

Information about the option range used for scoring in numeric questions.

EvaluationFormNumericQuestionProperties

data class EvaluationFormNumericQuestionProperties(val automation: EvaluationFormNumericQuestionAutomation? = null, val maxValue: Int, val minValue: Int, val options: List<EvaluationFormNumericQuestionOption>? = null)

Information about properties for a numeric question in an evaluation form.

EvaluationFormNumericQuestionPropertyValueAutomation

data class EvaluationFormNumericQuestionPropertyValueAutomation(val label: EvaluationFormNumericQuestionPropertyValueAutomationLabel)

Information about the property value used in automation of a numeric questions.

EvaluationFormQuestion

data class EvaluationFormQuestion(val instructions: String? = null, val notApplicableEnabled: Boolean? = null, val questionType: EvaluationFormQuestionQuestionType, val questionTypeProperties: EvaluationFormQuestionTypeProperties? = null, val refId: String, val title: String, val weight: Double? = null)

Information about a question from an evaluation form.

EvaluationFormQuestionTypeProperties

data class EvaluationFormQuestionTypeProperties(val numeric: EvaluationFormNumericQuestionProperties? = null, val singleSelect: EvaluationFormSingleSelectQuestionProperties? = null)

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.

EvaluationFormScoringStrategy

data class EvaluationFormScoringStrategy(val mode: EvaluationFormScoringStrategyMode, val status: EvaluationFormScoringStrategyStatus)

A scoring strategy of the evaluation form.

EvaluationFormSection

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

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

EvaluationFormSingleSelectQuestionAutomation

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

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.

EvaluationFormSingleSelectQuestionAutomationOption

data class EvaluationFormSingleSelectQuestionAutomationOption(val ruleCategory: EvaluationFormSingleSelectQuestionRuleCategoryAutomation)

The automation options of the single select question.

EvaluationFormSingleSelectQuestionOption

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

Information about the automation configuration in single select questions.

EvaluationFormSingleSelectQuestionProperties

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

Information about the options in single select questions.

EvaluationFormSingleSelectQuestionRuleCategoryAutomation

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

Information about the automation option based on a rule category for a single select question. Length Constraints: Minimum length of 1. Maximum length of 50.

GetAgentStatusResult

data class GetAgentStatusResult(val agentStatusArn: String? = null, val description: String? = null, val displayOrder: Int? = null, val instanceArn: String? = null, val lastModifiedRegion: String? = null, val lastModifiedTime: Double? = null, val name: String? = null, val resetOrderNumber: Boolean? = null, val state: AgentStatusState? = null, val tags: List<Tag>? = null, val type: AgentStatusType? = null)

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<Tag>? = 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<Tag>? = null)

GetContactFlowVersionResult

data class GetContactFlowVersionResult(val contactFlowVersionArn: String? = null, val flowContentSha256: String? = null, val version: Int? = null)

GetEmailAddressResult

data class GetEmailAddressResult(val description: String? = null, val displayName: String? = null, val emailAddressArn: String? = null, val instanceArn: String? = null, val tags: List<Tag>? = 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<Tag>? = null, val title: String? = null)

GetHoursOfOperationResult

data class GetHoursOfOperationResult(val config: List<HoursOfOperationConfig>? = null, val description: String? = null, val hoursOfOperationArn: String? = null, val hoursOfOperationOverrides: List<HoursOfOperationOverride>? = null, val instanceArn: String? = null, val name: String? = null, val tags: List<Tag>? = 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, val tags: List<Tag>? = 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 description: String? = null, val phoneNumberArn: String? = null, val tags: List<Tag>? = null, val targetArn: String? = null)

GetPredefinedAttributeResult

data class GetPredefinedAttributeResult(val lastModifiedRegion: String? = null, val lastModifiedTime: Double? = null, val values: ValuesProperties? = null)

GetPromptResult

data class GetPromptResult(val description: String? = null, val instanceArn: String? = null, val name: String? = null, val promptArn: String? = null, val tags: List<Tag>? = 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 outboundEmailConfig: QueueOutboundEmailConfig? = null, val queueArn: String? = null, val quickConnectArns: List<String>? = null, val status: QueueStatus? = null, val tags: List<Tag>? = 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<Tag>? = 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<Tag>? = 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<Tag>? = null)

GetSecurityKeyResult

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

GetSecurityProfileResult

data class GetSecurityProfileResult(val allowedAccessControlHierarchyGroupId: String? = null, val allowedAccessControlTags: List<SecurityProfileTag>? = null, val applications: List<SecurityProfileApplication>? = null, val description: String? = null, val hierarchyRestrictedResources: List<String>? = null, val lastModifiedRegion: String? = null, val lastModifiedTime: Double? = null, val permissions: List<String>? = null, val securityProfileArn: String? = null, val tagRestrictedResources: List<String>? = null, val tags: List<Tag>? = 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 selfAssignContactFlowArn: String? = null, val status: TaskTemplateStatus? = null, val tags: List<Tag>? = null)

GetTrafficDistributionGroupResult

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

GetUserHierarchyGroupResult

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

GetUserHierarchyStructureResult

data class GetUserHierarchyStructureResult(val userHierarchyStructure: UserHierarchyStructureProperties? = null, val userHierarchyStructureArn: 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<Tag>? = null, val userArn: String? = null, val userProficiencies: List<UserProficiency>? = 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<Tag>? = 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 versionDescription: String? = 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.

HoursOfOperationOverride

data class HoursOfOperationOverride(val effectiveFrom: String, val effectiveTill: String, val hoursOfOperationOverrideId: String? = null, val overrideConfig: List<HoursOfOperationOverrideConfig>, val overrideDescription: String? = null, val overrideName: String)

Overrides attached to the hours of operation.

HoursOfOperationOverrideConfig

data class HoursOfOperationOverrideConfig(val day: HoursOfOperationOverrideConfigDay, val endTime: HoursOfOperationOverrideTimeSlice, val startTime: HoursOfOperationOverrideTimeSlice)

Contains information about the hours of operation override.

HoursOfOperationOverrideTimeSlice

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

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

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, val prefix: String, val retentionPeriodHours: Double)

InstanceStorageConfigS3Config

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

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.

QueueOutboundEmailConfig

data class QueueOutboundEmailConfig(val outboundEmailAddressId: String? = null)

The outbound email address ID.

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.

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.

RuleActions

data class RuleActions(val assignContactCategoryActions: List<RuleAssignContactCategoryAction>? = null, val createCaseActions: List<RuleCreateCaseAction>? = null, val endAssociatedTasksActions: List<RuleEndAssociatedTasksAction>? = null, val eventBridgeActions: List<RuleEventBridgeAction>? = null, val sendNotificationActions: List<RuleSendNotificationAction>? = null, val submitAutoEvaluationActions: List<RuleSubmitAutoEvaluationAction>? = null, val taskActions: List<RuleTaskAction>? = null, val updateCaseActions: List<RuleUpdateCaseAction>? = null)

A list of actions to be run when the rule is triggered.

RuleAssignContactCategoryAction

class RuleAssignContactCategoryAction

The definition for assigning contact category action.

RuleCreateCaseAction

data class RuleCreateCaseAction(val fields: List<RuleField>, val templateId: String)

RuleEndAssociatedTasksAction

class RuleEndAssociatedTasksAction

The definition for ending associated task action.

RuleEventBridgeAction

data class RuleEventBridgeAction(val name: String)

The EV action definition.

RuleField

data class RuleField(val id: String, val value: RuleFieldValue)

RuleFieldValue

data class RuleFieldValue(val booleanValue: Boolean? = null, val doubleValue: Double? = null, val emptyValue: Any? = null, val stringValue: String? = null)

Object for case field values.

RuleNotificationRecipientType

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

The type of notification recipient.

RuleReference

data class RuleReference(val type: RuleReferenceType, val value: String)

Information about the reference when the `referenceType` is `URL`. Otherwise, null. (Supports variable injection in the `Value` field.)

RuleSendNotificationAction

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

Information about the send notification action.

RuleSubmitAutoEvaluationAction

data class RuleSubmitAutoEvaluationAction(val evaluationFormArn: String)

RuleTaskAction

data class RuleTaskAction(val contactFlowArn: String, val description: String? = null, val name: String, val references: Map<String, RuleReference>? = null)

Information about the task action. This field is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` | `OnZendeskTicketStatusUpdate` | `OnSalesforceCaseCreate`

RuleTriggerEventSource

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

The name of the event source.

RuleUpdateCaseAction

data class RuleUpdateCaseAction(val fields: List<RuleField>)

SecurityProfileApplication

data class SecurityProfileApplication(val applicationPermissions: List<String>, val namespace: String)

A third-party application's metadata.

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

UserHierarchyStructureLevelFive

data class UserHierarchyStructureLevelFive(val hierarchyLevelArn: String? = null, val hierarchyLevelId: String? = null, val name: String)

Information about level five.

UserHierarchyStructureLevelFour

data class UserHierarchyStructureLevelFour(val hierarchyLevelArn: String? = null, val hierarchyLevelId: String? = null, val name: String)

Information about level four.

UserHierarchyStructureLevelOne

data class UserHierarchyStructureLevelOne(val hierarchyLevelArn: String? = null, val hierarchyLevelId: String? = null, val name: String)

Information about level one.

UserHierarchyStructureLevelThree

data class UserHierarchyStructureLevelThree(val hierarchyLevelArn: String? = null, val hierarchyLevelId: String? = null, val name: String)

Information about level three.

UserHierarchyStructureLevelTwo

data class UserHierarchyStructureLevelTwo(val hierarchyLevelArn: String? = null, val hierarchyLevelId: String? = null, val name: String)

Information about level two.

UserHierarchyStructureProperties

data class UserHierarchyStructureProperties(val levelFive: UserHierarchyStructureLevelFive? = null, val levelFour: UserHierarchyStructureLevelFour? = null, val levelOne: UserHierarchyStructureLevelOne? = null, val levelThree: UserHierarchyStructureLevelThree? = null, val levelTwo: UserHierarchyStructureLevelTwo? = null)

Information about the hierarchy structure.

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.

UserProficiency

data class UserProficiency(val attributeName: String, val attributeValue: String, val level: Double)

Proficiency of a user.

ValuesProperties

data class ValuesProperties(val stringList: List<String>? = null)

The values of a predefined attribute.