Class: AWS.OSIS

var params = {
  PipelineName: 'STRING_VALUE' /* required */
};
osis.deletePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineName — (String)

    The name of the pipeline to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PipelineName: 'STRING_VALUE' /* required */
};
osis.getPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineName — (String)

    The name of the pipeline to get information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Pipeline — (map)

      Detailed information about the requested pipeline.

      • PipelineName — (String)

        The name of the pipeline.

      • PipelineArn — (String)

        The Amazon Resource Name (ARN) of the pipeline.

      • MinUnits — (Integer)

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • MaxUnits — (Integer)

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • Status — (String)

        The current status of the pipeline.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
        • "STARTING"
        • "START_FAILED"
        • "STOPPING"
        • "STOPPED"
      • StatusReason — (map)

        The reason for the current status of the pipeline.

        • Description — (String)

          A description of why a pipeline has a certain status.

      • PipelineConfigurationBody — (String)

        The Data Prepper pipeline configuration in YAML format.

      • CreatedAt — (Date)

        The date and time when the pipeline was created.

      • LastUpdatedAt — (Date)

        The date and time when the pipeline was last updated.

      • IngestEndpointUrls — (Array<String>)

        The ingestion endpoints for the pipeline, which you can send data to.

      • LogPublishingOptions — (map)

        Key-value pairs that represent log publishing settings.

        • IsLoggingEnabled — (Boolean)

          Whether logs should be published.

        • CloudWatchLogDestination — (map)

          The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

          • LogGroup — required — (String)

            The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

      • VpcEndpoints — (Array<map>)

        The VPC interface endpoints that have access to the pipeline.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcId — (String)

          The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.

        • VpcOptions — (map)

          Information about the VPC, including associated subnets and security groups.

          • SubnetIds — required — (Array<String>)

            A list of subnet IDs associated with the VPC endpoint.

          • SecurityGroupIds — (Array<String>)

            A list of security groups associated with the VPC endpoint.

      • BufferOptions — (map)

        Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.

        • PersistentBufferEnabled — required — (Boolean)

          Whether persistent buffering should be enabled.

      • EncryptionAtRestOptions — (map)

        Options to control how OpenSearch encrypts all data-at-rest.

        • KmsKeyArn — required — (String)

          The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.

      • ServiceVpcEndpoints — (Array<map>)

        A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

        • ServiceName — (String)

          The name of the service for which a VPC endpoint was created.

          Possible values include:
          • "OPENSEARCH_SERVERLESS"
        • VpcEndpointId — (String)

          The ID of the VPC endpoint that was created.

      • Tags — (Array<map>)

        A list of tags associated with the given pipeline.

        • Key — required — (String)

          The tag key. Tag keys must be unique for the pipeline to which they are attached.

        • Value — required — (String)

          The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BlueprintName: 'STRING_VALUE' /* required */
};
osis.getPipelineBlueprint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BlueprintName — (String)

    The name of the blueprint to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Blueprint — (map)

      The requested blueprint in YAML format.

      • BlueprintName — (String)

        The name of the blueprint.

      • PipelineConfigurationBody — (String)

        The YAML configuration of the blueprint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PipelineName: 'STRING_VALUE' /* required */
};
osis.getPipelineChangeProgress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineName — (String)

    The name of the pipeline.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ChangeProgressStatuses — (Array<map>)

      The current status of the change happening on the pipeline.

      • StartTime — (Date)

        The time at which the configuration change is made on the pipeline.

      • Status — (String)

        The overall status of the pipeline configuration change.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
      • TotalNumberOfStages — (Integer)

        The total number of stages required for the pipeline configuration change.

      • ChangeProgressStages — (Array<map>)

        Information about the stages that the pipeline is going through to perform the configuration change.

        • Name — (String)

          The name of the stage.

        • Status — (String)

          The current status of the stage that the change is in.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
        • Description — (String)

          A description of the stage.

        • LastUpdatedAt — (Date)

          The most recent updated timestamp of the stage.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Blueprints — (Array<map>)

      A list of available blueprints for Data Prepper.

      • BlueprintName — (String)

        The name of the blueprint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
