|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 8 | +import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient"; |
| 9 | +import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0"; |
| 10 | +import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Aws_json1_1"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link ListTagsForResourceCommand}. |
| 21 | + */ |
| 22 | +export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link ListTagsForResourceCommand}. |
| 27 | + */ |
| 28 | +export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <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> |
| 32 | + * <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> |
| 33 | + * @example |
| 34 | + * Use a bare-bones client and the command you need to make an API call. |
| 35 | + * ```javascript |
| 36 | + * import { KinesisClient, ListTagsForResourceCommand } from "@aws-sdk/client-kinesis"; // ES Modules import |
| 37 | + * // const { KinesisClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import |
| 38 | + * const client = new KinesisClient(config); |
| 39 | + * const input = { // ListTagsForResourceInput |
| 40 | + * ResourceARN: "STRING_VALUE", |
| 41 | + * }; |
| 42 | + * const command = new ListTagsForResourceCommand(input); |
| 43 | + * const response = await client.send(command); |
| 44 | + * // { // ListTagsForResourceOutput |
| 45 | + * // Tags: [ // TagList |
| 46 | + * // { // Tag |
| 47 | + * // Key: "STRING_VALUE", // required |
| 48 | + * // Value: "STRING_VALUE", |
| 49 | + * // }, |
| 50 | + * // ], |
| 51 | + * // }; |
| 52 | + * |
| 53 | + * ``` |
| 54 | + * |
| 55 | + * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput} |
| 56 | + * @returns {@link ListTagsForResourceCommandOutput} |
| 57 | + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. |
| 58 | + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. |
| 59 | + * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape. |
| 60 | + * |
| 61 | + * @throws {@link AccessDeniedException} (client fault) |
| 62 | + * <p>Specifies that you do not have the permissions required to perform this |
| 63 | + * operation.</p> |
| 64 | + * |
| 65 | + * @throws {@link InvalidArgumentException} (client fault) |
| 66 | + * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used. |
| 67 | + * For more information, see the returned message.</p> |
| 68 | + * |
| 69 | + * @throws {@link LimitExceededException} (client fault) |
| 70 | + * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent |
| 71 | + * stream requests exceeds the maximum number allowed. </p> |
| 72 | + * |
| 73 | + * @throws {@link ResourceInUseException} (client fault) |
| 74 | + * <p>The resource is not available for this operation. For successful operation, the |
| 75 | + * resource must be in the <code>ACTIVE</code> state.</p> |
| 76 | + * |
| 77 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 78 | + * <p>The requested resource could not be found. The stream might not be specified |
| 79 | + * correctly.</p> |
| 80 | + * |
| 81 | + * @throws {@link KinesisServiceException} |
| 82 | + * <p>Base exception class for all service exceptions from Kinesis service.</p> |
| 83 | + * |
| 84 | + * |
| 85 | + * @public |
| 86 | + */ |
| 87 | +export class ListTagsForResourceCommand extends $Command |
| 88 | + .classBuilder< |
| 89 | + ListTagsForResourceCommandInput, |
| 90 | + ListTagsForResourceCommandOutput, |
| 91 | + KinesisClientResolvedConfig, |
| 92 | + ServiceInputTypes, |
| 93 | + ServiceOutputTypes |
| 94 | + >() |
| 95 | + .ep({ |
| 96 | + ...commonParams, |
| 97 | + OperationType: { type: "staticContextParams", value: `control` }, |
| 98 | + ResourceARN: { type: "contextParams", name: "ResourceARN" }, |
| 99 | + }) |
| 100 | + .m(function (this: any, Command: any, cs: any, config: KinesisClientResolvedConfig, o: any) { |
| 101 | + return [ |
| 102 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 103 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 104 | + ]; |
| 105 | + }) |
| 106 | + .s("Kinesis_20131202", "ListTagsForResource", {}) |
| 107 | + .n("KinesisClient", "ListTagsForResourceCommand") |
| 108 | + .f(void 0, void 0) |
| 109 | + .ser(se_ListTagsForResourceCommand) |
| 110 | + .de(de_ListTagsForResourceCommand) |
| 111 | + .build() { |
| 112 | + /** @internal type navigation helper, not in runtime. */ |
| 113 | + protected declare static __types: { |
| 114 | + api: { |
| 115 | + input: ListTagsForResourceInput; |
| 116 | + output: ListTagsForResourceOutput; |
| 117 | + }; |
| 118 | + sdk: { |
| 119 | + input: ListTagsForResourceCommandInput; |
| 120 | + output: ListTagsForResourceCommandOutput; |
| 121 | + }; |
| 122 | + }; |
| 123 | +} |
0 commit comments