Validate Pipeline

opensearchingestion_validate_pipeline

R Documentation

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation¶

Description¶

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

Usage¶

opensearchingestion_validate_pipeline(PipelineConfigurationBody)

Arguments¶

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

Value¶

A list with the following syntax:

list(
  isValid = TRUE|FALSE,
  Errors = list(
    list(
      Message = "string"
    )
  )
)

Request syntax¶

svc$validate_pipeline(
  PipelineConfigurationBody = "string"
)