@aws-sdk/client-internetmonitor 3.450.0 → 3.454.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 (44) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/InternetMonitor.js +8 -0
  3. package/dist-cjs/commands/GetQueryResultsCommand.js +51 -0
  4. package/dist-cjs/commands/GetQueryStatusCommand.js +51 -0
  5. package/dist-cjs/commands/StartQueryCommand.js +51 -0
  6. package/dist-cjs/commands/StopQueryCommand.js +51 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/models/models_0.js +17 -1
  9. package/dist-cjs/pagination/GetQueryResultsPaginator.js +29 -0
  10. package/dist-cjs/pagination/index.js +1 -0
  11. package/dist-cjs/protocols/Aws_restJson1.js +270 -1
  12. package/dist-es/InternetMonitor.js +8 -0
  13. package/dist-es/commands/GetQueryResultsCommand.js +47 -0
  14. package/dist-es/commands/GetQueryStatusCommand.js +47 -0
  15. package/dist-es/commands/StartQueryCommand.js +47 -0
  16. package/dist-es/commands/StopQueryCommand.js +47 -0
  17. package/dist-es/commands/index.js +4 -0
  18. package/dist-es/models/models_0.js +16 -0
  19. package/dist-es/pagination/GetQueryResultsPaginator.js +25 -0
  20. package/dist-es/pagination/index.js +1 -0
  21. package/dist-es/protocols/Aws_restJson1.js +261 -0
  22. package/dist-types/InternetMonitor.d.ts +28 -0
  23. package/dist-types/InternetMonitorClient.d.ts +6 -2
  24. package/dist-types/commands/GetQueryResultsCommand.d.ts +106 -0
  25. package/dist-types/commands/GetQueryStatusCommand.d.ts +112 -0
  26. package/dist-types/commands/StartQueryCommand.d.ts +105 -0
  27. package/dist-types/commands/StopQueryCommand.d.ts +87 -0
  28. package/dist-types/commands/index.d.ts +4 -0
  29. package/dist-types/models/models_0.d.ts +255 -3
  30. package/dist-types/pagination/GetQueryResultsPaginator.d.ts +7 -0
  31. package/dist-types/pagination/index.d.ts +1 -0
  32. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  33. package/dist-types/ts3.4/InternetMonitor.d.ts +68 -0
  34. package/dist-types/ts3.4/InternetMonitorClient.d.ts +24 -0
  35. package/dist-types/ts3.4/commands/GetQueryResultsCommand.d.ts +38 -0
  36. package/dist-types/ts3.4/commands/GetQueryStatusCommand.d.ts +35 -0
  37. package/dist-types/ts3.4/commands/StartQueryCommand.d.ts +35 -0
  38. package/dist-types/ts3.4/commands/StopQueryCommand.d.ts +35 -0
  39. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  40. package/dist-types/ts3.4/models/models_0.d.ts +61 -0
  41. package/dist-types/ts3.4/pagination/GetQueryResultsPaginator.d.ts +11 -0
  42. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  43. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  44. package/package.json +35 -35
