@aws-sdk/client-firehose 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.
@@ -13,6 +13,7 @@ import { UntagDeliveryStreamCommandInput, UntagDeliveryStreamCommandOutput } fro
13
13
  import { UpdateDestinationCommandInput, UpdateDestinationCommandOutput } from "./commands/UpdateDestinationCommand";
14
14
  import { FirehoseClient } from "./FirehoseClient";
15
15
  /**
16
+ * @public
16
17
  * <fullname>Amazon Kinesis Data Firehose API Reference</fullname>
17
18
  * <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time
18
19
  * streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
@@ -21,6 +22,7 @@ import { FirehoseClient } from "./FirehoseClient";
21
22
  */
22
23
  export declare class Firehose extends FirehoseClient {
23
24
  /**
25
+ * @public
24
26
  * <p>Creates a Kinesis Data Firehose delivery stream.</p>
25
27
  *
26
28
  * <p>By default, you can create up to 50 delivery streams per Amazon Web Services
@@ -96,6 +98,7 @@ export declare class Firehose extends FirehoseClient {
96
98
  createDeliveryStream(args: CreateDeliveryStreamCommandInput, cb: (err: any, data?: CreateDeliveryStreamCommandOutput) => void): void;
97
99
  createDeliveryStream(args: CreateDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeliveryStreamCommandOutput) => void): void;
98
100
  /**
101
+ * @public
99
102
  * <p>Deletes a delivery stream and its data.</p>
100
103
  * <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. You can delete a delivery stream only if it is in one of the following states:
101
104
  * <code>ACTIVE</code>, <code>DELETING</code>, <code>CREATING_FAILED</code>, or
@@ -111,6 +114,7 @@ export declare class Firehose extends FirehoseClient {
111
114
  deleteDeliveryStream(args: DeleteDeliveryStreamCommandInput, cb: (err: any, data?: DeleteDeliveryStreamCommandOutput) => void): void;
112
115
  deleteDeliveryStream(args: DeleteDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeliveryStreamCommandOutput) => void): void;
113
116
  /**
117
+ * @public
114
118
  * <p>Describes the specified delivery stream and its status. For example, after your
115
119
  * delivery stream is created, call <code>DescribeDeliveryStream</code> to see whether the
116
120
  * delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it. </p>
@@ -123,6 +127,7 @@ export declare class Firehose extends FirehoseClient {
123
127
  describeDeliveryStream(args: DescribeDeliveryStreamCommandInput, cb: (err: any, data?: DescribeDeliveryStreamCommandOutput) => void): void;
124
128
  describeDeliveryStream(args: DescribeDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryStreamCommandOutput) => void): void;
125
129
  /**
130
+ * @public
126
131
  * <p>Lists your delivery streams in alphabetical order of their names.</p>
127
132
  * <p>The number of delivery streams might be too large to return using a single call to
128
133
  * <code>ListDeliveryStreams</code>. You can limit the number of delivery streams returned,
@@ -136,6 +141,7 @@ export declare class Firehose extends FirehoseClient {
136
141
  listDeliveryStreams(args: ListDeliveryStreamsCommandInput, cb: (err: any, data?: ListDeliveryStreamsCommandOutput) => void): void;
137
142
  listDeliveryStreams(args: ListDeliveryStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeliveryStreamsCommandOutput) => void): void;
138
143
  /**
144
+ * @public
139
145
  * <p>Lists the tags for the specified delivery stream. This operation has a limit of five
140
146
  * transactions per second per account. </p>
141
147
  */
@@ -143,6 +149,7 @@ export declare class Firehose extends FirehoseClient {
143
149
  listTagsForDeliveryStream(args: ListTagsForDeliveryStreamCommandInput, cb: (err: any, data?: ListTagsForDeliveryStreamCommandOutput) => void): void;
144
150
  listTagsForDeliveryStream(args: ListTagsForDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForDeliveryStreamCommandOutput) => void): void;
145
151
  /**
152
+ * @public
146
153
  * <p>Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To
147
154
  * write multiple data records into a delivery stream, use <a>PutRecordBatch</a>.
148
155
  * Applications using these operations are referred to as producers.</p>
@@ -180,6 +187,7 @@ export declare class Firehose extends FirehoseClient {
180
187
  putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void;
181
188
  putRecord(args: PutRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordCommandOutput) => void): void;
182
189
  /**
190
+ * @public
183
191
  * <p>Writes multiple data records into a delivery stream in a single call, which can
184
192
  * achieve higher throughput per producer than when writing single records. To write single
185
193
  * data records into a delivery stream, use <a>PutRecord</a>. Applications using
@@ -236,6 +244,7 @@ export declare class Firehose extends FirehoseClient {
236
244
  putRecordBatch(args: PutRecordBatchCommandInput, cb: (err: any, data?: PutRecordBatchCommandOutput) => void): void;
237
245
  putRecordBatch(args: PutRecordBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordBatchCommandOutput) => void): void;
238
246
  /**
247
+ * @public
239
248
  * <p>Enables server-side encryption (SSE) for the delivery stream. </p>
240
249
  * <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data
241
250
  * Firehose first sets the encryption status of the stream to <code>ENABLING</code>, and then
@@ -277,6 +286,7 @@ export declare class Firehose extends FirehoseClient {
277
286
  startDeliveryStreamEncryption(args: StartDeliveryStreamEncryptionCommandInput, cb: (err: any, data?: StartDeliveryStreamEncryptionCommandOutput) => void): void;
278
287
  startDeliveryStreamEncryption(args: StartDeliveryStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeliveryStreamEncryptionCommandOutput) => void): void;
279
288
  /**
289
+ * @public
280
290
  * <p>Disables server-side encryption (SSE) for the delivery stream. </p>
281
291
  * <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data
282
292
  * Firehose first sets the encryption status of the stream to <code>DISABLING</code>, and then
@@ -302,6 +312,7 @@ export declare class Firehose extends FirehoseClient {
302
312
  stopDeliveryStreamEncryption(args: StopDeliveryStreamEncryptionCommandInput, cb: (err: any, data?: StopDeliveryStreamEncryptionCommandOutput) => void): void;
303
313
  stopDeliveryStreamEncryption(args: StopDeliveryStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDeliveryStreamEncryptionCommandOutput) => void): void;
304
314
  /**
315
+ * @public
305
316
  * <p>Adds or updates tags for the specified delivery stream. A tag is a key-value pair
306
317
  * that you can define and assign to Amazon Web Services resources. If you specify a tag that
307
318
  * already exists, the tag value is replaced with the value that you specify in the request.
@@ -317,6 +328,7 @@ export declare class Firehose extends FirehoseClient {
317
328
  tagDeliveryStream(args: TagDeliveryStreamCommandInput, cb: (err: any, data?: TagDeliveryStreamCommandOutput) => void): void;
318
329
  tagDeliveryStream(args: TagDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagDeliveryStreamCommandOutput) => void): void;
319
330
  /**
331
+ * @public
320
332
  * <p>Removes tags from the specified delivery stream. Removed tags are deleted, and you
321
333
  * can't recover them after this operation successfully completes.</p>
322
334
  * <p>If you specify a tag that doesn't exist, the operation ignores it.</p>
@@ -326,6 +338,7 @@ export declare class Firehose extends FirehoseClient {
326
338
  untagDeliveryStream(args: UntagDeliveryStreamCommandInput, cb: (err: any, data?: UntagDeliveryStreamCommandOutput) => void): void;
327
339
  untagDeliveryStream(args: UntagDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagDeliveryStreamCommandOutput) => void): void;
328
340
  /**
341
+ * @public
329
342
  * <p>Updates the specified destination of the specified delivery stream.</p>
330
343
  *
331
344
  * <p>Use this operation to change the destination type (for example, to replace the Amazon
@@ -20,15 +20,24 @@ import { TagDeliveryStreamCommandInput, TagDeliveryStreamCommandOutput } from ".
20
20
  import { UntagDeliveryStreamCommandInput, UntagDeliveryStreamCommandOutput } from "./commands/UntagDeliveryStreamCommand";
21
21
  import { UpdateDestinationCommandInput, UpdateDestinationCommandOutput } from "./commands/UpdateDestinationCommand";
22
22
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
23
+ /**
24
+ * @public
25
+ */
23
26
  export type ServiceInputTypes = CreateDeliveryStreamCommandInput | DeleteDeliveryStreamCommandInput | DescribeDeliveryStreamCommandInput | ListDeliveryStreamsCommandInput | ListTagsForDeliveryStreamCommandInput | PutRecordBatchCommandInput | PutRecordCommandInput | StartDeliveryStreamEncryptionCommandInput | StopDeliveryStreamEncryptionCommandInput | TagDeliveryStreamCommandInput | UntagDeliveryStreamCommandInput | UpdateDestinationCommandInput;
27
+ /**
28
+ * @public
29
+ */
24
30
  export type ServiceOutputTypes = CreateDeliveryStreamCommandOutput | DeleteDeliveryStreamCommandOutput | DescribeDeliveryStreamCommandOutput | ListDeliveryStreamsCommandOutput | ListTagsForDeliveryStreamCommandOutput | PutRecordBatchCommandOutput | PutRecordCommandOutput | StartDeliveryStreamEncryptionCommandOutput | StopDeliveryStreamEncryptionCommandOutput | TagDeliveryStreamCommandOutput | UntagDeliveryStreamCommandOutput | UpdateDestinationCommandOutput;
31
+ /**
32
+ * @public
33
+ */
25
34
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
26
35
  /**
27
36
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
28
37
  */
29
38
  requestHandler?: __HttpHandler;
30
39
  /**
31
- * A constructor for a class implementing the {@link __Checksum} interface
40
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
32
41
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
33
42
  * @internal
34
43
  */
@@ -118,23 +127,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
118
127
  */
119
128
  logger?: __Logger;
120
129
  /**
121
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
130
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
122
131
  */
123
132
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
124
133
  }
