A structure of search criteria to be used to return contacts.
Contents
- AgentHierarchyGroups
-
The agent hierarchy groups of the agent at the time of handling the contact.
Type: AgentHierarchyGroups object
Required: No
- AgentIds
-
The identifiers of agents who handled the contacts.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Channels
-
The list of channels associated with contacts.
Type: Array of strings
Valid Values:
VOICE | CHAT | TASK | EMAILRequired: No
- ContactAnalysis
-
Search criteria based on analysis outputs from Amazon Connect Contact Lens.
Type: ContactAnalysis object
Required: No
- InitiationMethods
-
The list of initiation methods associated with contacts.
Type: Array of strings
Valid Values:
INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API | DISCONNECT | MONITOR | EXTERNAL_OUTBOUND | WEBRTC_API | AGENT_REPLY | FLOWRequired: No
- QueueIds
-
The list of queue IDs associated with contacts.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- SearchableContactAttributes
-
The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
Important
To use
SearchableContactAttributesin a search request, theGetContactAttributesaction is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.Type: SearchableContactAttributes object
Required: No
- SearchableSegmentAttributes
-
The search criteria based on searchable segment attributes of a contact.
Type: SearchableSegmentAttributes object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