@@ -0,0 +1,105 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
+ import { StartQueryInput, StartQueryOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartQueryCommand}.
14
+ */
15
+ export interface StartQueryCommandInput extends StartQueryInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartQueryCommand}.
21
+ */
22
+ export interface StartQueryCommandOutput extends StartQueryOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period
27
+ * for the data that you want returned by using <code>StartTime</code> and <code>EndTime</code>. You filter the query
28
+ * results to return by providing parameters that you specify with <code>FilterParameters</code>.</p>
29
+ * <p>For more information about using the query interface, including examples, see
30
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">Using the Amazon CloudWatch Internet Monitor query interface</a>
31
+ * in the Amazon CloudWatch Internet Monitor User Guide.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { InternetMonitorClient, StartQueryCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import
36
+ * // const { InternetMonitorClient, StartQueryCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import
37
+ * const client = new InternetMonitorClient(config);
38
+ * const input = { // StartQueryInput
39
+ * MonitorName: "STRING_VALUE", // required
40
+ * StartTime: new Date("TIMESTAMP"), // required
41
+ * EndTime: new Date("TIMESTAMP"), // required
42
+ * QueryType: "STRING_VALUE", // required
43
+ * FilterParameters: [ // FilterParameters
44
+ * { // FilterParameter
45
+ * Field: "STRING_VALUE",
46
+ * Operator: "STRING_VALUE",
47
+ * Values: [ // FilterList
48
+ * "STRING_VALUE",
49
+ * ],
50
+ * },
51
+ * ],
52
+ * };
53
+ * const command = new StartQueryCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // StartQueryOutput
56
+ * // QueryId: "STRING_VALUE", // required
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param StartQueryCommandInput - {@link StartQueryCommandInput}
62
+ * @returns {@link StartQueryCommandOutput}
63
+ * @see {@link StartQueryCommandInput} for command's `input` shape.
64
+ * @see {@link StartQueryCommandOutput} for command's `response` shape.
65
+ * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
66
+ *
67
+ * @throws {@link AccessDeniedException} (client fault)
68
+ * <p>You don't have sufficient permission to perform this action.</p>
69
+ *
70
+ * @throws {@link InternalServerException} (server fault)
71
+ * <p>An internal error occurred.</p>
72
+ *
73
+ * @throws {@link LimitExceededException} (client fault)
74
+ * <p>The request exceeded a service quota.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>The request was denied due to request throttling.</p>
78
+ *
79
+ * @throws {@link ValidationException} (client fault)
80
+ * <p>Invalid request.</p>
81
+ *
82
+ * @throws {@link InternetMonitorServiceException}
83
+ * <p>Base exception class for all service exceptions from InternetMonitor service.</p>
84
+ *
85
+ */
86
+ export declare class StartQueryCommand extends $Command<StartQueryCommandInput, StartQueryCommandOutput, InternetMonitorClientResolvedConfig> {
87
+ readonly input: StartQueryCommandInput;
88
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
92
+ constructor(input: StartQueryCommandInput);
93
+ /**
94
+ * @internal
95
+ */
96
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartQueryCommandInput, StartQueryCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
100
+ private serialize;
101
+ /**
102
+ * @internal
103
+ */
104
+ private deserialize;
105
+ }
@@ -0,0 +1,87 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
5
+ import { StopQueryInput, StopQueryOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopQueryCommand}.
14
+ */
15
+ export interface StopQueryCommandInput extends StopQueryInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopQueryCommand}.
21
+ */
22
+ export interface StopQueryCommandOutput extends StopQueryOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Stop a query that is progress for a specific monitor.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { InternetMonitorClient, StopQueryCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import
31
+ * // const { InternetMonitorClient, StopQueryCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import
32
+ * const client = new InternetMonitorClient(config);
33
+ * const input = { // StopQueryInput
34
+ * MonitorName: "STRING_VALUE", // required
35
+ * QueryId: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new StopQueryCommand(input);
38
+ * const response = await client.send(command);
39
+ * // {};
40
+ *
41
+ * ```
42
+ *
43
+ * @param StopQueryCommandInput - {@link StopQueryCommandInput}
44
+ * @returns {@link StopQueryCommandOutput}
45
+ * @see {@link StopQueryCommandInput} for command's `input` shape.
46
+ * @see {@link StopQueryCommandOutput} for command's `response` shape.
47
+ * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
48
+ *
49
+ * @throws {@link AccessDeniedException} (client fault)
50
+ * <p>You don't have sufficient permission to perform this action.</p>
51
+ *
52
+ * @throws {@link InternalServerException} (server fault)
53
+ * <p>An internal error occurred.</p>
54
+ *
55
+ * @throws {@link LimitExceededException} (client fault)
56
+ * <p>The request exceeded a service quota.</p>
57
+ *
58
+ * @throws {@link ThrottlingException} (client fault)
59
+ * <p>The request was denied due to request throttling.</p>
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ * <p>Invalid request.</p>
63
+ *
64
+ * @throws {@link InternetMonitorServiceException}
65
+ * <p>Base exception class for all service exceptions from InternetMonitor service.</p>
66
+ *
67
+ */
68
+ export declare class StopQueryCommand extends $Command<StopQueryCommandInput, StopQueryCommandOutput, InternetMonitorClientResolvedConfig> {
69
+ readonly input: StopQueryCommandInput;
70
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
74
+ constructor(input: StopQueryCommandInput);
75
+ /**
76
+ * @internal
77
+ */
78
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InternetMonitorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopQueryCommandInput, StopQueryCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
82
+ private serialize;
83
+ /**
84
+ * @internal
85
+ */
86
+ private deserialize;
87
+ }
@@ -2,9 +2,13 @@ export * from "./CreateMonitorCommand";
2
2
  export * from "./DeleteMonitorCommand";
3
3
  export * from "./GetHealthEventCommand";
4
4
  export * from "./GetMonitorCommand";
5
+ export * from "./GetQueryResultsCommand";
6
+ export * from "./GetQueryStatusCommand";
5
7
  export * from "./ListHealthEventsCommand";
6
8
  export * from "./ListMonitorsCommand";
7
9
  export * from "./ListTagsForResourceCommand";
10
+ export * from "./StartQueryCommand";
11
+ export * from "./StopQueryCommand";
8
12
  export * from "./TagResourceCommand";
9
13
  export * from "./UntagResourceCommand";
10
14
  export * from "./UpdateMonitorCommand";
@@ -95,6 +95,7 @@ export type LocalHealthEventsConfigStatus = (typeof LocalHealthEventsConfigStatu
95
95
  * <p>Defines the percentages, for performance scores or availability scores, that are the local thresholds
96
96
  * for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage
97
97
  * of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.</p>
98
+ * <p>If you don't set a local health event threshold, the default value is 60%.</p>
98
99
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
99
100
  * Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
100
101
  */
@@ -114,6 +115,7 @@ export interface LocalHealthEventsConfig {
114
115
  * @public
115
116
  * <p>The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a
116
117
  * threshold is crossed for a local health score.</p>
118
+ * <p>If you don't set a minimum traffic impact threshold, the default value is 0.01%.</p>
117
119
  */
118
120
  MinTrafficImpact?: number;
119
121
  }
@@ -363,6 +365,53 @@ export interface DeleteMonitorInput {
363
365
  */
364
366
  export interface DeleteMonitorOutput {
365
367
  }
368
+ /**
369
+ * @public
370
+ * @enum
371
+ */
372
+ export declare const Operator: {
373
+ readonly EQUALS: "EQUALS";
374
+ readonly NOT_EQUALS: "NOT_EQUALS";
375
+ };
376
+ /**
377
+ * @public
378
+ */
379
+ export type Operator = (typeof Operator)[keyof typeof Operator];
380
+ /**
381
+ * @public
382
+ * <p>A filter that you use with the results of a Amazon CloudWatch Internet Monitor query that you created and ran. The query sets up a
383
+ * repository of data that is a subset of your application's Internet Monitor data. <code>FilterParameter</code> is a string
384
+ * that defines how you want to filter the repository of data to return a set of results, based on your criteria.</p>
385
+ * <p>The filter parameters that you can specify depend on the query type that you used to create the repository, since
386
+ * each query type returns a different set of Internet Monitor data.</p>
387
+ * <p>For each filter, you specify a field (such as <code>city</code>), an operator (such as <code>not_equals</code>,
388
+ * and a value or array of values (such as <code>["Seattle", "Redmond"]</code>). Separate values in the array with
389
+ * commas.</p>
390
+ * <p>For more information about specifying filter parameters, see
391
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">Using the Amazon CloudWatch Internet Monitor query interface</a>
392
+ * in the Amazon CloudWatch Internet Monitor User Guide.</p>
393
+ */
394
+ export interface FilterParameter {
395
+ /**
396
+ * @public
397
+ * <p>A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you
398
+ * created by running a query. A field might be <code>city</code>, for example. The field must be one of the fields
399
+ * that was returned by the specific query that you used to create the repository.</p>
400
+ */
401
+ Field?: string;
402
+ /**
403
+ * @public
404
+ * <p>The operator to use with the filter field and a value, such as <code>not_equals</code>.</p>
405
+ */
406
+ Operator?: Operator;
407
+ /**
408
+ * @public
409
+ * <p>One or more values to be used, together with the specified operator, to filter data for a query.
410
+ * For example, you could specify an array of values such as <code>["Seattle", "Redmond"]</code>. Values in the array are separated by
411
+ * commas.</p>
412
+ */
413
+ Values?: string[];
414
+ }
366
415
  /**
367
416
  * @public
368
417
  */
@@ -374,7 +423,7 @@ export interface GetHealthEventInput {
374
423
  MonitorName: string | undefined;
375
424
  /**
376
425
  * @public
377
- * <p>The internally generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must
426
+ * <p>The internally-generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must
378
427
  * URL-encode the <code>EventID</code> field in the request URL.</p>
379
428
  */
380
429
  EventId: string | undefined;
@@ -648,7 +697,7 @@ export interface GetHealthEventOutput {
648
697
  EventArn: string | undefined;
649
698
  /**
650
699
  * @public
651
- * <p>The internally generated identifier of a health event.</p>
700
+ * <p>The internally-generated identifier of a health event.</p>
652
701
  */
653
702
  EventId: string | undefined;
654
703
  /**
@@ -806,6 +855,114 @@ export interface GetMonitorOutput {
806
855
  */
807
856
  HealthEventsConfig?: HealthEventsConfig;
808
857
  }
858
+ /**
859
+ * @public
860
+ */
861
+ export interface GetQueryResultsInput {
862
+ /**
863
+ * @public
864
+ * <p>The name of the monitor to return data for.</p>
865
+ */
866
+ MonitorName: string | undefined;
867
+ /**
868
+ * @public
869
+ * <p>The ID of the query that you want to return data results for. A <code>QueryId</code> is an
870
+ * internally-generated identifier for a specific query.</p>
871
+ */
872
+ QueryId: string | undefined;
873
+ /**
874
+ * @public
875
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
876
+ */
877
+ NextToken?: string;
878
+ /**
879
+ * @public
880
+ * <p>The number of query results that you want to return with this call.</p>
881
+ */
882
+ MaxResults?: number;
883
+ }
884
+ /**
885
+ * @public
886
+ * <p>Defines a field to query for your application's Amazon CloudWatch Internet Monitor data. You create a data repository by running a query of a specific
887
+ * type. Each <code>QueryType</code> includes a specific set of fields and datatypes to retrieve data for. </p>
888
+ */
889
+ export interface QueryField {
890
+ /**
891
+ * @public
892
+ * <p>The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as <code>availability_score</code>.</p>
893
+ */
894
+ Name?: string;
895
+ /**
896
+ * @public
897
+ * <p>The data type for a query field, which must correspond to the field you're defining for <code>QueryField</code>. For example, if the query
898
+ * field name is <code>availability_score</code>, the data type is <code>float</code>.</p>
899
+ */
900
+ Type?: string;
901
+ }
902
+ /**
903
+ * @public
904
+ */
905
+ export interface GetQueryResultsOutput {
906
+ /**
907
+ * @public
908
+ * <p>The fields that the query returns data for. Fields are name-data type pairs, such as
909
+ * <code>availability_score</code>-<code>float</code>.</p>
910
+ */
911
+ Fields: QueryField[] | undefined;
912
+ /**
913
+ * @public
914
+ * <p>The data results that the query returns. Data is returned in arrays, aligned with the <code>Fields</code>
915
+ * for the query, which creates a repository of Amazon CloudWatch Internet Monitor information for your application. Then, you can filter
916
+ * the information in the repository by using <code>FilterParameters</code> that you define.</p>
917
+ */
918
+ Data: string[][] | undefined;
919
+ /**
920
+ * @public
921
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
922
+ */
923
+ NextToken?: string;
924
+ }
925
+ /**
926
+ * @public
927
+ */
928
+ export interface GetQueryStatusInput {
929
+ /**
930
+ * @public
931
+ * <p>The name of the monitor.</p>
932
+ */
933
+ MonitorName: string | undefined;
934
+ /**
935
+ * @public
936
+ * <p>The ID of the query that you want to return the status for. A <code>QueryId</code> is an internally-generated
937
+ * dentifier for a specific query.</p>
938
+ */
939
+ QueryId: string | undefined;
940
+ }
941
+ /**
942
+ * @public
943
+ * @enum
944
+ */
945
+ export declare const QueryStatus: {
946
+ readonly CANCELED: "CANCELED";
947
+ readonly FAILED: "FAILED";
948
+ readonly QUEUED: "QUEUED";
949
+ readonly RUNNING: "RUNNING";
950
+ readonly SUCCEEDED: "SUCCEEDED";
951
+ };
952
+ /**
953
+ * @public
954
+ */
955
+ export type QueryStatus = (typeof QueryStatus)[keyof typeof QueryStatus];
956
+ /**
957
+ * @public
958
+ */
959
+ export interface GetQueryStatusOutput {
960
+ /**
961
+ * @public
962
+ * <p>The current status for a query.</p>
963
+ */
964
+ Status: QueryStatus | undefined;
965
+ }
809
966
  /**
810
967
  * @public
811
968
  * <p>Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.</p>
@@ -818,7 +975,7 @@ export interface HealthEvent {
818
975
  EventArn: string | undefined;
819
976
  /**
820
977
  * @public
821
- * <p>The internally generated identifier of a specific network traffic impairment health event.</p>
978
+ * <p>The internally-generated identifier of a specific network traffic impairment health event.</p>
822
979
  */
823
980
  EventId: string | undefined;
824
981
  /**
@@ -1042,6 +1199,101 @@ export interface ListMonitorsOutput {
1042
1199
  */
1043
1200
  NextToken?: string;
1044
1201
  }
1202
+ /**
1203
+ * @public
1204
+ * @enum
1205
+ */
1206
+ export declare const QueryType: {
1207
+ readonly MEASUREMENTS: "MEASUREMENTS";
1208
+ readonly TOP_LOCATIONS: "TOP_LOCATIONS";
1209
+ readonly TOP_LOCATION_DETAILS: "TOP_LOCATION_DETAILS";
1210
+ };
1211
+ /**
1212
+ * @public
1213
+ */
1214
+ export type QueryType = (typeof QueryType)[keyof typeof QueryType];
1215
+ /**
1216
+ * @public
1217
+ */
1218
+ export interface StartQueryInput {
1219
+ /**
1220
+ * @public
1221
+ * <p>The name of the monitor to query.</p>
1222
+ */
1223
+ MonitorName: string | undefined;
1224
+ /**
1225
+ * @public
1226
+ * <p>The timestamp that is the beginning of the period that you want to retrieve data for with your query.</p>
1227
+ */
1228
+ StartTime: Date | undefined;
1229
+ /**
1230
+ * @public
1231
+ * <p>The timestamp that is the end of the period that you want to retrieve data for with your query.</p>
1232
+ */
1233
+ EndTime: Date | undefined;
1234
+ /**
1235
+ * @public
1236
+ * <p>The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:</p>
1237
+ * <ul>
1238
+ * <li>
1239
+ * <p>
1240
+ * <code>MEASUREMENTS</code>: TBD definition</p>
1241
+ * </li>
1242
+ * <li>
1243
+ * <p>
1244
+ * <code>TOP_LOCATIONS</code>: TBD definition</p>
1245
+ * </li>
1246
+ * <li>
1247
+ * <p>
1248
+ * <code>TOP_LOCATION_DETAILS</code>: TBD definition</p>
1249
+ * </li>
1250
+ * </ul>
1251
+ * <p>For lists of the fields returned with each query type and more information about how each type of query is
1252
+ * performed, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">
1253
+ * Using the Amazon CloudWatch Internet Monitor query interface</a> in the Amazon CloudWatch Internet Monitor User Guide.</p>
1254
+ */
1255
+ QueryType: QueryType | undefined;
1256
+ /**
1257
+ * @public
1258
+ * <p>The <code>FilterParameters</code> field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines
1259
+ * how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since
1260
+ * each query type returns a different set of Internet Monitor data.</p>
1261
+ * <p>For more information about specifying filter parameters, see
1262
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">Using the Amazon CloudWatch Internet Monitor query interface</a>
1263
+ * in the Amazon CloudWatch Internet Monitor User Guide.</p>
1264
+ */
1265
+ FilterParameters?: FilterParameter[];
1266
+ }
1267
+ /**
1268
+ * @public
1269
+ */
1270
+ export interface StartQueryOutput {
1271
+ /**
1272
+ * @public
1273
+ * <p>The internally-generated identifier of a specific query.</p>
1274
+ */
1275
+ QueryId: string | undefined;
1276
+ }
1277
+ /**
1278
+ * @public
1279
+ */
1280
+ export interface StopQueryInput {
1281
+ /**
1282
+ * @public
1283
+ * <p>The name of the monitor.</p>
1284
+ */
1285
+ MonitorName: string | undefined;
1286
+ /**
1287
+ * @public
1288
+ * <p>The ID of the query that you want to stop. A <code>QueryId</code> is an internally-generated identifier for a specific query.</p>
1289
+ */
1290
+ QueryId: string | undefined;
1291
+ }
1292
+ /**
1293
+ * @public
1294
+ */
1295
+ export interface StopQueryOutput {
1296
+ }
1045
1297
  /**
1046
1298
  * @public
1047
1299
  * <p>The request specifies a resource that doesn't exist.</p>
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { GetQueryResultsCommandInput, GetQueryResultsCommandOutput } from "../commands/GetQueryResultsCommand";
3
+ import { InternetMonitorPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare function paginateGetQueryResults(config: InternetMonitorPaginationConfiguration, input: GetQueryResultsCommandInput, ...additionalArguments: any): Paginator<GetQueryResultsCommandOutput>;
@@ -1,3 +1,4 @@
1
+ export * from "./GetQueryResultsPaginator";
1
2
  export * from "./Interfaces";
2
3
  export * from "./ListHealthEventsPaginator";
3
4
  export * from "./ListMonitorsPaginator";
@@ -4,9 +4,13 @@ import { CreateMonitorCommandInput, CreateMonitorCommandOutput } from "../comman
4
4
  import { DeleteMonitorCommandInput, DeleteMonitorCommandOutput } from "../commands/DeleteMonitorCommand";
5
5
  import { GetHealthEventCommandInput, GetHealthEventCommandOutput } from "../commands/GetHealthEventCommand";
6
6
  import { GetMonitorCommandInput, GetMonitorCommandOutput } from "../commands/GetMonitorCommand";
7
+ import { GetQueryResultsCommandInput, GetQueryResultsCommandOutput } from "../commands/GetQueryResultsCommand";
8
+ import { GetQueryStatusCommandInput, GetQueryStatusCommandOutput } from "../commands/GetQueryStatusCommand";
7
9
  import { ListHealthEventsCommandInput, ListHealthEventsCommandOutput } from "../commands/ListHealthEventsCommand";
8
10
  import { ListMonitorsCommandInput, ListMonitorsCommandOutput } from "../commands/ListMonitorsCommand";
9
11
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
12
+ import { StartQueryCommandInput, StartQueryCommandOutput } from "../commands/StartQueryCommand";
13
+ import { StopQueryCommandInput, StopQueryCommandOutput } from "../commands/StopQueryCommand";
10
14
  import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
11
15
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
12
16
  import { UpdateMonitorCommandInput, UpdateMonitorCommandOutput } from "../commands/UpdateMonitorCommand";
@@ -26,6 +30,14 @@ export declare const se_GetHealthEventCommand: (input: GetHealthEventCommandInpu
26
30
  * serializeAws_restJson1GetMonitorCommand
27
31
  */
28
32
  export declare const se_GetMonitorCommand: (input: GetMonitorCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
33
+ /**
34
+ * serializeAws_restJson1GetQueryResultsCommand
35
+ */
36
+ export declare const se_GetQueryResultsCommand: (input: GetQueryResultsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
37
+ /**
38
+ * serializeAws_restJson1GetQueryStatusCommand
39
+ */
40
+ export declare const se_GetQueryStatusCommand: (input: GetQueryStatusCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
29
41
  /**
30
42
  * serializeAws_restJson1ListHealthEventsCommand
31
43
  */
@@ -38,6 +50,14 @@ export declare const se_ListMonitorsCommand: (input: ListMonitorsCommandInput, c
38
50
  * serializeAws_restJson1ListTagsForResourceCommand
39
51
  */
40
52
  export declare const se_ListTagsForResourceCommand: (input: ListTagsForResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
53
+ /**
54
+ * serializeAws_restJson1StartQueryCommand
55
+ */
56
+ export declare const se_StartQueryCommand: (input: StartQueryCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
57
+ /**
58
+ * serializeAws_restJson1StopQueryCommand
59
+ */
60
+ export declare const se_StopQueryCommand: (input: StopQueryCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
41
61
  /**
42
62
  * serializeAws_restJson1TagResourceCommand
43
63
  */
@@ -66,6 +86,14 @@ export declare const de_GetHealthEventCommand: (output: __HttpResponse, context:
66
86
  * deserializeAws_restJson1GetMonitorCommand
67
87
  */
68
88
  export declare const de_GetMonitorCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetMonitorCommandOutput>;
89
+ /**
90
+ * deserializeAws_restJson1GetQueryResultsCommand
91
+ */
92
+ export declare const de_GetQueryResultsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetQueryResultsCommandOutput>;
93
+ /**
94
+ * deserializeAws_restJson1GetQueryStatusCommand
95
+ */
96
+ export declare const de_GetQueryStatusCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetQueryStatusCommandOutput>;
69
97
  /**
70
98
  * deserializeAws_restJson1ListHealthEventsCommand
71
99
  */
@@ -78,6 +106,14 @@ export declare const de_ListMonitorsCommand: (output: __HttpResponse, context: _
78
106
  * deserializeAws_restJson1ListTagsForResourceCommand
79
107
  */
80
108
  export declare const de_ListTagsForResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTagsForResourceCommandOutput>;
109
+ /**
110
+ * deserializeAws_restJson1StartQueryCommand
111
+ */
112
+ export declare const de_StartQueryCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartQueryCommandOutput>;
113
+ /**
114
+ * deserializeAws_restJson1StopQueryCommand
115
+ */
116
+ export declare const de_StopQueryCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StopQueryCommandOutput>;
81
117
  /**
82
118
  * deserializeAws_restJson1TagResourceCommand
83
119
  */