@aws-sdk/client-internetmonitor 3.312.0 → 3.316.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.
@@ -10,114 +10,86 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
10
10
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
11
11
  import { UpdateMonitorCommandInput, UpdateMonitorCommandOutput } from "./commands/UpdateMonitorCommand";
12
12
  import { InternetMonitorClient } from "./InternetMonitorClient";
13
- /**
14
- * @public
15
- * <p>Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability
16
- * between your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose
17
- * internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global
18
- * networking footprint to calculate a baseline of performance and availability for internet traffic. This
19
- * is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements
20
- * as a baseline, Internet Monitor raises awareness for you when there are significant problems for your
21
- * end users in the different geographic locations where your application runs.</p>
22
- * <p>Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics,
23
- * to easily support using CloudWatch tools with health information for geographies and networks specific to your application.
24
- * Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network,
25
- * you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.</p>
26
- * <p>To use Internet Monitor, you create a <i>monitor</i> and associate your application's resources
27
- * with it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know
28
- * where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to
29
- * the locations and networks that communicate with your application.</p>
30
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html">Using Amazon CloudWatch Internet Monitor</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
31
- */
32
- export declare class InternetMonitor extends InternetMonitorClient {
13
+ export interface InternetMonitor {
33
14
  /**
34
- * @public
35
- * <p>Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs),
36
- * Amazon CloudFront distributions, and WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to
37
- * the <i>city-networks</i>, that is, the locations and ASNs (typically internet service providers or ISPs),
38
- * where clients access your application. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html">Using Amazon CloudWatch Internet Monitor</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
39
- * <p>When you create a monitor, you set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum
40
- * that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time
41
- * by updating your monitor. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
15
+ * @see {@link CreateMonitorCommand}
42
16
  */
43
17
  createMonitor(args: CreateMonitorCommandInput, options?: __HttpHandlerOptions): Promise<CreateMonitorCommandOutput>;
44
18
  createMonitor(args: CreateMonitorCommandInput, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
45
19
  createMonitor(args: CreateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
46
20
  /**
47
- * @public
48
- * <p>Deletes a monitor in Amazon CloudWatch Internet Monitor. </p>
21
+ * @see {@link DeleteMonitorCommand}
49
22
  */
50
23
  deleteMonitor(args: DeleteMonitorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMonitorCommandOutput>;
51
24
  deleteMonitor(args: DeleteMonitorCommandInput, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
52
25
  deleteMonitor(args: DeleteMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
53
26
  /**
54
- * @public
55
- * <p>Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,
56
- * and all of the information related to the event by location.</p>
57
- * <p>The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type,
58
- * and so on.</p>
59
- * <p>Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.</p>
27
+ * @see {@link GetHealthEventCommand}
60
28
  */
61
29
  getHealthEvent(args: GetHealthEventCommandInput, options?: __HttpHandlerOptions): Promise<GetHealthEventCommandOutput>;
62
30
  getHealthEvent(args: GetHealthEventCommandInput, cb: (err: any, data?: GetHealthEventCommandOutput) => void): void;
63
31
  getHealthEvent(args: GetHealthEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthEventCommandOutput) => void): void;
64
32
  /**
65
- * @public
66
- * <p>Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time,
67
- * modified time, resources included in the monitor, and status information.</p>
33
+ * @see {@link GetMonitorCommand}
68
34
  */
69
35
  getMonitor(args: GetMonitorCommandInput, options?: __HttpHandlerOptions): Promise<GetMonitorCommandOutput>;
70
36
  getMonitor(args: GetMonitorCommandInput, cb: (err: any, data?: GetMonitorCommandOutput) => void): void;
71
37
  getMonitor(args: GetMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMonitorCommandOutput) => void): void;
72
38
  /**
73
- * @public
74
- * <p>Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network
75
- * cause and status, event start and end time, percentage of total traffic impacted, and status.</p>
76
- * <note>
77
- * <p>Health events that have start times during the time frame that is requested are not included in the list of health events.</p>
78
- * </note>
39
+ * @see {@link ListHealthEventsCommand}
79
40
  */
80
41
  listHealthEvents(args: ListHealthEventsCommandInput, options?: __HttpHandlerOptions): Promise<ListHealthEventsCommandOutput>;
81
42
  listHealthEvents(args: ListHealthEventsCommandInput, cb: (err: any, data?: ListHealthEventsCommandOutput) => void): void;
82
43
  listHealthEvents(args: ListHealthEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHealthEventsCommandOutput) => void): void;
83
44
  /**
84
- * @public
85
- * <p>Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.</p>
45
+ * @see {@link ListMonitorsCommand}
86
46
  */
87
47
  listMonitors(args: ListMonitorsCommandInput, options?: __HttpHandlerOptions): Promise<ListMonitorsCommandOutput>;
88
48
  listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
89
49
  listMonitors(args: ListMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
90
50
  /**
91
- * @public
92
- * <p>Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.</p>
51
+ * @see {@link ListTagsForResourceCommand}
93
52
  */
94
53
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
95
54
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
96
55
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
97
56
  /**
98
- * @public
99
- * <p>Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.</p>
100
- * <p>A minimum of one tag is required for this call. It returns an error if you use the <code>TagResource</code> request with 0 tags.</p>
57
+ * @see {@link TagResourceCommand}
101
58
  */
102
59
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
103
60
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
104
61
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
105
62
  /**
106
- * @public
107
- * <p>Removes a tag from a resource.</p>
63
+ * @see {@link UntagResourceCommand}
108
64
  */
109
65
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
110
66
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
111
67
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
112
68
  /**
113
- * @public
114
- * <p>Updates a monitor. You can update a monitor to change the maximum number of city-networks (locations and ASNs or
115
- * internet service providers), to add or remove resources,
116
- * or to change the status of the monitor. Note that you can't change the name of a monitor.</p>
117
- * <p>The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored.
118
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
69
+ * @see {@link UpdateMonitorCommand}
119
70
  */
120
71
  updateMonitor(args: UpdateMonitorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMonitorCommandOutput>;
121
72
  updateMonitor(args: UpdateMonitorCommandInput, cb: (err: any, data?: UpdateMonitorCommandOutput) => void): void;
122
73
  updateMonitor(args: UpdateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMonitorCommandOutput) => void): void;
123
74
  }
75
+ /**
76
+ * @public
77
+ * <p>Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability
78
+ * between your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose
79
+ * internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global
80
+ * networking footprint to calculate a baseline of performance and availability for internet traffic. This
81
+ * is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements
82
+ * as a baseline, Internet Monitor raises awareness for you when there are significant problems for your
83
+ * end users in the different geographic locations where your application runs.</p>
84
+ * <p>Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics,
85
+ * to easily support using CloudWatch tools with health information for geographies and networks specific to your application.
86
+ * Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network,
87
+ * you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.</p>
88
+ * <p>To use Internet Monitor, you create a <i>monitor</i> and associate your application's resources
89
+ * with it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know
90
+ * where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to
91
+ * the locations and networks that communicate with your application.</p>
92
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html">Using Amazon CloudWatch Internet Monitor</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
93
+ */
94
+ export declare class InternetMonitor extends InternetMonitorClient implements InternetMonitor {
95
+ }
@@ -41,7 +41,7 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
41
41
  * Tags: { // TagMap
42
42
  * "<keys>": "STRING_VALUE",
43
43
  * },
44
- * MaxCityNetworksToMonitor: Number("int"), // required
44
+ * MaxCityNetworksToMonitor: Number("int"),
45
45
  * InternetMeasurementsLogDelivery: { // InternetMeasurementsLogDelivery
46
46
  * S3Config: { // S3Config
47
47
  * BucketName: "STRING_VALUE",
@@ -49,6 +49,7 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
49
49
  * LogDeliveryStatus: "STRING_VALUE",
50
50
  * },
51
51
  * },
52
+ * TrafficPercentageToMonitor: Number("int"),
52
53
  * };
53
54
  * const command = new CreateMonitorCommand(input);
54
55
  * const response = await client.send(command);
@@ -48,6 +48,7 @@ export interface UpdateMonitorCommandOutput extends UpdateMonitorOutput, __Metad
48
48
  * LogDeliveryStatus: "STRING_VALUE",
49
49
  * },
50
50
  * },
51
+ * TrafficPercentageToMonitor: Number("int"),
51
52
  * };
