Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Connect Service can respond with.

Structs

ActionSummary

Information about an action.

AdditionalEmailRecipients

List of additional email addresses for an email contact.

AgentConfig

The distribution of agents between the instance and its replica(s).

AgentContactReference

Information about the contact associated to the user.

AgentHierarchyGroup

Information about an agent hierarchy group.

AgentHierarchyGroups

A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

AgentInfo

Information about the agent who accepted the contact.

AgentQualityMetrics

Information about the quality of the Agent's media connection

AgentStatus

Contains information about an agent status.

AgentStatusReference

Information about the agent's status.

AgentStatusSearchCriteria

The search criteria to be used to return agent statuses.

AgentStatusSearchFilter

Filters to be applied to search results.

AgentStatusSummary

Summary information for an agent status.

AgentsCriteria

Can be used to define a list of preferred agents to target the contact to within the queue.
 Note that agents must have the queue in their routing profile in order to be offered the
 contact.

AllowedCapabilities

Information about the capabilities enabled for participants of the contact.

AnalyticsDataAssociationResult

This API is in preview release for Amazon Connect and is subject to change.

Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

AnalyticsDataSetsResult

Information about datasets that are available to associate with: DataSetId, DataSetName.

AnswerMachineDetectionConfig

Configuration of the answering machine detection.

Application

This API is in preview release for Amazon Connect and is subject to change.

A third-party application's metadata.

AssignContactCategoryActionDefinition

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

RuleName is used as ContactCategory.

AssignSlaActionDefinition

The AssignSla action definition.

AssociatedContactSummary

Contact summary of a contact in contact tree associated with unique identifier.

AttachedFile

Information about the attached file.

AttachedFileError

Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.

AttachmentReference

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

Attendee

The attendee information, including attendee ID and join token.

Attribute

A toggle for an individual feature at the instance level.

AttributeAndCondition

A list of conditions which would be applied together with an AND condition.

AttributeCondition

An object to specify the predefined attribute condition.

AudioFeatures

Has audio-specific configurations as the operating parameter for Echo Reduction.

AudioQualityMetricsInfo

Contains information for score and potential quality issues for Audio

AuthenticationProfile

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.

Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts.

AuthenticationProfileSummary

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.

A summary of a given authentication profile.

AvailableNumberSummary

Information about available phone numbers.

Campaign

Information associated with a campaign.

CaseSlaConfiguration

The SLA configuration for Case SlaAssignmentType.

ChatContactMetrics

Information about the overall participant interactions at the contact level.

ChatEvent

Chat integration event containing payload to perform different chat actions such as:

• Sending a chat message

• Sending a chat event, such as typing

• Disconnecting from a chat

ChatMessage

A chat message.

ChatMetrics

Information about how agent, bot, and customer interact in a chat contact.

ChatParticipantRoleConfig

Configuration information for the chat participant role.

ChatStreamingConfiguration

The streaming configuration, such as the Amazon SNS streaming endpoint.

ClaimedPhoneNumberSummary

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

CommonAttributeAndCondition

A list of conditions which would be applied together with an AND condition.

Condition

A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit.

ConnectionData

Information required to join the call.

Contact

Contains information about a contact.

ContactAnalysis

A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.

ContactConfiguration

The contact configuration for push notification registration.

ContactDataRequest

Request object with information to create a contact.

ContactDetails

A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.

ContactEvaluation

Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.

ContactFilter

Filters user data based on the contact information that is associated to the users. It contains a list of contact states.

ContactFlow

Contains information about a flow.

ContactFlowModule

Contains information about a flow module.

ContactFlowModuleSearchCriteria

The search criteria to be used to return flow modules.

ContactFlowModuleSearchFilter

The search criteria to be used to return flow modules.

ContactFlowModuleSummary

Contains summary information about a flow.

ContactFlowSearchCriteria

The search criteria to be used to return flows.

ContactFlowSearchFilter

Filters to be applied to search results.

ContactFlowSummary

Contains summary information about a flow.

You can also create and update flows using the Amazon Connect Flow language.

ContactFlowVersionSummary

A summary of a flow version's metadata.

ContactSearchSummary

Information of returned contact.

ContactSearchSummaryAgentInfo

Information about the agent who accepted the contact.

ContactSearchSummaryQueueInfo