134
+ /**
135
+ * @public
136
+ */
125
137
  type FirehoseClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
126
138
  /**
127
- * The configuration interface of FirehoseClient class constructor that set the region, credentials and other options.
139
+ * @public
140
+ *
141
+ * The configuration interface of FirehoseClient class constructor that set the region, credentials and other options.
128
142
  */
129
143
  export interface FirehoseClientConfig extends FirehoseClientConfigType {
130
144
  }
145
+ /**
146
+ * @public
147
+ */
131
148
  type FirehoseClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
132
149
  /**
133
- * The resolved configuration interface of FirehoseClient class. This is resolved and normalized from the {@link FirehoseClientConfig | constructor configuration interface}.
150
+ * @public
151
+ *
152
+ * The resolved configuration interface of FirehoseClient class. This is resolved and normalized from the {@link FirehoseClientConfig | constructor configuration interface}.
134
153
  */
135
154
  export interface FirehoseClientResolvedConfig extends FirehoseClientResolvedConfigType {
136
155
  }
137
156
  /**
157
+ * @public
138
158
  * <fullname>Amazon Kinesis Data Firehose API Reference</fullname>
139
159
  * <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time
140
160
  * streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { CreateDeliveryStreamInput, CreateDeliveryStreamOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDeliveryStreamCommand}.
8
10
  */
