# Amazon OpenSearch Ingestion API

> Amazon OpenSearch Ingestion API on Apizie: 14 endpoints (Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion…, Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion…, Retrieves information about an OpenSearch Ingestion pipeline., Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:amazonaws-osis/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-osis`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://apizie.tech/api/cloud/amazonaws-osis
- OpenAPI: https://apizie.tech/api/cloud/amazonaws-osis/openapi.json

Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For…

## Endpoints

### Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/create-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/delete-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PipelineName | string | yes | The name of the pipeline to delete. |

### Retrieves information about an OpenSearch Ingestion pipeline.
`GET https://apizie.tech/v1/cloud:amazonaws-osis/get-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PipelineName | string | yes | The name of the pipeline to get information about. |

### Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the…
`GET https://apizie.tech/v1/cloud:amazonaws-osis/get-pipeline-blueprint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| BlueprintName | string | yes | The name of the blueprint to retrieve. |

### Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.…
`GET https://apizie.tech/v1/cloud:amazonaws-osis/get-pipeline-change-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PipelineName | string | yes | The name of the pipeline. |

### Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/list-pipeline-blueprints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more…
`GET https://apizie.tech/v1/cloud:amazonaws-osis/list-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial ListPipelines operation returns a nextToken , you can include the returned nextToken in subsequent ListPipelines… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging…
`GET https://apizie.tech/v1/cloud:amazonaws-osis/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The Amazon Resource Name (ARN) of the pipeline to retrieve tags for. |

### Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline .
`POST https://apizie.tech/v1/cloud:amazonaws-osis/start-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PipelineName | string | yes | The name of the pipeline to start. |

### Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline .
`POST https://apizie.tech/v1/cloud:amazonaws-osis/stop-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PipelineName | string | yes | The name of the pipeline to stop. |

### Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The Amazon Resource Name (ARN) of the pipeline to tag. |
| body | object | yes | JSON request body |

### Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The Amazon Resource Name (ARN) of the pipeline to remove tags from. |
| body | object | yes | JSON request body |

### Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/update-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PipelineName | string | yes | The name of the pipeline to update. |
| body | object | yes | JSON request body |

### Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more…
`POST https://apizie.tech/v1/cloud:amazonaws-osis/validate-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/cloud:amazonaws-osis/create-pipeline" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon OpenSearch Ingestion API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:amazonaws-osis/create-pipeline with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon OpenSearch Ingestion API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon OpenSearch Ingestion itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon OpenSearch Ingestion API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-osis.

### What is the status of the Amazon OpenSearch Ingestion API?
Needs your own provider key (bring your own key)