:doc:`CloudWatchObservabilityAdminService <../../observabilityadmin>` / Client / test_telemetry_pipeline

***********************
test_telemetry_pipeline
***********************



.. py:method:: CloudWatchObservabilityAdminService.Client.test_telemetry_pipeline(**kwargs)

  

  Tests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration works as expected.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/TestTelemetryPipeline>`_  


  **Request Syntax**
  ::

    response = client.test_telemetry_pipeline(
        Records=[
            {
                'Data': 'string',
                'Type': 'STRING'|'JSON'
            },
        ],
        Configuration={
            'Body': 'string'
        }
    )
    
  :type Records: list
  :param Records: **[REQUIRED]** 

    The sample records to process through the pipeline configuration for testing purposes.

    

  
    - *(dict) --* 

      Represents a test record structure used for pipeline testing operations to validate data processing.

      

    
      - **Data** *(string) --* 

        The data content of the test record used for pipeline validation.

        

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

        The type of the test record, indicating the format or category of the data.

        

      
    

  :type Configuration: dict
  :param Configuration: **[REQUIRED]** 

    The pipeline configuration to test with the provided sample records.

    

  
    - **Body** *(string) --* **[REQUIRED]** 

      The pipeline configuration body that defines the data processing rules and transformations.

      

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

    
    ::

      {
          'Results': [
              {
                  'Record': {
                      'Data': 'string',
                      'Type': 'STRING'|'JSON'
                  },
                  'Error': {
                      'Message': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Results** *(list) --* 

        The results of processing the test records through the pipeline configuration, including any outputs or errors.

        
        

        - *(dict) --* 

          Contains the output from pipeline test operations, including processed records and any errors encountered.

          
          

          - **Record** *(dict) --* 

            The processed record output from the pipeline test operation.

            
            

            - **Data** *(string) --* 

              The data content of the test record used for pipeline validation.

              
            

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

              The type of the test record, indicating the format or category of the data.

              
        
          

          - **Error** *(dict) --* 

            Any error that occurred during the pipeline test operation for this record.

            
            

            - **Message** *(string) --* 

              The detailed error message describing what went wrong during the pipeline test operation for this record.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.InternalServerException`

  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.ValidationException`

  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.TooManyRequestsException`

  