@aws-sdk/client-kinesis 3.1121.0 → 3.1123.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.
Files changed (71) hide show
  1. package/README.md +35 -0
  2. package/dist-cjs/index.js +834 -310
  3. package/dist-es/Kinesis.js +14 -0
  4. package/dist-es/commandBuilder.js +7 -3
  5. package/dist-es/commands/CreateChannelCommand.js +4 -0
  6. package/dist-es/commands/DeleteChannelCommand.js +4 -0
  7. package/dist-es/commands/DeleteResourcePolicyCommand.js +2 -2
  8. package/dist-es/commands/DeregisterStreamConsumerCommand.js +2 -2
  9. package/dist-es/commands/DescribeChannelCommand.js +4 -0
  10. package/dist-es/commands/DescribeStreamConsumerCommand.js +2 -2
  11. package/dist-es/commands/GetRecordsCommand.js +2 -2
  12. package/dist-es/commands/GetResourcePolicyCommand.js +2 -2
  13. package/dist-es/commands/GetShardIteratorCommand.js +2 -2
  14. package/dist-es/commands/ListChannelsCommand.js +4 -0
  15. package/dist-es/commands/ListTagsForResourceCommand.js +2 -2
  16. package/dist-es/commands/PutRecordCommand.js +2 -2
  17. package/dist-es/commands/PutRecordsCommand.js +2 -2
  18. package/dist-es/commands/PutResourcePolicyCommand.js +2 -2
  19. package/dist-es/commands/SubscribeToShardCommand.js +2 -2
  20. package/dist-es/commands/TagResourceCommand.js +2 -2
  21. package/dist-es/commands/UntagResourceCommand.js +2 -2
  22. package/dist-es/commands/UpdateChannelCommand.js +4 -0
  23. package/dist-es/commands/index.js +5 -0
  24. package/dist-es/endpoint/bdd.js +275 -211
  25. package/dist-es/endpoint/endpointResolver.js +1 -0
  26. package/dist-es/models/enums.js +38 -0
  27. package/dist-es/models/errors.js +44 -44
  28. package/dist-es/pagination/ListChannelsPaginator.js +4 -0
  29. package/dist-es/pagination/index.js +1 -0
  30. package/dist-es/schemas/schemas_0.js +312 -38
  31. package/dist-es/waiters/index.js +1 -0
  32. package/dist-es/waiters/waitForChannelActive.js +67 -0
  33. package/dist-types/Kinesis.d.ts +49 -0
  34. package/dist-types/KinesisClient.d.ts +7 -2
  35. package/dist-types/commandBuilder.d.ts +4 -0
  36. package/dist-types/commands/CreateChannelCommand.d.ts +456 -0
  37. package/dist-types/commands/DeleteChannelCommand.d.ts +105 -0
  38. package/dist-types/commands/DescribeChannelCommand.d.ts +219 -0
  39. package/dist-types/commands/DescribeLimitsCommand.d.ts +2 -0
  40. package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +1 -0
  41. package/dist-types/commands/ListChannelsCommand.d.ts +181 -0
  42. package/dist-types/commands/UpdateChannelCommand.d.ts +246 -0
  43. package/dist-types/commands/index.d.ts +5 -0
  44. package/dist-types/endpoint/EndpointParameters.d.ts +1 -0
  45. package/dist-types/models/enums.d.ts +102 -0
  46. package/dist-types/models/errors.d.ts +51 -51
  47. package/dist-types/models/models_0.d.ts +788 -1
  48. package/dist-types/pagination/ListChannelsPaginator.d.ts +7 -0
  49. package/dist-types/pagination/index.d.ts +1 -0
  50. package/dist-types/schemas/schemas_0.d.ts +37 -0
  51. package/dist-types/ts3.4/Kinesis.d.ts +99 -0
  52. package/dist-types/ts3.4/KinesisClient.d.ts +30 -0
  53. package/dist-types/ts3.4/commandBuilder.d.ts +1 -0
  54. package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +38 -0
  55. package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +38 -0
  56. package/dist-types/ts3.4/commands/DescribeChannelCommand.d.ts +38 -0
  57. package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +38 -0
  58. package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +38 -0
  59. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  60. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -0
  61. package/dist-types/ts3.4/models/enums.d.ts +49 -0
  62. package/dist-types/ts3.4/models/errors.d.ts +20 -20
  63. package/dist-types/ts3.4/models/models_0.d.ts +168 -0
  64. package/dist-types/ts3.4/pagination/ListChannelsPaginator.d.ts +11 -0
  65. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  66. package/dist-types/ts3.4/schemas/schemas_0.d.ts +37 -0
  67. package/dist-types/ts3.4/waiters/index.d.ts +1 -0
  68. package/dist-types/ts3.4/waiters/waitForChannelActive.d.ts +15 -0
  69. package/dist-types/waiters/index.d.ts +1 -0
  70. package/dist-types/waiters/waitForChannelActive.d.ts +15 -0
  71. package/package.json +2 -2
@@ -0,0 +1,456 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { CreateChannelInput, CreateChannelOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link CreateChannelCommand}.
11
+ */
12
+ export interface CreateChannelCommandInput extends CreateChannelInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link CreateChannelCommand}.
18
+ */
19
+ export interface CreateChannelCommandOutput extends CreateChannelOutput, __MetadataBearer {
20
+ }
21
+ declare const CreateChannelCommand_base: {
22
+ new (input: CreateChannelCommandInput): import("@smithy/core/client").CommandImpl<CreateChannelCommandInput, CreateChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: CreateChannelCommandInput): import("@smithy/core/client").CommandImpl<CreateChannelCommandInput, CreateChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Creates a channel that delivers records from a Kinesis data stream to a destination. A channel reads records from the specified stream and writes them to streaming tables on Apache Iceberg (Amazon S3 Tables) or to a general purpose Amazon S3 bucket.</p>
28
+ * <p>You must specify either <code>S3DestinationConfiguration</code> or <code>S3TablesDestinationConfiguration</code>, but not both.</p>
29
+ * <p>Creating a channel is an asynchronous operation. Upon receiving the request, Amazon Kinesis Data Streams returns immediately with the channel in the <code>CREATING</code> state. After provisioning is complete, Amazon Kinesis Data Streams sets the state to <code>ACTIVE</code>. You can use <a>DescribeChannel</a> to check the current state.</p>
30
+ * <p>This operation is only supported for data streams with the on-demand capacity mode.</p>
31
+ * <p>This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a <code>LimitExceededException</code>.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { KinesisClient, CreateChannelCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
36
+ * // const { KinesisClient, CreateChannelCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
37
+ * // import type { KinesisClientConfig } from "@aws-sdk/client-kinesis";
38
+ * const config = {}; // type is KinesisClientConfig
39
+ * const client = new KinesisClient(config);
40
+ * const input = { // CreateChannelInput
41
+ * ChannelName: "STRING_VALUE", // required
42
+ * ServiceExecutionRoleARN: "STRING_VALUE", // required
43
+ * StreamConfigurationList: [ // ChannelStreamConfigurationList // required
44
+ * { // ChannelStreamConfiguration
45
+ * StreamARN: "STRING_VALUE", // required
46
+ * RecordConfiguration: { // RecordConfiguration
47
+ * RecordFormatType: "GSR_JSON" || "JSON" || "STRING" || "BYTE_ARRAY", // required
48
+ * GSRSchemaARN: "STRING_VALUE",
49
+ * },
50
+ * },
51
+ * ],
52
+ * S3DestinationConfiguration: { // S3DestinationConfiguration
53
+ * DataFreshnessInSeconds: Number("int"),
54
+ * DeadLetterQueueS3Configuration: { // DeadLetterQueueS3Configuration
55
+ * BucketARN: "STRING_VALUE", // required
56
+ * ExpectedBucketOwner: "STRING_VALUE", // required
57
+ * ErrorOutputPrefix: "STRING_VALUE",
58
+ * },
59
+ * StorageConfiguration: { // S3StorageConfiguration
60
+ * BucketARN: "STRING_VALUE", // required
61
+ * ExpectedBucketOwner: "STRING_VALUE", // required
62
+ * OutputKeyTemplate: "STRING_VALUE",
63
+ * StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR",
64
+ * CompressionType: "NONE" || "GZIP" || "ZSTD", // required
65
+ * },
66
+ * },
67
+ * S3TablesDestinationConfiguration: { // S3TablesDestinationConfiguration
68
+ * DataFreshnessInSeconds: Number("int"),
69
+ * DeadLetterQueueS3Configuration: {
70
+ * BucketARN: "STRING_VALUE", // required
71
+ * ExpectedBucketOwner: "STRING_VALUE", // required
72
+ * ErrorOutputPrefix: "STRING_VALUE",
73
+ * },
74
+ * S3TablesConfigurationList: [ // S3TablesConfigurationList // required
75
+ * { // S3TablesConfiguration
76
+ * TableBucketARN: "STRING_VALUE", // required
77
+ * Namespace: "STRING_VALUE", // required
78
+ * TableName: "STRING_VALUE", // required
79
+ * CompressionType: "NONE" || "ZSTD" || "SNAPPY", // required
80
+ * PartitionSpec: { // PartitionSpec
81
+ * PartitionFields: [ // PartitionFieldList // required
82
+ * { // PartitionField
83
+ * Transform: "TIME_HOUR", // required
84
+ * SourceName: "STRING_VALUE", // required
85
+ * },
86
+ * ],
87
+ * },
88
+ * },
89
+ * ],
90
+ * },
91
+ * EncryptionConfiguration: { // ChannelEncryptionConfiguration
92
+ * EncryptionType: "KMS", // required
93
+ * KeyId: "STRING_VALUE", // required
94
+ * },
95
+ * Tags: { // TagMap
96
+ * "<keys>": "STRING_VALUE",
97
+ * },
98
+ * LoggingConfiguration: { // ChannelLoggingConfiguration
99
+ * CloudWatchLogs: { // CloudWatchLogs
100
+ * Enabled: true || false, // required
101
+ * LogGroupName: "STRING_VALUE",
102
+ * LogStreamName: "STRING_VALUE",
103
+ * },
104
+ * },
105
+ * };
106
+ * const command = new CreateChannelCommand(input);
107
+ * const response = await client.send(command);
108
+ * // { // CreateChannelOutput
109
+ * // ChannelDescription: { // ChannelDescription
110
+ * // ChannelName: "STRING_VALUE", // required
111
+ * // ChannelARN: "STRING_VALUE", // required
112
+ * // ChannelId: "STRING_VALUE", // required
113
+ * // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
114
+ * // ChannelStatusReason: "STRING_VALUE",
115
+ * // ChannelCreationTimestamp: new Date("TIMESTAMP"), // required
116
+ * // ServiceExecutionRoleARN: "STRING_VALUE", // required
117
+ * // StreamConfigurationList: [ // ChannelStreamDescriptionList // required
118
+ * // { // ChannelStreamDescription
119
+ * // StreamARN: "STRING_VALUE", // required
120
+ * // StreamCreationTimestamp: new Date("TIMESTAMP"), // required
121
+ * // RecordConfiguration: { // RecordConfiguration
122
+ * // RecordFormatType: "GSR_JSON" || "JSON" || "STRING" || "BYTE_ARRAY", // required
123
+ * // GSRSchemaARN: "STRING_VALUE",
124
+ * // },
125
+ * // },
126
+ * // ],
127
+ * // S3DestinationConfiguration: { // S3DestinationDescription
128
+ * // DataFreshnessInSeconds: Number("int"), // required
129
+ * // DeadLetterQueueS3Configuration: { // DeadLetterQueueS3Configuration
130
+ * // BucketARN: "STRING_VALUE", // required
131
+ * // ExpectedBucketOwner: "STRING_VALUE", // required
132
+ * // ErrorOutputPrefix: "STRING_VALUE",
133
+ * // },
134
+ * // StorageConfiguration: { // S3StorageConfiguration
135
+ * // BucketARN: "STRING_VALUE", // required
136
+ * // ExpectedBucketOwner: "STRING_VALUE", // required
137
+ * // OutputKeyTemplate: "STRING_VALUE",
138
+ * // StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR",
139
+ * // CompressionType: "NONE" || "GZIP" || "ZSTD", // required
140
+ * // },
141
+ * // },
142
+ * // S3TablesDestinationConfiguration: { // S3TablesDestinationDescription
143
+ * // DataFreshnessInSeconds: Number("int"), // required
144
+ * // DeadLetterQueueS3Configuration: {
145
+ * // BucketARN: "STRING_VALUE", // required
146
+ * // ExpectedBucketOwner: "STRING_VALUE", // required
147
+ * // ErrorOutputPrefix: "STRING_VALUE",
148
+ * // },
149
+ * // S3TablesConfigurationList: [ // S3TablesConfigurationList // required
150
+ * // { // S3TablesConfiguration
151
+ * // TableBucketARN: "STRING_VALUE", // required
152
+ * // Namespace: "STRING_VALUE", // required
153
+ * // TableName: "STRING_VALUE", // required
154
+ * // CompressionType: "NONE" || "ZSTD" || "SNAPPY", // required
155
+ * // PartitionSpec: { // PartitionSpec
156
+ * // PartitionFields: [ // PartitionFieldList // required
157
+ * // { // PartitionField
158
+ * // Transform: "TIME_HOUR", // required
159
+ * // SourceName: "STRING_VALUE", // required
160
+ * // },
161
+ * // ],
162
+ * // },
163
+ * // },
164
+ * // ],
165
+ * // },
166
+ * // EncryptionConfiguration: { // ChannelEncryptionConfiguration
167
+ * // EncryptionType: "KMS", // required
168
+ * // KeyId: "STRING_VALUE", // required
169
+ * // },
170
+ * // LoggingConfiguration: { // ChannelLoggingConfiguration
171
+ * // CloudWatchLogs: { // CloudWatchLogs
172
+ * // Enabled: true || false, // required
173
+ * // LogGroupName: "STRING_VALUE",
174
+ * // LogStreamName: "STRING_VALUE",
175
+ * // },
176
+ * // },
177
+ * // },
178
+ * // };
179
+ *
180
+ * ```
181
+ *
182
+ * @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
183
+ * @returns {@link CreateChannelCommandOutput}
184
+ * @see {@link CreateChannelCommandInput} for command's `input` shape.
185
+ * @see {@link CreateChannelCommandOutput} for command's `response` shape.
186
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
187
+ *
188
+ * @throws {@link AccessDeniedException} (client fault)
189
+ * <p>Specifies that you do not have the permissions required to perform this
190
+ * operation.</p>
191
+ *
192
+ * @throws {@link InvalidArgumentException} (client fault)
193
+ * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
194
+ * For more information, see the returned message.</p>
195
+ *
196
+ * @throws {@link KMSAccessDeniedException} (client fault)
197
+ * <p>The ciphertext references a key that doesn't exist or that you don't have access
198
+ * to.</p>
199
+ *
200
+ * @throws {@link KMSDisabledException} (client fault)
201
+ * <p>The request was rejected because the specified customer master key (CMK) isn't
202
+ * enabled.</p>
203
+ *
204
+ * @throws {@link KMSInvalidStateException} (client fault)
205
+ * <p>The request was rejected because the state of the specified resource isn't valid for
206
+ * this request. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a
207
+ * Customer Master Key</a> in the <i>Amazon Web Services Key Management
208
+ * Service Developer Guide</i>.</p>
209
+ *
210
+ * @throws {@link KMSNotFoundException} (client fault)
211
+ * <p>The request was rejected because the specified entity or resource can't be
212
+ * found.</p>
213
+ *
214
+ * @throws {@link KMSOptInRequired} (client fault)
215
+ * <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
216
+ *
217
+ * @throws {@link KMSThrottlingException} (client fault)
218
+ * <p>The request was denied due to request throttling. For more information about
219
+ * throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
220
+ * the <i>Amazon Web Services Key Management Service Developer
221
+ * Guide</i>.</p>
222
+ *
223
+ * @throws {@link LimitExceededException} (client fault)
224
+ * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
225
+ * stream requests exceeds the maximum number allowed. </p>
226
+ *
227
+ * @throws {@link ResourceInUseException} (client fault)
228
+ * <p>The resource is not available for this operation. For successful operation, the
229
+ * resource must be in the <code>ACTIVE</code> state.</p>
230
+ *
231
+ * @throws {@link ResourceNotFoundException} (client fault)
232
+ * <p>The requested resource could not be found. The stream might not be specified
233
+ * correctly.</p>
234
+ *
235
+ * @throws {@link ValidationException} (client fault)
236
+ * <p>Specifies that you tried to invoke this API for a data stream with the on-demand
237
+ * capacity mode. This API is only supported for data streams with the provisioned capacity
238
+ * mode. </p>
239
+ *
240
+ * @throws {@link KinesisServiceException}
241
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
242
+ *
243
+ *
244
+ * @example To create an S3 channel
245
+ * ```javascript
246
+ * //
247
+ * const input = {
248
+ * ChannelName: "my-channel-name",
249
+ * EncryptionConfiguration: {
250
+ * EncryptionType: "KMS",
251
+ * KeyId: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
252
+ * },
253
+ * LoggingConfiguration: {
254
+ * CloudWatchLogs: {
255
+ * Enabled: true,
256
+ * LogGroupName: "/aws/kinesis/my-channel",
257
+ * LogStreamName: "my-channel-log-stream"
258
+ * }
259
+ * },
260
+ * S3DestinationConfiguration: {
261
+ * DeadLetterQueueS3Configuration: {
262
+ * BucketARN: "arn:aws:s3:::my-channel-dlq-bucket",
263
+ * ExpectedBucketOwner: "123456789012"
264
+ * },
265
+ * StorageConfiguration: {
266
+ * BucketARN: "arn:aws:s3:::my-channel-bucket",
267
+ * CompressionType: "ZSTD",
268
+ * ExpectedBucketOwner: "123456789012"
269
+ * }
270
+ * },
271
+ * ServiceExecutionRoleARN: "arn:aws:iam::123456789012:role/my-channel-role",
272
+ * StreamConfigurationList: [
273
+ * {
274
+ * RecordConfiguration: {
275
+ * RecordFormatType: "JSON"
276
+ * },
277
+ * StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name"
278
+ * }
279
+ * ]
280
+ * };
281
+ * const command = new CreateChannelCommand(input);
282
+ * const response = await client.send(command);
283
+ * /* response is
284
+ * {
285
+ * ChannelDescription: {
286
+ * ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
287
+ * ChannelCreationTimestamp: "2024-07-02T00:00:00Z",
288
+ * ChannelId: "my-channel-id",
289
+ * ChannelName: "my-channel-name",
290
+ * ChannelStatus: "CREATING",
291
+ * EncryptionConfiguration: {
292
+ * EncryptionType: "KMS",
293
+ * KeyId: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
294
+ * },
295
+ * LoggingConfiguration: {
296
+ * CloudWatchLogs: {
297
+ * Enabled: true,
298
+ * LogGroupName: "/aws/kinesis/my-channel",
299
+ * LogStreamName: "my-channel-log-stream"
300
+ * }
301
+ * },
302
+ * S3DestinationConfiguration: {
303
+ * DataFreshnessInSeconds: 300,
304
+ * DeadLetterQueueS3Configuration: {
305
+ * BucketARN: "arn:aws:s3:::my-channel-dlq-bucket",
306
+ * ErrorOutputPrefix: "kinesis-channel/errors/my-channel/my-channel-id/",
307
+ * ExpectedBucketOwner: "123456789012"
308
+ * },
309
+ * StorageConfiguration: {
310
+ * BucketARN: "arn:aws:s3:::my-channel-bucket",
311
+ * CompressionType: "ZSTD",
312
+ * ExpectedBucketOwner: "123456789012",
313
+ * OutputKeyTemplate: "kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}",
314
+ * StorageClass: "STANDARD"
315
+ * }
316
+ * },
317
+ * ServiceExecutionRoleARN: "arn:aws:iam::123456789012:role/my-channel-role",
318
+ * StreamConfigurationList: [
319
+ * {
320
+ * RecordConfiguration: {
321
+ * RecordFormatType: "JSON"
322
+ * },
323
+ * StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name",
324
+ * StreamCreationTimestamp: "2024-07-01T00:00:00Z"
325
+ * }
326
+ * ]
327
+ * }
328
+ * }
329
+ * *\/
330
+ * ```
331
+ *
332
+ * @example To create an S3 Tables channel
333
+ * ```javascript
334
+ * //
335
+ * const input = {
336
+ * ChannelName: "my-channel-name",
337
+ * EncryptionConfiguration: {
338
+ * EncryptionType: "KMS",
339
+ * KeyId: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
340
+ * },
341
+ * LoggingConfiguration: {
342
+ * CloudWatchLogs: {
343
+ * Enabled: true,
344
+ * LogGroupName: "/aws/kinesis/my-channel",
345
+ * LogStreamName: "my-channel-log-stream"
346
+ * }
347
+ * },
348
+ * S3TablesDestinationConfiguration: {
349
+ * DeadLetterQueueS3Configuration: {
350
+ * BucketARN: "arn:aws:s3:::my-channel-dlq-bucket",
351
+ * ExpectedBucketOwner: "123456789012"
352
+ * },
353
+ * S3TablesConfigurationList: [
354
+ * {
355
+ * CompressionType: "ZSTD",
356
+ * Namespace: "my_namespace",
357
+ * PartitionSpec: {
358
+ * PartitionFields: [
359
+ * {
360
+ * SourceName: "creation_ts",
361
+ * Transform: "TIME_HOUR"
362
+ * }
363
+ * ]
364
+ * },
365
+ * TableBucketARN: "arn:aws:s3tables:us-east-1:123456789012:bucket/my-table-bucket",
366
+ * TableName: "my_table"
367
+ * }
368
+ * ]
369
+ * },
370
+ * ServiceExecutionRoleARN: "arn:aws:iam::123456789012:role/my-channel-role",
371
+ * StreamConfigurationList: [
372
+ * {
373
+ * RecordConfiguration: {
374
+ * GSRSchemaARN: "arn:aws:glue:us-east-1:123456789012:schema/my-registry/my-schema",
375
+ * RecordFormatType: "JSON"
376
+ * },
377
+ * StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name"
378
+ * }
379
+ * ]
380
+ * };
381
+ * const command = new CreateChannelCommand(input);
382
+ * const response = await client.send(command);
383
+ * /* response is
384
+ * {
385
+ * ChannelDescription: {
386
+ * ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
387
+ * ChannelCreationTimestamp: "2024-07-02T00:00:00Z",
388
+ * ChannelId: "my-channel-id",
389
+ * ChannelName: "my-channel-name",
390
+ * ChannelStatus: "CREATING",
391
+ * EncryptionConfiguration: {
392
+ * EncryptionType: "KMS",
393
+ * KeyId: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
394
+ * },
395
+ * LoggingConfiguration: {
396
+ * CloudWatchLogs: {
397
+ * Enabled: true,
398
+ * LogGroupName: "/aws/kinesis/my-channel",
399
+ * LogStreamName: "my-channel-log-stream"
400
+ * }
401
+ * },
402
+ * S3TablesDestinationConfiguration: {
403
+ * DataFreshnessInSeconds: 300,
404
+ * DeadLetterQueueS3Configuration: {
405
+ * BucketARN: "arn:aws:s3:::my-channel-dlq-bucket",
406
+ * ErrorOutputPrefix: "kinesis-channel/errors/my-channel/my-channel-id/",
407
+ * ExpectedBucketOwner: "123456789012"
408
+ * },
409
+ * S3TablesConfigurationList: [
410
+ * {
411
+ * CompressionType: "ZSTD",
412
+ * Namespace: "my_namespace",
413
+ * PartitionSpec: {
414
+ * PartitionFields: [
415
+ * {
416
+ * SourceName: "creation_ts",
417
+ * Transform: "TIME_HOUR"
418
+ * }
419
+ * ]
420
+ * },
421
+ * TableBucketARN: "arn:aws:s3tables:us-east-1:123456789012:bucket/my-table-bucket",
422
+ * TableName: "my_table"
423
+ * }
424
+ * ]
425
+ * },
426
+ * ServiceExecutionRoleARN: "arn:aws:iam::123456789012:role/my-channel-role",
427
+ * StreamConfigurationList: [
428
+ * {
429
+ * RecordConfiguration: {
430
+ * GSRSchemaARN: "arn:aws:glue:us-east-1:123456789012:schema/my-registry/my-schema",
431
+ * RecordFormatType: "JSON"
432
+ * },
433
+ * StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name",
434
+ * StreamCreationTimestamp: "2024-07-01T00:00:00Z"
435
+ * }
436
+ * ]
437
+ * }
438
+ * }
439
+ * *\/
440
+ * ```
441
+ *
442
+ * @public
443
+ */
444
+ export declare class CreateChannelCommand extends CreateChannelCommand_base {
445
+ /** @internal type navigation helper, not in runtime. */
446
+ protected static __types: {
447
+ api: {
448
+ input: CreateChannelInput;
449
+ output: CreateChannelOutput;
450
+ };
451
+ sdk: {
452
+ input: CreateChannelCommandInput;
453
+ output: CreateChannelCommandOutput;
454
+ };
455
+ };
456
+ }
@@ -0,0 +1,105 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DeleteChannelInput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DeleteChannelCommand}.
11
+ */
12
+ export interface DeleteChannelCommandInput extends DeleteChannelInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DeleteChannelCommand}.
18
+ */
19
+ export interface DeleteChannelCommandOutput extends __MetadataBearer {
20
+ }
21
+ declare const DeleteChannelCommand_base: {
22
+ new (input: DeleteChannelCommandInput): import("@smithy/core/client").CommandImpl<DeleteChannelCommandInput, DeleteChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DeleteChannelCommandInput): import("@smithy/core/client").CommandImpl<DeleteChannelCommandInput, DeleteChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Deletes the specified channel. Deleting a channel stops delivery from the source stream to the destination. Data already delivered to the destination is not deleted.</p>
28
+ * <p>A stream cannot be deleted while it has active channels. To delete the stream, first delete all channels attached to it. To find them, use <a>ListChannels</a> with a stream filter.</p>
29
+ * <p>This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a <code>LimitExceededException</code>.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { KinesisClient, DeleteChannelCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
34
+ * // const { KinesisClient, DeleteChannelCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
35
+ * // import type { KinesisClientConfig } from "@aws-sdk/client-kinesis";
36
+ * const config = {}; // type is KinesisClientConfig
37
+ * const client = new KinesisClient(config);
38
+ * const input = { // DeleteChannelInput
39
+ * ChannelARN: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteChannelCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
48
+ * @returns {@link DeleteChannelCommandOutput}
49
+ * @see {@link DeleteChannelCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteChannelCommandOutput} for command's `response` shape.
51
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p>Specifies that you do not have the permissions required to perform this
55
+ * operation.</p>
56
+ *
57
+ * @throws {@link InvalidArgumentException} (client fault)
58
+ * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
59
+ * For more information, see the returned message.</p>
60
+ *
61
+ * @throws {@link LimitExceededException} (client fault)
62
+ * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
63
+ * stream requests exceeds the maximum number allowed. </p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>The requested resource could not be found. The stream might not be specified
67
+ * correctly.</p>
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ * <p>Specifies that you tried to invoke this API for a data stream with the on-demand
71
+ * capacity mode. This API is only supported for data streams with the provisioned capacity
72
+ * mode. </p>
73
+ *
74
+ * @throws {@link KinesisServiceException}
75
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
76
+ *
77
+ *
78
+ * @example To delete a channel
79
+ * ```javascript
80
+ * //
81
+ * const input = {
82
+ * ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id"
83
+ * };
84
+ * const command = new DeleteChannelCommand(input);
85
+ * const response = await client.send(command);
86
+ * /* response is
87
+ * { /* empty *\/ }
88
+ * *\/
89
+ * ```
90
+ *
91
+ * @public
92
+ */
93
+ export declare class DeleteChannelCommand extends DeleteChannelCommand_base {
94
+ /** @internal type navigation helper, not in runtime. */
95
+ protected static __types: {
96
+ api: {
97
+ input: DeleteChannelInput;
98
+ output: {};
99
+ };
100
+ sdk: {
101
+ input: DeleteChannelCommandInput;
102
+ output: DeleteChannelCommandOutput;
103
+ };
104
+ };
105
+ }