If this contact was queued, this contains information about the queue.

ContactSearchSummarySegmentAttributeValue

The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.

ControlPlaneAttributeFilter

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

ControlPlaneTagFilter

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.

ControlPlaneUserAttributeFilter

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed Hierarchy Group conditions is 20.

CreateCaseActionDefinition

The CreateCase action definition.

Credentials

Contains credentials to use for federation.

CrossChannelBehavior

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.

CurrentMetric

Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.

CurrentMetricData

Contains the data for a real-time metric.

CurrentMetricResult

Contains information about a set of real-time metrics.

CurrentMetricSortCriteria

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.

Customer

Information about the Customer on the contact.

CustomerQualityMetrics

Information about the quality of the Customer's media connection

CustomerVoiceActivity

Information about customer’s voice activity.

DateCondition

An object to specify the hours of operation override date condition.

DateReference

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

DefaultVocabulary

Contains information about a default vocabulary.

DeviceInfo

Information regarding the device.

Dimensions

Contains information about the dimensions for a set of metrics.

DisconnectDetails

Information about the call disconnect experience.

DisconnectReason

Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.

Distribution

Information about a traffic distribution.

DownloadUrlMetadata

Metadata used to download the attached file.

EffectiveHoursOfOperations

Information about the hours of operations with the effective override applied.

EmailAddressInfo

Contains information about a source or destination email address.

EmailAddressMetadata

Contains information about an email address for a contact center.

EmailAddressSearchCriteria

The search criteria to be used to return email addresses.

EmailAddressSearchFilter

Filters to be applied to search results.

EmailAttachment

Information about the email attachment files.

EmailMessageReference

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

EmailRecipient

Information about the email recipient

EmailReference

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

EmptyFieldValue

An empty value.

EncryptionConfig

The encryption configuration.

EndAssociatedTasksActionDefinition

End associated tasks related to a case.

Endpoint

Information about the endpoint.

EndpointInfo

Information about the endpoint.

ErrorResult

This API is in preview release for Amazon Connect and is subject to change.

List of errors for dataset association failures.

Evaluation

Information about a contact evaluation.

EvaluationAnswerInput

Information about input answers for a contact evaluation.

EvaluationAnswerOutput

Information about output answers for a contact evaluation.

EvaluationForm

Information about the evaluation form.

EvaluationFormContent

Information about an evaluation form used in a contact evaluation.

EvaluationFormNumericQuestionOption

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

EvaluationFormNumericQuestionProperties

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

EvaluationFormQuestion

Information about a question from an evaluation form.

EvaluationFormScoringStrategy

Information about scoring strategy for an evaluation form.

EvaluationFormSection

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

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.

EvaluationFormSingleSelectQuestionOption

Information about the automation configuration in single select questions.

EvaluationFormSingleSelectQuestionProperties

Information about the options in single select questions.

EvaluationFormSummary

Summary information about an evaluation form.

EvaluationFormVersionSummary

Summary information about an evaluation form.

EvaluationMetadata

Metadata information about a contact evaluation.

EvaluationNote

Information about notes for a contact evaluation.

EvaluationScore

Information about scores of a contact evaluation item (section or question).

EvaluationSummary

Summary information about a contact evaluation.

EventBridgeActionDefinition

The EventBridge action definition.

Expiry

An object to specify the expiration of a routing step.

Expression

A tagged union to specify expression for a routing step.

FailedRequest

Request for which contact failed to be generated.

FieldValue

Object for case field values.

FieldValueUnion

Object to store union of Field values.

FilterV2

Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.

Filters

Contains the filter to apply when retrieving metrics.

FlowAssociationSummary

Information about flow associations.

HierarchyGroup

Contains information about a hierarchy group.

HierarchyGroupCondition

A leaf node condition which can be used to specify a hierarchy group condition.

HierarchyGroupSummary

Contains summary information about a hierarchy group.

HierarchyGroupSummaryReference

Information about the hierarchy group.

HierarchyGroups

Information about the agent hierarchy. Hierarchies can be configured with up to five levels.

HierarchyLevel

Contains information about a hierarchy level.

HierarchyLevelUpdate

Contains information about the hierarchy level to update.

HierarchyPath

Contains information about the levels of a hierarchy group.

HierarchyPathReference

