@aws-sdk/client-pipes 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,54 +11,63 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
11
11
  import { UpdatePipeCommandInput, UpdatePipeCommandOutput } from "./commands/UpdatePipeCommand";
12
12
  import { PipesClient } from "./PipesClient";
13
13
  /**
14
+ * @public
14
15
  * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
15
16
  * event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
16
17
  * To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. </p>
17
18
  */
18
19
  export declare class Pipes extends PipesClient {
19
20
  /**
21
+ * @public
20
22
  * <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.</p>
21
23
  */
22
24
  createPipe(args: CreatePipeCommandInput, options?: __HttpHandlerOptions): Promise<CreatePipeCommandOutput>;
23
25
  createPipe(args: CreatePipeCommandInput, cb: (err: any, data?: CreatePipeCommandOutput) => void): void;
24
26
  createPipe(args: CreatePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipeCommandOutput) => void): void;
25
27
  /**
28
+ * @public
26
29
  * <p>Delete an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
27
30
  */
28
31
  deletePipe(args: DeletePipeCommandInput, options?: __HttpHandlerOptions): Promise<DeletePipeCommandOutput>;
29
32
  deletePipe(args: DeletePipeCommandInput, cb: (err: any, data?: DeletePipeCommandOutput) => void): void;
30
33
  deletePipe(args: DeletePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipeCommandOutput) => void): void;
31
34
  /**
35
+ * @public
32
36
  * <p>Get the information about an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
33
37
  */
34
38
  describePipe(args: DescribePipeCommandInput, options?: __HttpHandlerOptions): Promise<DescribePipeCommandOutput>;
35
39
  describePipe(args: DescribePipeCommandInput, cb: (err: any, data?: DescribePipeCommandOutput) => void): void;
36
40
  describePipe(args: DescribePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipeCommandOutput) => void): void;
37
41
  /**
42
+ * @public
38
43
  * <p>Get the pipes associated with this account. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
39
44
  */
40
45
  listPipes(args: ListPipesCommandInput, options?: __HttpHandlerOptions): Promise<ListPipesCommandOutput>;
41
46
  listPipes(args: ListPipesCommandInput, cb: (err: any, data?: ListPipesCommandOutput) => void): void;
42
47
  listPipes(args: ListPipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipesCommandOutput) => void): void;
43
48
  /**
49
+ * @public
44
50
  * <p>Displays the tags associated with a pipe.</p>
45
51
  */
46
52
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
47
53
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
48
54
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
49
55
  /**
56
+ * @public
50
57
  * <p>Start an existing pipe.</p>
51
58
  */
52
59
  startPipe(args: StartPipeCommandInput, options?: __HttpHandlerOptions): Promise<StartPipeCommandOutput>;
53
60
  startPipe(args: StartPipeCommandInput, cb: (err: any, data?: StartPipeCommandOutput) => void): void;
54
61
  startPipe(args: StartPipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPipeCommandOutput) => void): void;
55
62
  /**
63
+ * @public
56
64
  * <p>Stop an existing pipe.</p>
57
65
  */
58
66
  stopPipe(args: StopPipeCommandInput, options?: __HttpHandlerOptions): Promise<StopPipeCommandOutput>;
59
67
  stopPipe(args: StopPipeCommandInput, cb: (err: any, data?: StopPipeCommandOutput) => void): void;
60
68
  stopPipe(args: StopPipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPipeCommandOutput) => void): void;
61
69
  /**
70
+ * @public
62
71
  * <p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can
63
72
  * help you organize and categorize your resources. You can also use them to scope user
64
73
  * permissions by granting a user permission to access or change only resources with certain tag
@@ -75,12 +84,14 @@ export declare class Pipes extends PipesClient {
75
84
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
76
85
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
77
86
  /**
87
+ * @public
78
88
  * <p>Removes one or more tags from the specified pipes.</p>
79
89
  */
80
90
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
81
91
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
82
92
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
83
93
  /**
94
+ * @public
84
95
  * <p>Update an existing pipe. When you call <code>UpdatePipe</code>, only the fields that are included in the request are changed, the rest are unchanged.
85
96
  * The exception to this is if you modify any Amazon Web Services-service specific fields in the <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
86
97
  * <code>TargetParameters</code> objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that
@@ -18,15 +18,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
18
18
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
19
19
  import { UpdatePipeCommandInput, UpdatePipeCommandOutput } from "./commands/UpdatePipeCommand";
20
20
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
21
+ /**
22
+ * @public
23
+ */
21
24
  export type ServiceInputTypes = CreatePipeCommandInput | DeletePipeCommandInput | DescribePipeCommandInput | ListPipesCommandInput | ListTagsForResourceCommandInput | StartPipeCommandInput | StopPipeCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdatePipeCommandInput;