9
11
  export interface CreateDeliveryStreamCommandInput extends CreateDeliveryStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDeliveryStreamCommand}.
13
17
  */
14
18
  export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a Kinesis Data Firehose delivery stream.</p>
18
23
  *
19
24
  * <p>By default, you can create up to 50 delivery streams per Amazon Web Services
@@ -94,6 +99,8 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
94
99
  * const response = await client.send(command);
95
100
  * ```
96
101
  *
102
+ * @param CreateDeliveryStreamCommandInput - {@link CreateDeliveryStreamCommandInput}
103
+ * @returns {@link CreateDeliveryStreamCommandOutput}
97
104
  * @see {@link CreateDeliveryStreamCommandInput} for command's `input` shape.
98
105
  * @see {@link CreateDeliveryStreamCommandOutput} for command's `response` shape.
99
106
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -119,11 +126,20 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO
119
126
  export declare class CreateDeliveryStreamCommand extends $Command<CreateDeliveryStreamCommandInput, CreateDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
120
127
  readonly input: CreateDeliveryStreamCommandInput;
121
128
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
129
+ /**
130
+ * @public
131
+ */
122
132
  constructor(input: CreateDeliveryStreamCommandInput);
123
133
  /**
124
134
  * @internal
125
135
  */
126
136
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDeliveryStreamCommandInput, CreateDeliveryStreamCommandOutput>;
137
+ /**
138
+ * @internal
139
+ */
127
140
  private serialize;
141
+ /**
142
+ * @internal
143
+ */
128
144
  private deserialize;
129
145
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { DeleteDeliveryStreamInput, DeleteDeliveryStreamOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDeliveryStreamCommand}.
8
10
  */
9
11
  export interface DeleteDeliveryStreamCommandInput extends DeleteDeliveryStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDeliveryStreamCommand}.
13
17
  */
14
18
  export interface DeleteDeliveryStreamCommandOutput extends DeleteDeliveryStreamOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a delivery stream and its data.</p>
18
23
  * <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. You can delete a delivery stream only if it is in one of the following states:
19
24
  * <code>ACTIVE</code>, <code>DELETING</code>, <code>CREATING_FAILED</code>, or
@@ -34,6 +39,8 @@ export interface DeleteDeliveryStreamCommandOutput extends DeleteDeliveryStreamO
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DeleteDeliveryStreamCommandInput - {@link DeleteDeliveryStreamCommandInput}
43
+ * @returns {@link DeleteDeliveryStreamCommandOutput}
37
44
  * @see {@link DeleteDeliveryStreamCommandInput} for command's `input` shape.
38
45
  * @see {@link DeleteDeliveryStreamCommandOutput} for command's `response` shape.
39
46
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteDeliveryStreamCommandOutput extends DeleteDeliveryStreamO
49
56
  export declare class DeleteDeliveryStreamCommand extends $Command<DeleteDeliveryStreamCommandInput, DeleteDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
50
57
  readonly input: DeleteDeliveryStreamCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteDeliveryStreamCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDeliveryStreamCommandInput, DeleteDeliveryStreamCommandOutput>;
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 { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { DescribeDeliveryStreamInput, DescribeDeliveryStreamOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDeliveryStreamCommand}.
8
10
  */
9
11
  export interface DescribeDeliveryStreamCommandInput extends DescribeDeliveryStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDeliveryStreamCommand}.
13
17
  */
14
18
  export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStreamOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified delivery stream and its status. For example, after your
18
23
  * delivery stream is created, call <code>DescribeDeliveryStream</code> to see whether the
19
24
  * delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it. </p>
@@ -31,6 +36,8 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DescribeDeliveryStreamCommandInput - {@link DescribeDeliveryStreamCommandInput}
40
+ * @returns {@link DescribeDeliveryStreamCommandOutput}
34
41
  * @see {@link DescribeDeliveryStreamCommandInput} for command's `input` shape.
35
42
  * @see {@link DescribeDeliveryStreamCommandOutput} for command's `response` shape.
36
43
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr
43
50
  export declare class DescribeDeliveryStreamCommand extends $Command<DescribeDeliveryStreamCommandInput, DescribeDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
44
51
  readonly input: DescribeDeliveryStreamCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeDeliveryStreamCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDeliveryStreamCommandInput, DescribeDeliveryStreamCommandOutput>;
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 { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { ListDeliveryStreamsInput, ListDeliveryStreamsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDeliveryStreamsCommand}.
8
10
  */
9
11
  export interface ListDeliveryStreamsCommandInput extends ListDeliveryStreamsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDeliveryStreamsCommand}.
13
17
  */
14
18
  export interface ListDeliveryStreamsCommandOutput extends ListDeliveryStreamsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists your delivery streams in alphabetical order of their names.</p>
18
23
  * <p>The number of delivery streams might be too large to return using a single call to
19
24
  * <code>ListDeliveryStreams</code>. You can limit the number of delivery streams returned,
@@ -32,6 +37,8 @@ export interface ListDeliveryStreamsCommandOutput extends ListDeliveryStreamsOut
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param ListDeliveryStreamsCommandInput - {@link ListDeliveryStreamsCommandInput}
41
+ * @returns {@link ListDeliveryStreamsCommandOutput}
35
42
  * @see {@link ListDeliveryStreamsCommandInput} for command's `input` shape.
36
43
  * @see {@link ListDeliveryStreamsCommandOutput} for command's `response` shape.
37
44
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListDeliveryStreamsCommandOutput extends ListDeliveryStreamsOut
41
48
  export declare class ListDeliveryStreamsCommand extends $Command<ListDeliveryStreamsCommandInput, ListDeliveryStreamsCommandOutput, FirehoseClientResolvedConfig> {
42
49
  readonly input: ListDeliveryStreamsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListDeliveryStreamsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDeliveryStreamsCommandInput, ListDeliveryStreamsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { ListTagsForDeliveryStreamInput, ListTagsForDeliveryStreamOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForDeliveryStreamCommand}.
8
10
  */
9
11
  export interface ListTagsForDeliveryStreamCommandInput extends ListTagsForDeliveryStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForDeliveryStreamCommand}.
13
17
  */
14
18
  export interface ListTagsForDeliveryStreamCommandOutput extends ListTagsForDeliveryStreamOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags for the specified delivery stream. This operation has a limit of five
18
23
  * transactions per second per account. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListTagsForDeliveryStreamCommandOutput extends ListTagsForDeliv
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListTagsForDeliveryStreamCommandInput - {@link ListTagsForDeliveryStreamCommandInput}
35
+ * @returns {@link ListTagsForDeliveryStreamCommandOutput}
29
36
  * @see {@link ListTagsForDeliveryStreamCommandInput} for command's `input` shape.
30
37
  * @see {@link ListTagsForDeliveryStreamCommandOutput} for command's `response` shape.
31
38
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListTagsForDeliveryStreamCommandOutput extends ListTagsForDeliv
44
51
  export declare class ListTagsForDeliveryStreamCommand extends $Command<ListTagsForDeliveryStreamCommandInput, ListTagsForDeliveryStreamCommandOutput, FirehoseClientResolvedConfig> {
45
52
  readonly input: ListTagsForDeliveryStreamCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListTagsForDeliveryStreamCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForDeliveryStreamCommandInput, ListTagsForDeliveryStreamCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { PutRecordBatchInput, PutRecordBatchOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutRecordBatchCommand}.
8
10
  */
9
11
  export interface PutRecordBatchCommandInput extends PutRecordBatchInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutRecordBatchCommand}.
13
17
  */
14
18
  export interface PutRecordBatchCommandOutput extends PutRecordBatchOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Writes multiple data records into a delivery stream in a single call, which can
18
23
  * achieve higher throughput per producer than when writing single records. To write single
19
24
  * data records into a delivery stream, use <a>PutRecord</a>. Applications using
@@ -75,6 +80,8 @@ export interface PutRecordBatchCommandOutput extends PutRecordBatchOutput, __Met
75
80
  * const response = await client.send(command);
76
81
  * ```
