ListPipelinesResponse

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
NextToken string When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Pipelines array A list of all existing Data Prepper pipelines.
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-list-pipelines-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-list-pipelines-response-schema.json",
  "title": "ListPipelinesResponse",
  "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/ListPipelinesResponse",
  "type": "object",
  "properties": {
    "NextToken": {
      "type": "string",
      "description": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page."
    },
    "Pipelines": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PipelineSummary"
      },
      "description": "A list of all existing Data Prepper pipelines."
    }
  },
  "$defs": {
    "OsisTag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The tag key. Tag keys must be unique for the pipeline to which they are attached."
        },
        "Value": {
          "type": "string",
          "description": "The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity"
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    },
    "PipelineDestination": {
      "type": "object",
      "properties": {
        "ServiceName": {
          "type": "string",
          "description": "The name of the service receiving data from the pipeline."
        },
        "Endpoint": {
          "type": "string",
          "description": "The endpoint receiving data from the pipeline."
        }
      }
    },
    "PipelineStatusReason": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string",
          "description": "A description of why a pipeline has a certain status."
        }
      }
    },
    "PipelineSummary": {
      "type": "object",
      "properties": {
        "Status": {
          "type": "string",
          "enum": [
            "CREATING",
            "ACTIVE",
            "UPDATING",
            "DELETING",
            "CREATE_FAILED",
            "UPDATE_FAILED",
            "STARTING",
            "START_FAILED",
            "STOPPING",
            "STOPPED"
          ],
          "description": "The current status of the pipeline."
        },
        "StatusReason": {
          "$ref": "#/$defs/PipelineStatusReason"
        },
        "PipelineName": {
          "type": "string",
          "description": "The name of the pipeline."
        },
        "PipelineArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the pipeline."
        },
        "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)."
        },
        "CreatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the pipeline was created."
        },
        "LastUpdatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the pipeline was last updated."
        },
        "Destinations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PipelineDestination"
          },
          "description": "A list of destinations to which the pipeline writes data."
        },
        "Tags": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OsisTag"
          },
          "description": "A list of tags associated with the given pipeline."
        }
      }
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-list-pipelines-response"
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.