:doc:`OpenSearchIngestion <../../osis>` / Client / validate_pipeline

*****************
validate_pipeline
*****************



.. py:method:: OpenSearchIngestion.Client.validate_pipeline(**kwargs)

  

  Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see `Creating Amazon OpenSearch Ingestion pipelines <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ValidatePipeline>`_  


  **Request Syntax**
  ::

    response = client.validate_pipeline(
        PipelineConfigurationBody='string'
    )
    
  :type PipelineConfigurationBody: string
  :param PipelineConfigurationBody: **[REQUIRED]** 

    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with ``\n``.

    

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

    
    ::

      {
          'isValid': True|False,
          'Errors': [
              {
                  'Message': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **isValid** *(boolean) --* 

        A boolean indicating whether or not the pipeline configuration is valid.

        
      

      - **Errors** *(list) --* 

        A list of errors if the configuration is invalid.

        
        

        - *(dict) --* 

          A validation message associated with a ``ValidatePipeline`` request in OpenSearch Ingestion.

          
          

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

            The validation message.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.DisabledOperationException`

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

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.InternalException`

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

  