-
Notifications
You must be signed in to change notification settings - Fork 1
/
monitoring-2010-08-01.json
1338 lines (1338 loc) · 53.5 KB
/
monitoring-2010-08-01.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"metadata":{
"apiVersion":"2010-08-01",
"endpointPrefix":"monitoring",
"serviceAbbreviation":"CloudWatch",
"serviceFullName":"Amazon CloudWatch",
"signatureVersion":"v4",
"xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/",
"protocol":"query"
},
"documentation":"<p>This is the <i>Amazon CloudWatch API Reference</i>. This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide\">Amazon CloudWatch Developer Guide</a>. </p> <p>Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to <a href=\"http://aws.amazon.com/cloudwatch\">http://aws.amazon.com/cloudwatch</a>. </p> <p> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p> <p>Use the following links to get started using the <i>Amazon CloudWatch API Reference</i>:</p> <ul> <li> <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Operations.html\">Actions</a>: An alphabetical list of all Amazon CloudWatch actions.</li> <li> <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Types.html\">Data Types</a>: An alphabetical list of all Amazon CloudWatch data types.</li> <li> <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CommonParameters.html\">Common Parameters</a>: Parameters that all Query actions can use.</li> <li> <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CommonErrors.html\">Common Errors</a>: Client and server errors that all actions can return.</li> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html\">Regions and Endpoints</a>: Itemized regions and endpoints for all AWS products.</li> <li> <a href=\"http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl\">WSDL Location</a>: http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl</li> </ul> <p>In addition to using the Amazon CloudWatch API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch programmatically.</p> <ul> <li><a href=\"http://aws.amazon.com/documentation/sdkforjava/\">AWS SDK for Java Documentation</a></li> <li><a href=\"http://aws.amazon.com/documentation/sdkfornet/\">AWS SDK for .NET Documentation</a></li> <li><a href=\"http://aws.amazon.com/documentation/sdkforphp/\">AWS SDK for PHP Documentation</a></li> <li><a href=\"http://aws.amazon.com/documentation/sdkforruby/\">AWS SDK for Ruby Documentation</a></li> </ul> <p>Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:</p> <ul> <li><a href=\"http://aws.amazon.com/java/\">AWS Java Developer Center</a></li> <li><a href=\"http://aws.amazon.com/php/\">AWS PHP Developer Center</a></li> <li><a href=\"http://aws.amazon.com/python/\">AWS Python Developer Center</a></li> <li><a href=\"http://aws.amazon.com/ruby/\">AWS Ruby Developer Center</a></li> <li><a href=\"http://aws.amazon.com/net/\">AWS Windows and .NET Developer Center</a></li> </ul>",
"operations":{
"DeleteAlarms":{
"name":"DeleteAlarms",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAlarmsInput"},
"errors":[
{
"shape":"ResourceNotFound",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p> The named resource does not exist. </p>"
}
],
"documentation":"<p> Deletes all specified alarms. In the event of an error, no alarms are deleted. </p>"
},
"DescribeAlarmHistory":{
"name":"DescribeAlarmHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAlarmHistoryInput"},
"output":{
"shape":"DescribeAlarmHistoryOutput",
"documentation":"<p> The output for the <a>DescribeAlarmHistory</a> action. </p>",
"resultWrapper":"DescribeAlarmHistoryResult"
},
"errors":[
{
"shape":"InvalidNextToken",
"error":{
"code":"InvalidNextToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> The next token specified is invalid. </p>"
}
],
"documentation":"<p> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. </p> <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note>"
},
"DescribeAlarms":{
"name":"DescribeAlarms",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAlarmsInput"},
"output":{
"shape":"DescribeAlarmsOutput",
"documentation":"<p> The output for the <a>DescribeAlarms</a> action. </p>",
"resultWrapper":"DescribeAlarmsResult"
},
"errors":[
{
"shape":"InvalidNextToken",
"error":{
"code":"InvalidNextToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> The next token specified is invalid. </p>"
}
],
"documentation":"<p> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </p>"
},
"DescribeAlarmsForMetric":{
"name":"DescribeAlarmsForMetric",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAlarmsForMetricInput"},
"output":{
"shape":"DescribeAlarmsForMetricOutput",
"documentation":"<p> The output for the <a>DescribeAlarmsForMetric</a> action. </p>",
"resultWrapper":"DescribeAlarmsForMetricResult"
},
"documentation":"<p> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </p>"
},
"DisableAlarmActions":{
"name":"DisableAlarmActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{
"shape":"DisableAlarmActionsInput",
"documentation":"<p> </p>"
},
"documentation":"<p> Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </p>"
},
"EnableAlarmActions":{
"name":"EnableAlarmActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableAlarmActionsInput"},
"documentation":"<p> Enables actions for the specified alarms. </p>"
},
"GetMetricStatistics":{
"name":"GetMetricStatistics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetMetricStatisticsInput"},
"output":{
"shape":"GetMetricStatisticsOutput",
"documentation":"<p> The output for the <a>GetMetricStatistics</a> action. </p>",
"resultWrapper":"GetMetricStatisticsResult"
},
"errors":[
{
"shape":"InvalidParameterValueException",
"error":{
"code":"InvalidParameterValue",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Bad or out-of-range value was supplied for the input parameter. </p>"
},
{
"shape":"MissingRequiredParameterException",
"error":{
"code":"MissingParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> An input parameter that is mandatory for processing the request is not supplied. </p>"
},
{
"shape":"InvalidParameterCombinationException",
"error":{
"code":"InvalidParameterCombination",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Parameters that must not be used together were used together. </p>"
},
{
"shape":"InternalServiceFault",
"error":{
"code":"InternalServiceError",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p> Indicates that the request processing has failed due to some unknown error, exception, or failure. </p>",
"xmlOrder":["Message"]
}
],
"documentation":"<p> Gets statistics for the specified metric. </p> <p> The maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440, wereas the maximum number of data points that can be queried is 50,850. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. </p> <p> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </p> <p> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </p> <ul> <li>Statistics for up to 400 instances for a span of one hour</li> <li>Statistics for up to 35 instances over a span of 24 hours</li> <li>Statistics for up to 2 instances over a span of 2 weeks</li> </ul> <p> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p>"
},
"ListMetrics":{
"name":"ListMetrics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListMetricsInput"},
"output":{
"shape":"ListMetricsOutput",
"documentation":"<p> The output for the <a>ListMetrics</a> action. </p>",
"xmlOrder":[
"Metrics",
"NextToken"
],
"resultWrapper":"ListMetricsResult"
},
"errors":[
{
"shape":"InternalServiceFault",
"error":{
"code":"InternalServiceError",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p> Indicates that the request processing has failed due to some unknown error, exception, or failure. </p>",
"xmlOrder":["Message"]
},
{
"shape":"InvalidParameterValueException",
"error":{
"code":"InvalidParameterValue",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Bad or out-of-range value was supplied for the input parameter. </p>"
}
],
"documentation":"<p> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. </p> <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note>"
},
"PutMetricAlarm":{
"name":"PutMetricAlarm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutMetricAlarmInput"},
"errors":[
{
"shape":"LimitExceededFault",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> The quota for alarms for this customer has already been reached. </p>"
}
],
"documentation":"<p> Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. </p> <p> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </p> <note> When updating an existing alarm, its <code>StateValue</code> is left unchanged. </note>"
},
"PutMetricData":{
"name":"PutMetricData",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutMetricDataInput"},
"errors":[
{
"shape":"InvalidParameterValueException",
"error":{
"code":"InvalidParameterValue",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Bad or out-of-range value was supplied for the input parameter. </p>"
},
{
"shape":"MissingRequiredParameterException",
"error":{
"code":"MissingParameter",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> An input parameter that is mandatory for processing the request is not supplied. </p>"
},
{
"shape":"InvalidParameterCombinationException",
"error":{
"code":"InvalidParameterCombination",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Parameters that must not be used together were used together. </p>"
},
{
"shape":"InternalServiceFault",
"error":{
"code":"InternalServiceError",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p> Indicates that the request processing has failed due to some unknown error, exception, or failure. </p>",
"xmlOrder":["Message"]
}
],
"documentation":"<p> Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. It can take up to fifteen minutes for a new metric to appear in calls to the <a>ListMetrics</a> action.</p> <p> The size of a <function>PutMetricData</function> request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests. </p> <important> Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. </important> <p>Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>.</p>"
},
"SetAlarmState":{
"name":"SetAlarmState",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetAlarmStateInput"},
"errors":[
{
"shape":"ResourceNotFound",
"error":{
"code":"ResourceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p> The named resource does not exist. </p>"
},
{
"shape":"InvalidFormatFault",
"error":{
"code":"InvalidFormat",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Data was not syntactically valid JSON. </p>"
}
],
"documentation":"<p> Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. </p>"
}
},
"shapes":{
"ActionPrefix":{
"type":"string",
"min":1,
"max":1024
},
"ActionsEnabled":{"type":"boolean"},
"AlarmArn":{
"type":"string",
"min":1,
"max":1600
},
"AlarmDescription":{
"type":"string",
"min":0,
"max":255
},
"AlarmHistoryItem":{
"type":"structure",
"members":{
"AlarmName":{
"shape":"AlarmName",
"documentation":"<p> The descriptive name for the alarm. </p>"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p> The time stamp for the alarm history item. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Time stamps</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p>"
},
"HistoryItemType":{
"shape":"HistoryItemType",
"documentation":"<p> The type of alarm history item. </p>"
},
"HistorySummary":{
"shape":"HistorySummary",
"documentation":"<p> A human-readable summary of the alarm history. </p>"
},
"HistoryData":{
"shape":"HistoryData",
"documentation":"<p> Machine-readable data about the alarm in JSON format. </p>"
}
},
"documentation":"<p> The <code>AlarmHistoryItem</code> data type contains descriptive information about the history of a specific alarm. If you call <a>DescribeAlarmHistory</a>, Amazon CloudWatch returns this data type as part of the <a>DescribeAlarmHistoryResult</a> data type. </p>"
},
"AlarmHistoryItems":{
"type":"list",
"member":{"shape":"AlarmHistoryItem"}
},
"AlarmName":{
"type":"string",
"min":1,
"max":255
},
"AlarmNamePrefix":{
"type":"string",
"min":1,
"max":255
},
"AlarmNames":{
"type":"list",
"member":{"shape":"AlarmName"},
"max":100
},
"AwsQueryErrorMessage":{"type":"string"},
"ComparisonOperator":{
"type":"string",
"enum":[
"GreaterThanOrEqualToThreshold",
"GreaterThanThreshold",
"LessThanThreshold",
"LessThanOrEqualToThreshold"
]
},
"Datapoint":{
"type":"structure",
"members":{
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p> The time stamp used for the datapoint. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Time stamps</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p>"
},
"SampleCount":{
"shape":"DatapointValue",
"documentation":"<p> The number of metric values that contributed to the aggregate value of this datapoint. </p>"
},
"Average":{
"shape":"DatapointValue",
"documentation":"<p> The average of metric values that correspond to the datapoint. </p>"
},
"Sum":{
"shape":"DatapointValue",
"documentation":"<p> The sum of metric values used for the datapoint. </p>"
},
"Minimum":{
"shape":"DatapointValue",
"documentation":"<p> The minimum metric value used for the datapoint. </p>"
},
"Maximum":{
"shape":"DatapointValue",
"documentation":"<p> The maximum of the metric value used for the datapoint. </p>"
},
"Unit":{
"shape":"StandardUnit",
"documentation":"<p> The standard unit used for the datapoint. </p>"
}
},
"documentation":"<p> The <code>Datapoint</code> data type encapsulates the statistical data that Amazon CloudWatch computes from metric data. </p>",
"xmlOrder":[
"Timestamp",
"SampleCount",
"Average",
"Sum",
"Minimum",
"Maximum",
"Unit"
]
},
"DatapointValue":{"type":"double"},
"Datapoints":{
"type":"list",
"member":{"shape":"Datapoint"}
},
"DeleteAlarmsInput":{
"type":"structure",
"required":["AlarmNames"],
"members":{
"AlarmNames":{
"shape":"AlarmNames",
"documentation":"<p> A list of alarms to be deleted. </p>"
}
}
},
"DescribeAlarmHistoryInput":{
"type":"structure",
"members":{
"AlarmName":{
"shape":"AlarmName",
"documentation":"<p> The name of the alarm. </p>"
},
"HistoryItemType":{
"shape":"HistoryItemType",
"documentation":"<p> The type of alarm histories to retrieve. </p>"
},
"StartDate":{
"shape":"Timestamp",
"documentation":"<p> The starting date to retrieve alarm history. </p>"
},
"EndDate":{
"shape":"Timestamp",
"documentation":"<p> The ending date to retrieve alarm history. </p>"
},
"MaxRecords":{
"shape":"MaxRecords",
"documentation":"<p> The maximum number of alarm history records to retrieve. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> The token returned by a previous call to indicate that there is more data available. </p>"
}
}
},
"DescribeAlarmHistoryOutput":{
"type":"structure",
"members":{
"AlarmHistoryItems":{
"shape":"AlarmHistoryItems",
"documentation":"<p> A list of alarm histories in JSON format. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> A string that marks the start of the next batch of returned results. </p>"
}
},
"documentation":"<p> The output for the <a>DescribeAlarmHistory</a> action. </p>"
},
"DescribeAlarmsForMetricInput":{
"type":"structure",
"required":[
"MetricName",
"Namespace"
],
"members":{
"MetricName":{
"shape":"MetricName",
"documentation":"<p> The name of the metric. </p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p> The namespace of the metric. </p>"
},
"Statistic":{
"shape":"Statistic",
"documentation":"<p> The statistic for the metric. </p>"
},
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p> The list of dimensions associated with the metric. </p>"
},
"Period":{
"shape":"Period",
"documentation":"<p> The period in seconds over which the statistic is applied. </p>"
},
"Unit":{
"shape":"StandardUnit",
"documentation":"<p> The unit for the metric. </p>"
}
}
},
"DescribeAlarmsForMetricOutput":{
"type":"structure",
"members":{
"MetricAlarms":{
"shape":"MetricAlarms",
"documentation":"<p> A list of information for each alarm with the specified metric. </p>"
}
},
"documentation":"<p> The output for the <a>DescribeAlarmsForMetric</a> action. </p>"
},
"DescribeAlarmsInput":{
"type":"structure",
"members":{
"AlarmNames":{
"shape":"AlarmNames",
"documentation":"<p> A list of alarm names to retrieve information for. </p>"
},
"AlarmNamePrefix":{
"shape":"AlarmNamePrefix",
"documentation":"<p> The alarm name prefix. <code>AlarmNames</code> cannot be specified if this parameter is specified. </p>"
},
"StateValue":{
"shape":"StateValue",
"documentation":"<p> The state value to be used in matching alarms. </p>"
},
"ActionPrefix":{
"shape":"ActionPrefix",
"documentation":"<p> The action name prefix. </p>"
},
"MaxRecords":{
"shape":"MaxRecords",
"documentation":"<p> The maximum number of alarm descriptions to retrieve. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> The token returned by a previous call to indicate that there is more data available. </p>"
}
}
},
"DescribeAlarmsOutput":{
"type":"structure",
"members":{
"MetricAlarms":{
"shape":"MetricAlarms",
"documentation":"<p> A list of information for the specified alarms. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> A string that marks the start of the next batch of returned results. </p>"
}
},
"documentation":"<p> The output for the <a>DescribeAlarms</a> action. </p>"
},
"Dimension":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{
"shape":"DimensionName",
"documentation":"<p> The name of the dimension. </p>"
},
"Value":{
"shape":"DimensionValue",
"documentation":"<p> The value representing the dimension measurement </p>"
}
},
"documentation":"<p> The <code>Dimension</code> data type further expands on the identity of a metric using a Name, Value pair. </p> <p>For examples that use one or more dimensions, see <a>PutMetricData</a>.</p>",
"xmlOrder":[
"Name",
"Value"
]
},
"DimensionFilter":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"DimensionName",
"documentation":"<p> The dimension name to be matched. </p>"
},
"Value":{
"shape":"DimensionValue",
"documentation":"<p> The value of the dimension to be matched. </p> <note> Specifying a <code>Name</code> without specifying a <code>Value</code> returns all values associated with that <code>Name</code>. </note>"
}
},
"documentation":"<p> The <code>DimensionFilter</code> data type is used to filter <a>ListMetrics</a> results. </p>"
},
"DimensionFilters":{
"type":"list",
"member":{"shape":"DimensionFilter"},
"max":10
},
"DimensionName":{
"type":"string",
"min":1,
"max":255
},
"DimensionValue":{
"type":"string",
"min":1,
"max":255
},
"Dimensions":{
"type":"list",
"member":{"shape":"Dimension"},
"max":10
},
"DisableAlarmActionsInput":{
"type":"structure",
"required":["AlarmNames"],
"members":{
"AlarmNames":{
"shape":"AlarmNames",
"documentation":"<p> The names of the alarms to disable actions for. </p>"
}
},
"documentation":"<p> </p>"
},
"EnableAlarmActionsInput":{
"type":"structure",
"required":["AlarmNames"],
"members":{
"AlarmNames":{
"shape":"AlarmNames",
"documentation":"<p> The names of the alarms to enable actions for. </p>"
}
}
},
"ErrorMessage":{
"type":"string",
"min":1,
"max":255
},
"EvaluationPeriods":{
"type":"integer",
"min":1
},
"FaultDescription":{"type":"string"},
"GetMetricStatisticsInput":{
"type":"structure",
"required":[
"Namespace",
"MetricName",
"StartTime",
"EndTime",
"Period",
"Statistics"
],
"members":{
"Namespace":{
"shape":"Namespace",
"documentation":"<p> The namespace of the metric, with or without spaces. </p>"
},
"MetricName":{
"shape":"MetricName",
"documentation":"<p> The name of the metric, with or without spaces. </p>"
},
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p> A list of dimensions describing qualities of the metric. </p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p> The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. </p> <note> The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks. <p>Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>.</p> </note>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p> The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. </p>"
},
"Period":{
"shape":"Period",
"documentation":"<p> The granularity, in seconds, of the returned datapoints. <code>Period</code> must be at least 60 seconds and must be a multiple of 60. The default value is 60. </p>"
},
"Statistics":{
"shape":"Statistics",
"documentation":"<p> The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, go to <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/index.html?CHAP_TerminologyandKeyConcepts.html#Statistic\">Statistics</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p> <p> Valid Values: <code>Average | Sum | SampleCount | Maximum | Minimum</code> </p>"
},
"Unit":{
"shape":"StandardUnit",
"documentation":"<p> The unit for the metric. </p>"
}
}
},
"GetMetricStatisticsOutput":{
"type":"structure",
"members":{
"Label":{
"shape":"MetricLabel",
"documentation":"<p> A label describing the specified metric. </p>"
},
"Datapoints":{
"shape":"Datapoints",
"documentation":"<p> The datapoints for the specified metric. </p>"
}
},
"documentation":"<p> The output for the <a>GetMetricStatistics</a> action. </p>"
},
"HistoryData":{
"type":"string",
"min":1,
"max":4095
},
"HistoryItemType":{
"type":"string",
"enum":[
"ConfigurationUpdate",
"StateUpdate",
"Action"
]
},
"HistorySummary":{
"type":"string",
"min":1,
"max":255
},
"InternalServiceFault":{
"type":"structure",
"members":{
"Message":{
"shape":"FaultDescription",
"documentation":"<p></p>"
}
},
"error":{
"code":"InternalServiceError",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p> Indicates that the request processing has failed due to some unknown error, exception, or failure. </p>",
"xmlOrder":["Message"]
},
"InvalidFormatFault":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p></p>"
}
},
"error":{
"code":"InvalidFormat",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Data was not syntactically valid JSON. </p>"
},
"InvalidNextToken":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p></p>"
}
},
"error":{
"code":"InvalidNextToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> The next token specified is invalid. </p>"
},
"InvalidParameterCombinationException":{
"type":"structure",
"members":{
"message":{
"shape":"AwsQueryErrorMessage",
"documentation":"<p></p>"
}
},
"error":{
"code":"InvalidParameterCombination",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Parameters that must not be used together were used together. </p>"
},
"InvalidParameterValueException":{
"type":"structure",
"members":{
"message":{
"shape":"AwsQueryErrorMessage",
"documentation":"<p></p>"
}
},
"error":{
"code":"InvalidParameterValue",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> Bad or out-of-range value was supplied for the input parameter. </p>"
},
"LimitExceededFault":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p></p>"
}
},
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p> The quota for alarms for this customer has already been reached. </p>"
},
"ListMetricsInput":{
"type":"structure",
"members":{
"Namespace":{
"shape":"Namespace",
"documentation":"<p> The namespace to filter against. </p>"
},
"MetricName":{
"shape":"MetricName",
"documentation":"<p> The name of the metric to filter against. </p>"
},
"Dimensions":{
"shape":"DimensionFilters",
"documentation":"<p> A list of dimensions to filter against. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> The token returned by a previous call to indicate that there is more data available. </p>"
}
}
},
"ListMetricsOutput":{
"type":"structure",
"members":{
"Metrics":{
"shape":"Metrics",
"documentation":"<p> A list of metrics used to generate statistics for an AWS account. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> A string that marks the start of the next batch of returned results. </p>"
}
},
"documentation":"<p> The output for the <a>ListMetrics</a> action. </p>",
"xmlOrder":[
"Metrics",
"NextToken"
]
},
"MaxRecords":{
"type":"integer",
"min":1,
"max":100
},
"Metric":{
"type":"structure",
"members":{
"Namespace":{
"shape":"Namespace",
"documentation":"<p> The namespace of the metric. </p>"
},
"MetricName":{
"shape":"MetricName",
"documentation":"<p> The name of the metric. </p>"
},
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p> A list of dimensions associated with the metric. </p>"
}
},
"documentation":"<p> The <code>Metric</code> data type contains information about a specific metric. If you call <a>ListMetrics</a>, Amazon CloudWatch returns information contained by this data type. </p> <p> The example in the Examples section publishes two metrics named buffers and latency. Both metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType. </p>",
"xmlOrder":[
"Namespace",
"MetricName",
"Dimensions"
]
},
"MetricAlarm":{
"type":"structure",
"members":{
"AlarmName":{
"shape":"AlarmName",
"documentation":"<p> The name of the alarm. </p>"
},
"AlarmArn":{
"shape":"AlarmArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the alarm. </p>"
},
"AlarmDescription":{
"shape":"AlarmDescription",
"documentation":"<p> The description for the alarm. </p>"
},
"AlarmConfigurationUpdatedTimestamp":{
"shape":"Timestamp",
"documentation":"<p> The time stamp of the last update to the alarm configuration. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Time stamps</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p>"
},
"ActionsEnabled":{
"shape":"ActionsEnabled",
"documentation":"<p> Indicates whether actions should be executed during any changes to the alarm's state. </p>"
},
"OKActions":{
"shape":"ResourceList",
"documentation":"<p> The list of actions to execute when this alarm transitions into an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy. </p>"
},
"AlarmActions":{
"shape":"ResourceList",
"documentation":"<p> The list of actions to execute when this alarm transitions into an <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy. </p>"
},
"InsufficientDataActions":{
"shape":"ResourceList",
"documentation":"<p> The list of actions to execute when this alarm transitions into an <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy. </p> <important>The current WSDL lists this attribute as <code>UnknownActions</code>.</important>"
},
"StateValue":{
"shape":"StateValue",
"documentation":"<p> The state value for the alarm. </p>"
},
"StateReason":{
"shape":"StateReason",
"documentation":"<p> A human-readable explanation for the alarm's state. </p>"
},
"StateReasonData":{
"shape":"StateReasonData",
"documentation":"<p> An explanation for the alarm's state in machine-readable JSON format </p>"
},
"StateUpdatedTimestamp":{
"shape":"Timestamp",
"documentation":"<p> The time stamp of the last update to the alarm's state. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Time stamps</a> in the <i>Amazon CloudWatch Developer Guide</i>. </p>"
},
"MetricName":{
"shape":"MetricName",
"documentation":"<p> The name of the alarm's metric. </p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p> The namespace of alarm's associated metric. </p>"
},
"Statistic":{
"shape":"Statistic",
"documentation":"<p> The statistic to apply to the alarm's associated metric. </p>"
},
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p> The list of dimensions associated with the alarm's associated metric. </p>"
},
"Period":{
"shape":"Period",
"documentation":"<p> The period in seconds over which the statistic is applied. </p>"
},
"Unit":{
"shape":"StandardUnit",
"documentation":"<p> The unit of the alarm's associated metric. </p>"
},
"EvaluationPeriods":{
"shape":"EvaluationPeriods",
"documentation":"<p> The number of periods over which data is compared to the specified threshold. </p>"
},
"Threshold":{
"shape":"Threshold",
"documentation":"<p> The value against which the specified statistic is compared. </p>"
},
"ComparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"<p> The arithmetic operation to use when comparing the specified <code>Statistic</code> and <code>Threshold</code>. The specified <code>Statistic</code> value is used as the first operand. </p>"
}
},
"documentation":"<p> The <a>MetricAlarm</a> data type represents an alarm. You can use <a>PutMetricAlarm</a> to create or update an alarm. </p>",
"xmlOrder":[
"AlarmName",
"AlarmArn",
"AlarmDescription",