aws-elixir v1.0.10

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

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.

Link to this section Summary

Functions

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

Creates an OpenSearch Ingestion pipeline.

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

Creates a VPC endpoint for an OpenSearch Ingestion pipeline.

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

Deletes an OpenSearch Ingestion pipeline.

delete_pipeline_endpoint(client, endpoint_id, input, options \\ [])

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

delete_resource_policy(client, resource_arn, input, options \\ [])

Deletes a resource-based policy from an OpenSearch Ingestion resource.

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

Retrieves information about an OpenSearch Ingestion pipeline.

get_pipeline_blueprint(client, blueprint_name, format \\ nil, 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.

get_resource_policy(client, resource_arn, options \\ [])

Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.

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

Retrieves a list of all available blueprints for Data Prepper.

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

Lists the pipeline endpoints connected to pipelines in your account.

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

Lists all pipeline endpoints in your account.

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()
put_resource_policy(client, resource_arn, input, options \\ [])

Attaches a resource-based policy to an OpenSearch Ingestion resource.

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

Revokes pipeline endpoints from specified endpoint IDs.

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.

Link to this section Functions

Link to this function

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

View Source

Creates an OpenSearch Ingestion pipeline.

For more information, see Creating Amazon OpenSearch Ingestion pipelines.

Link to this function

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

View Source

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

Link to this function

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

View Source

Deletes an OpenSearch Ingestion pipeline.

For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

Link to this function

delete_pipeline_endpoint(client, endpoint_id, input, options \\ [])

View Source

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

Link to this function

delete_resource_policy(client, resource_arn, input, options \\ [])

View Source

Deletes a resource-based policy from an OpenSearch Ingestion resource.

Link to this function

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

View Source

Retrieves information about an OpenSearch Ingestion pipeline.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

get_resource_policy(client, resource_arn, options \\ [])

View Source

Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.

Link to this function

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

View Source

Retrieves a list of all available blueprints for Data Prepper.

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

Link to this function

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

View Source

Lists the pipeline endpoints connected to pipelines in your account.

Link to this function

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

View Source

Lists all pipeline endpoints in your account.

Link to this function

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

View Source

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

For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

Link to this function

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

View Source

Lists all resource tags associated with an OpenSearch Ingestion pipeline.

For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Link to this function

metadata()

View Source
Link to this function

put_resource_policy(client, resource_arn, input, options \\ [])

View Source

Attaches a resource-based policy to an OpenSearch Ingestion resource.

Resource-based policies grant permissions to principals to perform actions on the resource.

Link to this function

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

View Source

Revokes pipeline endpoints from specified endpoint IDs.

Link to this function

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

View Source

Starts an OpenSearch Ingestion pipeline.

For more information, see Starting an OpenSearch Ingestion pipeline.

Link to this function

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

View Source

Stops an OpenSearch Ingestion pipeline.

For more information, see Stopping an OpenSearch Ingestion pipeline.

Link to this function

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

View Source

Tags an OpenSearch Ingestion pipeline.

For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Link to this function

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

View Source

Removes one or more tags from an OpenSearch Ingestion pipeline.

For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Link to this function

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

View Source

Updates an OpenSearch Ingestion pipeline.

For more information, see Updating Amazon OpenSearch Ingestion pipelines.

Link to this function

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

View Source

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

For more information, see Creating Amazon OpenSearch Ingestion pipelines.