View Source AWS.OSIS (aws-elixir v1.0.0)

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.

Summary

Functions

create_pipeline(client, input, options \\ [])

Creates an OpenSearch Ingestion pipeline.

delete_pipeline(client, pipeline_name, input, options \\ [])

Deletes an OpenSearch Ingestion pipeline.

get_pipeline(client, pipeline_name, options \\ [])

Retrieves information about an OpenSearch Ingestion pipeline.

get_pipeline_blueprint(client, blueprint_name, options \\ [])

Retrieves information about a specific blueprint for OpenSearch Ingestion.

get_pipeline_change_progress(client, pipeline_name, options \\ [])

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.

list_pipeline_blueprints(client, input, options \\ [])

Retrieves a list of all available blueprints for Data Prepper.

list_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.

list_tags_for_resource(client, arn, options \\ [])

Lists all resource tags associated with an OpenSearch Ingestion pipeline.

metadata()

start_pipeline(client, pipeline_name, input, options \\ [])

Starts an OpenSearch Ingestion pipeline.

stop_pipeline(client, pipeline_name, input, options \\ [])

Stops an OpenSearch Ingestion pipeline.

tag_resource(client, input, options \\ [])

Tags an OpenSearch Ingestion pipeline.

untag_resource(client, input, options \\ [])

Removes one or more tags from an OpenSearch Ingestion pipeline.

update_pipeline(client, pipeline_name, input, options \\ [])

Updates an OpenSearch Ingestion pipeline.

validate_pipeline(client, input, options \\ [])

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Functions

create_pipeline(client, input, options \\ [])

Creates an OpenSearch Ingestion pipeline.

For more information, see Creating Amazon OpenSearch Ingestion pipelines.

delete_pipeline(client, pipeline_name, input, options \\ [])

Deletes an OpenSearch Ingestion pipeline.

For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

get_pipeline(client, pipeline_name, options \\ [])

Retrieves information about an OpenSearch Ingestion pipeline.

get_pipeline_blueprint(client, blueprint_name, options \\ [])

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.

get_pipeline_change_progress(client, pipeline_name, options \\ [])

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.

list_pipeline_blueprints(client, input, options \\ [])

Retrieves a list of all available blueprints for Data Prepper.

For more information, see Using blueprints to create a pipeline.

list_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.

For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

list_tags_for_resource(client, arn, options \\ [])

Lists all resource tags associated with an OpenSearch Ingestion pipeline.

For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

metadata()

start_pipeline(client, pipeline_name, input, options \\ [])

Starts an OpenSearch Ingestion pipeline.

For more information, see Starting an OpenSearch Ingestion pipeline.

stop_pipeline(client, pipeline_name, input, options \\ [])

Stops an OpenSearch Ingestion pipeline.

For more information, see Stopping an OpenSearch Ingestion pipeline.

tag_resource(client, input, options \\ [])

Tags an OpenSearch Ingestion pipeline.

For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

untag_resource(client, input, options \\ [])

Removes one or more tags from an OpenSearch Ingestion pipeline.

For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

update_pipeline(client, pipeline_name, input, options \\ [])

Updates an OpenSearch Ingestion pipeline.

For more information, see Updating Amazon OpenSearch Ingestion pipelines.

validate_pipeline(client, input, options \\ [])

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

For more information, see Creating Amazon OpenSearch Ingestion pipelines.