Discovery needs no key. Ratings and market analysis are Pro.
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.
openapi: 3.2.0
info:
title: Amazon Web Services Osis API
description: 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 more information, see Getting data into your cluster using OpenSearch Ingestion.
tags:
- name: Osis
paths:
/2022-01-01/osis/createPipeline:
POST:
summary: Amazon Web Services Createpipeline
description: Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesCreatePipeline
tags:
- Osis
/2022-01-01/osis/deletePipeline/{PipelineName}:
DELETE:
summary: Amazon Web Services Deletepipeline
description: Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesDeletePipeline
tags:
- Osis
/2022-01-01/osis/getPipeline/{PipelineName}:
GET:
summary: Amazon Web Services Getpipeline
description: Retrieves information about an OpenSearch Ingestion pipeline.
operationId: amazonWebServicesGetPipeline
tags:
- Osis
/2022-01-01/osis/getPipelineBlueprint/{BlueprintName}:
GET:
summary: Amazon Web Services Getpipelineblueprint
description: Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
operationId: amazonWebServicesGetPipelineBlueprint
tags:
- Osis
/2022-01-01/osis/getPipelineChangeProgress/{PipelineName}:
GET:
summary: Amazon Web Services Getpipelinechangeprogress
description: Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. For more information, see Tracking the status of pipeline creation.
operationId: amazonWebServicesGetPipelineChangeProgress
tags:
- Osis
/2022-01-01/osis/listPipelineBlueprints:
POST:
summary: Amazon Web Services Listpipelineblueprints
description: Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
operationId: amazonWebServicesListPipelineBlueprints
tags:
- Osis
/2022-01-01/osis/listPipelines:
GET:
summary: Amazon Web Services Listpipelines
description: Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesListPipelines
tags:
- Osis
/2022-01-01/osis/listTagsForResource/:
GET:
summary: Amazon Web Services Listtagsforresource
description: Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesListTagsForResource
tags:
- Osis
/2022-01-01/osis/startPipeline/{PipelineName}:
PUT:
summary: Amazon Web Services Startpipeline
description: Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
operationId: amazonWebServicesStartPipeline
tags:
- Osis
/2022-01-01/osis/stopPipeline/{PipelineName}:
PUT:
summary: Amazon Web Services Stoppipeline
description: Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
operationId: amazonWebServicesStopPipeline
tags:
- Osis
/2022-01-01/osis/tagResource/:
POST:
summary: Amazon Web Services Tagresource
description: Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesTagResource
tags:
- Osis
/2022-01-01/osis/untagResource/:
POST:
summary: Amazon Web Services Untagresource
description: Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesUntagResource
tags:
- Osis
/2022-01-01/osis/updatePipeline/{PipelineName}:
PUT:
summary: Amazon Web Services Updatepipeline
description: Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesUpdatePipeline
tags:
- Osis
/2022-01-01/osis/validatePipeline:
POST:
summary: Amazon Web Services Validatepipeline
description: Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
operationId: amazonWebServicesValidatePipeline
tags:
- Osis