SearchCriteria ¶

class SearchCriteria(TypedDict, closed=True):
    name: NotRequired["capo_connect.types.name_criteria.NameCriteria"]
    """<p>Name of the contact.</p>"""
    agent_ids: NotRequired[
        "capo_connect.types.agent_resource_id_list.AgentResourceIdList"
    ]
    """<p>The identifiers of agents who handled the contacts.</p>"""
    agent_hierarchy_groups: NotRequired[
        "capo_connect.types.agent_hierarchy_groups.AgentHierarchyGroups"
    ]
    """<p>The agent hierarchy groups of the agent at the time of handling the contact.</p>"""
    channels: NotRequired["capo_connect.types.channel_list.ChannelList"]
    """<p>The list of channels associated with contacts.</p>"""
    contact_analysis: NotRequired["capo_connect.types.contact_analysis.ContactAnalysis"]
    """<p>Search criteria based on analysis outputs from Connect Customer Contact Lens.</p>"""
    initiation_methods: NotRequired[
        "capo_connect.types.initiation_method_list.InitiationMethodList"
    ]
    """<p>The list of initiation methods associated with contacts.</p>"""
    queue_ids: NotRequired["capo_connect.types.queue_id_list.QueueIdList"]
    """<p>The list of queue IDs associated with contacts.</p>"""
    routing_criteria: NotRequired[
        "capo_connect.types.searchable_routing_criteria.SearchableRoutingCriteria"
    ]
    """<p>Routing criteria for the contact.</p>"""
    additional_time_range: NotRequired[
        "capo_connect.types.search_contacts_additional_time_range.SearchContactsAdditionalTimeRange"
    ]
    """<p>Additional TimeRange used to filter contacts.</p>"""
    searchable_contact_attributes: NotRequired[
        "capo_connect.types.searchable_contact_attributes.SearchableContactAttributes"
    ]
    """<p>The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html">Search by custom contact attributes</a> in the <i>Connect Customer Administrator Guide</i>.</p> <important> <p>To use <code>SearchableContactAttributes</code> in a search request, the <code>GetContactAttributes</code> action is required to perform an API request. For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions">https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions</a>Actions defined by Connect Customer.</p> </important>"""
    searchable_segment_attributes: NotRequired[
        "capo_connect.types.searchable_segment_attributes.SearchableSegmentAttributes"
    ]
    """<p>The search criteria based on searchable segment attributes of a contact.</p>"""
    active_regions: NotRequired[
        "capo_connect.types.active_region_list.ActiveRegionList"
    ]
    """<p>The list of active regions for contacts in ACGR instances.</p>"""
    contact_tags: NotRequired[
        "capo_connect.types.control_plane_tag_filter.ControlPlaneTagFilter"
    ]
    ai_agents: NotRequired["capo_connect.types.ai_agents_criteria.AiAgentsCriteria"]
    """<p>AI Agent search criteria definitions.</p>"""