@aws-sdk/client-kinesis 3.1120.0 → 3.1122.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.
- package/README.md +35 -0
- package/dist-cjs/index.js +834 -310
- package/dist-es/Kinesis.js +14 -0
- package/dist-es/commandBuilder.js +7 -3
- package/dist-es/commands/CreateChannelCommand.js +4 -0
- package/dist-es/commands/DeleteChannelCommand.js +4 -0
- package/dist-es/commands/DeleteResourcePolicyCommand.js +2 -2
- package/dist-es/commands/DeregisterStreamConsumerCommand.js +2 -2
- package/dist-es/commands/DescribeChannelCommand.js +4 -0
- package/dist-es/commands/DescribeStreamConsumerCommand.js +2 -2
- package/dist-es/commands/GetRecordsCommand.js +2 -2
- package/dist-es/commands/GetResourcePolicyCommand.js +2 -2
- package/dist-es/commands/GetShardIteratorCommand.js +2 -2
- package/dist-es/commands/ListChannelsCommand.js +4 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +2 -2
- package/dist-es/commands/PutRecordCommand.js +2 -2
- package/dist-es/commands/PutRecordsCommand.js +2 -2
- package/dist-es/commands/PutResourcePolicyCommand.js +2 -2
- package/dist-es/commands/SubscribeToShardCommand.js +2 -2
- package/dist-es/commands/TagResourceCommand.js +2 -2
- package/dist-es/commands/UntagResourceCommand.js +2 -2
- package/dist-es/commands/UpdateChannelCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoint/bdd.js +275 -211
- package/dist-es/endpoint/endpointResolver.js +1 -0
- package/dist-es/models/enums.js +38 -0
- package/dist-es/models/errors.js +44 -44
- package/dist-es/pagination/ListChannelsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +312 -38
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForChannelActive.js +67 -0
- package/dist-types/Kinesis.d.ts +49 -0
- package/dist-types/KinesisClient.d.ts +7 -2
- package/dist-types/commandBuilder.d.ts +4 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +456 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +105 -0
- package/dist-types/commands/DescribeChannelCommand.d.ts +219 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +2 -0
- package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +1 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +181 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +246 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -0
- package/dist-types/models/enums.d.ts +102 -0
- package/dist-types/models/errors.d.ts +51 -51
- package/dist-types/models/models_0.d.ts +788 -1
- package/dist-types/pagination/ListChannelsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +37 -0
- package/dist-types/ts3.4/Kinesis.d.ts +99 -0
- package/dist-types/ts3.4/KinesisClient.d.ts +30 -0
- package/dist-types/ts3.4/commandBuilder.d.ts +1 -0
- package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +49 -0
- package/dist-types/ts3.4/models/errors.d.ts +20 -20
- package/dist-types/ts3.4/models/models_0.d.ts +168 -0
- package/dist-types/ts3.4/pagination/ListChannelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +37 -0
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForChannelActive.d.ts +15 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForChannelActive.d.ts +15 -0
- package/package.json +1 -1
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeChannelInput, DescribeChannelOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeChannelCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeChannelCommandInput extends DescribeChannelInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeChannelCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeChannelCommandOutput extends DescribeChannelOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeChannelCommand_base: {
|
|
22
|
+
new (input: DescribeChannelCommandInput): import("@smithy/core/client").CommandImpl<DescribeChannelCommandInput, DescribeChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeChannelCommandInput): import("@smithy/core/client").CommandImpl<DescribeChannelCommandInput, DescribeChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Describes the specified channel, including its configuration and current status.</p>
|
|
28
|
+
* <p>Use this operation to verify that a channel reached the <code>ACTIVE</code> state after creation, or to diagnose a channel in the <code>FAILED</code> state by reading the <code>ChannelStatusReason</code>.</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, DescribeChannelCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
34
|
+
* // const { KinesisClient, DescribeChannelCommand } = 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 = { // DescribeChannelInput
|
|
39
|
+
* ChannelARN: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DescribeChannelCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // DescribeChannelOutput
|
|
44
|
+
* // ChannelDescription: { // ChannelDescription
|
|
45
|
+
* // ChannelName: "STRING_VALUE", // required
|
|
46
|
+
* // ChannelARN: "STRING_VALUE", // required
|
|
47
|
+
* // ChannelId: "STRING_VALUE", // required
|
|
48
|
+
* // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
|
|
49
|
+
* // ChannelStatusReason: "STRING_VALUE",
|
|
50
|
+
* // ChannelCreationTimestamp: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // ServiceExecutionRoleARN: "STRING_VALUE", // required
|
|
52
|
+
* // StreamConfigurationList: [ // ChannelStreamDescriptionList // required
|
|
53
|
+
* // { // ChannelStreamDescription
|
|
54
|
+
* // StreamARN: "STRING_VALUE", // required
|
|
55
|
+
* // StreamCreationTimestamp: new Date("TIMESTAMP"), // required
|
|
56
|
+
* // RecordConfiguration: { // RecordConfiguration
|
|
57
|
+
* // RecordFormatType: "GSR_JSON" || "JSON" || "STRING" || "BYTE_ARRAY", // required
|
|
58
|
+
* // GSRSchemaARN: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // S3DestinationConfiguration: { // S3DestinationDescription
|
|
63
|
+
* // DataFreshnessInSeconds: Number("int"), // required
|
|
64
|
+
* // DeadLetterQueueS3Configuration: { // DeadLetterQueueS3Configuration
|
|
65
|
+
* // BucketARN: "STRING_VALUE", // required
|
|
66
|
+
* // ExpectedBucketOwner: "STRING_VALUE", // required
|
|
67
|
+
* // ErrorOutputPrefix: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // StorageConfiguration: { // S3StorageConfiguration
|
|
70
|
+
* // BucketARN: "STRING_VALUE", // required
|
|
71
|
+
* // ExpectedBucketOwner: "STRING_VALUE", // required
|
|
72
|
+
* // OutputKeyTemplate: "STRING_VALUE",
|
|
73
|
+
* // StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR",
|
|
74
|
+
* // CompressionType: "NONE" || "GZIP" || "ZSTD", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // S3TablesDestinationConfiguration: { // S3TablesDestinationDescription
|
|
78
|
+
* // DataFreshnessInSeconds: Number("int"), // required
|
|
79
|
+
* // DeadLetterQueueS3Configuration: {
|
|
80
|
+
* // BucketARN: "STRING_VALUE", // required
|
|
81
|
+
* // ExpectedBucketOwner: "STRING_VALUE", // required
|
|
82
|
+
* // ErrorOutputPrefix: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // S3TablesConfigurationList: [ // S3TablesConfigurationList // required
|
|
85
|
+
* // { // S3TablesConfiguration
|
|
86
|
+
* // TableBucketARN: "STRING_VALUE", // required
|
|
87
|
+
* // Namespace: "STRING_VALUE", // required
|
|
88
|
+
* // TableName: "STRING_VALUE", // required
|
|
89
|
+
* // CompressionType: "NONE" || "ZSTD" || "SNAPPY", // required
|
|
90
|
+
* // PartitionSpec: { // PartitionSpec
|
|
91
|
+
* // PartitionFields: [ // PartitionFieldList // required
|
|
92
|
+
* // { // PartitionField
|
|
93
|
+
* // Transform: "TIME_HOUR", // required
|
|
94
|
+
* // SourceName: "STRING_VALUE", // required
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // },
|
|
98
|
+
* // },
|
|
99
|
+
* // ],
|
|
100
|
+
* // },
|
|
101
|
+
* // EncryptionConfiguration: { // ChannelEncryptionConfiguration
|
|
102
|
+
* // EncryptionType: "KMS", // required
|
|
103
|
+
* // KeyId: "STRING_VALUE", // required
|
|
104
|
+
* // },
|
|
105
|
+
* // LoggingConfiguration: { // ChannelLoggingConfiguration
|
|
106
|
+
* // CloudWatchLogs: { // CloudWatchLogs
|
|
107
|
+
* // Enabled: true || false, // required
|
|
108
|
+
* // LogGroupName: "STRING_VALUE",
|
|
109
|
+
* // LogStreamName: "STRING_VALUE",
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // },
|
|
113
|
+
* // };
|
|
114
|
+
*
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
117
|
+
* @param DescribeChannelCommandInput - {@link DescribeChannelCommandInput}
|
|
118
|
+
* @returns {@link DescribeChannelCommandOutput}
|
|
119
|
+
* @see {@link DescribeChannelCommandInput} for command's `input` shape.
|
|
120
|
+
* @see {@link DescribeChannelCommandOutput} for command's `response` shape.
|
|
121
|
+
* @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
124
|
+
* <p>Specifies that you do not have the permissions required to perform this
|
|
125
|
+
* operation.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
128
|
+
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
|
|
129
|
+
* For more information, see the returned message.</p>
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
132
|
+
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
|
|
133
|
+
* stream requests exceeds the maximum number allowed. </p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
136
|
+
* <p>The requested resource could not be found. The stream might not be specified
|
|
137
|
+
* correctly.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link ValidationException} (client fault)
|
|
140
|
+
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
141
|
+
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
142
|
+
* mode. </p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link KinesisServiceException}
|
|
145
|
+
* <p>Base exception class for all service exceptions from Kinesis service.</p>
|
|
146
|
+
*
|
|
147
|
+
*
|
|
148
|
+
* @example To describe a channel
|
|
149
|
+
* ```javascript
|
|
150
|
+
* //
|
|
151
|
+
* const input = {
|
|
152
|
+
* ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id"
|
|
153
|
+
* };
|
|
154
|
+
* const command = new DescribeChannelCommand(input);
|
|
155
|
+
* const response = await client.send(command);
|
|
156
|
+
* /* response is
|
|
157
|
+
* {
|
|
158
|
+
* ChannelDescription: {
|
|
159
|
+
* ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
|
|
160
|
+
* ChannelCreationTimestamp: "2024-07-02T00:00:00Z",
|
|
161
|
+
* ChannelId: "my-channel-id",
|
|
162
|
+
* ChannelName: "my-channel-name",
|
|
163
|
+
* ChannelStatus: "ACTIVE",
|
|
164
|
+
* EncryptionConfiguration: {
|
|
165
|
+
* EncryptionType: "KMS",
|
|
166
|
+
* KeyId: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
167
|
+
* },
|
|
168
|
+
* LoggingConfiguration: {
|
|
169
|
+
* CloudWatchLogs: {
|
|
170
|
+
* Enabled: true,
|
|
171
|
+
* LogGroupName: "/aws/kinesis/my-channel",
|
|
172
|
+
* LogStreamName: "my-channel-log-stream"
|
|
173
|
+
* }
|
|
174
|
+
* },
|
|
175
|
+
* S3DestinationConfiguration: {
|
|
176
|
+
* DataFreshnessInSeconds: 300,
|
|
177
|
+
* DeadLetterQueueS3Configuration: {
|
|
178
|
+
* BucketARN: "arn:aws:s3:::my-channel-dlq-bucket",
|
|
179
|
+
* ErrorOutputPrefix: "kinesis-channel/errors/my-channel/my-channel-id/",
|
|
180
|
+
* ExpectedBucketOwner: "123456789012"
|
|
181
|
+
* },
|
|
182
|
+
* StorageConfiguration: {
|
|
183
|
+
* BucketARN: "arn:aws:s3:::my-channel-bucket",
|
|
184
|
+
* CompressionType: "ZSTD",
|
|
185
|
+
* ExpectedBucketOwner: "123456789012",
|
|
186
|
+
* OutputKeyTemplate: "kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}",
|
|
187
|
+
* StorageClass: "STANDARD"
|
|
188
|
+
* }
|
|
189
|
+
* },
|
|
190
|
+
* ServiceExecutionRoleARN: "arn:aws:iam::123456789012:role/my-channel-role",
|
|
191
|
+
* StreamConfigurationList: [
|
|
192
|
+
* {
|
|
193
|
+
* RecordConfiguration: {
|
|
194
|
+
* RecordFormatType: "JSON"
|
|
195
|
+
* },
|
|
196
|
+
* StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name",
|
|
197
|
+
* StreamCreationTimestamp: "2024-07-01T00:00:00Z"
|
|
198
|
+
* }
|
|
199
|
+
* ]
|
|
200
|
+
* }
|
|
201
|
+
* }
|
|
202
|
+
* *\/
|
|
203
|
+
* ```
|
|
204
|
+
*
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
export declare class DescribeChannelCommand extends DescribeChannelCommand_base {
|
|
208
|
+
/** @internal type navigation helper, not in runtime. */
|
|
209
|
+
protected static __types: {
|
|
210
|
+
api: {
|
|
211
|
+
input: DescribeChannelInput;
|
|
212
|
+
output: DescribeChannelOutput;
|
|
213
|
+
};
|
|
214
|
+
sdk: {
|
|
215
|
+
input: DescribeChannelCommandInput;
|
|
216
|
+
output: DescribeChannelCommandOutput;
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
}
|
|
@@ -44,6 +44,8 @@ declare const DescribeLimitsCommand_base: {
|
|
|
44
44
|
* // OpenShardCount: Number("int"), // required
|
|
45
45
|
* // OnDemandStreamCount: Number("int"), // required
|
|
46
46
|
* // OnDemandStreamCountLimit: Number("int"), // required
|
|
47
|
+
* // ChannelCount: Number("int"),
|
|
48
|
+
* // ChannelCountLimit: Number("int"),
|
|
47
49
|
* // };
|
|
48
50
|
*
|
|
49
51
|
* ```
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListChannelsInput, ListChannelsOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListChannelsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListChannelsCommandInput extends ListChannelsInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListChannelsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListChannelsCommandOutput extends ListChannelsOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListChannelsCommand_base: {
|
|
22
|
+
new (input: ListChannelsCommandInput): import("@smithy/core/client").CommandImpl<ListChannelsCommandInput, ListChannelsCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListChannelsCommandInput]): import("@smithy/core/client").CommandImpl<ListChannelsCommandInput, ListChannelsCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Lists the channels in your account. You can filter the results by source stream. The results are paginated. Use the <code>NextToken</code> value returned in the response to retrieve additional results.</p>
|
|
28
|
+
* <p>Use this operation to find channels before deleting a stream, or to audit the channels configured in an Amazon Web Services Region.</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, ListChannelsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
34
|
+
* // const { KinesisClient, ListChannelsCommand } = 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 = { // ListChannelsInput
|
|
39
|
+
* StreamFilter: [ // StreamFilterList
|
|
40
|
+
* { // StreamFilter
|
|
41
|
+
* StreamARN: "STRING_VALUE", // required
|
|
42
|
+
* StreamCreationTimestamp: new Date("TIMESTAMP"),
|
|
43
|
+
* },
|
|
44
|
+
* ],
|
|
45
|
+
* MaxResults: Number("int"),
|
|
46
|
+
* NextToken: "STRING_VALUE",
|
|
47
|
+
* };
|
|
48
|
+
* const command = new ListChannelsCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // ListChannelsOutput
|
|
51
|
+
* // ChannelSummaries: [ // ChannelSummaryList // required
|
|
52
|
+
* // { // ChannelSummary
|
|
53
|
+
* // ChannelName: "STRING_VALUE", // required
|
|
54
|
+
* // ChannelARN: "STRING_VALUE", // required
|
|
55
|
+
* // ChannelId: "STRING_VALUE", // required
|
|
56
|
+
* // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
|
|
57
|
+
* // ChannelStatusReason: "STRING_VALUE",
|
|
58
|
+
* // ChannelCreationTimestamp: new Date("TIMESTAMP"), // required
|
|
59
|
+
* // ChannelDestinationType: "S3" || "S3_TABLES", // required
|
|
60
|
+
* // Streams: [ // ChannelStreamIdentifierList // required
|
|
61
|
+
* // { // ChannelStreamIdentifier
|
|
62
|
+
* // StreamARN: "STRING_VALUE", // required
|
|
63
|
+
* // StreamCreationTimestamp: new Date("TIMESTAMP"), // required
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // NextToken: "STRING_VALUE",
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
|
|
74
|
+
* @returns {@link ListChannelsCommandOutput}
|
|
75
|
+
* @see {@link ListChannelsCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link ListChannelsCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
+
* <p>Specifies that you do not have the permissions required to perform this
|
|
81
|
+
* operation.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ExpiredNextTokenException} (client fault)
|
|
84
|
+
* <p>The pagination token passed to the operation is expired.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
87
|
+
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
|
|
88
|
+
* For more information, see the returned message.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
91
|
+
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
|
|
92
|
+
* stream requests exceeds the maximum number allowed. </p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ValidationException} (client fault)
|
|
95
|
+
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
96
|
+
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
97
|
+
* mode. </p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link KinesisServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from Kinesis service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @example To list channels
|
|
104
|
+
* ```javascript
|
|
105
|
+
* //
|
|
106
|
+
* const input = { /* empty *\/ };
|
|
107
|
+
* const command = new ListChannelsCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response is
|
|
110
|
+
* {
|
|
111
|
+
* ChannelSummaries: [
|
|
112
|
+
* {
|
|
113
|
+
* ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
|
|
114
|
+
* ChannelCreationTimestamp: "2024-07-02T00:00:00Z",
|
|
115
|
+
* ChannelDestinationType: "S3",
|
|
116
|
+
* ChannelId: "my-channel-id",
|
|
117
|
+
* ChannelName: "my-channel-name",
|
|
118
|
+
* ChannelStatus: "ACTIVE",
|
|
119
|
+
* Streams: [
|
|
120
|
+
* {
|
|
121
|
+
* StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name",
|
|
122
|
+
* StreamCreationTimestamp: "2024-07-01T00:00:00Z"
|
|
123
|
+
* }
|
|
124
|
+
* ]
|
|
125
|
+
* }
|
|
126
|
+
* ]
|
|
127
|
+
* }
|
|
128
|
+
* *\/
|
|
129
|
+
* ```
|
|
130
|
+
*
|
|
131
|
+
* @example To list channels filtered by stream
|
|
132
|
+
* ```javascript
|
|
133
|
+
* //
|
|
134
|
+
* const input = {
|
|
135
|
+
* MaxResults: 10,
|
|
136
|
+
* StreamFilter: [
|
|
137
|
+
* {
|
|
138
|
+
* StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name"
|
|
139
|
+
* }
|
|
140
|
+
* ]
|
|
141
|
+
* };
|
|
142
|
+
* const command = new ListChannelsCommand(input);
|
|
143
|
+
* const response = await client.send(command);
|
|
144
|
+
* /* response is
|
|
145
|
+
* {
|
|
146
|
+
* ChannelSummaries: [
|
|
147
|
+
* {
|
|
148
|
+
* ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
|
|
149
|
+
* ChannelCreationTimestamp: "2024-07-02T00:00:00Z",
|
|
150
|
+
* ChannelDestinationType: "S3",
|
|
151
|
+
* ChannelId: "my-channel-id",
|
|
152
|
+
* ChannelName: "my-channel-name",
|
|
153
|
+
* ChannelStatus: "ACTIVE",
|
|
154
|
+
* Streams: [
|
|
155
|
+
* {
|
|
156
|
+
* StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name",
|
|
157
|
+
* StreamCreationTimestamp: "2024-07-01T00:00:00Z"
|
|
158
|
+
* }
|
|
159
|
+
* ]
|
|
160
|
+
* }
|
|
161
|
+
* ],
|
|
162
|
+
* NextToken: "AAAAAgAAAAEAAAABbXktbmV4dC1wYWdlLXRva2Vu"
|
|
163
|
+
* }
|
|
164
|
+
* *\/
|
|
165
|
+
* ```
|
|
166
|
+
*
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export declare class ListChannelsCommand extends ListChannelsCommand_base {
|
|
170
|
+
/** @internal type navigation helper, not in runtime. */
|
|
171
|
+
protected static __types: {
|
|
172
|
+
api: {
|
|
173
|
+
input: ListChannelsInput;
|
|
174
|
+
output: ListChannelsOutput;
|
|
175
|
+
};
|
|
176
|
+
sdk: {
|
|
177
|
+
input: ListChannelsCommandInput;
|
|
178
|
+
output: ListChannelsCommandOutput;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
}
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateChannelInput, UpdateChannelOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateChannelCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateChannelCommandInput extends UpdateChannelInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateChannelCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateChannelCommandOutput extends UpdateChannelOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateChannelCommand_base: {
|
|
22
|
+
new (input: UpdateChannelCommandInput): import("@smithy/core/client").CommandImpl<UpdateChannelCommandInput, UpdateChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateChannelCommandInput): import("@smithy/core/client").CommandImpl<UpdateChannelCommandInput, UpdateChannelCommandOutput, import("..").KinesisClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates the data freshness interval or the Amazon CloudWatch Logs configuration of an existing channel. You cannot change the destination, source stream, record format, schema, encryption configuration, or service execution role of an existing channel. To change any other setting, delete the channel and create a new one.</p>
|
|
28
|
+
* <p>Updating a channel is an asynchronous operation. Upon receiving the request, Amazon Kinesis Data Streams sets the channel to the <code>UPDATING</code> state and returns immediately. After the change is applied, Amazon Kinesis Data Streams sets the channel back to the <code>ACTIVE</code> state.</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, UpdateChannelCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
34
|
+
* // const { KinesisClient, UpdateChannelCommand } = 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 = { // UpdateChannelInput
|
|
39
|
+
* ChannelARN: "STRING_VALUE", // required
|
|
40
|
+
* S3DestinationConfiguration: { // S3DestinationUpdateInput
|
|
41
|
+
* DataFreshnessInSeconds: Number("int"), // required
|
|
42
|
+
* },
|
|
43
|
+
* S3TablesDestinationConfiguration: { // S3TablesDestinationUpdateInput
|
|
44
|
+
* DataFreshnessInSeconds: Number("int"), // required
|
|
45
|
+
* },
|
|
46
|
+
* LoggingConfiguration: { // ChannelLoggingUpdateInput
|
|
47
|
+
* CloudWatchLogs: { // CloudWatchLogsUpdateInput
|
|
48
|
+
* Enabled: true || false, // required
|
|
49
|
+
* LogGroupName: "STRING_VALUE",
|
|
50
|
+
* LogStreamName: "STRING_VALUE",
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* };
|
|
54
|
+
* const command = new UpdateChannelCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* // { // UpdateChannelOutput
|
|
57
|
+
* // ChannelDescription: { // ChannelDescription
|
|
58
|
+
* // ChannelName: "STRING_VALUE", // required
|
|
59
|
+
* // ChannelARN: "STRING_VALUE", // required
|
|
60
|
+
* // ChannelId: "STRING_VALUE", // required
|
|
61
|
+
* // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
|
|
62
|
+
* // ChannelStatusReason: "STRING_VALUE",
|
|
63
|
+
* // ChannelCreationTimestamp: new Date("TIMESTAMP"), // required
|
|
64
|
+
* // ServiceExecutionRoleARN: "STRING_VALUE", // required
|
|
65
|
+
* // StreamConfigurationList: [ // ChannelStreamDescriptionList // required
|
|
66
|
+
* // { // ChannelStreamDescription
|
|
67
|
+
* // StreamARN: "STRING_VALUE", // required
|
|
68
|
+
* // StreamCreationTimestamp: new Date("TIMESTAMP"), // required
|
|
69
|
+
* // RecordConfiguration: { // RecordConfiguration
|
|
70
|
+
* // RecordFormatType: "GSR_JSON" || "JSON" || "STRING" || "BYTE_ARRAY", // required
|
|
71
|
+
* // GSRSchemaARN: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // S3DestinationConfiguration: { // S3DestinationDescription
|
|
76
|
+
* // DataFreshnessInSeconds: Number("int"), // required
|
|
77
|
+
* // DeadLetterQueueS3Configuration: { // DeadLetterQueueS3Configuration
|
|
78
|
+
* // BucketARN: "STRING_VALUE", // required
|
|
79
|
+
* // ExpectedBucketOwner: "STRING_VALUE", // required
|
|
80
|
+
* // ErrorOutputPrefix: "STRING_VALUE",
|
|
81
|
+
* // },
|
|
82
|
+
* // StorageConfiguration: { // S3StorageConfiguration
|
|
83
|
+
* // BucketARN: "STRING_VALUE", // required
|
|
84
|
+
* // ExpectedBucketOwner: "STRING_VALUE", // required
|
|
85
|
+
* // OutputKeyTemplate: "STRING_VALUE",
|
|
86
|
+
* // StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR",
|
|
87
|
+
* // CompressionType: "NONE" || "GZIP" || "ZSTD", // required
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // S3TablesDestinationConfiguration: { // S3TablesDestinationDescription
|
|
91
|
+
* // DataFreshnessInSeconds: Number("int"), // required
|
|
92
|
+
* // DeadLetterQueueS3Configuration: {
|
|
93
|
+
* // BucketARN: "STRING_VALUE", // required
|
|
94
|
+
* // ExpectedBucketOwner: "STRING_VALUE", // required
|
|
95
|
+
* // ErrorOutputPrefix: "STRING_VALUE",
|
|
96
|
+
* // },
|
|
97
|
+
* // S3TablesConfigurationList: [ // S3TablesConfigurationList // required
|
|
98
|
+
* // { // S3TablesConfiguration
|
|
99
|
+
* // TableBucketARN: "STRING_VALUE", // required
|
|
100
|
+
* // Namespace: "STRING_VALUE", // required
|
|
101
|
+
* // TableName: "STRING_VALUE", // required
|
|
102
|
+
* // CompressionType: "NONE" || "ZSTD" || "SNAPPY", // required
|
|
103
|
+
* // PartitionSpec: { // PartitionSpec
|
|
104
|
+
* // PartitionFields: [ // PartitionFieldList // required
|
|
105
|
+
* // { // PartitionField
|
|
106
|
+
* // Transform: "TIME_HOUR", // required
|
|
107
|
+
* // SourceName: "STRING_VALUE", // required
|
|
108
|
+
* // },
|
|
109
|
+
* // ],
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // ],
|
|
113
|
+
* // },
|
|
114
|
+
* // EncryptionConfiguration: { // ChannelEncryptionConfiguration
|
|
115
|
+
* // EncryptionType: "KMS", // required
|
|
116
|
+
* // KeyId: "STRING_VALUE", // required
|
|
117
|
+
* // },
|
|
118
|
+
* // LoggingConfiguration: { // ChannelLoggingConfiguration
|
|
119
|
+
* // CloudWatchLogs: { // CloudWatchLogs
|
|
120
|
+
* // Enabled: true || false, // required
|
|
121
|
+
* // LogGroupName: "STRING_VALUE",
|
|
122
|
+
* // LogStreamName: "STRING_VALUE",
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // },
|
|
126
|
+
* // };
|
|
127
|
+
*
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput}
|
|
131
|
+
* @returns {@link UpdateChannelCommandOutput}
|
|
132
|
+
* @see {@link UpdateChannelCommandInput} for command's `input` shape.
|
|
133
|
+
* @see {@link UpdateChannelCommandOutput} for command's `response` shape.
|
|
134
|
+
* @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
137
|
+
* <p>Specifies that you do not have the permissions required to perform this
|
|
138
|
+
* operation.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
141
|
+
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
|
|
142
|
+
* For more information, see the returned message.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
145
|
+
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
|
|
146
|
+
* stream requests exceeds the maximum number allowed. </p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
149
|
+
* <p>The resource is not available for this operation. For successful operation, the
|
|
150
|
+
* resource must be in the <code>ACTIVE</code> state.</p>
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
153
|
+
* <p>The requested resource could not be found. The stream might not be specified
|
|
154
|
+
* correctly.</p>
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link ValidationException} (client fault)
|
|
157
|
+
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
158
|
+
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
159
|
+
* mode. </p>
|
|
160
|
+
*
|
|
161
|
+
* @throws {@link KinesisServiceException}
|
|
162
|
+
* <p>Base exception class for all service exceptions from Kinesis service.</p>
|
|
163
|
+
*
|
|
164
|
+
*
|
|
165
|
+
* @example To update a channel
|
|
166
|
+
* ```javascript
|
|
167
|
+
* //
|
|
168
|
+
* const input = {
|
|
169
|
+
* ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
|
|
170
|
+
* LoggingConfiguration: {
|
|
171
|
+
* CloudWatchLogs: {
|
|
172
|
+
* Enabled: true,
|
|
173
|
+
* LogGroupName: "/aws/kinesis/my-channel",
|
|
174
|
+
* LogStreamName: "my-channel-log-stream"
|
|
175
|
+
* }
|
|
176
|
+
* },
|
|
177
|
+
* S3DestinationConfiguration: {
|
|
178
|
+
* DataFreshnessInSeconds: 600
|
|
179
|
+
* }
|
|
180
|
+
* };
|
|
181
|
+
* const command = new UpdateChannelCommand(input);
|
|
182
|
+
* const response = await client.send(command);
|
|
183
|
+
* /* response is
|
|
184
|
+
* {
|
|
185
|
+
* ChannelDescription: {
|
|
186
|
+
* ChannelARN: "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id",
|
|
187
|
+
* ChannelCreationTimestamp: "2024-07-02T00:00:00Z",
|
|
188
|
+
* ChannelId: "my-channel-id",
|
|
189
|
+
* ChannelName: "my-channel-name",
|
|
190
|
+
* ChannelStatus: "UPDATING",
|
|
191
|
+
* EncryptionConfiguration: {
|
|
192
|
+
* EncryptionType: "KMS",
|
|
193
|
+
* KeyId: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
194
|
+
* },
|
|
195
|
+
* LoggingConfiguration: {
|
|
196
|
+
* CloudWatchLogs: {
|
|
197
|
+
* Enabled: true,
|
|
198
|
+
* LogGroupName: "/aws/kinesis/my-channel",
|
|
199
|
+
* LogStreamName: "my-channel-log-stream"
|
|
200
|
+
* }
|
|
201
|
+
* },
|
|
202
|
+
* S3DestinationConfiguration: {
|
|
203
|
+
* DataFreshnessInSeconds: 600,
|
|
204
|
+
* DeadLetterQueueS3Configuration: {
|
|
205
|
+
* BucketARN: "arn:aws:s3:::my-channel-dlq-bucket",
|
|
206
|
+
* ErrorOutputPrefix: "kinesis-channel/errors/my-channel/my-channel-id/",
|
|
207
|
+
* ExpectedBucketOwner: "123456789012"
|
|
208
|
+
* },
|
|
209
|
+
* StorageConfiguration: {
|
|
210
|
+
* BucketARN: "arn:aws:s3:::my-channel-bucket",
|
|
211
|
+
* CompressionType: "ZSTD",
|
|
212
|
+
* ExpectedBucketOwner: "123456789012",
|
|
213
|
+
* OutputKeyTemplate: "kinesis-channel/!{channel-name}/!{channel-id}/!{yyyy}/!{MM}/!{dd}/!{HH}/!{channel-name}-!{channel-id}-!{yyyy}-!{MM}-!{dd}-!{HH}-!{mm}!{extension}",
|
|
214
|
+
* StorageClass: "STANDARD"
|
|
215
|
+
* }
|
|
216
|
+
* },
|
|
217
|
+
* ServiceExecutionRoleARN: "arn:aws:iam::123456789012:role/my-channel-role",
|
|
218
|
+
* StreamConfigurationList: [
|
|
219
|
+
* {
|
|
220
|
+
* RecordConfiguration: {
|
|
221
|
+
* RecordFormatType: "JSON"
|
|
222
|
+
* },
|
|
223
|
+
* StreamARN: "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name",
|
|
224
|
+
* StreamCreationTimestamp: "2024-07-01T00:00:00Z"
|
|
225
|
+
* }
|
|
226
|
+
* ]
|
|
227
|
+
* }
|
|
228
|
+
* }
|
|
229
|
+
* *\/
|
|
230
|
+
* ```
|
|
231
|
+
*
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
export declare class UpdateChannelCommand extends UpdateChannelCommand_base {
|
|
235
|
+
/** @internal type navigation helper, not in runtime. */
|
|
236
|
+
protected static __types: {
|
|
237
|
+
api: {
|
|
238
|
+
input: UpdateChannelInput;
|
|
239
|
+
output: UpdateChannelOutput;
|
|
240
|
+
};
|
|
241
|
+
sdk: {
|
|
242
|
+
input: UpdateChannelCommandInput;
|
|
243
|
+
output: UpdateChannelCommandOutput;
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
}
|