52
53
  * const command = new UpdateMonitorCommand(input);
53
54
  * const response = await client.send(command);
@@ -104,8 +104,7 @@ export interface S3Config {
104
104
  }
105
105
  /**
106
106
  * @public
107
- * <p>Configuration information for other locations that you choose to publish Amazon CloudWatch Internet Monitor internet measurements to, such as Amazon S3.
108
- * The measurements are also published to Amazon CloudWatch Logs.</p>
107
+ * <p>Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.</p>
109
108
  */
110
109
  export interface InternetMeasurementsLogDelivery {
111
110
  /**
@@ -147,11 +146,15 @@ export interface CreateMonitorInput {
147
146
  * <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value
148
147
  * </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
149
148
  */
150
- MaxCityNetworksToMonitor: number | undefined;
149
+ MaxCityNetworksToMonitor?: number;
151
150
  /**
152
- * <p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>
151
+ * <p>Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.</p>
153
152
  */
154
153
  InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
154
+ /**
155
+ * <p>The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.</p>
156
+ */
157
+ TrafficPercentageToMonitor?: number;
155
158
  }
156
159
  /**
157
160
  * @public
@@ -602,11 +605,15 @@ export interface GetMonitorOutput {
602
605
  * <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value
603
606
  * </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
604
607
  */
605
- MaxCityNetworksToMonitor: number | undefined;
608
+ MaxCityNetworksToMonitor?: number;
606
609
  /**
607
610
  * <p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>
608
611
  */
609
612
  InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
613
+ /**
614
+ * <p>The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.</p>
615
+ */
616
+ TrafficPercentageToMonitor?: number;
610
617
  }
611
618
  /**
612
619
  * @public
@@ -862,6 +869,10 @@ export interface UpdateMonitorInput {
862
869
  * <p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>
863
870
  */
864
871
  InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
872
+ /**
873
+ * <p>The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.</p>
874
+ */
875
+ TrafficPercentageToMonitor?: number;
865
876
  }
866
877
  /**
867
878
  * @public
@@ -40,7 +40,7 @@ import {
40
40
  UpdateMonitorCommandOutput,
41
41
  } from "./commands/UpdateMonitorCommand";
42
42
  import { InternetMonitorClient } from "./InternetMonitorClient";
43
- export declare class InternetMonitor extends InternetMonitorClient {
43
+ export interface InternetMonitor {
44
44
  createMonitor(
45
45
  args: CreateMonitorCommandInput,
46
46
  options?: __HttpHandlerOptions
@@ -172,3 +172,6 @@ export declare class InternetMonitor extends InternetMonitorClient {
172
172
  cb: (err: any, data?: UpdateMonitorCommandOutput) => void
173
173
  ): void;
174
174
  }
175
+ export declare class InternetMonitor
176
+ extends InternetMonitorClient
177
+ implements InternetMonitor {}
@@ -43,8 +43,9 @@ export interface CreateMonitorInput {
43
43
  Resources?: string[];
44
44
  ClientToken?: string;
45
45
  Tags?: Record<string, string>;
46
- MaxCityNetworksToMonitor: number | undefined;
46
+ MaxCityNetworksToMonitor?: number;
47
47
  InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
48
+ TrafficPercentageToMonitor?: number;
48
49
  }
49
50
  export declare const MonitorConfigState: {
50
51
  readonly ACTIVE: "ACTIVE";
@@ -191,8 +192,9 @@ export interface GetMonitorOutput {
191
192
  ProcessingStatus?: MonitorProcessingStatusCode | string;
192
193
  ProcessingStatusInfo?: string;
193
194
  Tags?: Record<string, string>;
194
- MaxCityNetworksToMonitor: number | undefined;
195
+ MaxCityNetworksToMonitor?: number;
195
196
  InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
197
+ TrafficPercentageToMonitor?: number;
196
198
  }
197
199
  export interface HealthEvent {
198
200
  EventArn: string | undefined;
@@ -277,6 +279,7 @@ export interface UpdateMonitorInput {
277
279
  ClientToken?: string;
278
280
  MaxCityNetworksToMonitor?: number;
279
281
  InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
282
+ TrafficPercentageToMonitor?: number;
280
283
  }
281
284
  export interface UpdateMonitorOutput {
282
285
  MonitorArn: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-internetmonitor",
3
3
  "description": "AWS SDK for JavaScript Internetmonitor Client for Node.js, Browser and React Native",
4
- "version": "3.312.0",
4
+ "version": "3.316.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.312.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.310.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.310.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.310.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",