25
+ /**
26
+ * @public
27
+ */
22
28
  export type ServiceOutputTypes = CreatePipeCommandOutput | DeletePipeCommandOutput | DescribePipeCommandOutput | ListPipesCommandOutput | ListTagsForResourceCommandOutput | StartPipeCommandOutput | StopPipeCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdatePipeCommandOutput;
29
+ /**
30
+ * @public
31
+ */
23
32
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
24
33
  /**
25
34
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
26
35
  */
27
36
  requestHandler?: __HttpHandler;
28
37
  /**
29
- * A constructor for a class implementing the {@link __Checksum} interface
38
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
30
39
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
31
40
  * @internal
32
41
  */
@@ -116,23 +125,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
116
125
  */
117
126
  logger?: __Logger;
118
127
  /**
119
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
128
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
120
129
  */
121
130
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
122
131
  }
132
+ /**
133
+ * @public
134
+ */
123
135
  type PipesClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
124
136
  /**
125
- * The configuration interface of PipesClient class constructor that set the region, credentials and other options.
137
+ * @public
138
+ *
139
+ * The configuration interface of PipesClient class constructor that set the region, credentials and other options.
126
140
  */
127
141
  export interface PipesClientConfig extends PipesClientConfigType {
128
142
  }
143
+ /**
144
+ * @public
145
+ */
129
146
  type PipesClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
130
147
  /**
131
- * The resolved configuration interface of PipesClient class. This is resolved and normalized from the {@link PipesClientConfig | constructor configuration interface}.
148
+ * @public
149
+ *
150
+ * The resolved configuration interface of PipesClient class. This is resolved and normalized from the {@link PipesClientConfig | constructor configuration interface}.
132
151
  */
133
152
  export interface PipesClientResolvedConfig extends PipesClientResolvedConfigType {
134
153
  }
135
154
  /**
155
+ * @public
136
156
  * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
137
157
  * event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
138
158
  * To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. </p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreatePipeRequest, CreatePipeResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePipeCommand}.
8
10
  */
9
11
  export interface CreatePipeCommandInput extends CreatePipeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePipeCommand}.
13
17
  */
14
18
  export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreatePipeCommandInput - {@link CreatePipeCommandInput}
34
+ * @returns {@link CreatePipeCommandOutput}
28
35
  * @see {@link CreatePipeCommandInput} for command's `input` shape.
29
36
  * @see {@link CreatePipeCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB
52
59
  export declare class CreatePipeCommand extends $Command<CreatePipeCommandInput, CreatePipeCommandOutput, PipesClientResolvedConfig> {
53
60
  readonly input: CreatePipeCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreatePipeCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePipeCommandInput, CreatePipeCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeletePipeRequest, DeletePipeResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePipeCommand}.
8
10
  */
9
11
  export interface DeletePipeCommandInput extends DeletePipeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePipeCommand}.
13
17
  */
14
18
  export interface DeletePipeCommandOutput extends DeletePipeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeletePipeCommandOutput extends DeletePipeResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeletePipeCommandInput - {@link DeletePipeCommandInput}
34
+ * @returns {@link DeletePipeCommandOutput}
28
35
  * @see {@link DeletePipeCommandInput} for command's `input` shape.
29
36
  * @see {@link DeletePipeCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeletePipeCommandOutput extends DeletePipeResponse, __MetadataB
49
56
  export declare class DeletePipeCommand extends $Command<DeletePipeCommandInput, DeletePipeCommandOutput, PipesClientResolvedConfig> {
50
57
  readonly input: DeletePipeCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeletePipeCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePipeCommandInput, DeletePipeCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribePipeRequest, DescribePipeResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePipeCommand}.
8
10
  */
9
11
  export interface DescribePipeCommandInput extends DescribePipeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePipeCommand}.
13
17
  */
14
18
  export interface DescribePipeCommandOutput extends DescribePipeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get the information about an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribePipeCommandInput - {@link DescribePipeCommandInput}
34
+ * @returns {@link DescribePipeCommandOutput}
28
35
  * @see {@link DescribePipeCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribePipeCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad
46
53
  export declare class DescribePipeCommand extends $Command<DescribePipeCommandInput, DescribePipeCommandOutput, PipesClientResolvedConfig> {
47
54
  readonly input: DescribePipeCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribePipeCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePipeCommandInput, DescribePipeCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListPipesRequest, ListPipesResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPipesCommand}.
8
10
  */
9
11
  export interface ListPipesCommandInput extends ListPipesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPipesCommand}.
