@aws-sdk/client-internetmonitor 3.296.0 → 3.298.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 (41) hide show
  1. package/dist-cjs/commands/CreateMonitorCommand.js +2 -3
  2. package/dist-cjs/commands/DeleteMonitorCommand.js +2 -3
  3. package/dist-cjs/commands/GetHealthEventCommand.js +2 -3
  4. package/dist-cjs/commands/GetMonitorCommand.js +2 -3
  5. package/dist-cjs/commands/ListHealthEventsCommand.js +2 -3
  6. package/dist-cjs/commands/ListMonitorsCommand.js +2 -3
  7. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  8. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  9. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  10. package/dist-cjs/commands/UpdateMonitorCommand.js +2 -3
  11. package/dist-cjs/models/models_0.js +1 -117
  12. package/dist-es/commands/CreateMonitorCommand.js +2 -3
  13. package/dist-es/commands/DeleteMonitorCommand.js +2 -3
  14. package/dist-es/commands/GetHealthEventCommand.js +2 -3
  15. package/dist-es/commands/GetMonitorCommand.js +2 -3
  16. package/dist-es/commands/ListHealthEventsCommand.js +2 -3
  17. package/dist-es/commands/ListMonitorsCommand.js +2 -3
  18. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  19. package/dist-es/commands/TagResourceCommand.js +2 -3
  20. package/dist-es/commands/UntagResourceCommand.js +2 -3
  21. package/dist-es/commands/UpdateMonitorCommand.js +2 -3
  22. package/dist-es/models/models_0.js +0 -87
  23. package/dist-types/InternetMonitor.d.ts +11 -0
  24. package/dist-types/InternetMonitorClient.d.ts +24 -4
  25. package/dist-types/commands/CreateMonitorCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteMonitorCommand.d.ts +16 -0
  27. package/dist-types/commands/GetHealthEventCommand.d.ts +16 -0
  28. package/dist-types/commands/GetMonitorCommand.d.ts +16 -0
  29. package/dist-types/commands/ListHealthEventsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListMonitorsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  32. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  33. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  34. package/dist-types/commands/UpdateMonitorCommand.d.ts +16 -0
  35. package/dist-types/models/InternetMonitorServiceException.d.ts +2 -0
  36. package/dist-types/models/models_0.d.ts +95 -116
  37. package/dist-types/pagination/Interfaces.d.ts +3 -0
  38. package/dist-types/pagination/ListHealthEventsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListMonitorsPaginator.d.ts +3 -0
  40. package/dist-types/ts3.4/models/models_0.d.ts +0 -81
  41. package/package.json +4 -3
@@ -11,6 +11,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
11
11
  import { UpdateMonitorCommandInput, UpdateMonitorCommandOutput } from "./commands/UpdateMonitorCommand";
12
12
  import { InternetMonitorClient } from "./InternetMonitorClient";
13
13
  /**
14
+ * @public
14
15
  * <p>Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end
15
16
  * users, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames
16
17
  * and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for
@@ -25,6 +26,7 @@ import { InternetMonitorClient } from "./InternetMonitorClient";
25
26
  */
26
27
  export declare class InternetMonitor extends InternetMonitorClient {
27
28
  /**
29
+ * @public
28
30
  * <p>Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs),
29
31
  * Amazon CloudFront distributions, and WorkSpaces directories. </p>
30
32
  * <p>After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are
@@ -34,12 +36,14 @@ export declare class InternetMonitor extends InternetMonitorClient {
34
36
  createMonitor(args: CreateMonitorCommandInput, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
35
37
  createMonitor(args: CreateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
36
38
  /**
39
+ * @public
37
40
  * <p>Deletes a monitor in Amazon CloudWatch Internet Monitor. </p>
38
41
  */
39
42
  deleteMonitor(args: DeleteMonitorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMonitorCommandOutput>;
40
43
  deleteMonitor(args: DeleteMonitorCommandInput, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
41
44
  deleteMonitor(args: DeleteMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
42
45
  /**
46
+ * @public
43
47
  * <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,
44
48
  * and all of the information related to the event by location.</p>
45
49
  * <p>The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type,
@@ -50,6 +54,7 @@ export declare class InternetMonitor extends InternetMonitorClient {
50
54
  getHealthEvent(args: GetHealthEventCommandInput, cb: (err: any, data?: GetHealthEventCommandOutput) => void): void;
51
55
  getHealthEvent(args: GetHealthEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthEventCommandOutput) => void): void;
52
56
  /**
57
+ * @public
53
58
  * <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,
54
59
  * modified time, resources included in the monitor, and status information.</p>
55
60
  */
@@ -57,6 +62,7 @@ export declare class InternetMonitor extends InternetMonitorClient {
57
62
  getMonitor(args: GetMonitorCommandInput, cb: (err: any, data?: GetMonitorCommandOutput) => void): void;
58
63
  getMonitor(args: GetMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMonitorCommandOutput) => void): void;
59
64
  /**
65
+ * @public
60
66
  * <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
61
67
  * cause and status, event start and end time, percentage of total traffic impacted, and status.</p>
62
68
  * <note>
@@ -67,18 +73,21 @@ export declare class InternetMonitor extends InternetMonitorClient {
67
73
  listHealthEvents(args: ListHealthEventsCommandInput, cb: (err: any, data?: ListHealthEventsCommandOutput) => void): void;
68
74
  listHealthEvents(args: ListHealthEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHealthEventsCommandOutput) => void): void;
69
75
  /**
76
+ * @public
70
77
  * <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>
71
78
  */
72
79
  listMonitors(args: ListMonitorsCommandInput, options?: __HttpHandlerOptions): Promise<ListMonitorsCommandOutput>;
73
80
  listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
74
81
  listMonitors(args: ListMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
75
82
  /**
83
+ * @public
76
84
  * <p>Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.</p>
77
85
  */
78
86
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
79
87
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
80
88
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
81
89
  /**
90
+ * @public
82
91
  * <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>
83
92
  * <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>
84
93
  */
@@ -86,12 +95,14 @@ export declare class InternetMonitor extends InternetMonitorClient {
86
95
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
87
96
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
88
97
  /**
98
+ * @public
89
99
  * <p>Removes a tag from a resource.</p>
90
100
  */
91
101
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
92
102
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
93
103
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
94
104
  /**
105
+ * @public
95
106
  * <p>Updates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a
96
107
  * monitor.</p>
97
108
  */
@@ -18,15 +18,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
18
18
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
19
19
  import { UpdateMonitorCommandInput, UpdateMonitorCommandOutput } from "./commands/UpdateMonitorCommand";
20
20
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
21
+ /**
22
+ * @public
23
+ */
21
24
  export type ServiceInputTypes = CreateMonitorCommandInput | DeleteMonitorCommandInput | GetHealthEventCommandInput | GetMonitorCommandInput | ListHealthEventsCommandInput | ListMonitorsCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMonitorCommandInput;
25
+ /**
26
+ * @public
27
+ */
22
28
  export type ServiceOutputTypes = CreateMonitorCommandOutput | DeleteMonitorCommandOutput | GetHealthEventCommandOutput | GetMonitorCommandOutput | ListHealthEventsCommandOutput | ListMonitorsCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMonitorCommandOutput;
29
+ /**
30
+ * @public
31
+ */
23
32
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
24
33
  /**
25
34
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
26
35
  */
27
36
  requestHandler?: __HttpHandler;
28
37
  /**
29
- * A constructor for a class implementing the {@link __Checksum} interface
38
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
30
39
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
31
40
  * @internal
32
41
  */
@@ -116,23 +125,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
116
125
  */
117
126
  logger?: __Logger;
118
127
  /**
119
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
128
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
120
129
  */
121
130
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
122
131
  }
132
+ /**
133
+ * @public
134
+ */
123
135
  type InternetMonitorClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
124
136
  /**
125
- * The configuration interface of InternetMonitorClient class constructor that set the region, credentials and other options.
137
+ * @public
138
+ *
139
+ * The configuration interface of InternetMonitorClient class constructor that set the region, credentials and other options.
126
140
  */
127
141
  export interface InternetMonitorClientConfig extends InternetMonitorClientConfigType {
128
142
  }
143
+ /**
144
+ * @public
145
+ */
129
146
  type InternetMonitorClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
130
147
  /**
131
- * The resolved configuration interface of InternetMonitorClient class. This is resolved and normalized from the {@link InternetMonitorClientConfig | constructor configuration interface}.
148
+ * @public
149
+ *
150
+ * The resolved configuration interface of InternetMonitorClient class. This is resolved and normalized from the {@link InternetMonitorClientConfig | constructor configuration interface}.
132
151
  */
133
152
  export interface InternetMonitorClientResolvedConfig extends InternetMonitorClientResolvedConfigType {
134
153
  }
135
154
  /**
155
+ * @public
136
156
  * <p>Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end
137
157
  * users, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames
138
158
  * and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { CreateMonitorInput, CreateMonitorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateMonitorCommand}.
8
10
  */
9
11
  export interface CreateMonitorCommandInput extends CreateMonitorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateMonitorCommand}.
13
17
  */
14
18
  export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs),
18
23
  * Amazon CloudFront distributions, and WorkSpaces directories. </p>
19
24
  * <p>After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are
@@ -28,6 +33,8 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateMonitorCommandInput - {@link CreateMonitorCommandInput}
37
+ * @returns {@link CreateMonitorCommandOutput}
31
38
  * @see {@link CreateMonitorCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateMonitorCommandOutput} for command's `response` shape.
33
40
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
55
62
  export declare class CreateMonitorCommand extends $Command<CreateMonitorCommandInput, CreateMonitorCommandOutput, InternetMonitorClientResolvedConfig> {
56
63
  readonly input: CreateMonitorCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateMonitorCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateMonitorCommandInput, CreateMonitorCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { DeleteMonitorInput, DeleteMonitorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMonitorCommand}.
8
10
  */
9
11
  export interface DeleteMonitorCommandInput extends DeleteMonitorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMonitorCommand}.
13
17
  */
14
18
  export interface DeleteMonitorCommandOutput extends DeleteMonitorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a monitor in Amazon CloudWatch Internet Monitor. </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 DeleteMonitorCommandOutput extends DeleteMonitorOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteMonitorCommandInput - {@link DeleteMonitorCommandInput}
34
+ * @returns {@link DeleteMonitorCommandOutput}
28
35
  * @see {@link DeleteMonitorCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteMonitorCommandOutput} for command's `response` shape.
30
37
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteMonitorCommandOutput extends DeleteMonitorOutput, __Metad
46
53
  export declare class DeleteMonitorCommand extends $Command<DeleteMonitorCommandInput, DeleteMonitorCommandOutput, InternetMonitorClientResolvedConfig> {
47
54
  readonly input: DeleteMonitorCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteMonitorCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMonitorCommandInput, DeleteMonitorCommandOutput>;
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 { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { GetHealthEventInput, GetHealthEventOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetHealthEventCommand}.
8
10
  */
9
11
  export interface GetHealthEventCommandInput extends GetHealthEventInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetHealthEventCommand}.
13
17
  */
14
18
  export interface GetHealthEventCommandOutput extends GetHealthEventOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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,
18
23
  * and all of the information related to the event by location.</p>
19
24
  * <p>The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type,
@@ -29,6 +34,8 @@ export interface GetHealthEventCommandOutput extends GetHealthEventOutput, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param GetHealthEventCommandInput - {@link GetHealthEventCommandInput}
38
+ * @returns {@link GetHealthEventCommandOutput}
32
39
  * @see {@link GetHealthEventCommandInput} for command's `input` shape.
33
40
  * @see {@link GetHealthEventCommandOutput} for command's `response` shape.
34
41
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetHealthEventCommandOutput extends GetHealthEventOutput, __Met
50
57
  export declare class GetHealthEventCommand extends $Command<GetHealthEventCommandInput, GetHealthEventCommandOutput, InternetMonitorClientResolvedConfig> {
51
58
  readonly input: GetHealthEventCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetHealthEventCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetHealthEventCommandInput, GetHealthEventCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { GetMonitorInput, GetMonitorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMonitorCommand}.
8
10
  */
9
11
  export interface GetMonitorCommandInput extends GetMonitorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMonitorCommand}.
13
17
  */
14
18
  export interface GetMonitorCommandOutput extends GetMonitorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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,
18
23
  * modified time, resources included in the monitor, and status information.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetMonitorCommandOutput extends GetMonitorOutput, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetMonitorCommandInput - {@link GetMonitorCommandInput}
35
+ * @returns {@link GetMonitorCommandOutput}
29
36
  * @see {@link GetMonitorCommandInput} for command's `input` shape.
30
37
  * @see {@link GetMonitorCommandOutput} for command's `response` shape.
31
38
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetMonitorCommandOutput extends GetMonitorOutput, __MetadataBea
47
54
  export declare class GetMonitorCommand extends $Command<GetMonitorCommandInput, GetMonitorCommandOutput, InternetMonitorClientResolvedConfig> {
48
55
  readonly input: GetMonitorCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetMonitorCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMonitorCommandInput, GetMonitorCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { ListHealthEventsInput, ListHealthEventsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListHealthEventsCommand}.
8
10
  */
9
11
  export interface ListHealthEventsCommandInput extends ListHealthEventsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListHealthEventsCommand}.
13
17
  */
14
18
  export interface ListHealthEventsCommandOutput extends ListHealthEventsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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
18
23
  * cause and status, event start and end time, percentage of total traffic impacted, and status.</p>
19
24
  * <note>
@@ -29,6 +34,8 @@ export interface ListHealthEventsCommandOutput extends ListHealthEventsOutput, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListHealthEventsCommandInput - {@link ListHealthEventsCommandInput}
38
+ * @returns {@link ListHealthEventsCommandOutput}
32
39
  * @see {@link ListHealthEventsCommandInput} for command's `input` shape.
33
40
  * @see {@link ListHealthEventsCommandOutput} for command's `response` shape.
34
41
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListHealthEventsCommandOutput extends ListHealthEventsOutput, _
50
57
  export declare class ListHealthEventsCommand extends $Command<ListHealthEventsCommandInput, ListHealthEventsCommandOutput, InternetMonitorClientResolvedConfig> {
51
58
  readonly input: ListHealthEventsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListHealthEventsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListHealthEventsCommandInput, ListHealthEventsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { ListMonitorsInput, ListMonitorsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListMonitorsCommand}.
8
10
  */
9
11
  export interface ListMonitorsCommandInput extends ListMonitorsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListMonitorsCommand}.
13
17
  */
14
18
  export interface ListMonitorsCommandOutput extends ListMonitorsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 ListMonitorsCommandOutput extends ListMonitorsOutput, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListMonitorsCommandInput - {@link ListMonitorsCommandInput}
34
+ * @returns {@link ListMonitorsCommandOutput}
28
35
  * @see {@link ListMonitorsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListMonitorsCommandOutput} for command's `response` shape.
30
37
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListMonitorsCommandOutput extends ListMonitorsOutput, __Metadat
46
53
  export declare class ListMonitorsCommand extends $Command<ListMonitorsCommandInput, ListMonitorsCommandOutput, InternetMonitorClientResolvedConfig> {
47
54
  readonly input: ListMonitorsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListMonitorsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMonitorsCommandInput, ListMonitorsCommandOutput>;
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 { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.</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 ListTagsForResourceCommandOutput extends ListTagsForResourceOut
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
49
56
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, InternetMonitorClientResolvedConfig> {
50
57
  readonly input: ListTagsForResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ListTagsForResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { TagResourceInput, TagResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
35
+ * @returns {@link TagResourceCommandOutput}
29
36
  * @see {@link TagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -50,11 +57,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
50
57
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, InternetMonitorClientResolvedConfig> {
51
58
  readonly input: TagResourceCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: TagResourceCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
5
  import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a tag from a resource.</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 UntagResourceCommandOutput extends UntagResourceOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
49
56
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, InternetMonitorClientResolvedConfig> {
50
57
  readonly input: UntagResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UntagResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }