Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Action
Summary Information about an action.
- Additional
Email Recipients List of additional email addresses for an email contact.
- Agent
Config The distribution of agents between the instance and its replica(s).
- Agent
Contact Reference Information about the contact associated to the user.
- Agent
Hierarchy Group Information about an agent hierarchy group.
- Agent
Hierarchy Groups 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.
- Agent
Info Information about the agent who accepted the contact.
- Agent
Quality Metrics Information about the quality of the Agent's media connection
- Agent
Status Contains information about an agent status.
- Agent
Status Reference Information about the agent's status.
- Agent
Status Search Criteria The search criteria to be used to return agent statuses.
- Agent
Status Search Filter Filters to be applied to search results.
- Agent
Status Summary Summary information for an agent status.
- Agents
Criteria 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.
- Allowed
Capabilities Information about the capabilities enabled for participants of the contact.
- Analytics
Data Association Result 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
.- Analytics
Data Sets Result Information about datasets that are available to associate with:
DataSetId
,DataSetName
.- Answer
Machine Detection Config 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.
- Assign
Contact Category Action Definition 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 asContactCategory
.- Assign
SlaAction Definition The AssignSla action definition.
- Associated
Contact Summary Contact summary of a contact in contact tree associated with unique identifier.
- Attached
File Information about the attached file.
- Attached
File Error Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
- Attachment
Reference Information about a reference when the
referenceType
isATTACHMENT
. Otherwise, null.- Attendee
The attendee information, including attendee ID and join token.
- Attribute
A toggle for an individual feature at the instance level.
- Attribute
AndCondition A list of conditions which would be applied together with an
AND
condition.- Attribute
Condition An object to specify the predefined attribute condition.
- Audio
Features Has audio-specific configurations as the operating parameter for Echo Reduction.
- Audio
Quality Metrics Info Contains information for score and potential quality issues for Audio
- Authentication
Profile 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.
- Authentication
Profile Summary 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.
- Available
Number Summary Information about available phone numbers.
- Campaign
Information associated with a campaign.
- Case
SlaConfiguration The SLA configuration for Case SlaAssignmentType.
- Chat
Contact Metrics Information about the overall participant interactions at the contact level.
- Chat
Event 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
-
- Chat
Message A chat message.
- Chat
Metrics Information about how agent, bot, and customer interact in a chat contact.
- Chat
Participant Role Config Configuration information for the chat participant role.
- Chat
Streaming Configuration The streaming configuration, such as the Amazon SNS streaming endpoint.
- Claimed
Phone Number Summary Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
- Common
Attribute AndCondition 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.
- Connection
Data Information required to join the call.
- Contact
Contains information about a contact.
- Contact
Analysis A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
- Contact
Configuration The contact configuration for push notification registration.
- Contact
Data Request Request object with information to create a contact.
- Contact
Details 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.
- Contact
Evaluation Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
- Contact
Filter Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
- Contact
Flow Contains information about a flow.
- Contact
Flow Module Contains information about a flow module.
- Contact
Flow Module Search Criteria The search criteria to be used to return flow modules.
- Contact
Flow Module Search Filter The search criteria to be used to return flow modules.
- Contact
Flow Module Summary Contains summary information about a flow.
- Contact
Flow Search Criteria The search criteria to be used to return flows.
- Contact
Flow Search Filter Filters to be applied to search results.
- Contact
Flow Summary Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
- Contact
Flow Version Summary A summary of a flow version's metadata.
- Contact
Search Summary Information of returned contact.
- Contact
Search Summary Agent Info Information about the agent who accepted the contact.
- Contact
Search Summary Queue Info If this contact was queued, this contains information about the queue.
- Contact
Search Summary Segment Attribute Value 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.
- Control
Plane Attribute Filter An object that can be used to specify Tag conditions inside the
SearchFilter
. This accepts anOR
orAND
(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.
-
- Control
Plane TagFilter An object that can be used to specify Tag conditions inside the
SearchFilter
. This accepts anOR
ofAND
(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.
-
- Control
Plane User Attribute Filter An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the
SearchFilter
.This accepts an
OR
ofAND
(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.
-
- Create
Case Action Definition The
CreateCase
action definition.- Credentials
Contains credentials to use for federation.
- Cross
Channel Behavior 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.
- Current
Metric Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
- Current
Metric Data Contains the data for a real-time metric.
- Current
Metric Result Contains information about a set of real-time metrics.
- Current
Metric Sort Criteria 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.
- Customer
Quality Metrics Information about the quality of the Customer's media connection
- Customer
Voice Activity Information about customer’s voice activity.
- Date
Condition An object to specify the hours of operation override date condition.
- Date
Reference Information about a reference when the
referenceType
isDATE
. Otherwise, null.- Default
Vocabulary Contains information about a default vocabulary.
- Device
Info Information regarding the device.
- Dimensions
Contains information about the dimensions for a set of metrics.
- Disconnect
Details Information about the call disconnect experience.
- Disconnect
Reason Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.
- Distribution
Information about a traffic distribution.
- Download
UrlMetadata Metadata used to download the attached file.
- Effective
Hours OfOperations Information about the hours of operations with the effective override applied.
- Email
Address Info Contains information about a source or destination email address.
- Email
Address Metadata Contains information about an email address for a contact center.
- Email
Address Search Criteria The search criteria to be used to return email addresses.
- Email
Address Search Filter Filters to be applied to search results.
- Email
Attachment Information about the email attachment files.
- Email
Message Reference Information about the reference when the referenceType is
EMAIL_MESSAGE
. Otherwise, null.- Email
Recipient Information about the email recipient
- Email
Reference Information about a reference when the
referenceType
isEMAIL
. Otherwise, null.- Empty
Field Value An empty value.
- Encryption
Config The encryption configuration.
- EndAssociated
Tasks Action Definition End associated tasks related to a case.
- Endpoint
Information about the endpoint.
- Endpoint
Info Information about the endpoint.
- Error
Result 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.
- Evaluation
Answer Input Information about input answers for a contact evaluation.
- Evaluation
Answer Output Information about output answers for a contact evaluation.
- Evaluation
Form Information about the evaluation form.
- Evaluation
Form Content Information about an evaluation form used in a contact evaluation.
- Evaluation
Form Numeric Question Option Information about the option range used for scoring in numeric questions.
- Evaluation
Form Numeric Question Properties Information about properties for a numeric question in an evaluation form.
- Evaluation
Form Question Information about a question from an evaluation form.
- Evaluation
Form Scoring Strategy Information about scoring strategy for an evaluation form.
- Evaluation
Form Section 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).
- Evaluation
Form Single Select Question Automation 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.
- Evaluation
Form Single Select Question Option Information about the automation configuration in single select questions.
- Evaluation
Form Single Select Question Properties Information about the options in single select questions.
- Evaluation
Form Summary Summary information about an evaluation form.
- Evaluation
Form Version Summary Summary information about an evaluation form.
- Evaluation
Metadata Metadata information about a contact evaluation.
- Evaluation
Note Information about notes for a contact evaluation.
- Evaluation
Score Information about scores of a contact evaluation item (section or question).
- Evaluation
Summary Summary information about a contact evaluation.
- Event
Bridge Action Definition 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.
- Failed
Request Request for which contact failed to be generated.
- Field
Value Object for case field values.
- Field
Value Union Object to store union of Field values.
- Filter
V2 Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
- Filters
Contains the filter to apply when retrieving metrics.
- Flow
Association Summary Information about flow associations.
- Hierarchy
Group Contains information about a hierarchy group.
- Hierarchy
Group Condition A leaf node condition which can be used to specify a hierarchy group condition.
- Hierarchy
Group Summary Contains summary information about a hierarchy group.
- Hierarchy
Group Summary Reference Information about the hierarchy group.
- Hierarchy
Groups Information about the agent hierarchy. Hierarchies can be configured with up to five levels.
- Hierarchy
Level Contains information about a hierarchy level.
- Hierarchy
Level Update Contains information about the hierarchy level to update.
- Hierarchy
Path Contains information about the levels of a hierarchy group.
- Hierarchy
Path Reference Information about the levels in the hierarchy group.
- Hierarchy
Structure Contains information about a hierarchy structure.
- Hierarchy
Structure Update Contains information about the level hierarchy to update.
- Historical
Metric Contains information about a historical metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
- Historical
Metric Data Contains the data for a historical metric.
- Historical
Metric Result Contains information about the historical metrics retrieved.
- Hours
OfOperation Information about of the hours of operation.
- Hours
OfOperation Config Contains information about the hours of operation.
- Hours
OfOperation Override Information about the hours of operations override.
- Hours
OfOperation Override Config Information about the hours of operation override config: day, start time, and end time.
- Hours
OfOperation Override Search Criteria The search criteria to be used to return hours of operations overrides.
- Hours
OfOperation Search Criteria The search criteria to be used to return hours of operations.
- Hours
OfOperation Search Filter Filters to be applied to search results.
- Hours
OfOperation Summary Contains summary information about hours of operation for a contact center.
- Hours
OfOperation Time Slice The start time or end time for an hours of operation.
- Inbound
Additional Recipients 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
, andCcAddresses
. This total must include one requiredDestinationEmailAddress
. You can then specify up to 49 addresses allocated acrossToAddresses
andCcAddresses
as needed.- Inbound
Email Content Information about email body content.
- Inbound
RawMessage Information about the raw email body content.
- Instance
The Amazon Connect instance.
- Instance
Status Reason Relevant details why the instance was not successfully created.
- Instance
Storage Config The storage configuration for the instance.
- Instance
Summary Information about the instance.
- Integration
Association Summary Contains summary information about the associated AppIntegrations.
- Interval
Details Information about the interval period to use for returning results.
- Invisible
Field Info A field that is invisible to an agent.
- Kinesis
Firehose Config Configuration information of a Kinesis Data Firehose delivery stream.
- Kinesis
Stream Config Configuration information of a Kinesis data stream.
- Kinesis
Video Stream Config Configuration information of a Kinesis video stream.
- LexBot
Configuration information of an Amazon Lex bot.
- LexBot
Config Configuration information of an Amazon Lex or Amazon Lex V2 bot.
- LexV2
Bot Configuration information of an Amazon Lex V2 bot.
- List
Condition A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
- List
Phone Numbers Summary Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
- Match
Criteria An object to define AgentsCriteria.
- Media
Concurrency Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
- Media
Placement 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.
- Meeting
Features Configuration The configuration settings of the features available to a meeting.
- Metric
Data V2 Contains the name, thresholds, and metric filters.
- Metric
Filter V2 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
.- Metric
Interval The interval period with the start and end time for the metrics.
- Metric
Result V2 Contains information about the metric results.
- Metric
V2 Contains information about the metric.
- NewSession
Details Payload of chat properties to apply when starting a new contact.
- Notification
Recipient Type The type of notification recipient.
- Number
Condition A leaf node condition which can be used to specify a numeric condition.
The currently supported value for
FieldName
islimit
.- Number
Reference Information about a reference when the
referenceType
isNUMBER
. Otherwise, null.- Numeric
Question Property Value Automation 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.
-
- Operational
Hour Information about the hours of operations with the effective override applied.
- Outbound
Additional Recipients Information about the additional recipients of outbound email.
- Outbound
Caller Config The outbound caller ID name, number, and outbound whisper flow.
- Outbound
Email Config The outbound email address ID.
- Outbound
Email Content Information about email body content.
- Outbound
RawMessage Information about the raw email body content.
- Override
Time Slice The start time or end time for an hours of operation override.
- Participant
Capabilities 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.
- Participant
Details The customer's details.
- Participant
Details ToAdd The details to add for the participant.
- Participant
Metrics Information about a participant's interactions in a contact.
- Participant
Timer Configuration 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.
- Participant
Token Credentials The credentials used by the participant.
- Persistent
Chat 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.
- Phone
Number Quick Connect Config Contains information about a phone number for a quick connect.
- Phone
Number Status 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 theTargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received aFAILED
status from aClaimPhoneNumber
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.
-
- Phone
Number Summary Contains summary information about a phone number for a contact center.
- Predefined
Attribute Information about a predefined attribute.
- Predefined
Attribute Search Criteria The search criteria to be used to return predefined attributes.
- Predefined
Attribute Summary Summary of a predefined attribute.
- Problem
Detail Information about a problem detail.
- Prompt
Information about a prompt.
- Prompt
Search Criteria The search criteria to be used to return prompts.
- Prompt
Search Filter Filters to be applied to search results.
- Prompt
Summary Contains information about the prompt.
- Property
Validation Exception Property Contains information about why a property is not valid.
- Quality
Metrics Information about the quality of the participant's media connection.
- Queue
Contains information about a queue.
- Queue
Info If this contact was queued, this contains information about the queue.
- Queue
Info Input Information about a queue.
- Queue
Quick Connect Config Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
- Queue
Reference Contains information about a queue resource for which metrics are returned.
- Queue
Search Criteria The search criteria to be used to return queues.
The
name
anddescription
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.- Queue
Search Filter Filters to be applied to search results.
- Queue
Summary Contains summary information about a queue.
- Quick
Connect Contains information about a quick connect.
- Quick
Connect Config Contains configuration settings for a quick connect.
- Quick
Connect Search Criteria The search criteria to be used to return quick connects.
- Quick
Connect Search Filter Filters to be applied to search results.
- Quick
Connect Summary Contains summary information about a quick connect.
- Range
An Object to define the minimum and maximum proficiency levels.
- Read
Only Field Info Indicates a field that is read-only to an agent.
- Real
Time Contact Analysis Attachment Object that describes attached file.
- Real
Time Contact Analysis Category Details Provides information about the category rule that was matched.
- Real
Time Contact Analysis Character Interval Begin and end offsets for a part of text.
- Real
Time Contact Analysis Issue Detected Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation.
- Real
Time Contact Analysis Point OfInterest The section of the contact transcript segment that category rule was detected.
- Real
Time Contact Analysis Segment Attachments Segment containing list of attachments.
- Real
Time Contact Analysis Segment Categories The matched category rules.
- Real
Time Contact Analysis Segment Event Segment type describing a contact event.
- Real
Time Contact Analysis Segment Issues Segment type containing a list of detected issues.
- Real
Time Contact Analysis Segment Post Contact Summary Information about the post-contact summary for a real-time contact segment.
- Real
Time Contact Analysis Segment Transcript The analyzed transcript segment.
- Real
Time Contact Analysis Transcript Item Redaction Object describing redaction applied to the segment.
- Real
Time Contact Analysis Transcript Item With Character Offsets 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.- Real
Time Contact Analysis Transcript Item With Content 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.
- Recording
Info 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.
- Replication
Configuration 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.
- Replication
Status Summary 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.
- Required
Field Info Information about a required field.
- Resource
Tags Search Criteria The search criteria to be used to search tags.
- Routing
Criteria Latest routing criteria on the contact.
- Routing
Criteria Input An object to define the RoutingCriteria.
- Routing
Criteria Input Step Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.
- Routing
Criteria Input Step Expiry Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never expire.
- Routing
Profile Contains information about a routing profile.
- Routing
Profile Queue Config Contains information about the queue and channel for which priority and delay can be set.
- Routing
Profile Queue Config Summary Contains summary information about a routing profile queue.
- Routing
Profile Queue Reference Contains the channel and queue identifier for a routing profile.
- Routing
Profile Reference Information about the routing profile assigned to the user.
- Routing
Profile Search Criteria The search criteria to be used to return routing profiles.
The
name
anddescription
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.- Routing
Profile Search Filter Filters to be applied to search results.
- Routing
Profile Summary Contains summary information about a routing profile.
- Rule
Information about a rule.
- Rule
Action Information about the action to be performed when a rule is triggered.
- Rule
Summary A list of
ActionTypes
associated with a rule.- Rule
Trigger Event Source 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.
- Search
Contacts Time Range A structure of time range that you want to search results.
- Search
Criteria A structure of search criteria to be used to return contacts.
- Searchable
Contact Attributes A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
- Searchable
Contact Attributes Criteria The search criteria based on user-defined contact attribute key and values to search on.
- Searchable
Segment Attributes The search criteria based on searchable segment attributes of a contact
- Searchable
Segment Attributes Criteria The search criteria based on searchable segment attribute key and values to search on.
- Security
Key Configuration information of the security key.
- Security
Profile Contains information about a security profile.
- Security
Profile Search Criteria 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.- Security
Profile Search Summary Information about the returned security profiles.
- Security
Profile Summary Contains information about a security profile.
- Security
Profiles Search Filter Filters to be applied to search results.
- Segment
Attribute Value A value for a segment attribute. This is structured as a map where the key is
valueString
and the value is a string.- Send
Notification Action Definition Information about the send notification action.
- Sign
InConfig 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).
- Sign
InDistribution The distribution of sign in traffic between the instance and its replica(s).
- Single
Select Question Rule Category Automation 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.
- Source
Campaign Information about the campaign.
- State
Transition Information about the state transition of a supervisor.
- Step
Step signifies the criteria to be used for routing to an agent
- String
Condition A leaf node condition which can be used to specify a string condition.
- String
Reference Information about a reference when the
referenceType
isSTRING
. Otherwise, null.- Submit
Auto Evaluation Action Definition Information about the submit automated evaluation action.
- Successful
Request 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
.- TagSearch
Condition The search criteria to be used to return tags.
- TagSet
A tag set contains tag key and tag value.
- Task
Action Definition Information about the task action.
- Task
Template Constraints Describes constraints that apply to the template fields.
- Task
Template Default Field Value Describes a default field and its corresponding value.
- Task
Template Defaults Describes default values for fields on a template.
- Task
Template Field Describes a single task template field.
- Task
Template Field Identifier The identifier of the task template field.
- Task
Template Metadata Contains summary information about the task template.
- Telephony
Config The distribution of traffic between the instance and its replicas.
- Template
Attributes Information about the template attributes.
- Templated
Message Config Information about template message configuration.
- Threshold
Contains information about the threshold for service level metrics.
- Threshold
V2 Contains information about the threshold for service level metrics.
- Traffic
Distribution Group Information about a traffic distribution group.
- Traffic
Distribution Group Summary Information about traffic distribution groups.
- Traffic
Distribution Group User Summary 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.
- Transcript
Criteria A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
- Update
Case Action Definition The
UpdateCase
action definition.- Upload
UrlMetadata 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.
- User
Data Data for a user.
- User
Data Filters A filter for the user data.
- User
Hierarchy Group Search Criteria The search criteria to be used to return userHierarchyGroup.
- User
Hierarchy Group Search Filter Filters to be applied to search results.
- User
Identity Info Contains information about the identity of a user.
For Amazon Connect instances that are created with the
EXISTING_DIRECTORY
identity management type,FirstName
,LastName
, andEmail
cannot be updated from within Amazon Connect because they are managed by the directory.The
FirstName
andLastName
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 forFirstName
, and 1-256 forLastName
.- User
Identity Info Lite The user's first name and last name.
- User
Info The user details for the contact.
- User
Phone Config Contains information about the phone configuration settings for a user.
- User
Proficiency Information about proficiency of a user.
- User
Proficiency Disassociate Information about proficiency to be disassociated from the user.
- User
Quick Connect Config Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.
- User
Reference Information about the user.
- User
Search Criteria The search criteria to be used to return users.
The
name
anddescription
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.- User
Search Filter Filters to be applied to search results.
- User
Search Summary Information about the returned users.
- User
Summary Contains summary information about a user.
- View
A view resource object. Contains metadata and content necessary to render the view.
- View
Content View content containing all content necessary to render a view except for runtime input data.
- View
Input Content 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.
- View
Summary A summary of a view's metadata.
- View
Version Summary A summary of a view version's metadata.
- Vocabulary
Contains information about a custom vocabulary.
- Vocabulary
Summary Contains summary information about the custom vocabulary.
- Voice
Recording Configuration Contains information about the recording configuration settings.
- Wisdom
Info Information about Amazon Connect Wisdom.
Enums§
- Action
Type - 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. - Agent
Availability Timer - 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. - Agent
Status State - 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. - Agent
Status Type - 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. - Answering
Machine Detection Status - 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. - Artifact
Status - 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. - Attached
File Invalid Request Exception Reason - 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. - Attached
File Service Quota Exceeded Exception Reason - 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. - Behavior
Type - 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. - Chat
Event Type - 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. - Contact
Flow Module State - 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. - Contact
Flow Module Status - 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. - Contact
Flow State - 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. - Contact
Flow Status - 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. - Contact
Flow Type - 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. - Contact
Initiation Method - 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. - Contact
Recording Type - 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. - Contact
State - 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. - Created
ByInfo Information on the identity that created the file.
- Current
Metric Name - 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. - Date
Comparison Type - 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. - Device
Type - 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. - Directory
Type - 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. - Email
Header Type - 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. - Encryption
Type - 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. - Endpoint
Type - 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. - Evaluation
Answer Data Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
- Evaluation
Form Item Information about an item from an evaluation form. The item must be either a section or a question.
- Evaluation
Form Numeric Question Automation Information about the automation configuration in numeric questions.
- Evaluation
Form Question Type - 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. - Evaluation
Form Question Type Properties 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.
- Evaluation
Form Scoring Mode - 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. - Evaluation
Form Scoring Status - 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. - Evaluation
Form Single Select Question Automation Option Information about the automation option of a single select question.
- Evaluation
Form Single Select Question Display Mode - 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. - Evaluation
Form Version Status - 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. - Evaluation
Status - 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. - Event
Source Name - 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. - Failure
Reason Code - 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. - File
Status Type - 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. - File
UseCase Type - 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. - Flow
Association Resource Type - 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. - Hierarchy
Group Match Type - 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. - Historical
Metric Name - 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. - Hours
OfOperation Days - 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. - Inbound
Message Source Type - 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. - Initiate
As - 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. - Instance
Attribute Type - 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. - Instance
Replication Status - 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. - Instance
Status - 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. - Instance
Storage Resource Type - 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. - Integration
Type - 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. - Interval
Period - 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. - Invalid
Request Exception Reason Reason why the request was invalid.
- IvrRecording
Track - 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. - List
Flow Association Resource Type - 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. - Media
Stream Type - 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. - Meeting
Feature Status - 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. - Monitor
Capability - 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. - Notification
Content Type - 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. - Notification
Delivery Type - 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. - Number
Comparison Type - 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. - Numeric
Question Property Automation Label - 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. - Outbound
Message Source Type - 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. - Override
Days - 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. - Participant
Role - 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. - Participant
State - 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. - Participant
Timer Action - 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. - Participant
Timer Type - 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. - Participant
Timer Value 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.
- Participant
Type - 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. - Phone
Number Country Code - 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. - Phone
Number Type - 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. - Phone
Number Workflow Status - 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. - Phone
Type - 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. - Predefined
Attribute Values Information about values of a predefined attribute.
- Property
Validation Exception Reason - 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. - Queue
Status - 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. - Queue
Type - 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. - Quick
Connect Type - 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. - Real
Time Contact Analysis Output Type - 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. - Real
Time Contact Analysis Post Contact Summary Failure Code - 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. - Real
Time Contact Analysis Post Contact Summary Status - 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. - Real
Time Contact Analysis Segment Type - 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. - Real
Time Contact Analysis Sentiment Label - 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. - Real
Time Contact Analysis Status - 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. - Real
Time Contact Analysis Supported Channel - 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. - Real
Time Contact Analysis Time Data Object describing time with which the segment is associated. It can have different representations of time. Currently supported: absoluteTime
- Realtime
Contact Analysis Segment An analyzed segment for a real-time analysis session.
- Recording
Status - 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. - Reference
Status - 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. - Reference
Summary Contains summary information about a reference.
ReferenceSummary
contains only one non null field between the URL and attachment based on the reference type.- 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. - Rehydration
Type - 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. - Resource
Type - 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. - Routing
Criteria Step Status - 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. - Rule
Publish Status - 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. - Screen
Share Capability - 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. - Search
Contacts Match Type - 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. - Search
Contacts Time Range Type - 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. - Searchable
Queue Type - 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. - Service
Quota Exceeded Exception Reason The reason for the exception.
- Single
Select Question Rule Category Automation Condition - 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. - SlaAssignment
Type - 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. - Sort
Order - 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. - Sortable
Field Name - 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. - Source
Type - 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. - Storage
Type - 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. - String
Comparison Type - 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. - Target
List Type - 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. - Task
Template Field Type - 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. - Task
Template Status - 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. - Timer
Eligible Participant Roles - 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. - Traffic
Distribution Group Status - 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. - Traffic
Type - 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. - Update
Participant Role Config Channel Info Configuration information for the chat participant role.
- UseCase
Type - 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. - Video
Capability - 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. - View
Status - 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. - View
Type - 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. - Vocabulary
Language Code - 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. - Vocabulary
State - 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. - Voice
Recording Track - 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.