13
17
  */
14
18
  export interface ListPipesCommandOutput extends ListPipesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get the pipes associated with this account. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListPipesCommandOutput extends ListPipesResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListPipesCommandInput - {@link ListPipesCommandInput}
34
+ * @returns {@link ListPipesCommandOutput}
28
35
  * @see {@link ListPipesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListPipesCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListPipesCommandOutput extends ListPipesResponse, __MetadataBea
43
50
  export declare class ListPipesCommand extends $Command<ListPipesCommandInput, ListPipesCommandOutput, PipesClientResolvedConfig> {
44
51
  readonly input: ListPipesCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListPipesCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPipesCommandInput, ListPipesCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Displays the tags associated with a pipe.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
43
50
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, PipesClientResolvedConfig> {
44
51
  readonly input: ListTagsForResourceCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListTagsForResourceCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartPipeRequest, StartPipeResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartPipeCommand}.
8
10
  */
9
11
  export interface StartPipeCommandInput extends StartPipeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartPipeCommand}.
13
17
  */
14
18
  export interface StartPipeCommandOutput extends StartPipeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Start an existing pipe.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartPipeCommandOutput extends StartPipeResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartPipeCommandInput - {@link StartPipeCommandInput}
34
+ * @returns {@link StartPipeCommandOutput}
28
35
  * @see {@link StartPipeCommandInput} for command's `input` shape.
29
36
  * @see {@link StartPipeCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartPipeCommandOutput extends StartPipeResponse, __MetadataBea
49
56
  export declare class StartPipeCommand extends $Command<StartPipeCommandInput, StartPipeCommandOutput, PipesClientResolvedConfig> {
50
57
  readonly input: StartPipeCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: StartPipeCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartPipeCommandInput, StartPipeCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StopPipeRequest, StopPipeResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopPipeCommand}.
8
10
  */
9
11
  export interface StopPipeCommandInput extends StopPipeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopPipeCommand}.
13
17
  */
14
18
  export interface StopPipeCommandOutput extends StopPipeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stop an existing pipe.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopPipeCommandOutput extends StopPipeResponse, __MetadataBeare
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StopPipeCommandInput - {@link StopPipeCommandInput}
34
+ * @returns {@link StopPipeCommandOutput}
28
35
  * @see {@link StopPipeCommandInput} for command's `input` shape.
29
36
  * @see {@link StopPipeCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StopPipeCommandOutput extends StopPipeResponse, __MetadataBeare
49
56
  export declare class StopPipeCommand extends $Command<StopPipeCommandInput, StopPipeCommandOutput, PipesClientResolvedConfig> {
50
57
  readonly input: StopPipeCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: StopPipeCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopPipeCommandInput, StopPipeCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can
18
23
  * help you organize and categorize your resources. You can also use them to scope user
19
24
  * permissions by granting a user permission to access or change only resources with certain tag
@@ -35,6 +40,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
44
+ * @returns {@link TagResourceCommandOutput}
38
45
  * @see {@link TagResourceCommandInput} for command's `input` shape.
39
46
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
40
47
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -53,11 +60,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
53
60
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, PipesClientResolvedConfig> {
54
61
  readonly input: TagResourceCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: TagResourceCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more tags from the specified pipes.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -43,11 +50,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
43
50
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, PipesClientResolvedConfig> {
44
51
  readonly input: UntagResourceCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: UntagResourceCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdatePipeRequest, UpdatePipeResponse } from "../models/models_0";
5
5
  import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdatePipeCommand}.
8
10
  */
9
11
  export interface UpdatePipeCommandInput extends UpdatePipeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdatePipeCommand}.
13
17
  */
14
18
  export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update an existing pipe. When you call <code>UpdatePipe</code>, only the fields that are included in the request are changed, the rest are unchanged.
18
23
  * The exception to this is if you modify any Amazon Web Services-service specific fields in the <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
19
24
  * <code>TargetParameters</code> objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that
@@ -30,6 +35,8 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdatePipeCommandInput - {@link UpdatePipeCommandInput}
39
+ * @returns {@link UpdatePipeCommandOutput}
33
40
  * @see {@link UpdatePipeCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdatePipeCommandOutput} for command's `response` shape.
35
42
  * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
54
61
  export declare class UpdatePipeCommand extends $Command<UpdatePipeCommandInput, UpdatePipeCommandOutput, PipesClientResolvedConfig> {
55
62
  readonly input: UpdatePipeCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdatePipeCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePipeCommandInput, UpdatePipeCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }