@aws-sdk/client-kinesis 3.797.0 → 3.799.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 (36) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +148 -28
  3. package/dist-cjs/runtimeConfig.js +1 -0
  4. package/dist-es/Kinesis.js +6 -0
  5. package/dist-es/commands/ListTagsForResourceCommand.js +26 -0
  6. package/dist-es/commands/TagResourceCommand.js +26 -0
  7. package/dist-es/commands/UntagResourceCommand.js +26 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/models/models_0.js +12 -12
  10. package/dist-es/protocols/Aws_json1_1.js +63 -9
  11. package/dist-es/runtimeConfig.js +2 -1
  12. package/dist-types/Kinesis.d.ts +22 -0
  13. package/dist-types/KinesisClient.d.ts +5 -2
  14. package/dist-types/commands/CreateStreamCommand.d.ts +1 -5
  15. package/dist-types/commands/GetRecordsCommand.d.ts +4 -0
  16. package/dist-types/commands/GetShardIteratorCommand.d.ts +4 -0
  17. package/dist-types/commands/ListTagsForResourceCommand.d.ts +98 -0
  18. package/dist-types/commands/PutRecordCommand.d.ts +4 -0
  19. package/dist-types/commands/PutRecordsCommand.d.ts +4 -0
  20. package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +4 -0
  21. package/dist-types/commands/TagResourceCommand.d.ts +93 -0
  22. package/dist-types/commands/UntagResourceCommand.d.ts +93 -0
  23. package/dist-types/commands/index.d.ts +3 -0
  24. package/dist-types/models/models_0.d.ts +90 -34
  25. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  26. package/dist-types/runtimeConfig.d.ts +1 -1
  27. package/dist-types/ts3.4/Kinesis.d.ts +52 -0
  28. package/dist-types/ts3.4/KinesisClient.d.ts +18 -0
  29. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  30. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
  31. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
  32. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  33. package/dist-types/ts3.4/models/models_0.d.ts +26 -11
  34. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  35. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
  36. package/package.json +11 -11
@@ -18,6 +18,7 @@ import { IncreaseStreamRetentionPeriodCommandInput, IncreaseStreamRetentionPerio
18
18
  import { ListShardsCommandInput, ListShardsCommandOutput } from "./commands/ListShardsCommand";
19
19
  import { ListStreamConsumersCommandInput, ListStreamConsumersCommandOutput } from "./commands/ListStreamConsumersCommand";
20
20
  import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/ListStreamsCommand";
21
+ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
21
22
  import { ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput } from "./commands/ListTagsForStreamCommand";
22
23
  import { MergeShardsCommandInput, MergeShardsCommandOutput } from "./commands/MergeShardsCommand";
23
24
  import { PutRecordCommandInput, PutRecordCommandOutput } from "./commands/PutRecordCommand";
@@ -29,6 +30,8 @@ import { SplitShardCommandInput, SplitShardCommandOutput } from "./commands/Spli
29
30
  import { StartStreamEncryptionCommandInput, StartStreamEncryptionCommandOutput } from "./commands/StartStreamEncryptionCommand";
30
31
  import { StopStreamEncryptionCommandInput, StopStreamEncryptionCommandOutput } from "./commands/StopStreamEncryptionCommand";
31
32
  import { SubscribeToShardCommandInput, SubscribeToShardCommandOutput } from "./commands/SubscribeToShardCommand";
33
+ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
34
+ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
32
35
  import { UpdateShardCountCommandInput, UpdateShardCountCommandOutput } from "./commands/UpdateShardCountCommand";
33
36
  import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput } from "./commands/UpdateStreamModeCommand";
34
37
  import { KinesisClient } from "./KinesisClient";
@@ -155,6 +158,13 @@ export interface Kinesis {
155
158
  listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamsCommandOutput>;
156
159
  listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
157
160
  listStreams(args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
161
+ /**
162
+ * @see {@link ListTagsForResourceCommand}
163
+ */
164
+ listTagsForResource(): Promise<ListTagsForResourceCommandOutput>;
165
+ listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
166
+ listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
167
+ listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
158
168
  /**
159
169
  * @see {@link ListTagsForStreamCommand}
160
170
  */
@@ -222,6 +232,18 @@ export interface Kinesis {
222
232
  subscribeToShard(args: SubscribeToShardCommandInput, options?: __HttpHandlerOptions): Promise<SubscribeToShardCommandOutput>;
223
233
  subscribeToShard(args: SubscribeToShardCommandInput, cb: (err: any, data?: SubscribeToShardCommandOutput) => void): void;
224
234
  subscribeToShard(args: SubscribeToShardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeToShardCommandOutput) => void): void;
235
+ /**
236
+ * @see {@link TagResourceCommand}
237
+ */
238
+ tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
239
+ tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
240
+ tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
241
+ /**
242
+ * @see {@link UntagResourceCommand}
243
+ */
244
+ untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
245
+ untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
246
+ untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
225
247
  /**
226
248
  * @see {@link UpdateShardCountCommand}
227
249
  */
@@ -27,6 +27,7 @@ import { IncreaseStreamRetentionPeriodCommandInput, IncreaseStreamRetentionPerio
27
27
  import { ListShardsCommandInput, ListShardsCommandOutput } from "./commands/ListShardsCommand";
28
28
  import { ListStreamConsumersCommandInput, ListStreamConsumersCommandOutput } from "./commands/ListStreamConsumersCommand";
29
29
  import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/ListStreamsCommand";
30
+ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
30
31
  import { ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput } from "./commands/ListTagsForStreamCommand";
31
32
  import { MergeShardsCommandInput, MergeShardsCommandOutput } from "./commands/MergeShardsCommand";
32
33
  import { PutRecordCommandInput, PutRecordCommandOutput } from "./commands/PutRecordCommand";
@@ -38,6 +39,8 @@ import { SplitShardCommandInput, SplitShardCommandOutput } from "./commands/Spli
38
39
  import { StartStreamEncryptionCommandInput, StartStreamEncryptionCommandOutput } from "./commands/StartStreamEncryptionCommand";
39
40
  import { StopStreamEncryptionCommandInput, StopStreamEncryptionCommandOutput } from "./commands/StopStreamEncryptionCommand";
40
41
  import { SubscribeToShardCommandInput, SubscribeToShardCommandOutput } from "./commands/SubscribeToShardCommand";
42
+ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
43
+ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
41
44
  import { UpdateShardCountCommandInput, UpdateShardCountCommandOutput } from "./commands/UpdateShardCountCommand";
42
45
  import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput } from "./commands/UpdateStreamModeCommand";
43
46
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
@@ -46,11 +49,11 @@ export { __Client };
46
49
  /**
47
50
  * @public
48
51
  */
49
- export type ServiceInputTypes = AddTagsToStreamCommandInput | CreateStreamCommandInput | DecreaseStreamRetentionPeriodCommandInput | DeleteResourcePolicyCommandInput | DeleteStreamCommandInput | DeregisterStreamConsumerCommandInput | DescribeLimitsCommandInput | DescribeStreamCommandInput | DescribeStreamConsumerCommandInput | DescribeStreamSummaryCommandInput | DisableEnhancedMonitoringCommandInput | EnableEnhancedMonitoringCommandInput | GetRecordsCommandInput | GetResourcePolicyCommandInput | GetShardIteratorCommandInput | IncreaseStreamRetentionPeriodCommandInput | ListShardsCommandInput | ListStreamConsumersCommandInput | ListStreamsCommandInput | ListTagsForStreamCommandInput | MergeShardsCommandInput | PutRecordCommandInput | PutRecordsCommandInput | PutResourcePolicyCommandInput | RegisterStreamConsumerCommandInput | RemoveTagsFromStreamCommandInput | SplitShardCommandInput | StartStreamEncryptionCommandInput | StopStreamEncryptionCommandInput | SubscribeToShardCommandInput | UpdateShardCountCommandInput | UpdateStreamModeCommandInput;
52
+ export type ServiceInputTypes = AddTagsToStreamCommandInput | CreateStreamCommandInput | DecreaseStreamRetentionPeriodCommandInput | DeleteResourcePolicyCommandInput | DeleteStreamCommandInput | DeregisterStreamConsumerCommandInput | DescribeLimitsCommandInput | DescribeStreamCommandInput | DescribeStreamConsumerCommandInput | DescribeStreamSummaryCommandInput | DisableEnhancedMonitoringCommandInput | EnableEnhancedMonitoringCommandInput | GetRecordsCommandInput | GetResourcePolicyCommandInput | GetShardIteratorCommandInput | IncreaseStreamRetentionPeriodCommandInput | ListShardsCommandInput | ListStreamConsumersCommandInput | ListStreamsCommandInput | ListTagsForResourceCommandInput | ListTagsForStreamCommandInput | MergeShardsCommandInput | PutRecordCommandInput | PutRecordsCommandInput | PutResourcePolicyCommandInput | RegisterStreamConsumerCommandInput | RemoveTagsFromStreamCommandInput | SplitShardCommandInput | StartStreamEncryptionCommandInput | StopStreamEncryptionCommandInput | SubscribeToShardCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateShardCountCommandInput | UpdateStreamModeCommandInput;
50
53
  /**
51
54
  * @public
52
55
  */
53
- export type ServiceOutputTypes = AddTagsToStreamCommandOutput | CreateStreamCommandOutput | DecreaseStreamRetentionPeriodCommandOutput | DeleteResourcePolicyCommandOutput | DeleteStreamCommandOutput | DeregisterStreamConsumerCommandOutput | DescribeLimitsCommandOutput | DescribeStreamCommandOutput | DescribeStreamConsumerCommandOutput | DescribeStreamSummaryCommandOutput | DisableEnhancedMonitoringCommandOutput | EnableEnhancedMonitoringCommandOutput | GetRecordsCommandOutput | GetResourcePolicyCommandOutput | GetShardIteratorCommandOutput | IncreaseStreamRetentionPeriodCommandOutput | ListShardsCommandOutput | ListStreamConsumersCommandOutput | ListStreamsCommandOutput | ListTagsForStreamCommandOutput | MergeShardsCommandOutput | PutRecordCommandOutput | PutRecordsCommandOutput | PutResourcePolicyCommandOutput | RegisterStreamConsumerCommandOutput | RemoveTagsFromStreamCommandOutput | SplitShardCommandOutput | StartStreamEncryptionCommandOutput | StopStreamEncryptionCommandOutput | SubscribeToShardCommandOutput | UpdateShardCountCommandOutput | UpdateStreamModeCommandOutput;
56
+ export type ServiceOutputTypes = AddTagsToStreamCommandOutput | CreateStreamCommandOutput | DecreaseStreamRetentionPeriodCommandOutput | DeleteResourcePolicyCommandOutput | DeleteStreamCommandOutput | DeregisterStreamConsumerCommandOutput | DescribeLimitsCommandOutput | DescribeStreamCommandOutput | DescribeStreamConsumerCommandOutput | DescribeStreamSummaryCommandOutput | DisableEnhancedMonitoringCommandOutput | EnableEnhancedMonitoringCommandOutput | GetRecordsCommandOutput | GetResourcePolicyCommandOutput | GetShardIteratorCommandOutput | IncreaseStreamRetentionPeriodCommandOutput | ListShardsCommandOutput | ListStreamConsumersCommandOutput | ListStreamsCommandOutput | ListTagsForResourceCommandOutput | ListTagsForStreamCommandOutput | MergeShardsCommandOutput | PutRecordCommandOutput | PutRecordsCommandOutput | PutResourcePolicyCommandOutput | RegisterStreamConsumerCommandOutput | RemoveTagsFromStreamCommandOutput | SplitShardCommandOutput | StartStreamEncryptionCommandOutput | StopStreamEncryptionCommandOutput | SubscribeToShardCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateShardCountCommandOutput | UpdateStreamModeCommandOutput;
54
57
  /**
55
58
  * @public
56
59
  */
@@ -71,11 +71,7 @@ declare const CreateStreamCommand_base: {
71
71
  * <p>
72
72
  * <a>CreateStream</a> has a limit of five transactions per second per
73
73
  * account.</p>
74
- * <p>You can add tags to the stream when making a <code>CreateStream</code> request by
75
- * setting the <code>Tags</code> parameter. If you pass <code>Tags</code> parameter, in
76
- * addition to having <code>kinesis:createStream</code> permission, you must also have
77
- * <code>kinesis:addTagsToStream</code> permission for the stream that will be created.
78
- * Tags will take effect from the <code>CREATING</code> status of the stream. </p>
74
+ * <p>You can add tags to the stream when making a <code>CreateStream</code> request by setting the <code>Tags</code> parameter. If you pass the <code>Tags</code> parameter, in addition to having the <code>kinesis:CreateStream</code> permission, you must also have the <code>kinesis:AddTagsToStream</code> permission for the stream that will be created. The <code>kinesis:TagResource</code> permission won’t work to tag streams on creation. Tags will take effect from the <code>CREATING</code> status of the stream, but you can't make any updates to the tags until the stream is in <code>ACTIVE</code> state.</p>
79
75
  * @example
80
76
  * Use a bare-bones client and the command you need to make an API call.
81
77
  * ```javascript
@@ -134,6 +134,10 @@ declare const GetRecordsCommand_base: {
134
134
  * @throws {@link ExpiredIteratorException} (client fault)
135
135
  * <p>The provided iterator exceeds the maximum age allowed.</p>
136
136
  *
137
+ * @throws {@link InternalFailureException} (server fault)
138
+ * <p>The processing of the request failed because of an unknown error, exception, or
139
+ * failure.</p>
140
+ *
137
141
  * @throws {@link InvalidArgumentException} (client fault)
138
142
  * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
139
143
  * For more information, see the returned message.</p>
@@ -98,6 +98,10 @@ declare const GetShardIteratorCommand_base: {
98
98
  * <p>Specifies that you do not have the permissions required to perform this
99
99
  * operation.</p>
100
100
  *
101
+ * @throws {@link InternalFailureException} (server fault)
102
+ * <p>The processing of the request failed because of an unknown error, exception, or
103
+ * failure.</p>
104
+ *
101
105
  * @throws {@link InvalidArgumentException} (client fault)
102
106
  * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
103
107
  * For more information, see the returned message.</p>
@@ -0,0 +1,98 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
4
+ import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListTagsForResourceCommand}.
14
+ */
15
+ export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListTagsForResourceCommand}.
21
+ */
22
+ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
23
+ }
24
+ declare const ListTagsForResourceCommand_base: {
25
+ new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListTagsForResourceCommandInput]): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</p>
31
+ * <p>For more information about tagging Kinesis resources, see <a href="https://docs.aws.amazon.com/streams/latest/dev/tagging.html">Tag your Amazon Kinesis Data Streams resources</a>.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { KinesisClient, ListTagsForResourceCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
36
+ * // const { KinesisClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
37
+ * const client = new KinesisClient(config);
38
+ * const input = { // ListTagsForResourceInput
39
+ * ResourceARN: "STRING_VALUE",
40
+ * };
41
+ * const command = new ListTagsForResourceCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // ListTagsForResourceOutput
44
+ * // Tags: [ // TagList
45
+ * // { // Tag
46
+ * // Key: "STRING_VALUE", // required
47
+ * // Value: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
55
+ * @returns {@link ListTagsForResourceCommandOutput}
56
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
57
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
58
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
59
+ *
60
+ * @throws {@link AccessDeniedException} (client fault)
61
+ * <p>Specifies that you do not have the permissions required to perform this
62
+ * operation.</p>
63
+ *
64
+ * @throws {@link InvalidArgumentException} (client fault)
65
+ * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
66
+ * For more information, see the returned message.</p>
67
+ *
68
+ * @throws {@link LimitExceededException} (client fault)
69
+ * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
70
+ * stream requests exceeds the maximum number allowed. </p>
71
+ *
72
+ * @throws {@link ResourceInUseException} (client fault)
73
+ * <p>The resource is not available for this operation. For successful operation, the
74
+ * resource must be in the <code>ACTIVE</code> state.</p>
75
+ *
76
+ * @throws {@link ResourceNotFoundException} (client fault)
77
+ * <p>The requested resource could not be found. The stream might not be specified
78
+ * correctly.</p>
79
+ *
80
+ * @throws {@link KinesisServiceException}
81
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
82
+ *
83
+ *
84
+ * @public
85
+ */
86
+ export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: ListTagsForResourceInput;
91
+ output: ListTagsForResourceOutput;
92
+ };
93
+ sdk: {
94
+ input: ListTagsForResourceCommandInput;
95
+ output: ListTagsForResourceCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -102,6 +102,10 @@ declare const PutRecordCommand_base: {
102
102
  * <p>Specifies that you do not have the permissions required to perform this
103
103
  * operation.</p>
104
104
  *
105
+ * @throws {@link InternalFailureException} (server fault)
106
+ * <p>The processing of the request failed because of an unknown error, exception, or
107
+ * failure.</p>
108
+ *
105
109
  * @throws {@link InvalidArgumentException} (client fault)
106
110
  * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
107
111
  * For more information, see the returned message.</p>
@@ -132,6 +132,10 @@ declare const PutRecordsCommand_base: {
132
132
  * <p>Specifies that you do not have the permissions required to perform this
133
133
  * operation.</p>
134
134
  *
135
+ * @throws {@link InternalFailureException} (server fault)
136
+ * <p>The processing of the request failed because of an unknown error, exception, or
137
+ * failure.</p>
138
+ *
135
139
  * @throws {@link InvalidArgumentException} (client fault)
136
140
  * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
137
141
  * For more information, see the returned message.</p>
@@ -32,6 +32,7 @@ declare const RegisterStreamConsumerCommand_base: {
32
32
  * from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every
33
33
  * shard you subscribe to. This rate is unaffected by the total number of consumers that
34
34
  * read from the same stream.</p>
35
+ * <p>You can add tags to the registered consumer when making a <code>RegisterStreamConsumer</code> request by setting the <code>Tags</code> parameter. If you pass the <code>Tags</code> parameter, in addition to having the <code>kinesis:RegisterStreamConsumer</code> permission, you must also have the <code>kinesis:TagResource</code> permission for the consumer that will be registered. Tags will take effect from the <code>CREATING</code> status of the consumer.</p>
35
36
  * <p>You can register up to 20 consumers per stream. A given consumer can only be
36
37
  * registered with one stream at a time.</p>
37
38
  * <p>For an example of how to use this operation, see <a href="https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
@@ -50,6 +51,9 @@ declare const RegisterStreamConsumerCommand_base: {
50
51
  * const input = { // RegisterStreamConsumerInput
51
52
  * StreamARN: "STRING_VALUE", // required
52
53
  * ConsumerName: "STRING_VALUE", // required
54
+ * Tags: { // TagMap
55
+ * "<keys>": "STRING_VALUE",
56
+ * },
53
57
  * };
54
58
  * const command = new RegisterStreamConsumerCommand(input);
55
59
  * const response = await client.send(command);
@@ -0,0 +1,93 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
4
+ import { TagResourceInput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link TagResourceCommand}.
14
+ */
15
+ export interface TagResourceCommandInput extends TagResourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link TagResourceCommand}.
21
+ */
22
+ export interface TagResourceCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const TagResourceCommand_base: {
25
+ new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Adds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KinesisClient, TagResourceCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
35
+ * // const { KinesisClient, TagResourceCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
36
+ * const client = new KinesisClient(config);
37
+ * const input = { // TagResourceInput
38
+ * Tags: { // TagMap // required
39
+ * "<keys>": "STRING_VALUE",
40
+ * },
41
+ * ResourceARN: "STRING_VALUE",
42
+ * };
43
+ * const command = new TagResourceCommand(input);
44
+ * const response = await client.send(command);
45
+ * // {};
46
+ *
47
+ * ```
48
+ *
49
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
50
+ * @returns {@link TagResourceCommandOutput}
51
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
52
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
53
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
54
+ *
55
+ * @throws {@link AccessDeniedException} (client fault)
56
+ * <p>Specifies that you do not have the permissions required to perform this
57
+ * operation.</p>
58
+ *
59
+ * @throws {@link InvalidArgumentException} (client fault)
60
+ * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
61
+ * For more information, see the returned message.</p>
62
+ *
63
+ * @throws {@link LimitExceededException} (client fault)
64
+ * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
65
+ * stream requests exceeds the maximum number allowed. </p>
66
+ *
67
+ * @throws {@link ResourceInUseException} (client fault)
68
+ * <p>The resource is not available for this operation. For successful operation, the
69
+ * resource must be in the <code>ACTIVE</code> state.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>The requested resource could not be found. The stream might not be specified
73
+ * correctly.</p>
74
+ *
75
+ * @throws {@link KinesisServiceException}
76
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
77
+ *
78
+ *
79
+ * @public
80
+ */
81
+ export declare class TagResourceCommand extends TagResourceCommand_base {
82
+ /** @internal type navigation helper, not in runtime. */
83
+ protected static __types: {
84
+ api: {
85
+ input: TagResourceInput;
86
+ output: {};
87
+ };
88
+ sdk: {
89
+ input: TagResourceCommandInput;
90
+ output: TagResourceCommandOutput;
91
+ };
92
+ };
93
+ }
@@ -0,0 +1,93 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
4
+ import { UntagResourceInput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UntagResourceCommand}.
14
+ */
15
+ export interface UntagResourceCommandInput extends UntagResourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UntagResourceCommand}.
21
+ */
22
+ export interface UntagResourceCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const UntagResourceCommand_base: {
25
+ new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KinesisClient, UntagResourceCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
35
+ * // const { KinesisClient, UntagResourceCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
36
+ * const client = new KinesisClient(config);
37
+ * const input = { // UntagResourceInput
38
+ * TagKeys: [ // TagKeyList // required
39
+ * "STRING_VALUE",
40
+ * ],
41
+ * ResourceARN: "STRING_VALUE",
42
+ * };
43
+ * const command = new UntagResourceCommand(input);
44
+ * const response = await client.send(command);
45
+ * // {};
46
+ *
47
+ * ```
48
+ *
49
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
50
+ * @returns {@link UntagResourceCommandOutput}
51
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
52
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
53
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
54
+ *
55
+ * @throws {@link AccessDeniedException} (client fault)
56
+ * <p>Specifies that you do not have the permissions required to perform this
57
+ * operation.</p>
58
+ *
59
+ * @throws {@link InvalidArgumentException} (client fault)
60
+ * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
61
+ * For more information, see the returned message.</p>
62
+ *
63
+ * @throws {@link LimitExceededException} (client fault)
64
+ * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
65
+ * stream requests exceeds the maximum number allowed. </p>
66
+ *
67
+ * @throws {@link ResourceInUseException} (client fault)
68
+ * <p>The resource is not available for this operation. For successful operation, the
69
+ * resource must be in the <code>ACTIVE</code> state.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>The requested resource could not be found. The stream might not be specified
73
+ * correctly.</p>
74
+ *
75
+ * @throws {@link KinesisServiceException}
76
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
77
+ *
78
+ *
79
+ * @public
80
+ */
81
+ export declare class UntagResourceCommand extends UntagResourceCommand_base {
82
+ /** @internal type navigation helper, not in runtime. */
83
+ protected static __types: {
84
+ api: {
85
+ input: UntagResourceInput;
86
+ output: {};
87
+ };
88
+ sdk: {
89
+ input: UntagResourceCommandInput;
90
+ output: UntagResourceCommandOutput;
91
+ };
92
+ };
93
+ }
@@ -17,6 +17,7 @@ export * from "./IncreaseStreamRetentionPeriodCommand";
17
17
  export * from "./ListShardsCommand";
18
18
  export * from "./ListStreamConsumersCommand";
19
19
  export * from "./ListStreamsCommand";
20
+ export * from "./ListTagsForResourceCommand";
20
21
  export * from "./ListTagsForStreamCommand";
21
22
  export * from "./MergeShardsCommand";
22
23
  export * from "./PutRecordCommand";
@@ -28,5 +29,7 @@ export * from "./SplitShardCommand";
28
29
  export * from "./StartStreamEncryptionCommand";
29
30
  export * from "./StopStreamEncryptionCommand";
30
31
  export * from "./SubscribeToShardCommand";
32
+ export * from "./TagResourceCommand";
33
+ export * from "./UntagResourceCommand";
31
34
  export * from "./UpdateShardCountCommand";
32
35
  export * from "./UpdateStreamModeCommand";
@@ -24,7 +24,7 @@ export interface AddTagsToStreamInput {
24
24
  */
25
25
  StreamName?: string | undefined;
26
26
  /**
27
- * <p>A set of up to 10 key-value pairs to use to create the tags.</p>
27
+ * <p>A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.</p>
28
28
  * @public
29
29
  */
30
30
  Tags: Record<string, string> | undefined;
@@ -264,7 +264,7 @@ export interface CreateStreamInput {
264
264
  */
265
265
  StreamModeDetails?: StreamModeDetails | undefined;
266
266
  /**
267
- * <p>A set of up to 10 key-value pairs to use to create the tags.</p>
267
+ * <p>A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.</p>
268
268
  * @public
269
269
  */
270
270
  Tags?: Record<string, string> | undefined;
@@ -1189,6 +1189,19 @@ export interface GetRecordsOutput {
1189
1189
  */
1190
1190
  ChildShards?: ChildShard[] | undefined;
1191
1191
  }
1192
+ /**
1193
+ * <p>The processing of the request failed because of an unknown error, exception, or
1194
+ * failure.</p>
1195
+ * @public
1196
+ */
1197
+ export declare class InternalFailureException extends __BaseException {
1198
+ readonly name: "InternalFailureException";
1199
+ readonly $fault: "server";
1200
+ /**
1201
+ * @internal
1202
+ */
1203
+ constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
1204
+ }
1192
1205
  /**
1193
1206
  * <p>The ciphertext references a key that doesn't exist or that you don't have access
1194
1207
  * to.</p>
@@ -1425,19 +1438,6 @@ export interface IncreaseStreamRetentionPeriodInput {
1425
1438
  */
1426
1439
  StreamARN?: string | undefined;
1427
1440
  }
1428
- /**
1429
- * <p>The processing of the request failed because of an unknown error, exception, or
1430
- * failure.</p>
1431
- * @public
1432
- */
1433
- export declare class InternalFailureException extends __BaseException {
1434
- readonly name: "InternalFailureException";
1435
- readonly $fault: "server";
1436
- /**
1437
- * @internal
1438
- */
1439
- constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
1440
- }
1441
1441
  /**
1442
1442
  * @public
1443
1443
  * @enum
@@ -1811,6 +1811,45 @@ export interface ListStreamsOutput {
1811
1811
  */
1812
1812
  StreamSummaries?: StreamSummary[] | undefined;
1813
1813
  }
1814
+ /**
1815
+ * @public
1816
+ */
1817
+ export interface ListTagsForResourceInput {
1818
+ /**
1819
+ * <p>The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.</p>
1820
+ * @public
1821
+ */
1822
+ ResourceARN?: string | undefined;
1823
+ }
1824
+ /**
1825
+ * <p>Metadata assigned to the stream or consumer, consisting of a key-value pair.</p>
1826
+ * @public
1827
+ */
1828
+ export interface Tag {
1829
+ /**
1830
+ * <p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
1831
+ * Unicode letters, digits, white space, _ . / = + - % @</p>
1832
+ * @public
1833
+ */
1834
+ Key: string | undefined;
1835
+ /**
1836
+ * <p>An optional string, typically used to describe or define the tag. Maximum length: 256
1837
+ * characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
1838
+ * @</p>
1839
+ * @public
1840
+ */
1841
+ Value?: string | undefined;
1842
+ }
1843
+ /**
1844
+ * @public
1845
+ */
1846
+ export interface ListTagsForResourceOutput {
1847
+ /**
1848
+ * <p>An array of tags associated with the specified Kinesis resource.</p>
1849
+ * @public
1850
+ */
1851
+ Tags?: Tag[] | undefined;
1852
+ }
1814
1853
  /**
1815
1854
  * <p>Represents the input for <code>ListTagsForStream</code>.</p>
1816
1855
  * @public
@@ -1842,25 +1881,6 @@ export interface ListTagsForStreamInput {
1842
1881
  */
1843
1882
  StreamARN?: string | undefined;
1844
1883
  }
1845
- /**
1846
- * <p>Metadata assigned to the stream, consisting of a key-value pair.</p>
1847
- * @public
1848
- */
1849
- export interface Tag {
1850
- /**
1851
- * <p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
1852
- * Unicode letters, digits, white space, _ . / = + - % @</p>
1853
- * @public
1854
- */
1855
- Key: string | undefined;
1856
- /**
1857
- * <p>An optional string, typically used to describe or define the tag. Maximum length: 256
1858
- * characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
1859
- * @</p>
1860
- * @public
1861
- */
1862
- Value?: string | undefined;
1863
- }
1864
1884
  /**
1865
1885
  * <p>Represents the output for <code>ListTagsForStream</code>.</p>
1866
1886
  * @public
@@ -2162,6 +2182,11 @@ export interface RegisterStreamConsumerInput {
2162
2182
  * @public
2163
2183
  */
2164
2184
  ConsumerName: string | undefined;
2185
+ /**
2186
+ * <p>A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.</p>
2187
+ * @public
2188
+ */
2189
+ Tags?: Record<string, string> | undefined;
2165
2190
  }
2166
2191
  /**
2167
2192
  * @public
@@ -2670,6 +2695,37 @@ export interface SubscribeToShardOutput {
2670
2695
  */
2671
2696
  EventStream: AsyncIterable<SubscribeToShardEventStream> | undefined;
2672
2697
  }
2698
+ /**
2699
+ * @public
2700
+ */
2701
+ export interface TagResourceInput {
2702
+ /**
2703
+ * <p>An array of tags to be added to the Kinesis resource. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.</p>
2704
+ * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.</p>
2705
+ * @public
2706
+ */
2707
+ Tags: Record<string, string> | undefined;
2708
+ /**
2709
+ * <p>The Amazon Resource Name (ARN) of the Kinesis resource to which to add tags.</p>
2710
+ * @public
2711
+ */
2712
+ ResourceARN?: string | undefined;
2713
+ }
2714
+ /**
2715
+ * @public
2716
+ */
2717
+ export interface UntagResourceInput {
2718
+ /**
2719
+ * <p>A list of tag key-value pairs. Existing tags of the resource whose keys are members of this list will be removed from the Kinesis resource.</p>
2720
+ * @public
2721
+ */
2722
+ TagKeys: string[] | undefined;
2723
+ /**
2724
+ * <p>The Amazon Resource Name (ARN) of the Kinesis resource from which to remove tags.</p>
2725
+ * @public
2726
+ */
2727
+ ResourceARN?: string | undefined;
2728
+ }
2673
2729
  /**
2674
2730
  * @public
2675
2731
  * @enum