OpenSearchIngestion / Client / validate_pipeline

validate_pipeline#

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.

Request Syntax

response = client.validate_pipeline(
    PipelineConfigurationBody='string'
)

Parameters:

PipelineConfigurationBody (string) –

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

Return type:

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

OpenSearchIngestion.Client.exceptions.AccessDeniedException
OpenSearchIngestion.Client.exceptions.InternalException
OpenSearchIngestion.Client.exceptions.ValidationException