Amazon OpenSearch Service API · Schema
UpdatePipelineRequest
AnalyticsAmazon Web ServicesElasticsearchSearch
Properties
| Name | Type | Description |
|---|---|---|
| PipelineName | string | The name of the pipeline to update. |
| MinUnits | integer | The minimum pipeline capacity, in Ingestion Compute Units (ICUs). |
| MaxUnits | integer | The maximum pipeline capacity, in Ingestion Compute Units (ICUs) |
| PipelineConfigurationBody | string | 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 escape |
| LogPublishingOptions | object | |
| BufferOptions | object | |
| EncryptionAtRestOptions | object | |
| PipelineRoleArn | string | The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-pipeline-request-schema.json",
"title": "UpdatePipelineRequest",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/amazon-opensearch-osis-api-openapi.yml#/components/schemas/UpdatePipelineRequest",
"type": "object",
"properties": {
"PipelineName": {
"type": "string",
"description": "The name of the pipeline to update."
},
"MinUnits": {
"type": "integer",
"description": "The minimum pipeline capacity, in Ingestion Compute Units (ICUs)."
},
"MaxUnits": {
"type": "integer",
"description": "The maximum pipeline capacity, in Ingestion Compute Units (ICUs)"
},
"PipelineConfigurationBody": {
"type": "string",
"description": "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."
},
"LogPublishingOptions": {
"$ref": "#/$defs/LogPublishingOptions"
},
"BufferOptions": {
"$ref": "#/$defs/BufferOptions"
},
"EncryptionAtRestOptions": {
"$ref": "#/$defs/OsisEncryptionAtRestOptions"
},
"PipelineRoleArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources."
}
},
"required": [
"PipelineName"
],
"$defs": {
"BufferOptions": {
"type": "object",
"properties": {
"PersistentBufferEnabled": {
"type": "boolean",
"description": "Whether persistent buffering should be enabled."
}
},
"required": [
"PersistentBufferEnabled"
]
},
"CloudWatchLogDestination": {
"type": "object",
"properties": {
"LogGroup": {
"type": "string",
"description": "The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines."
}
},
"required": [
"LogGroup"
]
},
"LogPublishingOptions": {
"type": "object",
"properties": {
"IsLoggingEnabled": {
"type": "boolean",
"description": "Whether logs should be published."
},
"CloudWatchLogDestination": {
"$ref": "#/$defs/CloudWatchLogDestination"
}
}
},
"OsisEncryptionAtRestOptions": {
"type": "object",
"properties": {
"KmsKeyArn": {
"type": "string",
"description": "The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key."
}
},
"required": [
"KmsKeyArn"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-update-pipeline-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.