osis/aws.sdk.kotlin.services.osis

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createPipeline

inline suspend fun OsisClient.createPipeline(crossinline block: CreatePipelineRequest.Builder.() -> Unit): CreatePipelineResponse

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

deletePipeline

inline suspend fun OsisClient.deletePipeline(crossinline block: DeletePipelineRequest.Builder.() -> Unit): DeletePipelineResponse

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

getPipeline

inline suspend fun OsisClient.getPipeline(crossinline block: GetPipelineRequest.Builder.() -> Unit): GetPipelineResponse

Retrieves information about an OpenSearch Ingestion pipeline.

getPipelineBlueprint

inline suspend fun OsisClient.getPipelineBlueprint(crossinline block: GetPipelineBlueprintRequest.Builder.() -> Unit): GetPipelineBlueprintResponse

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

inline suspend fun OsisClient.getPipelineChangeProgress(crossinline block: GetPipelineChangeProgressRequest.Builder.() -> Unit): GetPipelineChangeProgressResponse

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.

listPipelineBlueprints

inline suspend fun OsisClient.listPipelineBlueprints(crossinline block: ListPipelineBlueprintsRequest.Builder.() -> Unit): ListPipelineBlueprintsResponse

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

listPipelines

inline suspend fun OsisClient.listPipelines(crossinline block: ListPipelinesRequest.Builder.() -> Unit): ListPipelinesResponse

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

listTagsForResource

inline suspend fun OsisClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

startPipeline

inline suspend fun OsisClient.startPipeline(crossinline block: StartPipelineRequest.Builder.() -> Unit): StartPipelineResponse

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

stopPipeline

inline suspend fun OsisClient.stopPipeline(crossinline block: StopPipelineRequest.Builder.() -> Unit): StopPipelineResponse

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

tagResource

inline suspend fun OsisClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

untagResource

inline suspend fun OsisClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

updatePipeline

inline suspend fun OsisClient.updatePipeline(crossinline block: UpdatePipelineRequest.Builder.() -> Unit): UpdatePipelineResponse

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.

validatePipeline

inline suspend fun OsisClient.validatePipeline(crossinline block: ValidatePipelineRequest.Builder.() -> Unit): ValidatePipelineResponse

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

withConfig

fun OsisClient.withConfig(block: OsisClient.Config.Builder.() -> Unit): OsisClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.