:doc:`Connect <../../connect>` / Client / search_quick_connects

*********************
search_quick_connects
*********************



.. py:method:: Connect.Client.search_quick_connects(**kwargs)

  

  Searches quick connects in an Amazon Connect instance, with optional filtering.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchQuickConnects>`_  


  **Request Syntax**
  ::

    response = client.search_quick_connects(
        InstanceId='string',
        NextToken='string',
        MaxResults=123,
        SearchFilter={
            'TagFilter': {
                'OrConditions': [
                    [
                        {
                            'TagKey': 'string',
                            'TagValue': 'string'
                        },
                    ],
                ],
                'AndConditions': [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
                'TagCondition': {
                    'TagKey': 'string',
                    'TagValue': 'string'
                }
            }
        },
        SearchCriteria={
            'OrConditions': [
                {'... recursive ...'},
            ],
            'AndConditions': [
                {'... recursive ...'},
            ],
            'StringCondition': {
                'FieldName': 'string',
                'Value': 'string',
                'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
            }
        }
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per page.

    

  
  :type SearchFilter: dict
  :param SearchFilter: 

    Filters to be applied to search results.

    

  
    - **TagFilter** *(dict) --* 

      An object that can be used to specify Tag conditions inside the ``SearchFilter``. This accepts an ``OR`` of ``AND`` (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.
      

      

    
      - **OrConditions** *(list) --* 

        A list of conditions which would be applied together with an ``OR`` condition.

        

      
        - *(list) --* 

        
          - *(dict) --* 

            A leaf node condition which can be used to specify a tag condition, for example, ``HAVE BPO = 123``.

            

          
            - **TagKey** *(string) --* 

              The tag key in the tag condition.

              

            
            - **TagValue** *(string) --* 

              The tag value in the tag condition.

              

            
          
      
    
      - **AndConditions** *(list) --* 

        A list of conditions which would be applied together with an ``AND`` condition.

        

      
        - *(dict) --* 

          A leaf node condition which can be used to specify a tag condition, for example, ``HAVE BPO = 123``.

          

        
          - **TagKey** *(string) --* 

            The tag key in the tag condition.

            

          
          - **TagValue** *(string) --* 

            The tag value in the tag condition.

            

          
        
    
      - **TagCondition** *(dict) --* 

        A leaf node condition which can be used to specify a tag condition.

        

      
        - **TagKey** *(string) --* 

          The tag key in the tag condition.

          

        
        - **TagValue** *(string) --* 

          The tag value in the tag condition.

          

        
      
    
  
  :type SearchCriteria: dict
  :param SearchCriteria: 

    The search criteria to be used to return quick connects.

    

  
    - **OrConditions** *(list) --* 

      A list of conditions which would be applied together with an OR condition.

      

    
      - *(dict) --* 

        The search criteria to be used to return quick connects.

        

      
  
    - **AndConditions** *(list) --* 

      A list of conditions which would be applied together with an AND condition.

      

    
      - *(dict) --* 

        The search criteria to be used to return quick connects.

        

      
  
    - **StringCondition** *(dict) --* 

      A leaf node condition which can be used to specify a string condition.

       

      .. note::

        

        The currently supported values for ``FieldName`` are ``name``, ``description``, and ``resourceID``.

        

      

    
      - **FieldName** *(string) --* 

        The name of the field in the string condition.

        

      
      - **Value** *(string) --* 

        The value of the string.

        

      
      - **ComparisonType** *(string) --* 

        The type of comparison to be made when evaluating the string condition.

        

      
    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'QuickConnects': [
              {
                  'QuickConnectARN': 'string',
                  'QuickConnectId': 'string',
                  'Name': 'string',
                  'Description': 'string',
                  'QuickConnectConfig': {
                      'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW',
                      'UserConfig': {
                          'UserId': 'string',
                          'ContactFlowId': 'string'
                      },
                      'QueueConfig': {
                          'QueueId': 'string',
                          'ContactFlowId': 'string'
                      },
                      'PhoneConfig': {
                          'PhoneNumber': 'string'
                      },
                      'FlowConfig': {
                          'ContactFlowId': 'string'
                      }
                  },
                  'Tags': {
                      'string': 'string'
                  },
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string'
              },
          ],
          'NextToken': 'string',
          'ApproximateTotalCount': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **QuickConnects** *(list) --* 

        Information about the quick connects.

        
        

        - *(dict) --* 

          Contains information about a quick connect.

          
          

          - **QuickConnectARN** *(string) --* 

            The Amazon Resource Name (ARN) of the quick connect.

            
          

          - **QuickConnectId** *(string) --* 

            The identifier for the quick connect.

            
          

          - **Name** *(string) --* 

            The name of the quick connect.

            
          

          - **Description** *(string) --* 

            The description.

            
          

          - **QuickConnectConfig** *(dict) --* 

            Contains information about the quick connect.

            
            

            - **QuickConnectType** *(string) --* 

              The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

              
            

            - **UserConfig** *(dict) --* 

              The user configuration. This is required only if QuickConnectType is USER.

              
              

              - **UserId** *(string) --* 

                The identifier of the user.

                
              

              - **ContactFlowId** *(string) --* 

                The identifier of the flow.

                
          
            

            - **QueueConfig** *(dict) --* 

              The queue configuration. This is required only if QuickConnectType is QUEUE.

              
              

              - **QueueId** *(string) --* 

                The identifier for the queue.

                
              

              - **ContactFlowId** *(string) --* 

                The identifier of the flow.

                
          
            

            - **PhoneConfig** *(dict) --* 

              The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

              
              

              - **PhoneNumber** *(string) --* 

                The phone number in E.164 format.

                
          
            

            - **FlowConfig** *(dict) --* 

              Flow configuration for quick connect setup.

              
              

              - **ContactFlowId** *(string) --* 

                The contact flow ID for the quick connect configuration.

                
          
        
          

          - **Tags** *(dict) --* 

            The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when this resource was last modified.

            
          

          - **LastModifiedRegion** *(string) --* 

            The Amazon Web Services Region where this resource was last modified.

            
      
    
      

      - **NextToken** *(string) --* 

        If there are additional results, this is the token for the next set of results.

        
      

      - **ApproximateTotalCount** *(integer) --* 

        The total number of quick connects which matched your search query.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  