77
82
  *
83
+ * @param PutRecordBatchCommandInput - {@link PutRecordBatchCommandInput}
84
+ * @returns {@link PutRecordBatchCommandOutput}
78
85
  * @see {@link PutRecordBatchCommandInput} for command's `input` shape.
79
86
  * @see {@link PutRecordBatchCommandOutput} for command's `response` shape.
80
87
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -103,11 +110,20 @@ export interface PutRecordBatchCommandOutput extends PutRecordBatchOutput, __Met
103
110
  export declare class PutRecordBatchCommand extends $Command<PutRecordBatchCommandInput, PutRecordBatchCommandOutput, FirehoseClientResolvedConfig> {
104
111
  readonly input: PutRecordBatchCommandInput;
105
112
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
113
+ /**
114
+ * @public
115
+ */
106
116
  constructor(input: PutRecordBatchCommandInput);
107
117
  /**
108
118
  * @internal
109
119
  */
110
120
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRecordBatchCommandInput, PutRecordBatchCommandOutput>;
121
+ /**
122
+ * @internal
123
+ */
111
124
  private serialize;
125
+ /**
126
+ * @internal
127
+ */
112
128
  private deserialize;
113
129
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { PutRecordInput, PutRecordOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutRecordCommand}.
8
10
  */
9
11
  export interface PutRecordCommandInput extends PutRecordInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutRecordCommand}.
