@aws-sdk/client-cloudwatch 3.296.0 → 3.297.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 (55) hide show
  1. package/dist-cjs/protocols/Aws_query.js +64 -347
  2. package/dist-es/protocols/Aws_query.js +64 -347
  3. package/dist-types/CloudWatch.d.ts +39 -0
  4. package/dist-types/CloudWatchClient.d.ts +24 -4
  5. package/dist-types/commands/DeleteAlarmsCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteDashboardsCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteInsightRulesCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteMetricStreamCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeAlarmsCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeInsightRulesCommand.d.ts +16 -0
  15. package/dist-types/commands/DisableAlarmActionsCommand.d.ts +16 -0
  16. package/dist-types/commands/DisableInsightRulesCommand.d.ts +16 -0
  17. package/dist-types/commands/EnableAlarmActionsCommand.d.ts +16 -0
  18. package/dist-types/commands/EnableInsightRulesCommand.d.ts +16 -0
  19. package/dist-types/commands/GetDashboardCommand.d.ts +16 -0
  20. package/dist-types/commands/GetInsightRuleReportCommand.d.ts +16 -0
  21. package/dist-types/commands/GetMetricDataCommand.d.ts +16 -0
  22. package/dist-types/commands/GetMetricStatisticsCommand.d.ts +16 -0
  23. package/dist-types/commands/GetMetricStreamCommand.d.ts +16 -0
  24. package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +16 -0
  25. package/dist-types/commands/ListDashboardsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListManagedInsightRulesCommand.d.ts +16 -0
  27. package/dist-types/commands/ListMetricStreamsCommand.d.ts +16 -0
  28. package/dist-types/commands/ListMetricsCommand.d.ts +16 -0
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  30. package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +16 -0
  31. package/dist-types/commands/PutCompositeAlarmCommand.d.ts +16 -0
  32. package/dist-types/commands/PutDashboardCommand.d.ts +16 -0
  33. package/dist-types/commands/PutInsightRuleCommand.d.ts +16 -0
  34. package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +16 -0
  35. package/dist-types/commands/PutMetricAlarmCommand.d.ts +16 -0
  36. package/dist-types/commands/PutMetricDataCommand.d.ts +16 -0
  37. package/dist-types/commands/PutMetricStreamCommand.d.ts +16 -0
  38. package/dist-types/commands/SetAlarmStateCommand.d.ts +16 -0
  39. package/dist-types/commands/StartMetricStreamsCommand.d.ts +16 -0
  40. package/dist-types/commands/StopMetricStreamsCommand.d.ts +16 -0
  41. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  42. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  43. package/dist-types/models/CloudWatchServiceException.d.ts +2 -0
  44. package/dist-types/models/models_0.d.ts +298 -2
  45. package/dist-types/pagination/DescribeAlarmHistoryPaginator.d.ts +3 -0
  46. package/dist-types/pagination/DescribeAlarmsPaginator.d.ts +3 -0
  47. package/dist-types/pagination/DescribeAnomalyDetectorsPaginator.d.ts +3 -0
  48. package/dist-types/pagination/DescribeInsightRulesPaginator.d.ts +3 -0
  49. package/dist-types/pagination/GetMetricDataPaginator.d.ts +3 -0
  50. package/dist-types/pagination/Interfaces.d.ts +3 -0
  51. package/dist-types/pagination/ListDashboardsPaginator.d.ts +3 -0
  52. package/dist-types/pagination/ListManagedInsightRulesPaginator.d.ts +3 -0
  53. package/dist-types/pagination/ListMetricStreamsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/ListMetricsPaginator.d.ts +3 -0
  55. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DescribeAlarmHistoryInput, DescribeAlarmHistoryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAlarmHistoryCommand}.
8
10
  */
9
11
  export interface DescribeAlarmHistoryCommandInput extends DescribeAlarmHistoryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAlarmHistoryCommand}.
13
17
  */
14
18
  export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the history for the specified alarm. You can filter the results by date range or item type.
18
23
  * If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.</p>
19
24
  * <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
@@ -30,6 +35,8 @@ export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryO
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeAlarmHistoryCommandInput - {@link DescribeAlarmHistoryCommandInput}
39
+ * @returns {@link DescribeAlarmHistoryCommandOutput}
33
40
  * @see {@link DescribeAlarmHistoryCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeAlarmHistoryCommandOutput} for command's `response` shape.
35
42
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryO
42
49
  export declare class DescribeAlarmHistoryCommand extends $Command<DescribeAlarmHistoryCommandInput, DescribeAlarmHistoryCommandOutput, CloudWatchClientResolvedConfig> {
43
50
  readonly input: DescribeAlarmHistoryCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeAlarmHistoryCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAlarmHistoryCommandInput, DescribeAlarmHistoryCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DescribeAlarmsInput, DescribeAlarmsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAlarmsCommand}.
