Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

OSIS

import { OSIS } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/osis.ts?docs=full";
class OSIS {
constructor(apiFactory: client.ApiFactory);
async createPipeline(params: CreatePipelineRequest, opts?: client.RequestOptions): Promise<CreatePipelineResponse>;
async deletePipeline(params: DeletePipelineRequest, opts?: client.RequestOptions): Promise<void>;
async getPipeline(params: GetPipelineRequest, opts?: client.RequestOptions): Promise<GetPipelineResponse>;
async getPipelineBlueprint(params: GetPipelineBlueprintRequest, opts?: client.RequestOptions): Promise<GetPipelineBlueprintResponse>;
async getPipelineChangeProgress(params: GetPipelineChangeProgressRequest, opts?: client.RequestOptions): Promise<GetPipelineChangeProgressResponse>;
async listPipelineBlueprints(opts?: client.RequestOptions): Promise<ListPipelineBlueprintsResponse>;
async listPipelines(params?: ListPipelinesRequest, opts?: client.RequestOptions): Promise<ListPipelinesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async startPipeline(params: StartPipelineRequest, opts?: client.RequestOptions): Promise<StartPipelineResponse>;
async stopPipeline(params: StopPipelineRequest, opts?: client.RequestOptions): Promise<StopPipelineResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updatePipeline(params: UpdatePipelineRequest, opts?: client.RequestOptions): Promise<UpdatePipelineResponse>;
async validatePipeline(params: ValidatePipelineRequest, opts?: client.RequestOptions): Promise<ValidatePipelineResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new OSIS(apiFactory: client.ApiFactory)
[src]

§Methods

§
createPipeline(params: CreatePipelineRequest, opts?: client.RequestOptions): Promise<CreatePipelineResponse>
[src]

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

§
deletePipeline(params: DeletePipelineRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
getPipeline(params: GetPipelineRequest, opts?: client.RequestOptions): Promise<GetPipelineResponse>
[src]

Retrieves information about an OpenSearch Ingestion pipeline.

§
getPipelineBlueprint(params: GetPipelineBlueprintRequest, opts?: client.RequestOptions): Promise<GetPipelineBlueprintResponse>
[src]

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(params: GetPipelineChangeProgressRequest, opts?: client.RequestOptions): Promise<GetPipelineChangeProgressResponse>
[src]

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.

§
listPipelineBlueprints(opts?: client.RequestOptions): Promise<ListPipelineBlueprintsResponse>
[src]

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

§
listPipelines(params?: ListPipelinesRequest, opts?: client.RequestOptions): Promise<ListPipelinesResponse>
[src]

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

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

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

§
startPipeline(params: StartPipelineRequest, opts?: client.RequestOptions): Promise<StartPipelineResponse>
[src]

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

§
stopPipeline(params: StopPipelineRequest, opts?: client.RequestOptions): Promise<StopPipelineResponse>
[src]

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

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
updatePipeline(params: UpdatePipelineRequest, opts?: client.RequestOptions): Promise<UpdatePipelineResponse>
[src]

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

§
validatePipeline(params: ValidatePipelineRequest, opts?: client.RequestOptions): Promise<ValidatePipelineResponse>
[src]

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

§Static Properties