osis/aws.sdk.kotlin.services.osis/OsisClient

OsisClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<OsisClient.Config, OsisClient.Config.Builder, OsisClient>

Companion

object Companion : AbstractAwsSdkClientFactory<OsisClient.Config, OsisClient.Config.Builder, OsisClient, OsisClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

config

abstract override val config: OsisClient.Config

OsisClient's configuration

Functions

createPipeline

abstract suspend fun createPipeline(input: CreatePipelineRequest): CreatePipelineResponse

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

createPipelineEndpoint

abstract suspend fun createPipelineEndpoint(input: CreatePipelineEndpointRequest): CreatePipelineEndpointResponse

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.

deletePipeline

abstract suspend fun deletePipeline(input: DeletePipelineRequest): DeletePipelineResponse

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

deletePipelineEndpoint

abstract suspend fun deletePipelineEndpoint(input: DeletePipelineEndpointRequest): DeletePipelineEndpointResponse

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

deleteResourcePolicy

abstract suspend fun deleteResourcePolicy(input: DeleteResourcePolicyRequest): DeleteResourcePolicyResponse

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

getPipeline

abstract suspend fun getPipeline(input: GetPipelineRequest): GetPipelineResponse

Retrieves information about an OpenSearch Ingestion pipeline.

getPipelineBlueprint

abstract suspend fun getPipelineBlueprint(input: GetPipelineBlueprintRequest): 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

abstract suspend fun getPipelineChangeProgress(input: GetPipelineChangeProgressRequest): 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.

getResourcePolicy

abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

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

listPipelineBlueprints

abstract suspend fun listPipelineBlueprints(input: ListPipelineBlueprintsRequest = ListPipelineBlueprintsRequest { }): ListPipelineBlueprintsResponse

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

listPipelineEndpointConnections

abstract suspend fun listPipelineEndpointConnections(input: ListPipelineEndpointConnectionsRequest = ListPipelineEndpointConnectionsRequest { }): ListPipelineEndpointConnectionsResponse

Lists the pipeline endpoints connected to pipelines in your account.

listPipelineEndpoints

abstract suspend fun listPipelineEndpoints(input: ListPipelineEndpointsRequest = ListPipelineEndpointsRequest { }): ListPipelineEndpointsResponse

Lists all pipeline endpoints in your account.

listPipelines

abstract suspend fun listPipelines(input: ListPipelinesRequest = ListPipelinesRequest { }): 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

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

putResourcePolicy

abstract suspend fun putResourcePolicy(input: PutResourcePolicyRequest): PutResourcePolicyResponse

Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the resource.

revokePipelineEndpointConnections

abstract suspend fun revokePipelineEndpointConnections(input: RevokePipelineEndpointConnectionsRequest): RevokePipelineEndpointConnectionsResponse

Revokes pipeline endpoints from specified endpoint IDs.

startPipeline

abstract suspend fun startPipeline(input: StartPipelineRequest): StartPipelineResponse

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

stopPipeline

abstract suspend fun stopPipeline(input: StopPipelineRequest): StopPipelineResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

updatePipeline

abstract suspend fun updatePipeline(input: UpdatePipelineRequest): UpdatePipelineResponse

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

validatePipeline

abstract suspend fun validatePipeline(input: ValidatePipelineRequest): ValidatePipelineResponse

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

Inherited functions

expect abstract fun close()

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.

createPipelineEndpoint

inline suspend fun OsisClient.createPipelineEndpoint(crossinline block: CreatePipelineEndpointRequest.Builder.() -> Unit): CreatePipelineEndpointResponse

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.

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.

deletePipelineEndpoint

inline suspend fun OsisClient.deletePipelineEndpoint(crossinline block: DeletePipelineEndpointRequest.Builder.() -> Unit): DeletePipelineEndpointResponse

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

deleteResourcePolicy

inline suspend fun OsisClient.deleteResourcePolicy(crossinline block: DeleteResourcePolicyRequest.Builder.() -> Unit): DeleteResourcePolicyResponse

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

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

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.

getResourcePolicy

inline suspend fun OsisClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

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

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.

listPipelineEndpointConnections

inline suspend fun OsisClient.listPipelineEndpointConnections(crossinline block: ListPipelineEndpointConnectionsRequest.Builder.() -> Unit): ListPipelineEndpointConnectionsResponse

Lists the pipeline endpoints connected to pipelines in your account.

listPipelineEndpointConnectionsPaginated

fun OsisClient.listPipelineEndpointConnectionsPaginated(initialRequest: ListPipelineEndpointConnectionsRequest = ListPipelineEndpointConnectionsRequest { }): Flow<ListPipelineEndpointConnectionsResponse>

fun OsisClient.listPipelineEndpointConnectionsPaginated(block: ListPipelineEndpointConnectionsRequest.Builder.() -> Unit): Flow<ListPipelineEndpointConnectionsResponse>

Paginate over ListPipelineEndpointConnectionsResponse results.

listPipelineEndpoints

inline suspend fun OsisClient.listPipelineEndpoints(crossinline block: ListPipelineEndpointsRequest.Builder.() -> Unit): ListPipelineEndpointsResponse

Lists all pipeline endpoints in your account.

listPipelineEndpointsPaginated

fun OsisClient.listPipelineEndpointsPaginated(initialRequest: ListPipelineEndpointsRequest = ListPipelineEndpointsRequest { }): Flow<ListPipelineEndpointsResponse>

fun OsisClient.listPipelineEndpointsPaginated(block: ListPipelineEndpointsRequest.Builder.() -> Unit): Flow<ListPipelineEndpointsResponse>

Paginate over ListPipelineEndpointsResponse results.

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.

listPipelinesPaginated

fun OsisClient.listPipelinesPaginated(initialRequest: ListPipelinesRequest = ListPipelinesRequest { }): Flow<ListPipelinesResponse>

fun OsisClient.listPipelinesPaginated(block: ListPipelinesRequest.Builder.() -> Unit): Flow<ListPipelinesResponse>

Paginate over ListPipelinesResponse results.

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.

putResourcePolicy

inline suspend fun OsisClient.putResourcePolicy(crossinline block: PutResourcePolicyRequest.Builder.() -> Unit): PutResourcePolicyResponse

Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the resource.

revokePipelineEndpointConnections

inline suspend fun OsisClient.revokePipelineEndpointConnections(crossinline block: RevokePipelineEndpointConnectionsRequest.Builder.() -> Unit): RevokePipelineEndpointConnectionsResponse

Revokes pipeline endpoints from specified endpoint IDs.

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.