osis.listPipelines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    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)

    If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      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.

    • Pipelines — (Array<map>)

      A list of all existing Data Prepper pipelines.

      • Status — (String)

        The current status of the pipeline.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
        • "STARTING"
        • "START_FAILED"
        • "STOPPING"
        • "STOPPED"
      • StatusReason — (map)

        Information about a pipeline's current status.

        • Description — (String)

          A description of why a pipeline has a certain status.

      • PipelineName — (String)

        The name of the pipeline.

      • PipelineArn — (String)

        The Amazon Resource Name (ARN) of the pipeline.

      • MinUnits — (Integer)

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • MaxUnits — (Integer)

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • CreatedAt — (Date)

        The date and time when the pipeline was created.

      • LastUpdatedAt — (Date)

        The date and time when the pipeline was last updated.

      • Tags — (Array<map>)

        A list of tags associated with the given pipeline.

        • Key — required — (String)

          The tag key. Tag keys must be unique for the pipeline to which they are attached.

        • Value — required — (String)

          The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE' /* required */
};
osis.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      A list of tags associated with the given pipeline.

      • Key — required — (String)

        The tag key. Tag keys must be unique for the pipeline to which they are attached.

      • Value — required — (String)

        The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PipelineName: 'STRING_VALUE' /* required */
};
osis.startPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineName — (String)

    The name of the pipeline to start.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Pipeline — (map)

      Information about an existing OpenSearch Ingestion pipeline.

      • PipelineName — (String)

        The name of the pipeline.

      • PipelineArn — (String)

        The Amazon Resource Name (ARN) of the pipeline.

      • MinUnits — (Integer)

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • MaxUnits — (Integer)

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • Status — (String)

        The current status of the pipeline.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
        • "STARTING"
        • "START_FAILED"
        • "STOPPING"
        • "STOPPED"
      • StatusReason — (map)

        The reason for the current status of the pipeline.

        • Description — (String)

          A description of why a pipeline has a certain status.

      • PipelineConfigurationBody — (String)

        The Data Prepper pipeline configuration in YAML format.

      • CreatedAt — (Date)

        The date and time when the pipeline was created.

      • LastUpdatedAt — (Date)

        The date and time when the pipeline was last updated.

      • IngestEndpointUrls — (Array<String>)

        The ingestion endpoints for the pipeline, which you can send data to.

      • LogPublishingOptions — (map)

        Key-value pairs that represent log publishing settings.

        • IsLoggingEnabled — (Boolean)

          Whether logs should be published.

        • CloudWatchLogDestination — (map)

          The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

          • LogGroup — required — (String)

            The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

      • VpcEndpoints — (Array<map>)

        The VPC interface endpoints that have access to the pipeline.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcId — (String)

          The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.

        • VpcOptions — (map)

          Information about the VPC, including associated subnets and security groups.

          • SubnetIds — required — (Array<String>)

            A list of subnet IDs associated with the VPC endpoint.

          • SecurityGroupIds — (Array<String>)

            A list of security groups associated with the VPC endpoint.

      • BufferOptions — (map)

        Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.

        • PersistentBufferEnabled — required — (Boolean)

          Whether persistent buffering should be enabled.

      • EncryptionAtRestOptions — (map)

        Options to control how OpenSearch encrypts all data-at-rest.

        • KmsKeyArn — required — (String)

          The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.

      • ServiceVpcEndpoints — (Array<map>)

        A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

        • ServiceName — (String)

          The name of the service for which a VPC endpoint was created.

          Possible values include:
          • "OPENSEARCH_SERVERLESS"
        • VpcEndpointId — (String)

          The ID of the VPC endpoint that was created.

      • Tags — (Array<map>)

        A list of tags associated with the given pipeline.

        • Key — required — (String)

          The tag key. Tag keys must be unique for the pipeline to which they are attached.

        • Value — required — (String)

          The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PipelineName: 'STRING_VALUE' /* required */
};
osis.stopPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineName — (String)

    The name of the pipeline to stop.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Pipeline — (map)

      Information about an existing OpenSearch Ingestion pipeline.

      • PipelineName — (String)

        The name of the pipeline.

      • PipelineArn — (String)

        The Amazon Resource Name (ARN) of the pipeline.

      • MinUnits — (Integer)

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • MaxUnits — (Integer)

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • Status — (String)

        The current status of the pipeline.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
        • "STARTING"
        • "START_FAILED"
        • "STOPPING"
        • "STOPPED"
      • StatusReason — (map)

        The reason for the current status of the pipeline.

        • Description — (String)

          A description of why a pipeline has a certain status.

      • PipelineConfigurationBody — (String)

        The Data Prepper pipeline configuration in YAML format.

      • CreatedAt — (Date)

        The date and time when the pipeline was created.

      • LastUpdatedAt — (Date)

        The date and time when the pipeline was last updated.

      • IngestEndpointUrls — (Array<String>)

        The ingestion endpoints for the pipeline, which you can send data to.

      • LogPublishingOptions — (map)

        Key-value pairs that represent log publishing settings.

        • IsLoggingEnabled — (Boolean)

          Whether logs should be published.

        • CloudWatchLogDestination — (map)

          The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

          • LogGroup — required — (String)

            The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

      • VpcEndpoints — (Array<map>)

        The VPC interface endpoints that have access to the pipeline.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcId — (String)

          The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.

        • VpcOptions — (map)

          Information about the VPC, including associated subnets and security groups.

          • SubnetIds — required — (Array<String>)

            A list of subnet IDs associated with the VPC endpoint.

          • SecurityGroupIds — (Array<String>)

            A list of security groups associated with the VPC endpoint.

      • BufferOptions — (map)

        Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.

        • PersistentBufferEnabled — required — (Boolean)

          Whether persistent buffering should be enabled.

      • EncryptionAtRestOptions — (map)

        Options to control how OpenSearch encrypts all data-at-rest.

        • KmsKeyArn — required — (String)

          The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.

      • ServiceVpcEndpoints — (Array<map>)

        A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

        • ServiceName — (String)

          The name of the service for which a VPC endpoint was created.

          Possible values include:
          • "OPENSEARCH_SERVERLESS"
        • VpcEndpointId — (String)

          The ID of the VPC endpoint that was created.

      • Tags — (Array<map>)

        A list of tags associated with the given pipeline.

        • Key — required — (String)

          The tag key. Tag keys must be unique for the pipeline to which they are attached.

        • Value — required — (String)

          The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
osis.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the pipeline to tag.

  • Tags — (Array<map>)

    The list of key-value tags to add to the pipeline.

    • Key — required — (String)

      The tag key. Tag keys must be unique for the pipeline to which they are attached.

    • Value — required — (String)

      The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Arn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
osis.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the pipeline to remove tags from.

  • TagKeys — (Array<String>)

    The tag keys to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PipelineName: 'STRING_VALUE', /* required */
  BufferOptions: {
    PersistentBufferEnabled: true || false /* required */
  },
  EncryptionAtRestOptions: {
    KmsKeyArn: 'STRING_VALUE' /* required */
  },
  LogPublishingOptions: {
    CloudWatchLogDestination: {
      LogGroup: 'STRING_VALUE' /* required */
    },
    IsLoggingEnabled: true || false
  },
  MaxUnits: 'NUMBER_VALUE',
  MinUnits: 'NUMBER_VALUE',
  PipelineConfigurationBody: 'STRING_VALUE'
};
osis.updatePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineName — (String)

    The name of the pipeline to update.

  • MinUnits — (Integer)

    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

  • MaxUnits — (Integer)

    The maximum pipeline capacity, in Ingestion Compute Units (ICUs)

  • PipelineConfigurationBody — (String)

    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

  • LogPublishingOptions — (map)

    Key-value pairs to configure log publishing.

    • IsLoggingEnabled — (Boolean)

      Whether logs should be published.

    • CloudWatchLogDestination — (map)

      The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

      • LogGroup — required — (String)

        The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

  • BufferOptions — (map)

    Key-value pairs to configure persistent buffering for the pipeline.

    • PersistentBufferEnabled — required — (Boolean)

      Whether persistent buffering should be enabled.

  • EncryptionAtRestOptions — (map)

    Key-value pairs to configure encryption for data that is written to a persistent buffer.

    • KmsKeyArn — required — (String)

      The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Pipeline — (map)

      Container for information about the updated pipeline.

      • PipelineName — (String)

        The name of the pipeline.

      • PipelineArn — (String)

        The Amazon Resource Name (ARN) of the pipeline.

      • MinUnits — (Integer)

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • MaxUnits — (Integer)

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • Status — (String)

        The current status of the pipeline.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "CREATE_FAILED"
        • "UPDATE_FAILED"
        • "STARTING"
        • "START_FAILED"
        • "STOPPING"
        • "STOPPED"
      • StatusReason — (map)

        The reason for the current status of the pipeline.

        • Description — (String)

          A description of why a pipeline has a certain status.

      • PipelineConfigurationBody — (String)

        The Data Prepper pipeline configuration in YAML format.

      • CreatedAt — (Date)

        The date and time when the pipeline was created.

      • LastUpdatedAt — (Date)

        The date and time when the pipeline was last updated.

      • IngestEndpointUrls — (Array<String>)

        The ingestion endpoints for the pipeline, which you can send data to.

      • LogPublishingOptions — (map)

        Key-value pairs that represent log publishing settings.

        • IsLoggingEnabled — (Boolean)

          Whether logs should be published.

        • CloudWatchLogDestination — (map)

          The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

          • LogGroup — required — (String)

            The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

      • VpcEndpoints — (Array<map>)

        The VPC interface endpoints that have access to the pipeline.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcId — (String)

          The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.

        • VpcOptions — (map)

          Information about the VPC, including associated subnets and security groups.

          • SubnetIds — required — (Array<String>)

            A list of subnet IDs associated with the VPC endpoint.

          • SecurityGroupIds — (Array<String>)

            A list of security groups associated with the VPC endpoint.

      • BufferOptions — (map)

        Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions.

        • PersistentBufferEnabled — required — (Boolean)

          Whether persistent buffering should be enabled.

      • EncryptionAtRestOptions — (map)

        Options to control how OpenSearch encrypts all data-at-rest.

        • KmsKeyArn — required — (String)

          The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.

      • ServiceVpcEndpoints — (Array<map>)

        A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

        • ServiceName — (String)

          The name of the service for which a VPC endpoint was created.

          Possible values include:
          • "OPENSEARCH_SERVERLESS"
        • VpcEndpointId — (String)

          The ID of the VPC endpoint that was created.

      • Tags — (Array<map>)

        A list of tags associated with the given pipeline.

        • Key — required — (String)

          The tag key. Tag keys must be unique for the pipeline to which they are attached.

        • Value — required — (String)

          The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PipelineConfigurationBody: 'STRING_VALUE' /* required */
};
osis.validatePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PipelineConfigurationBody — (String)

    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • isValid — (Boolean)

      A boolean indicating whether or not the pipeline configuration is valid.

    • Errors — (Array<map>)

      A list of errors if the configuration is invalid.

      • Message — (String)

        The validation message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.