Amazon OpenSearch Ingestion
Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 22
- POSTCreate pipeline
/2022-01-01/osis/createPipelineCreates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines . - POSTCreate pipeline endpoint
/2022-01-01/osis/createPipelineEndpointCreates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to. - DELETEDelete pipeline
/2022-01-01/osis/deletePipeline/:PipelineNameDeletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines . - DELETEDelete pipeline endpoint
/2022-01-01/osis/deletePipelineEndpoint/:EndpointIdDeletes a VPC endpoint for an OpenSearch Ingestion pipeline. - GETGet resource policy
/2022-01-01/osis/resourcePolicy/:ResourceArnRetrieves the resource-based policy attached to an OpenSearch Ingestion resource. - PUTPut resource policy
/2022-01-01/osis/resourcePolicy/:ResourceArnAttaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the… - DELETEDelete resource policy
/2022-01-01/osis/resourcePolicy/:ResourceArnDeletes a resource-based policy from an OpenSearch Ingestion resource. - GETGet pipeline
/2022-01-01/osis/getPipeline/:PipelineNameRetrieves information about an OpenSearch Ingestion pipeline. - GETGet pipeline blueprint
/2022-01-01/osis/getPipelineBlueprint/:BlueprintName?format=stringRetrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request.… - GETGet pipeline change progress
/2022-01-01/osis/getPipelineChangeProgress/:PipelineNameReturns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a… - POSTList pipeline blueprints
/2022-01-01/osis/listPipelineBlueprintsRetrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline . - GETList pipeline endpoint connections
/2022-01-01/osis/listPipelineEndpointConnections?maxResults=0&nextToken=stringLists the pipeline endpoints connected to pipelines in your account. - GETList pipeline endpoints
/2022-01-01/osis/listPipelineEndpoints?maxResults=0&nextToken=stringLists all pipeline endpoints in your account. - GETList pipelines
/2022-01-01/osis/listPipelines?maxResults=0&nextToken=stringLists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion… - GETList tags for resource
/2022-01-01/osis/listTagsForResource?arn=stringLists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines . - POSTRevoke pipeline endpoint connections
/2022-01-01/osis/revokePipelineEndpointConnectionsRevokes pipeline endpoints from specified endpoint IDs. - PUTStart pipeline
/2022-01-01/osis/startPipeline/:PipelineNameStarts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline . - PUTStop pipeline
/2022-01-01/osis/stopPipeline/:PipelineNameStops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline . - POSTTag resource
/2022-01-01/osis/tagResource?arn=stringTags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines . - POSTUntag resource
/2022-01-01/osis/untagResource?arn=stringRemoves one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines . - PUTUpdate pipeline
/2022-01-01/osis/updatePipeline/:PipelineNameUpdates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines . - POSTValidate pipeline
/2022-01-01/osis/validatePipelineChecks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion…
API details
- Base URL
https://osis.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 22 operations on 20 pathsGET 8POST 7PUT 4DELETE 3
- Description format
- AWS Smithy model, API version
2022-01-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon OpenSearch Ingestion in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon OpenSearch Ingestion collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create pipeline” (POST /2022-01-01/osis/createPipeline), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon OpenSearch Ingestion?
Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers… It is listed under Developer tools and has 22 endpoints.
Who publishes the Amazon OpenSearch Ingestion?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon OpenSearch Ingestion?
Requests go to https://osis.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon OpenSearch Ingestion?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon OpenSearch Ingestion have?
22 operations on 20 paths (8 GET, 7 POST, 4 PUT, 3 DELETE).
Is forking the Amazon OpenSearch Ingestion free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.