ValidatePipeline - Amazon OpenSearch Service


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

Request Syntax

POST /2022-01-01/osis/validatePipeline HTTP/1.1 Content-type: application/json { "PipelineConfigurationBody": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 24000.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Errors": [ { "Message": "string" } ], "isValid": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


A list of errors if the configuration is invalid.

Type: Array of ValidationMessage objects


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

Type: Boolean


For information about the errors that are common to all actions, see Common Errors.


You don't have permissions to access the resource.

HTTP Status Code: 403


Exception is thrown when an operation has been disabled.

HTTP Status Code: 409


The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500


An exception for missing or invalid input fields.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: