Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142211885.0 KB

Creates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html">Creating Amazon OpenSearch Ingestion pipelines</a>.

post/2022-01-01/osis/createPipeline

Request body

PipelineNamestring required

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

MinUnitsinteger required

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

MaxUnitsinteger required

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

PipelineConfigurationBodystring 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 <code>\n</code>.

PipelineRoleArnstring

The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.

Response

Success

All 22 operations