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

******************
describe_test_case
******************



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

  

  Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

  

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


  **Request Syntax**
  ::

    response = client.describe_test_case(
        InstanceId='string',
        TestCaseId='string',
        Status='PUBLISHED'|'SAVED'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance.

    

  
  :type TestCaseId: string
  :param TestCaseId: **[REQUIRED]** 

    The identifier of the test case.

    

  
  :type Status: string
  :param Status: 

    The status of the test case version to retrieve. If not specified, returns the published version if available, otherwise returns the saved version.

    

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

    
    ::

      {
          'TestCase': {
              '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'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TestCase** *(dict) --* 

        The test case object containing all test case information.

        
        

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

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

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

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

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

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

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

  