Information about the levels in the hierarchy group.

HierarchyStructure

Contains information about a hierarchy structure.

HierarchyStructureUpdate

Contains information about the level hierarchy to update.

HistoricalMetric

Contains information about a historical metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.

HistoricalMetricData

Contains the data for a historical metric.

HistoricalMetricResult

Contains information about the historical metrics retrieved.

HoursOfOperation

Information about of the hours of operation.

HoursOfOperationConfig

Contains information about the hours of operation.

HoursOfOperationOverride

Information about the hours of operations override.

HoursOfOperationOverrideConfig

Information about the hours of operation override config: day, start time, and end time.

HoursOfOperationOverrideSearchCriteria

The search criteria to be used to return hours of operations overrides.

HoursOfOperationSearchCriteria

The search criteria to be used to return hours of operations.

HoursOfOperationSearchFilter

Filters to be applied to search results.

HoursOfOperationSummary

Contains summary information about hours of operation for a contact center.

HoursOfOperationTimeSlice

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

InboundAdditionalRecipients

Information about the additional TO and CC recipients of an inbound email contact.

You can include up to 50 email addresses in total, distributed across DestinationEmailAddress, ToAddresses, and CcAddresses. This total must include one required DestinationEmailAddress. You can then specify up to 49 addresses allocated across ToAddresses and CcAddresses as needed.

InboundEmailContent

Information about email body content.

InboundRawMessage

Information about the raw email body content.

Instance

The Amazon Connect instance.

InstanceStatusReason

Relevant details why the instance was not successfully created.

InstanceStorageConfig

The storage configuration for the instance.

InstanceSummary

Information about the instance.

IntegrationAssociationSummary

Contains summary information about the associated AppIntegrations.

IntervalDetails

Information about the interval period to use for returning results.

InvisibleFieldInfo

A field that is invisible to an agent.

KinesisFirehoseConfig

Configuration information of a Kinesis Data Firehose delivery stream.

KinesisStreamConfig

Configuration information of a Kinesis data stream.

KinesisVideoStreamConfig

Configuration information of a Kinesis video stream.

LexBot

Configuration information of an Amazon Lex bot.

LexBotConfig

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

LexV2Bot

Configuration information of an Amazon Lex V2 bot.

ListCondition

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

ListPhoneNumbersSummary

Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.

MatchCriteria

An object to define AgentsCriteria.

MediaConcurrency

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

MediaPlacement

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

Meeting

A meeting created using the Amazon Chime SDK.

MeetingFeaturesConfiguration

The configuration settings of the features available to a meeting.

MetricDataV2

Contains the name, thresholds, and metric filters.

MetricFilterV2

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.

MetricInterval

The interval period with the start and end time for the metrics.

MetricResultV2

Contains information about the metric results.

MetricV2

Contains information about the metric.

NewSessionDetails

Payload of chat properties to apply when starting a new contact.

NotificationRecipientType

The type of notification recipient.

NumberCondition

A leaf node condition which can be used to specify a numeric condition.

The currently supported value for FieldName is limit.

NumberReference

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

NumericQuestionPropertyValueAutomation

Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.

• Sentiment scores have a minimum value of -5 and maximum value of 5.

• Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 63072000.

• Percentages have a minimum value of 0 and maximum value of 100.

• NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.

OperationalHour

Information about the hours of operations with the effective override applied.

OutboundAdditionalRecipients

Information about the additional recipients of outbound email.

OutboundCallerConfig

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

OutboundEmailConfig

The outbound email address ID.

OutboundEmailContent

Information about email body content.

OutboundRawMessage

Information about the raw email body content.

OverrideTimeSlice

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

ParticipantCapabilities

The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

ParticipantDetails

The customer's details.

ParticipantDetailsToAdd

The details to add for the participant.

ParticipantMetrics

Information about a participant's interactions in a contact.

ParticipantTimerConfiguration

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.

ParticipantTokenCredentials

The credentials used by the participant.

PersistentChat

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.

PhoneNumberQuickConnectConfig

Contains information about a phone number for a quick connect.

PhoneNumberStatus

The status of the phone number.

• CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

• IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

• FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

PhoneNumberSummary

Contains summary information about a phone number for a contact center.

PredefinedAttribute

Information about a predefined attribute.

