Struct SearchCriteria

#[non_exhaustive]
pub struct SearchCriteria {
    pub agent_ids: Option<Vec<String>>,
    pub agent_hierarchy_groups: Option<AgentHierarchyGroups>,
    pub channels: Option<Vec<Channel>>,
    pub contact_analysis: Option<ContactAnalysis>,
    pub initiation_methods: Option<Vec<ContactInitiationMethod>>,
    pub queue_ids: Option<Vec<String>>,
    pub searchable_contact_attributes: Option<SearchableContactAttributes>,
    pub searchable_segment_attributes: Option<SearchableSegmentAttributes>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

agent_ids: Option<Vec<String>>

The identifiers of agents who handled the contacts.

agent_hierarchy_groups: Option<AgentHierarchyGroups>

The agent hierarchy groups of the agent at the time of handling the contact.

channels: Option<Vec<Channel>>

The list of channels associated with contacts.

contact_analysis: Option<ContactAnalysis>

Search criteria based on analysis outputs from Amazon Connect Contact Lens.

initiation_methods: Option<Vec<ContactInitiationMethod>>

The list of initiation methods associated with contacts.

queue_ids: Option<Vec<String>>

The list of queue IDs associated with contacts.

searchable_contact_attributes: Option<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.

To use SearchableContactAttributes in a search request, the GetContactAttributes action 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.

searchable_segment_attributes: Option<SearchableSegmentAttributes>

The search criteria based on searchable segment attributes of a contact.

Implementations

impl SearchCriteria

pub fn agent_ids(&self) -> &[String]

The identifiers of agents who handled the contacts.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .agent_ids.is_none().

pub fn agent_hierarchy_groups(&self) -> Option<&AgentHierarchyGroups>

The agent hierarchy groups of the agent at the time of handling the contact.

pub fn channels(&self) -> &[Channel]

The list of channels associated with contacts.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .channels.is_none().

pub fn contact_analysis(&self) -> Option<&ContactAnalysis>

Search criteria based on analysis outputs from Amazon Connect Contact Lens.

pub fn initiation_methods(&self) -> &[ContactInitiationMethod]

The list of initiation methods associated with contacts.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .initiation_methods.is_none().

pub fn queue_ids(&self) -> &[String]

The list of queue IDs associated with contacts.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .queue_ids.is_none().

pub fn searchable_contact_attributes( &self, ) -> Option<&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.

To use SearchableContactAttributes in a search request, the GetContactAttributes action 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.

pub fn searchable_segment_attributes( &self, ) -> Option<&SearchableSegmentAttributes>

The search criteria based on searchable segment attributes of a contact.

impl SearchCriteria

pub fn builder() -> SearchCriteriaBuilder

Creates a new builder-style object to manufacture SearchCriteria.

Trait Implementations

impl Clone for SearchCriteria

fn clone(&self) -> SearchCriteria

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchCriteria

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SearchCriteria

fn eq(&self, other: &SearchCriteria) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SearchCriteria