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

*****************
search_test_cases
*****************



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

  

  Searches for test cases in the specified Amazon Connect instance, with optional filtering.

  

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


  **Request Syntax**
  ::

    response = client.search_test_cases(
        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'
            },
            'StatusCondition': 'PUBLISHED'|'SAVED'
        }
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can find the instance ID 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 test cases.

    

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

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

      

    
      - *(dict) --* 

        The search criteria to be used to return test cases.

        

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

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

      

    
      - *(dict) --* 

        The search criteria to be used to return test cases.

        

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

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

      

    
      - **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.

        

      
    
    - **StatusCondition** *(string) --* 

      The status of the test case.

      

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

    
    ::

      {
          'TestCases': [
              {
                  'Arn': 'string',
                  'Id': 'string',
                  'Name': 'string',
                  'Content': 'string',
                  'EntryPoint': {
                      'Type': 'VOICE_CALL',
                      'VoiceCallEntryPointParameters': {
                          'SourcePhoneNumber': 'string',
                          'DestinationPhoneNumber': 'string',
                          'FlowId': 'string'
                      }
                  },
                  'InitializationData': 'string',
                  'Description': 'string',
                  'Status': 'PUBLISHED'|'SAVED',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string',
                  'Tags': {
                      'string': 'string'
                  },
                  'TestCaseSha256': 'string'
              },
          ],
          'NextToken': 'string',
          'ApproximateTotalCount': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TestCases** *(list) --* 

        Information about the test cases.

        
        

        - *(dict) --* 

          Contains information about a test case.

          
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the test case.

            
          

          - **Id** *(string) --* 

            The identifier of the test case.

            
          

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

            The name of the test case.

            
          

          - **Content** *(string) --* 

            The JSON string that represents the content of the test.

            
          

          - **EntryPoint** *(dict) --* 

            Defines the starting point for the test, including channel type and parameters.

            
            

            - **Type** *(string) --* 

              The type of entry point.

              
            

            - **VoiceCallEntryPointParameters** *(dict) --* 

              Parameters for voice call entry point.

              
              

              - **SourcePhoneNumber** *(string) --* 

                The source phone number for the test.

                
              

              - **DestinationPhoneNumber** *(string) --* 

                The destination phone number for the test.

                
              

              - **FlowId** *(string) --* 

                The flow identifier for the test.

                
          
        
          

          - **InitializationData** *(string) --* 

            Defines the test attributes for precise data representation.

            
          

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

            The description of the test case.

            
          

          - **Status** *(string) --* 

            Indicates the test status as either SAVED or PUBLISHED.

            
          

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

            The time at which the test case was last modified.

            
          

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

            The region in which the test case was last modified.

            
          

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

            The tags used to organize, track, or control access for this resource.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **TestCaseSha256** *(string) --* 

            The SHA256 hash of the test case content.

            
      
    
      

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

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

        
      

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

        The total number of test cases which matched your search query.

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

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

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

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

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

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

  