PredefinedAttributeSearchCriteria

The search criteria to be used to return predefined attributes.

PredefinedAttributeSummary

Summary of a predefined attribute.

ProblemDetail

Information about a problem detail.

Prompt

Information about a prompt.

PromptSearchCriteria

The search criteria to be used to return prompts.

PromptSearchFilter

Filters to be applied to search results.

PromptSummary

Contains information about the prompt.

PropertyValidationExceptionProperty

Contains information about why a property is not valid.

QualityMetrics

Information about the quality of the participant's media connection.

Queue

Contains information about a queue.

QueueInfo

If this contact was queued, this contains information about the queue.

QueueInfoInput

Information about a queue.

QueueQuickConnectConfig

Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.

QueueReference

Contains information about a queue resource for which metrics are returned.

QueueSearchCriteria

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.

QueueSearchFilter

Filters to be applied to search results.

QueueSummary

Contains summary information about a queue.

QuickConnect

Contains information about a quick connect.

QuickConnectConfig

Contains configuration settings for a quick connect.

QuickConnectSearchCriteria

The search criteria to be used to return quick connects.

QuickConnectSearchFilter

Filters to be applied to search results.

QuickConnectSummary

Contains summary information about a quick connect.

Range

An Object to define the minimum and maximum proficiency levels.

ReadOnlyFieldInfo

Indicates a field that is read-only to an agent.

RealTimeContactAnalysisAttachment

Object that describes attached file.

RealTimeContactAnalysisCategoryDetails

Provides information about the category rule that was matched.

RealTimeContactAnalysisCharacterInterval

Begin and end offsets for a part of text.

RealTimeContactAnalysisIssueDetected

Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.

RealTimeContactAnalysisPointOfInterest

The section of the contact transcript segment that category rule was detected.

RealTimeContactAnalysisSegmentAttachments

Segment containing list of attachments.

RealTimeContactAnalysisSegmentCategories

The matched category rules.

RealTimeContactAnalysisSegmentEvent

Segment type describing a contact event.

RealTimeContactAnalysisSegmentIssues

Segment type containing a list of detected issues.

RealTimeContactAnalysisSegmentPostContactSummary

Information about the post-contact summary for a real-time contact segment.

RealTimeContactAnalysisSegmentTranscript

The analyzed transcript segment.

RealTimeContactAnalysisTranscriptItemRedaction

Object describing redaction applied to the segment.

RealTimeContactAnalysisTranscriptItemWithCharacterOffsets

Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a RealTimeContactAnalysisPointOfInterest in Category.MatchedDetails would have character interval describing part of the text that matched category.

RealTimeContactAnalysisTranscriptItemWithContent

Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from.

RecordingInfo

Information about a voice recording, chat transcript, or screen recording.

Reference

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.

ReplicationConfiguration

Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call fails in the Create a replica of your existing Amazon Connect instance topic in the Amazon Connect Administrator Guide.

ReplicationStatusSummary

Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see Set up Amazon Connect Global Resiliency in the Amazon Connect Administrator Guide.

RequiredFieldInfo

Information about a required field.

ResourceTagsSearchCriteria

The search criteria to be used to search tags.

RoutingCriteria

Latest routing criteria on the contact.

RoutingCriteriaInput

An object to define the RoutingCriteria.

RoutingCriteriaInputStep

Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.

RoutingCriteriaInputStepExpiry

Specify whether this routing criteria step should apply for only a limited amount of time,
 or if it should never expire.

RoutingProfile

Contains information about a routing profile.

RoutingProfileQueueConfig

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

RoutingProfileQueueConfigSummary

Contains summary information about a routing profile queue.

RoutingProfileQueueReference

Contains the channel and queue identifier for a routing profile.

RoutingProfileReference

Information about the routing profile assigned to the user.

RoutingProfileSearchCriteria

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.

RoutingProfileSearchFilter

Filters to be applied to search results.

RoutingProfileSummary

Contains summary information about a routing profile.

Rule

Information about a rule.

RuleAction

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

RuleSummary

A list of ActionTypes associated with a rule.

RuleTriggerEventSource

The name of the event source. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate.

S3Config

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

SearchContactsTimeRange

A structure of time range that you want to search results.

SearchCriteria

A structure of search criteria to be used to return contacts.

SearchableContactAttributes

A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.

SearchableContactAttributesCriteria

The search criteria based on user-defined contact attribute key and values to search on.

SearchableSegmentAttributes

The search criteria based on searchable segment attributes of a contact

SearchableSegmentAttributesCriteria

The search criteria based on searchable segment attribute key and values to search on.

SecurityKey

Configuration information of the security key.

SecurityProfile

Contains information about a security profile.

SecurityProfileSearchCriteria

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.

SecurityProfileSearchSummary

Information about the returned security profiles.

SecurityProfileSummary

Contains information about a security profile.

SecurityProfilesSearchFilter

Filters to be applied to search results.

SegmentAttributeValue

A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

SendNotificationActionDefinition

Information about the send notification action.

SignInConfig

The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

SignInDistribution

The distribution of sign in traffic between the instance and its replica(s).

SingleSelectQuestionRuleCategoryAutomation

Information about the automation option based on a rule category for a single select question.

Sort

A structure that defines the field name to sort by and a sort order.

SourceCampaign

Information about the campaign.

StateTransition

Information about the state transition of a supervisor.

Step

Step signifies the criteria to be used for routing to an agent

StringCondition

A leaf node condition which can be used to specify a string condition.

StringReference

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

SubmitAutoEvaluationActionDefinition

Information about the submit automated evaluation action.

SuccessfulRequest

Request for which contact was successfully created.

TagCondition

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

TagSearchCondition

The search criteria to be used to return tags.

TagSet

A tag set contains tag key and tag value.

TaskActionDefinition

Information about the task action.

TaskTemplateConstraints

Describes constraints that apply to the template fields.

TaskTemplateDefaultFieldValue

Describes a default field and its corresponding value.

TaskTemplateDefaults

Describes default values for fields on a template.

TaskTemplateField

Describes a single task template field.

TaskTemplateFieldIdentifier

The identifier of the task template field.

TaskTemplateMetadata

Contains summary information about the task template.

TelephonyConfig

The distribution of traffic between the instance and its replicas.

TemplateAttributes

Information about the template attributes.

TemplatedMessageConfig

Information about template message configuration.

Threshold

Contains information about the threshold for service level metrics.

ThresholdV2

Contains information about the threshold for service level metrics.

TrafficDistributionGroup

Information about a traffic distribution group.

TrafficDistributionGroupSummary

Information about traffic distribution groups.

TrafficDistributionGroupUserSummary

Summary information about a traffic distribution group user.

Transcript

A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.

TranscriptCriteria

A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.

UpdateCaseActionDefinition

The UpdateCase action definition.

UploadUrlMetadata

Fields required when uploading an attached file.

UrlReference

The URL reference.

UseCase

Contains the use case.

User

Contains information about a user account for an Amazon Connect instance.

UserData

Data for a user.

UserDataFilters

A filter for the user data.

UserHierarchyGroupSearchCriteria

The search criteria to be used to return userHierarchyGroup.

UserHierarchyGroupSearchFilter

Filters to be applied to search results.

UserIdentityInfo

Contains information about the identity of a user.

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.

UserIdentityInfoLite

The user's first name and last name.

UserInfo

The user details for the contact.

UserPhoneConfig

Contains information about the phone configuration settings for a user.

UserProficiency

Information about proficiency of a user.

UserProficiencyDisassociate

Information about proficiency to be disassociated from the user.

UserQuickConnectConfig

Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.

UserReference

Information about the user.

UserSearchCriteria

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.

UserSearchFilter

Filters to be applied to search results.

UserSearchSummary

Information about the returned users.

UserSummary

Contains summary information about a user.

View

A view resource object. Contains metadata and content necessary to render the view.

ViewContent

View content containing all content necessary to render a view except for runtime input data.

ViewInputContent

View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.

ViewSummary

A summary of a view's metadata.

ViewVersionSummary

A summary of a view version's metadata.

Vocabulary

Contains information about a custom vocabulary.

VocabularySummary

Contains summary information about the custom vocabulary.

VoiceRecordingConfiguration

Contains information about the recording configuration settings.

WisdomInfo

Information about Amazon Connect Wisdom.

Enums

ActionType

When writing a match expression against ActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AgentAvailabilityTimer

When writing a match expression against AgentAvailabilityTimer, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AgentStatusState

When writing a match expression against AgentStatusState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AgentStatusType

When writing a match expression against AgentStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AnsweringMachineDetectionStatus

When writing a match expression against AnsweringMachineDetectionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArtifactStatus

When writing a match expression against ArtifactStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AttachedFileInvalidRequestExceptionReason

When writing a match expression against AttachedFileInvalidRequestExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AttachedFileServiceQuotaExceededExceptionReason

When writing a match expression against AttachedFileServiceQuotaExceededExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

BehaviorType

When writing a match expression against BehaviorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Channel

When writing a match expression against Channel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ChatEventType

When writing a match expression against ChatEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Comparison

When writing a match expression against Comparison, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactFlowModuleState

When writing a match expression against ContactFlowModuleState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactFlowModuleStatus

When writing a match expression against ContactFlowModuleStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactFlowState

When writing a match expression against ContactFlowState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactFlowStatus

When writing a match expression against ContactFlowStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactFlowType

When writing a match expression against ContactFlowType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactInitiationMethod

When writing a match expression against ContactInitiationMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactRecordingType

When writing a match expression against ContactRecordingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContactState

When writing a match expression against ContactState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CreatedByInfo

Information on the identity that created the file.

CurrentMetricName

When writing a match expression against CurrentMetricName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DateComparisonType

When writing a match expression against DateComparisonType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeviceType

When writing a match expression against DeviceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DirectoryType

When writing a match expression against DirectoryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EmailHeaderType

When writing a match expression against EmailHeaderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionType

When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EndpointType

When writing a match expression against EndpointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EvaluationAnswerData

Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.

EvaluationFormItem

Information about an item from an evaluation form. The item must be either a section or a question.

EvaluationFormNumericQuestionAutomation

Information about the automation configuration in numeric questions.

EvaluationFormQuestionType

When writing a match expression against EvaluationFormQuestionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EvaluationFormQuestionTypeProperties

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.

EvaluationFormScoringMode

When writing a match expression against EvaluationFormScoringMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EvaluationFormScoringStatus

When writing a match expression against EvaluationFormScoringStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EvaluationFormSingleSelectQuestionAutomationOption

Information about the automation option of a single select question.

EvaluationFormSingleSelectQuestionDisplayMode

When writing a match expression against EvaluationFormSingleSelectQuestionDisplayMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EvaluationFormVersionStatus

When writing a match expression against EvaluationFormVersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EvaluationStatus

When writing a match expression against EvaluationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventSourceName

When writing a match expression against EventSourceName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FailureReasonCode

When writing a match expression against FailureReasonCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FileStatusType

When writing a match expression against FileStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FileUseCaseType

When writing a match expression against FileUseCaseType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowAssociationResourceType

When writing a match expression against FlowAssociationResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Grouping

When writing a match expression against Grouping, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HierarchyGroupMatchType

When writing a match expression against HierarchyGroupMatchType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HistoricalMetricName

When writing a match expression against HistoricalMetricName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HoursOfOperationDays

When writing a match expression against HoursOfOperationDays, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InboundMessageSourceType

When writing a match expression against InboundMessageSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InitiateAs

When writing a match expression against InitiateAs, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InstanceAttributeType

When writing a match expression against InstanceAttributeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InstanceReplicationStatus

When writing a match expression against InstanceReplicationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InstanceStatus

When writing a match expression against InstanceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InstanceStorageResourceType

When writing a match expression against InstanceStorageResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IntegrationType

When writing a match expression against IntegrationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IntervalPeriod

When writing a match expression against IntervalPeriod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InvalidRequestExceptionReason

Reason why the request was invalid.

IvrRecordingTrack

When writing a match expression against IvrRecordingTrack, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LexVersion

When writing a match expression against LexVersion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ListFlowAssociationResourceType

When writing a match expression against ListFlowAssociationResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MediaStreamType

When writing a match expression against MediaStreamType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MeetingFeatureStatus

When writing a match expression against MeetingFeatureStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MonitorCapability

When writing a match expression against MonitorCapability, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NotificationContentType

When writing a match expression against NotificationContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NotificationDeliveryType

When writing a match expression against NotificationDeliveryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NumberComparisonType

When writing a match expression against NumberComparisonType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NumericQuestionPropertyAutomationLabel

When writing a match expression against NumericQuestionPropertyAutomationLabel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OutboundMessageSourceType

When writing a match expression against OutboundMessageSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OverrideDays

When writing a match expression against OverrideDays, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantRole

When writing a match expression against ParticipantRole, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantState

When writing a match expression against ParticipantState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantTimerAction

When writing a match expression against ParticipantTimerAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantTimerType

When writing a match expression against ParticipantTimerType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantTimerValue

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.

ParticipantType

When writing a match expression against ParticipantType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberCountryCode

When writing a match expression against PhoneNumberCountryCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberType

When writing a match expression against PhoneNumberType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneNumberWorkflowStatus

When writing a match expression against PhoneNumberWorkflowStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PhoneType

When writing a match expression against PhoneType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PredefinedAttributeValues

Information about values of a predefined attribute.

PropertyValidationExceptionReason

When writing a match expression against PropertyValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueueStatus

When writing a match expression against QueueStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueueType

When writing a match expression against QueueType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QuickConnectType

When writing a match expression against QuickConnectType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisOutputType

When writing a match expression against RealTimeContactAnalysisOutputType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisPostContactSummaryFailureCode

When writing a match expression against RealTimeContactAnalysisPostContactSummaryFailureCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisPostContactSummaryStatus

When writing a match expression against RealTimeContactAnalysisPostContactSummaryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisSegmentType

When writing a match expression against RealTimeContactAnalysisSegmentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisSentimentLabel

When writing a match expression against RealTimeContactAnalysisSentimentLabel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisStatus

When writing a match expression against RealTimeContactAnalysisStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisSupportedChannel

When writing a match expression against RealTimeContactAnalysisSupportedChannel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RealTimeContactAnalysisTimeData

Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime

RealtimeContactAnalysisSegment

An analyzed segment for a real-time analysis session.

RecordingStatus

When writing a match expression against RecordingStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ReferenceStatus

When writing a match expression against ReferenceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ReferenceSummary

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

ReferenceType

When writing a match expression against ReferenceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RehydrationType

When writing a match expression against RehydrationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceType

When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RoutingCriteriaStepStatus

When writing a match expression against RoutingCriteriaStepStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RulePublishStatus

When writing a match expression against RulePublishStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ScreenShareCapability

When writing a match expression against ScreenShareCapability, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SearchContactsMatchType

When writing a match expression against SearchContactsMatchType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SearchContactsTimeRangeType

When writing a match expression against SearchContactsTimeRangeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SearchableQueueType

When writing a match expression against SearchableQueueType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceQuotaExceededExceptionReason

The reason for the exception.

SingleSelectQuestionRuleCategoryAutomationCondition

When writing a match expression against SingleSelectQuestionRuleCategoryAutomationCondition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SlaAssignmentType

When writing a match expression against SlaAssignmentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SlaType

When writing a match expression against SlaType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SortOrder

When writing a match expression against SortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SortableFieldName

When writing a match expression against SortableFieldName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SourceType

When writing a match expression against SourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Statistic

When writing a match expression against Statistic, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Status

When writing a match expression against Status, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StorageType

When writing a match expression against StorageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StringComparisonType

When writing a match expression against StringComparisonType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TargetListType

When writing a match expression against TargetListType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TaskTemplateFieldType

When writing a match expression against TaskTemplateFieldType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TaskTemplateStatus

When writing a match expression against TaskTemplateStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TimerEligibleParticipantRoles

When writing a match expression against TimerEligibleParticipantRoles, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TrafficDistributionGroupStatus

When writing a match expression against TrafficDistributionGroupStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TrafficType

When writing a match expression against TrafficType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Unit

When writing a match expression against Unit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UpdateParticipantRoleConfigChannelInfo

Configuration information for the chat participant role.

UseCaseType

When writing a match expression against UseCaseType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VideoCapability

When writing a match expression against VideoCapability, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ViewStatus

When writing a match expression against ViewStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ViewType

When writing a match expression against ViewType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VocabularyLanguageCode

When writing a match expression against VocabularyLanguageCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VocabularyState

When writing a match expression against VocabularyState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VoiceRecordingTrack

When writing a match expression against VoiceRecordingTrack, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.