|
| 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 { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { DescribeAlarmContributorsInput, DescribeAlarmContributorsOutput } from "../models/models_0"; |
| 10 | +import { de_DescribeAlarmContributorsCommand, se_DescribeAlarmContributorsCommand } from "../protocols/Aws_query"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link DescribeAlarmContributorsCommand}. |
| 21 | + */ |
| 22 | +export interface DescribeAlarmContributorsCommandInput extends DescribeAlarmContributorsInput {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link DescribeAlarmContributorsCommand}. |
| 27 | + */ |
| 28 | +export interface DescribeAlarmContributorsCommandOutput extends DescribeAlarmContributorsOutput, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Returns the information of the current alarm contributors that are in <code>ALARM</code> state. This operation returns details about the individual time series that contribute to the alarm's state.</p> |
| 32 | + * @example |
| 33 | + * Use a bare-bones client and the command you need to make an API call. |
| 34 | + * ```javascript |
| 35 | + * import { CloudWatchClient, DescribeAlarmContributorsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import |
| 36 | + * // const { CloudWatchClient, DescribeAlarmContributorsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import |
| 37 | + * const client = new CloudWatchClient(config); |
| 38 | + * const input = { // DescribeAlarmContributorsInput |
| 39 | + * AlarmName: "STRING_VALUE", // required |
| 40 | + * NextToken: "STRING_VALUE", |
| 41 | + * }; |
| 42 | + * const command = new DescribeAlarmContributorsCommand(input); |
| 43 | + * const response = await client.send(command); |
| 44 | + * // { // DescribeAlarmContributorsOutput |
| 45 | + * // AlarmContributors: [ // AlarmContributors // required |
| 46 | + * // { // AlarmContributor |
| 47 | + * // ContributorId: "STRING_VALUE", // required |
| 48 | + * // ContributorAttributes: { // ContributorAttributes // required |
| 49 | + * // "<keys>": "STRING_VALUE", |
| 50 | + * // }, |
| 51 | + * // StateReason: "STRING_VALUE", // required |
| 52 | + * // StateTransitionedTimestamp: new Date("TIMESTAMP"), |
| 53 | + * // }, |
| 54 | + * // ], |
| 55 | + * // NextToken: "STRING_VALUE", |
| 56 | + * // }; |
| 57 | + * |
| 58 | + * ``` |
| 59 | + * |
| 60 | + * @param DescribeAlarmContributorsCommandInput - {@link DescribeAlarmContributorsCommandInput} |
| 61 | + * @returns {@link DescribeAlarmContributorsCommandOutput} |
| 62 | + * @see {@link DescribeAlarmContributorsCommandInput} for command's `input` shape. |
| 63 | + * @see {@link DescribeAlarmContributorsCommandOutput} for command's `response` shape. |
| 64 | + * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. |
| 65 | + * |
| 66 | + * @throws {@link InvalidNextToken} (client fault) |
| 67 | + * <p>The next token specified is invalid.</p> |
| 68 | + * |
| 69 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 70 | + * <p>The named resource does not exist.</p> |
| 71 | + * |
| 72 | + * @throws {@link CloudWatchServiceException} |
| 73 | + * <p>Base exception class for all service exceptions from CloudWatch service.</p> |
| 74 | + * |
| 75 | + * |
| 76 | + * @public |
| 77 | + */ |
| 78 | +export class DescribeAlarmContributorsCommand extends $Command |
| 79 | + .classBuilder< |
| 80 | + DescribeAlarmContributorsCommandInput, |
| 81 | + DescribeAlarmContributorsCommandOutput, |
| 82 | + CloudWatchClientResolvedConfig, |
| 83 | + ServiceInputTypes, |
| 84 | + ServiceOutputTypes |
| 85 | + >() |
| 86 | + .ep(commonParams) |
| 87 | + .m(function (this: any, Command: any, cs: any, config: CloudWatchClientResolvedConfig, o: any) { |
| 88 | + return [ |
| 89 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 90 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 91 | + ]; |
| 92 | + }) |
| 93 | + .s("GraniteServiceVersion20100801", "DescribeAlarmContributors", {}) |
| 94 | + .n("CloudWatchClient", "DescribeAlarmContributorsCommand") |
| 95 | + .f(void 0, void 0) |
| 96 | + .ser(se_DescribeAlarmContributorsCommand) |
| 97 | + .de(de_DescribeAlarmContributorsCommand) |
| 98 | + .build() { |
| 99 | + /** @internal type navigation helper, not in runtime. */ |
| 100 | + protected declare static __types: { |
| 101 | + api: { |
| 102 | + input: DescribeAlarmContributorsInput; |
| 103 | + output: DescribeAlarmContributorsOutput; |
| 104 | + }; |
| 105 | + sdk: { |
| 106 | + input: DescribeAlarmContributorsCommandInput; |
| 107 | + output: DescribeAlarmContributorsCommandOutput; |
| 108 | + }; |
| 109 | + }; |
| 110 | +} |
0 commit comments