Module aws_sdk_connect::types
source · Expand description
Data structures used by operation inputs/outputs.
Modules§
- Builders
- Error types that Amazon Connect Service can respond with.
Structs§
Information about an action.
The distribution of agents between the instance and its replica(s).
Information about the contact associated to the user.
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.
Information about the agent who accepted the contact.
Contains information about an agent status.
Information about the agent's status.
Summary information for an agent status.
Information about the capabilities enabled for participants of the contact.
This API is in preview release for Amazon Connect and is subject to change.
Configuration of the answering machine detection.
This API is in preview release for Amazon Connect and is subject to change.
This action must be set if
TriggerEventSource
is one of the following values:OnPostCallAnalysisAvailable
|OnRealTimeCallAnalysisAvailable
|OnRealTimeChatAnalysisAvailable
|OnPostChatAnalysisAvailable
. Contact is categorized using the rule name.Information about the attached file.
Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
Information about a reference when the
referenceType
isATTACHMENT
. Otherwise, null.The attendee information, including attendee ID and join token.
A toggle for an individual feature at the instance level.
A list of conditions which would be applied together with an
AND
condition.Has audio-specific configurations as the operating parameter for Echo Reduction.
Information about available phone numbers.
Information associated with a campaign.
Chat integration event containing payload to perform different chat actions such as:
A chat message.
Configuration information for the chat participant role.
The streaming configuration, such as the Amazon SNS streaming endpoint.
Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
Information required to join the call.
Contains information about a contact.
A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
Request object with information to create a contact.
Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
Contains information about a flow.
Contains information about a flow module.
Contains summary information about a flow.
Contains summary information about a flow.
Information of returned contact.
Information about the agent who accepted the contact.
If this contact was queued, this contains information about the queue.
An object that can be used to specify Tag conditions inside the
SearchFilter
. This accepts anOR
ofAND
(List of List) input where:An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the
SearchFilter
.The
CreateCase
action definition.Contains credentials to use for federation.
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.
Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Contains the data for a real-time metric.
Contains information about a set of real-time metrics.
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.Information about a reference when the
referenceType
isDATE
. Otherwise, null.Contains information about a default vocabulary.
Contains information about the dimensions for a set of metrics.
Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
Information about a traffic distribution.
Metadata used to download the attached file.
Information about a reference when the
referenceType
isEMAIL
. Otherwise, null.An empty value.
The encryption configuration.
End associated tasks related to a case.
Information about the endpoint.
This API is in preview release for Amazon Connect and is subject to change.
Information about a contact evaluation.
Information about input answers for a contact evaluation.
Information about output answers for a contact evaluation.
Information about the evaluation form.
Information about an evaluation form used in a contact evaluation.
Information about the option range used for scoring in numeric questions.
Information about properties for a numeric question in an evaluation form.
Information about a question from an evaluation form.
Information about scoring strategy for an evaluation form.
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).
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.
Information about the automation configuration in single select questions.
Information about the options in single select questions.
Summary information about an evaluation form.
Summary information about an evaluation form.
Metadata information about a contact evaluation.
Information about notes for a contact evaluation.
Information about scores of a contact evaluation item (section or question).
Summary information about a contact evaluation.
The EventBridge action definition.
Request for which contact failed to be generated.
Object for case field values.
Object to store union of Field values.
Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
Contains the filter to apply when retrieving metrics.
Information about flow associations.
Contains information about a hierarchy group.
A leaf node condition which can be used to specify a hierarchy group condition.
Contains summary information about a hierarchy group.
Information about the hierarchy group.
Contains information about a hierarchy level.
Contains information about the hierarchy level to update.
Contains information about the levels of a hierarchy group.
Information about the levels in the hierarchy group.
Contains information about a hierarchy structure.
Contains information about the level hierarchy to update.
Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
Contains the data for a historical metric.
Contains information about the historical metrics retrieved.
Information about of the hours of operation.
Contains information about the hours of operation.
The search criteria to be used to return hours of operations.
Filters to be applied to search results.
Contains summary information about hours of operation for a contact center.
The start time or end time for an hours of operation.
The Amazon Connect instance.
Relevant details why the instance was not successfully created.
The storage configuration for the instance.
Information about the instance.
Contains summary information about the associated AppIntegrations.
Information about the interval period to use for returning results.
A field that is invisible to an agent.
Configuration information of a Kinesis Data Firehose delivery stream.
Configuration information of a Kinesis data stream.
Configuration information of a Kinesis video stream.
Configuration information of an Amazon Lex bot.
Configuration information of an Amazon Lex or Amazon Lex V2 bot.
Configuration information of an Amazon Lex V2 bot.
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
A meeting created using the Amazon Chime SDK.
The configuration settings of the features available to a meeting.
Contains the name, thresholds, and metric filters.
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
.The interval period with the start and end time for the metrics.
Contains information about the metric results.
Contains information about the metric.
Payload of chat properties to apply when starting a new contact.
The type of notification recipient.
Information about a reference when the
referenceType
isNUMBER
. Otherwise, null.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.
The outbound caller ID name, number, and outbound whisper flow.
The configuration for the allowed capabilities for participants present over the call.
The customer's details.
The details to add for the participant.
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.
The credentials used by the participant.
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.
Contains information about a phone number for a quick connect.
The status of the phone number.
Contains summary information about a phone number for a contact center.
Information about a predefined attribute.
The search criteria to be used to return predefined attributes.
Summary of a predefined attribute.
Information about a problem detail.
Information about a prompt.
The search criteria to be used to return prompts.
Filters to be applied to search results.
Contains information about the prompt.
Contains information about why a property is not valid.
Contains information about a queue.
If this contact was queued, this contains information about the queue.
Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
Contains information about a queue resource for which metrics are returned.
The search criteria to be used to return queues.
Filters to be applied to search results.
Contains summary information about a queue.
Contains information about a quick connect.
Contains configuration settings for a quick connect.
The search criteria to be used to return quick connects.
Filters to be applied to search results.
Contains summary information about a quick connect.
Indicates a field that is read-only to an agent.
Object that describes attached file.
Provides information about the category rule that was matched.
Begin and end offsets for a part of text.
Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
The section of the contact transcript segment that category rule was detected.
Segment containing list of attachments.
The matched category rules.
Segment type describing a contact event.
Segment type containing a list of detected issues.
The analyzed transcript segment.
Object describing redaction applied to the segment.
Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a
RealTimeContactAnalysisPointOfInterest
inCategory.MatchedDetails
would have character interval describing part of the text that matched category.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.
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.
Information about a required field.
The search criteria to be used to search tags.
Contains information about a routing profile.
Contains information about the queue and channel for which priority and delay can be set.
Contains summary information about a routing profile queue.
Contains the channel and queue identifier for a routing profile.
Information about the routing profile assigned to the user.
The search criteria to be used to return routing profiles.
Filters to be applied to search results.
Contains summary information about a routing profile.
Information about a rule.
Information about the action to be performed when a rule is triggered.
A list of
ActionTypes
associated with a rule.The name of the event source. This field is required if
TriggerEventSource
is one of the following values:OnZendeskTicketCreate
|OnZendeskTicketStatusUpdate
|OnSalesforceCaseCreate
|OnContactEvaluationSubmit
|OnMetricDataUpdate
.Information about the Amazon Simple Storage Service (Amazon S3) storage type.
A structure of time range that you want to search results.
A structure of search criteria to be used to return contacts.
A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
The search criteria based on user-defned contact attribute key and values to search on.
Configuration information of the security key.
Contains information about a security profile.
The search criteria to be used to return security profiles.
Information about the returned security profiles.
Contains information about a security profile.
Filters to be applied to search results.
A value for a segment attribute. This is structured as a map where the key is
valueString
and the value is a string.Information about the send notification action.
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).
The distribution of sign in traffic between the instance and its replica(s).
Information about the automation option based on a rule category for a single select question.
A structure that defineds the field name to sort by and a sort order.
A leaf node condition which can be used to specify a string condition.
Information about a reference when the
referenceType
isSTRING
. Otherwise, null.Information about the submit automated evaluation action.
Request for which contact was successfully created.
A leaf node condition which can be used to specify a tag condition, for example,
HAVE BPO = 123
.The search criteria to be used to return tags.
A tag set contains tag key and tag value.
Information about the task action.
Describes constraints that apply to the template fields.
Describes a default field and its corresponding value.
Describes default values for fields on a template.
Describes a single task template field.
The identifier of the task template field.
Contains summary information about the task template.
The distribution of traffic between the instance and its replicas.
Contains information about the threshold for service level metrics.
Contains information about the threshold for service level metrics.
Information about a traffic distribution group.
Information about traffic distribution groups.
Summary information about a traffic distribution group user.
A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
The
UpdateCase
action definition.Fields required when uploading an attached file.
The URL reference.
Contains the use case.
Contains information about a user account for an Amazon Connect instance.
Data for a user.
A filter for the user data.
Contains information about the identity of a user.
The user's first name and last name.
Contains information about the phone configuration settings for a user.
Information about proficiency of a user.
Information about proficiency to be disassociated from the user.
Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
Information about the user.
The search criteria to be used to return users.
Filters to be applied to search results.
Information about the returned users.
Contains summary information about a user.
A view resource object. Contains metadata and content necessary to render the view.
View content containing all content necessary to render a view except for runtime input data.
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.
A summary of a view's metadata.
A summary of a view version's metadata.
Contains information about a custom vocabulary.
Contains summary information about the custom vocabulary.
Contains information about the recording configuration settings.
Information about Amazon Connect Wisdom.
Enums§
- 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. Information on the identity that created the file.
- 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. - 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. - 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. - 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. Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
Information about an item from an evaluation form. The item must be either a section or a question.
Information about the automation configuration in numeric questions.
- 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. 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.
- 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. - 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. Information about the automation option of a single select question.
- 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. Reason why the request was invalid.
- 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. 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.- 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. - 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. - 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. - 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. Information about values of a predefined attribute.
- 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
An analyzed segment for a real-time analysis session.
- 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. Contains summary information about a reference.
ReferenceSummary
contains only one non null field between the URL and attachment based on the reference type.- 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. - 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. Configuration information for the chat participant role.
- 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. - 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. - 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. - 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. - 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. - 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. - 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.