8
10
  */
9
11
  export interface DescribeAlarmsCommandInput extends DescribeAlarmsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAlarmsCommand}.
13
17
  */
14
18
  export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm
18
23
  * name, the alarm state, or a prefix for any action.</p>
19
24
  * <p>To use this operation and return information about composite alarms, you must be signed on with
@@ -29,6 +34,8 @@ export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeAlarmsCommandInput - {@link DescribeAlarmsCommandInput}
38
+ * @returns {@link DescribeAlarmsCommandOutput}
32
39
  * @see {@link DescribeAlarmsCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeAlarmsCommandOutput} for command's `response` shape.
34
41
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __Met
41
48
  export declare class DescribeAlarmsCommand extends $Command<DescribeAlarmsCommandInput, DescribeAlarmsCommandOutput, CloudWatchClientResolvedConfig> {
42
49
  readonly input: DescribeAlarmsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DescribeAlarmsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAlarmsCommandInput, DescribeAlarmsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DescribeAlarmsForMetricInput, DescribeAlarmsForMetricOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAlarmsForMetricCommand}.
8
10
  */
9
11
  export interface DescribeAlarmsForMetricCommandInput extends DescribeAlarmsForMetricInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAlarmsForMetricCommand}.
13
17
  */
14
18
  export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForMetricOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the alarms for the specified metric. To
18
23
  * filter the results, specify a statistic, period, or unit.</p>
19
24
  * <p>This operation retrieves only standard alarms that are based on
@@ -29,6 +34,8 @@ export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForM
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeAlarmsForMetricCommandInput - {@link DescribeAlarmsForMetricCommandInput}
38
+ * @returns {@link DescribeAlarmsForMetricCommandOutput}
32
39
  * @see {@link DescribeAlarmsForMetricCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeAlarmsForMetricCommandOutput} for command's `response` shape.
34
41
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForM
38
45
  export declare class DescribeAlarmsForMetricCommand extends $Command<DescribeAlarmsForMetricCommandInput, DescribeAlarmsForMetricCommandOutput, CloudWatchClientResolvedConfig> {
39
46
  readonly input: DescribeAlarmsForMetricCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: DescribeAlarmsForMetricCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAlarmsForMetricCommandInput, DescribeAlarmsForMetricCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DescribeAnomalyDetectorsInput, DescribeAnomalyDetectorsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAnomalyDetectorsCommand}.
8
10
  */
9
11
  export interface DescribeAnomalyDetectorsCommandInput extends DescribeAnomalyDetectorsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAnomalyDetectorsCommand}.
13
17
  */
14
18
  export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDetectorsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the anomaly detection models that you have created in your account.
18
23
  * For single metric anomaly detectors,
19
24
  * you can list all of the models in your account or filter the results
@@ -31,6 +36,8 @@ export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDe
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DescribeAnomalyDetectorsCommandInput - {@link DescribeAnomalyDetectorsCommandInput}
40
+ * @returns {@link DescribeAnomalyDetectorsCommandOutput}
34
41
  * @see {@link DescribeAnomalyDetectorsCommandInput} for command's `input` shape.
35
42
  * @see {@link DescribeAnomalyDetectorsCommandOutput} for command's `response` shape.
36
43
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDe
52
59
  export declare class DescribeAnomalyDetectorsCommand extends $Command<DescribeAnomalyDetectorsCommandInput, DescribeAnomalyDetectorsCommandOutput, CloudWatchClientResolvedConfig> {
53
60
  readonly input: DescribeAnomalyDetectorsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeAnomalyDetectorsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAnomalyDetectorsCommandInput, DescribeAnomalyDetectorsCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DescribeInsightRulesInput, DescribeInsightRulesOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeInsightRulesCommand}.
8
10
  */
9
11
  export interface DescribeInsightRulesCommandInput extends DescribeInsightRulesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeInsightRulesCommand}.
13
17
  */
14
18
  export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of all the Contributor Insights rules in your account.</p>
18
23
  * <p>For more information about Contributor Insights, see
19
24
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p>
@@ -27,6 +32,8 @@ export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesO
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeInsightRulesCommandInput - {@link DescribeInsightRulesCommandInput}
36
+ * @returns {@link DescribeInsightRulesCommandOutput}
30
37
  * @see {@link DescribeInsightRulesCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeInsightRulesCommandOutput} for command's `response` shape.
32
39
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -39,11 +46,20 @@ export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesO
39
46
  export declare class DescribeInsightRulesCommand extends $Command<DescribeInsightRulesCommandInput, DescribeInsightRulesCommandOutput, CloudWatchClientResolvedConfig> {
40
47
  readonly input: DescribeInsightRulesCommandInput;
41
48
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
49
+ /**
50
+ * @public
51
+ */
42
52
  constructor(input: DescribeInsightRulesCommandInput);
43
53
  /**
44
54
  * @internal
45
55
  */
46
56
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeInsightRulesCommandInput, DescribeInsightRulesCommandOutput>;
57
+ /**
58
+ * @internal
59
+ */
47
60
  private serialize;
61
+ /**
62
+ * @internal
63
+ */
48
64
  private deserialize;
49
65
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DisableAlarmActionsInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableAlarmActionsCommand}.
8
10
  */
