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

Pipes

import { Pipes } from "https://aws-api.deno.dev/v0.4/services/pipes.ts?docs=full";
class Pipes {
constructor(apiFactory: client.ApiFactory);
async createPipe(params: CreatePipeRequest, opts?: client.RequestOptions): Promise<CreatePipeResponse>;
async deletePipe(params: DeletePipeRequest, opts?: client.RequestOptions): Promise<DeletePipeResponse>;
async describePipe(params: DescribePipeRequest, opts?: client.RequestOptions): Promise<DescribePipeResponse>;
async listPipes(params?: ListPipesRequest, opts?: client.RequestOptions): Promise<ListPipesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async startPipe(params: StartPipeRequest, opts?: client.RequestOptions): Promise<StartPipeResponse>;
async stopPipe(params: StopPipeRequest, opts?: client.RequestOptions): Promise<StopPipeResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updatePipe(params: UpdatePipeRequest, opts?: client.RequestOptions): Promise<UpdatePipeResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

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

§Methods

§

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

§

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

§

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

§
listPipes(params?: ListPipesRequest, opts?: client.RequestOptions): Promise<ListPipesResponse>
[src]

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

§

Displays the tags associated with a pipe.

§

Start an existing pipe.

§
stopPipe(params: StopPipeRequest, opts?: client.RequestOptions): Promise<StopPipeResponse>
[src]

Stop an existing pipe.

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

Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a pipe.

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

Removes one or more tags from the specified pipes.

§

TODO: Failed to render documentation: unhandled top level doc tag pre

§Static Properties