AWS.OSIS — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.OSIS

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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.

Sending a Request Using OSIS

var osis = new AWS.OSIS();
osis.createPipeline(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the OSIS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var osis = new AWS.OSIS({apiVersion: '2022-01-01'});

You can also set the API version globally in AWS.config.apiVersions using the osis service identifier:

AWS.config.apiVersions = {
  osis: '2022-01-01',
  // other service API versions
};

var osis = new AWS.OSIS();

Constructor Summarycollapse

new AWS.OSIS(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summarycollapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

createPipeline(params = {}, callback) ⇒ AWS.Request
Creates an OpenSearch Ingestion pipeline.
deletePipeline(params = {}, callback) ⇒ AWS.Request
Deletes an OpenSearch Ingestion pipeline.
getPipeline(params = {}, callback) ⇒ AWS.Request
Retrieves information about an OpenSearch Ingestion pipeline.
.
getPipelineBlueprint(params = {}, callback) ⇒ AWS.Request
Retrieves information about a specific blueprint for OpenSearch Ingestion.
getPipelineChangeProgress(params = {}, callback) ⇒ AWS.Request
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
listPipelineBlueprints(params = {}, callback) ⇒ AWS.Request
Retrieves a list of all available blueprints for Data Prepper.
listPipelines(params = {}, callback) ⇒ AWS.Request
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
startPipeline(params = {}, callback) ⇒ AWS.Request
Starts an OpenSearch Ingestion pipeline.
stopPipeline(params = {}, callback) ⇒ AWS.Request
Stops an OpenSearch Ingestion pipeline.
tagResource(params = {}, callback) ⇒ AWS.Request
Tags an OpenSearch Ingestion pipeline.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes one or more tags from an OpenSearch Ingestion pipeline.
updatePipeline(params = {}, callback) ⇒ AWS.Request
Updates an OpenSearch Ingestion pipeline.
validatePipeline(params = {}, callback) ⇒ AWS.Request
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.OSIS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createPipeline(params = {}, callback) ⇒ AWS.Request

deletePipeline(params = {}, callback) ⇒ AWS.Request

getPipeline(params = {}, callback) ⇒ AWS.Request

Retrieves information about an OpenSearch Ingestion pipeline.

getPipelineBlueprint(params = {}, callback) ⇒ AWS.Request

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.

getPipelineChangeProgress(params = {}, callback) ⇒ AWS.Request

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.