9
11
  export interface DisableAlarmActionsCommandInput extends DisableAlarmActionsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableAlarmActionsCommand}.
13
17
  */
14
18
  export interface DisableAlarmActionsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables the actions for the specified alarms. When an alarm's actions are disabled, the
18
23
  * alarm actions do not execute when the alarm state changes.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DisableAlarmActionsCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DisableAlarmActionsCommandInput - {@link DisableAlarmActionsCommandInput}
35
+ * @returns {@link DisableAlarmActionsCommandOutput}
29
36
  * @see {@link DisableAlarmActionsCommandInput} for command's `input` shape.
30
37
  * @see {@link DisableAlarmActionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -35,11 +42,20 @@ export interface DisableAlarmActionsCommandOutput extends __MetadataBearer {
35
42
  export declare class DisableAlarmActionsCommand extends $Command<DisableAlarmActionsCommandInput, DisableAlarmActionsCommandOutput, CloudWatchClientResolvedConfig> {
36
43
  readonly input: DisableAlarmActionsCommandInput;
37
44
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
45
+ /**
46
+ * @public
47
+ */
38
48
  constructor(input: DisableAlarmActionsCommandInput);
39
49
  /**
40
50
  * @internal
41
51
  */
42
52
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableAlarmActionsCommandInput, DisableAlarmActionsCommandOutput>;
53
+ /**
54
+ * @internal
55
+ */
43
56
  private serialize;
57
+ /**
58
+ * @internal
59
+ */
44
60
  private deserialize;
45
61
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { DisableInsightRulesInput, DisableInsightRulesOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableInsightRulesCommand}.
8
10
  */
9
11
  export interface DisableInsightRulesCommandInput extends DisableInsightRulesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableInsightRulesCommand}.
13
17
  */
14
18
  export interface DisableInsightRulesCommandOutput extends DisableInsightRulesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do
18
23
  * not incur costs.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DisableInsightRulesCommandOutput extends DisableInsightRulesOut
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DisableInsightRulesCommandInput - {@link DisableInsightRulesCommandInput}
35
+ * @returns {@link DisableInsightRulesCommandOutput}
29
36
  * @see {@link DisableInsightRulesCommandInput} for command's `input` shape.
30
37
  * @see {@link DisableInsightRulesCommandOutput} for command's `response` shape.
31
38
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DisableInsightRulesCommandOutput extends DisableInsightRulesOut
41
48
  export declare class DisableInsightRulesCommand extends $Command<DisableInsightRulesCommandInput, DisableInsightRulesCommandOutput, CloudWatchClientResolvedConfig> {
42
49
  readonly input: DisableInsightRulesCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DisableInsightRulesCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableInsightRulesCommandInput, DisableInsightRulesCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { EnableAlarmActionsInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableAlarmActionsCommand}.
8
10
  */
9
11
  export interface EnableAlarmActionsCommandInput extends EnableAlarmActionsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableAlarmActionsCommand}.
13
17
  */
14
18
  export interface EnableAlarmActionsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables the actions for the specified alarms.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface EnableAlarmActionsCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param EnableAlarmActionsCommandInput - {@link EnableAlarmActionsCommandInput}
34
+ * @returns {@link EnableAlarmActionsCommandOutput}
28
35
  * @see {@link EnableAlarmActionsCommandInput} for command's `input` shape.
29
36
  * @see {@link EnableAlarmActionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -34,11 +41,20 @@ export interface EnableAlarmActionsCommandOutput extends __MetadataBearer {
34
41
  export declare class EnableAlarmActionsCommand extends $Command<EnableAlarmActionsCommandInput, EnableAlarmActionsCommandOutput, CloudWatchClientResolvedConfig> {
35
42
  readonly input: EnableAlarmActionsCommandInput;
36
43
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
44
+ /**
45
+ * @public
46
+ */
37
47
  constructor(input: EnableAlarmActionsCommandInput);
38
48
  /**
39
49
  * @internal
40
50
  */
41
51
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableAlarmActionsCommandInput, EnableAlarmActionsCommandOutput>;
52
+ /**
53
+ * @internal
54
+ */
42
55
  private serialize;
56
+ /**
57
+ * @internal
58
+ */
43
59
  private deserialize;
44
60
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { EnableInsightRulesInput, EnableInsightRulesOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableInsightRulesCommand}.
8
10
  */
9
11
  export interface EnableInsightRulesCommandInput extends EnableInsightRulesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableInsightRulesCommand}.
13
17
  */
14
18
  export interface EnableInsightRulesCommandOutput extends EnableInsightRulesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface EnableInsightRulesCommandOutput extends EnableInsightRulesOutpu
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param EnableInsightRulesCommandInput - {@link EnableInsightRulesCommandInput}
34
+ * @returns {@link EnableInsightRulesCommandOutput}
28
35
  * @see {@link EnableInsightRulesCommandInput} for command's `input` shape.
29
36
  * @see {@link EnableInsightRulesCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -43,11 +50,20 @@ export interface EnableInsightRulesCommandOutput extends EnableInsightRulesOutpu
43
50
  export declare class EnableInsightRulesCommand extends $Command<EnableInsightRulesCommandInput, EnableInsightRulesCommandOutput, CloudWatchClientResolvedConfig> {
44
51
  readonly input: EnableInsightRulesCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: EnableInsightRulesCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableInsightRulesCommandInput, EnableInsightRulesCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { GetDashboardInput, GetDashboardOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDashboardCommand}.
8
10
  */
9
11
  export interface GetDashboardCommandInput extends GetDashboardInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDashboardCommand}.
13
17
  */
14
18
  export interface GetDashboardCommandOutput extends GetDashboardOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Displays the details of the dashboard that you specify.</p>
18
23
  * <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned
19
24
  * within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create
@@ -28,6 +33,8 @@ export interface GetDashboardCommandOutput extends GetDashboardOutput, __Metadat
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetDashboardCommandInput - {@link GetDashboardCommandInput}
37
+ * @returns {@link GetDashboardCommandOutput}
31
38
  * @see {@link GetDashboardCommandInput} for command's `input` shape.
32
39
  * @see {@link GetDashboardCommandOutput} for command's `response` shape.
33
40
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetDashboardCommandOutput extends GetDashboardOutput, __Metadat
46
53
  export declare class GetDashboardCommand extends $Command<GetDashboardCommandInput, GetDashboardCommandOutput, CloudWatchClientResolvedConfig> {
47
54
  readonly input: GetDashboardCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetDashboardCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDashboardCommandInput, GetDashboardCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { GetInsightRuleReportInput, GetInsightRuleReportOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetInsightRuleReportCommand}.
8
10
  */
9
11
  export interface GetInsightRuleReportCommandInput extends GetInsightRuleReportInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetInsightRuleReportCommand}.
13
17
  */
14
18
  export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of
18
23
  * contributors to the log group.</p>
19
24
  * <p>You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:</p>
@@ -61,6 +66,8 @@ export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportO
61
66
  * const response = await client.send(command);
62
67
  * ```
63
68
  *
69
+ * @param GetInsightRuleReportCommandInput - {@link GetInsightRuleReportCommandInput}
70
+ * @returns {@link GetInsightRuleReportCommandOutput}
64
71
  * @see {@link GetInsightRuleReportCommandInput} for command's `input` shape.
65
72
  * @see {@link GetInsightRuleReportCommandOutput} for command's `response` shape.
66
73
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -79,11 +86,20 @@ export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportO
79
86
  export declare class GetInsightRuleReportCommand extends $Command<GetInsightRuleReportCommandInput, GetInsightRuleReportCommandOutput, CloudWatchClientResolvedConfig> {
80
87
  readonly input: GetInsightRuleReportCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: GetInsightRuleReportCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetInsightRuleReportCommandInput, GetInsightRuleReportCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
5
5
  import { GetMetricDataInput, GetMetricDataOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMetricDataCommand}.
8
10
  */
9
11
  export interface GetMetricDataCommandInput extends GetMetricDataInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMetricDataCommand}.
13
17
  */
14
18
  export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation
18
23
  * can also include a CloudWatch Metrics Insights query, and one or more metric math functions.</p>
19
24
  * <p>A <code>GetMetricData</code> operation that does not include a query can retrieve as many as 500 different
@@ -72,6 +77,8 @@ export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __Metad
72
77
  * const response = await client.send(command);
73
78
  * ```
74
79
  *
80
+ * @param GetMetricDataCommandInput - {@link GetMetricDataCommandInput}
81
+ * @returns {@link GetMetricDataCommandOutput}
75
82
  * @see {@link GetMetricDataCommandInput} for command's `input` shape.
76
83
  * @see {@link GetMetricDataCommandOutput} for command's `response` shape.
77
84
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -84,11 +91,20 @@ export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __Metad
84
91
  export declare class GetMetricDataCommand extends $Command<GetMetricDataCommandInput, GetMetricDataCommandOutput, CloudWatchClientResolvedConfig> {
85
92
  readonly input: GetMetricDataCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: GetMetricDataCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMetricDataCommandInput, GetMetricDataCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }