Amazon OpenSearch Service API Opensearch Ingestion Stream API

The Opensearch Ingestion Stream API from Amazon OpenSearch Service API — 4 operation(s) for opensearch ingestion stream.

GitHub OpenAPI

Operations 4

POST /#CreateIngestionStream Create Ingestion Stream #
POST /#GetIngestionStream Get Ingestion Stream #
POST /#DeleteIngestionStream Delete Ingestion Stream #
POST /#ListIngestionStreams List Ingestion Streams #

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/amazon-opensearch:amazon-opensearch-ingestion-stream-api"
All apis
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

amazon-opensearch-ingestion-stream-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon OpenSearch Service Ingestion Stream API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon OpenSearch Service. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://aoss.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateIngestionStream:
    post:
      operationId: CreateIngestionStream
      summary: Create Ingestion Stream
      description: Creates an ingestion stream that continuously ingests data from an Amazon S3 bucket into an index in an
        OpenSearch Serverless collection. An ingestion stream processes Amazon S3 event notifications delivered to an Amazon
        SQS queue and ingests new objects as they arrive. The stream continues to ingest data until you delete it. To perform
        a one-time bulk ingestion instead, use CreateIngestionJob.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateIngestionStreamResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.CreateIngestionStream
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateIngestionStreamRequest'
      tags:
      - Ingestion Stream
  /#GetIngestionStream:
    post:
      operationId: GetIngestionStream
      summary: Get Ingestion Stream
      description: Returns information about an ingestion stream, including its configuration, status, and processing state.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetIngestionStreamResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.GetIngestionStream
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetIngestionStreamRequest'
      tags:
      - Ingestion Stream
  /#DeleteIngestionStream:
    post:
      operationId: DeleteIngestionStream
      summary: Delete Ingestion Stream
      description: Deletes an ingestion stream. Documents that were already indexed by the stream remain in the index.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteIngestionStreamResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.DeleteIngestionStream
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteIngestionStreamRequest'
      tags:
      - Ingestion Stream
  /#ListIngestionStreams:
    post:
      operationId: ListIngestionStreams
      summary: List Ingestion Streams
      description: Returns a list of ingestion streams in a collection.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListIngestionStreamsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.ListIngestionStreams
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListIngestionStreamsRequest'
      tags:
      - Ingestion Stream
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: aoss
  schemas:
    AossConflictException:
      type: object
      properties:
        message:
          type: string
    AossResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    AossServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
        serviceCode:
          type: string
          description: Service Quotas requirement to identify originating service.
        quotaCode:
          type: string
          description: Service Quotas requirement to identify originating quota.
      required:
      - message
      - serviceCode
    AossTag:
      type: object
      properties:
        key:
          type: string
          description: The key to use in the tag.
        value:
          type: string
          description: The value of the tag.
      required:
      - key
      - value
    AossValidationException:
      type: object
      properties:
        message:
          type: string
    CreateIngestionStreamRequest:
      type: object
      properties:
        collectionId:
          type: string
          description: The unique identifier of the collection to ingest data into.
        ingestionStreamName:
          type: string
          description: The name of the ingestion stream. The name must be unique within the collection.
        indexName:
          type: string
          description: The name of the index to ingest documents into.
        failureIndexName:
          type: string
          description: The name of the index where documents that fail to be ingested are recorded.
        source:
          $ref: '#/components/schemas/IngestionStreamSource'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from
            the source. The role must be in the same account as the collection.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AossTag'
          description: An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - collectionId
      - ingestionStreamName
      - indexName
      - source
      - roleArn
    CreateIngestionStreamResponse:
      type: object
      properties:
        ingestionStreamDetail:
          $ref: '#/components/schemas/IngestionStreamDetail'
    DeleteIngestionStreamRequest:
      type: object
      properties:
        collectionId:
          type: string
          description: The unique identifier of the collection that the ingestion stream belongs to.
        ingestionStreamId:
          type: string
          description: The unique identifier of the ingestion stream to delete.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - collectionId
      - ingestionStreamId
    DeleteIngestionStreamResponse:
      type: object
      properties:
        ingestionStreamId:
          type: string
          description: The unique identifier of the deleted ingestion stream.
        collectionId:
          type: string
          description: The unique identifier of the collection that the ingestion stream belonged to.
        ingestionStreamName:
          type: string
          description: The name of the deleted ingestion stream.
        status:
          type: string
          description: The current status of the ingestion stream.
    GetIngestionStreamRequest:
      type: object
      properties:
        collectionId:
          type: string
          description: The unique identifier of the collection that the ingestion stream belongs to.
        ingestionStreamId:
          type: string
          description: The unique identifier of the ingestion stream to retrieve.
      required:
      - collectionId
      - ingestionStreamId
    GetIngestionStreamResponse:
      type: object
      properties:
        ingestionStreamDetail:
          $ref: '#/components/schemas/IngestionStreamDetail'
    IngestionAlert:
      type: object
      properties:
        code:
          type: string
          description: The code that identifies the alert.
        message:
          type: string
          description: A description of the alert.
    IngestionFailureReason:
      type: object
      properties:
        code:
          type: string
          description: The code that identifies the reason for the failure.
        message:
          type: string
          description: A description of the reason for the failure.
    IngestionStatistics:
      type: object
      properties:
        s3:
          $ref: '#/components/schemas/S3Statistics'
    IngestionStreamDetail:
      type: object
      properties:
        ingestionStreamId:
          type: string
          description: The unique identifier of the ingestion stream.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the ingestion stream.
        collectionId:
          type: string
          description: The unique identifier of the collection that the ingestion stream belongs to.
        ingestionStreamName:
          type: string
          description: The name of the ingestion stream.
        indexName:
          type: string
          description: The name of the index that documents are ingested into.
        failureIndexName:
          type: string
          description: The name of the index where documents that fail to be ingested are recorded.
        source:
          $ref: '#/components/schemas/IngestionStreamSource'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from
            the source.
        status:
          type: string
          description: The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE, or DELETING.
        state:
          type: string
          description: The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.
        statistics:
          $ref: '#/components/schemas/IngestionStatistics'
        revision:
          type: integer
          description: The revision number of the ingestion stream.
        createdAt:
          type: string
          description: The date and time when the ingestion stream was created.
        updatedAt:
          type: string
          description: The date and time when the ingestion stream was last updated.
        failureReasons:
          type: array
          items:
            $ref: '#/components/schemas/IngestionFailureReason'
          description: The reasons that the ingestion stream reached a terminal failure state, if applicable.
        activeAlerts:
          type: array
          items:
            $ref: '#/components/schemas/IngestionAlert'
          description: Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared
            when the issue is resolved.
    IngestionStreamS3Source:
      type: object
      properties:
        sqsArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon SQS queue that receives Amazon S3 event notifications
            for the source buckets.
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/StreamBucketConfig'
          description: The configuration for each Amazon S3 bucket that the ingestion stream ingests data from.
      required:
      - sqsArn
    IngestionStreamSource:
      type: object
      properties:
        s3:
          $ref: '#/components/schemas/IngestionStreamS3Source'
      required:
      - s3
    IngestionStreamSummary:
      type: object
      properties:
        ingestionStreamId:
          type: string
          description: The unique identifier of the ingestion stream.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the ingestion stream.
        ingestionStreamName:
          type: string
          description: The name of the ingestion stream.
        indexName:
          type: string
          description: The name of the index that documents are ingested into.
        status:
          type: string
          description: The current lifecycle status of the ingestion stream.
        createdAt:
          type: string
          description: The date and time when the ingestion stream was created.
        updatedAt:
          type: string
          description: The date and time when the ingestion stream was last updated.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListIngestionStreamsRequest:
      type: object
      properties:
        collectionId:
          type: string
          description: The unique identifier of the collection to list ingestion streams for.
        nextToken:
          type: string
          description: If your initial ListIngestionStreams operation returns a nextToken, you can include the returned nextToken
            in subsequent ListIngestionStreams operations, which returns results in the next page.
        maxResults:
          type: integer
          description: The maximum number of results to return. Valid values are 1–100. If you don't specify a value, the
            default is 100. You can use nextToken to get the next page of results. A response can contain fewer results than
            maxResults, or no results, and still include a nextToken. To retrieve all results, continue to make the call with
            the returned nextToken until no nextToken is returned.
      required:
      - collectionId
    ListIngestionStreamsResponse:
      type: object
      properties:
        ingestionStreamSummaries:
          type: array
          items:
            $ref: '#/components/schemas/IngestionStreamSummary'
          description: Summary information about each ingestion stream.
        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.
    S3Statistics:
      type: object
      properties:
        objectsDiscovered:
          type: integer
          description: The number of Amazon S3 objects discovered for ingestion.
        objectsIngested:
          type: integer
          description: The number of Amazon S3 objects successfully ingested.
        objectsFailed:
          type: integer
          description: The number of Amazon S3 objects that failed to be ingested.
    StreamBucketConfig:
      type: object
      properties:
        bucket:
          type: string
          description: The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.
        bucketOwnerAccountId:
          type: string
          description: The AWS account ID that owns the S3 bucket. Optional. If omitted, the control plane derives it from
            the account segment of sqsArn.
        initialScan:
          type: string
          description: Specifies whether to perform a one-time scan of the objects that already exist in the bucket before
            the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.
      required:
      - bucket
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)