13
17
  */
14
18
  export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To
18
23
  * write multiple data records into a delivery stream, use <a>PutRecordBatch</a>.
19
24
  * Applications using these operations are referred to as producers.</p>
@@ -56,6 +61,8 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
56
61
  * const response = await client.send(command);
57
62
  * ```
58
63
  *
64
+ * @param PutRecordCommandInput - {@link PutRecordCommandInput}
65
+ * @returns {@link PutRecordCommandOutput}
59
66
  * @see {@link PutRecordCommandInput} for command's `input` shape.
60
67
  * @see {@link PutRecordCommandOutput} for command's `response` shape.
61
68
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -84,11 +91,20 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
84
91
  export declare class PutRecordCommand extends $Command<PutRecordCommandInput, PutRecordCommandOutput, FirehoseClientResolvedConfig> {
85
92
  readonly input: PutRecordCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: PutRecordCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRecordCommandInput, PutRecordCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { StartDeliveryStreamEncryptionInput, StartDeliveryStreamEncryptionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartDeliveryStreamEncryptionCommand}.
8
10
  */
9
11
  export interface StartDeliveryStreamEncryptionCommandInput extends StartDeliveryStreamEncryptionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartDeliveryStreamEncryptionCommand}.
13
17
  */
14
18
  export interface StartDeliveryStreamEncryptionCommandOutput extends StartDeliveryStreamEncryptionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables server-side encryption (SSE) for the delivery stream. </p>
18
23
  * <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data
19
24
  * Firehose first sets the encryption status of the stream to <code>ENABLING</code>, and then
@@ -60,6 +65,8 @@ export interface StartDeliveryStreamEncryptionCommandOutput extends StartDeliver
60
65
  * const response = await client.send(command);
61
66
  * ```
62
67
  *
68
+ * @param StartDeliveryStreamEncryptionCommandInput - {@link StartDeliveryStreamEncryptionCommandInput}
69
+ * @returns {@link StartDeliveryStreamEncryptionCommandOutput}
63
70
  * @see {@link StartDeliveryStreamEncryptionCommandInput} for command's `input` shape.
64
71
  * @see {@link StartDeliveryStreamEncryptionCommandOutput} for command's `response` shape.
65
72
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -88,11 +95,20 @@ export interface StartDeliveryStreamEncryptionCommandOutput extends StartDeliver
88
95
  export declare class StartDeliveryStreamEncryptionCommand extends $Command<StartDeliveryStreamEncryptionCommandInput, StartDeliveryStreamEncryptionCommandOutput, FirehoseClientResolvedConfig> {
89
96
  readonly input: StartDeliveryStreamEncryptionCommandInput;
90
97
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
98
+ /**
99
+ * @public
100
+ */
91
101
  constructor(input: StartDeliveryStreamEncryptionCommandInput);
92
102
  /**
93
103
  * @internal
94
104
  */
95
105
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDeliveryStreamEncryptionCommandInput, StartDeliveryStreamEncryptionCommandOutput>;
106
+ /**
107
+ * @internal
108
+ */
96
109
  private serialize;
110
+ /**
111
+ * @internal
112
+ */
97
113
  private deserialize;
98
114
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FirehoseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FirehoseClient";
5
5
  import { StopDeliveryStreamEncryptionInput, StopDeliveryStreamEncryptionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopDeliveryStreamEncryptionCommand}.
8
10
  */
9
11
  export interface StopDeliveryStreamEncryptionCommandInput extends StopDeliveryStreamEncryptionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopDeliveryStreamEncryptionCommand}.
13
17
  */
14
18
  export interface StopDeliveryStreamEncryptionCommandOutput extends StopDeliveryStreamEncryptionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables server-side encryption (SSE) for the delivery stream. </p>
18
23
  * <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data
19
24
  * Firehose first sets the encryption status of the stream to <code>DISABLING</code>, and then
@@ -44,6 +49,8 @@ export interface StopDeliveryStreamEncryptionCommandOutput extends StopDeliveryS
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param StopDeliveryStreamEncryptionCommandInput - {@link StopDeliveryStreamEncryptionCommandInput}
53
+ * @returns {@link StopDeliveryStreamEncryptionCommandOutput}
47
54
  * @see {@link StopDeliveryStreamEncryptionCommandInput} for command's `input` shape.
48
55
  * @see {@link StopDeliveryStreamEncryptionCommandOutput} for command's `response` shape.
49
56
  * @see {@link FirehoseClientResolvedConfig | config} for FirehoseClient's `config` shape.
@@ -65,11 +72,20 @@ export interface StopDeliveryStreamEncryptionCommandOutput extends StopDeliveryS
65
72
  export declare class StopDeliveryStreamEncryptionCommand extends $Command<StopDeliveryStreamEncryptionCommandInput, StopDeliveryStreamEncryptionCommandOutput, FirehoseClientResolvedConfig> {
66
73
  readonly input: StopDeliveryStreamEncryptionCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: StopDeliveryStreamEncryptionCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FirehoseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopDeliveryStreamEncryptionCommandInput, StopDeliveryStreamEncryptionCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }