/
docs-2.json
786 lines (786 loc) · 56.7 KB
/
docs-2.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
{
"version": "2.0",
"service": "<p>The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
"operations": {
"GetCostAndUsage": "<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> </code> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>",
"GetCostForecast": "<p>Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs. </p>",
"GetDimensionValues": "<p>Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
"GetReservationCoverage": "<p>Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
"GetReservationPurchaseRecommendation": "<p>Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.</p> <p>AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. </p> <p>For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for <code>c4.large</code>, because that is the smallest size instance in the c4 instance family.</p>",
"GetReservationUtilization": "<p>Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
"GetTags": "<p>Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>"
},
"shapes": {
"AccountScope": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$AccountScope": "<p>The account scope that you want recommendations for. <code>PAYER</code> means that AWS includes the master account and any member accounts when it calculates its recommendations. <code>LINKED</code> means that AWS includes only member accounts when it calculates its recommendations.</p> <p>Valid values are <code>PAYER</code> and <code>LINKED</code>.</p>",
"ReservationPurchaseRecommendation$AccountScope": "<p>The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.</p>"
}
},
"AmortizedRecurringFee": {
"base": null,
"refs": {
"ReservationAggregates$AmortizedRecurringFee": "<p>The monthly cost of your RI, amortized over the RI period.</p>"
}
},
"AmortizedUpfrontFee": {
"base": null,
"refs": {
"ReservationAggregates$AmortizedUpfrontFee": "<p>The upfront cost of your RI, amortized over the RI period.</p>"
}
},
"AttributeType": {
"base": null,
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": null,
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": null,
"refs": {
"DimensionValuesWithAttributes$Attributes": "<p>The attribute that applies to a specific <code>Dimension</code>.</p>",
"ReservationCoverageGroup$Attributes": "<p>The attributes for this group of reservations.</p>",
"ReservationUtilizationGroup$Attributes": "<p>The attributes for this group of RIs.</p>"
}
},
"BillExpirationException": {
"base": "<p>The requested report expired. Update the date interval and try again.</p>",
"refs": {
}
},
"Context": {
"base": null,
"refs": {
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> operation. If the context is set to <code>COST_AND_USAGE</code> the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"Coverage": {
"base": "<p>The amount of instance usage that a reservation covered.</p>",
"refs": {
"CoverageByTime$Total": "<p>The total reservation coverage, in hours.</p>",
"GetReservationCoverageResponse$Total": "<p>The total amount of instance usage that is covered by a reservation.</p>",
"ReservationCoverageGroup$Coverage": "<p>How much instance usage this group of reservations covered.</p>"
}
},
"CoverageByTime": {
"base": "<p>Reservation coverage for a specified period, in hours.</p>",
"refs": {
"CoveragesByTime$member": null
}
},
"CoverageHours": {
"base": "<p>How long a running instance either used a reservation or was On-Demand.</p>",
"refs": {
"Coverage$CoverageHours": "<p>The amount of instance usage that a reservation covered, in hours.</p>"
}
},
"CoverageHoursPercentage": {
"base": null,
"refs": {
"CoverageHours$CoverageHoursPercentage": "<p>The percentage of instance hours that are covered by a reservation.</p>"
}
},
"CoveragesByTime": {
"base": null,
"refs": {
"GetReservationCoverageResponse$CoveragesByTime": "<p>The amount of time that your reservations covered.</p>"
}
},
"DataUnavailableException": {
"base": "<p>The requested data is unavailable.</p>",
"refs": {
}
},
"DateInterval": {
"base": "<p>The time period that you want the usage and costs for. </p>",
"refs": {
"CoverageByTime$TimePeriod": "<p>The period over which this coverage was used.</p>",
"ForecastResult$TimePeriod": "<p>The period of time that the forecast covers.</p>",
"GetCostAndUsageRequest$TimePeriod": "<p>Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetCostForecastRequest$TimePeriod": "<p>The period of time that you want the forecast to cover.</p>",
"GetDimensionValuesRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetTagsRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"ResultByTime$TimePeriod": "<p>The time period covered by a result.</p>",
"UtilizationByTime$TimePeriod": "<p>The period of time over which this utilization was used.</p>"
}
},
"Dimension": {
"base": null,
"refs": {
"DimensionValues$Key": "<p>The names of the metadata types that you can use to filter and group your results. For example, <code>AZ</code> returns a list of Availability Zones.</p>",
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Each <code>Dimension</code> is available for different a <code>Context</code>. For more information, see <code>Context</code>.</p>"
}
},
"DimensionValues": {
"base": "<p>The metadata that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"refs": {
"Expression$Dimensions": "<p>The specific <code>Dimension</code> to use for <code>Expression</code>.</p>"
}
},
"DimensionValuesWithAttributes": {
"base": "<p>The metadata of a specific type that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"refs": {
"DimensionValuesWithAttributesList$member": null
}
},
"DimensionValuesWithAttributesList": {
"base": null,
"refs": {
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context:</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"EC2InstanceDetails": {
"base": "<p>Details about the EC2 instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$EC2InstanceDetails": "<p>The EC2 instances that AWS recommends that you purchase.</p>"
}
},
"EC2Specification": {
"base": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>",
"refs": {
"ServiceSpecification$EC2Specification": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>"
}
},
"ESInstanceDetails": {
"base": "<p>Details about the ES instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$ESInstanceDetails": "<p>The Amazon ES instances that AWS recommends that you purchase.</p>"
}
},
"ElastiCacheInstanceDetails": {
"base": "<p>Details about the ElastiCache instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$ElastiCacheInstanceDetails": "<p>The ElastiCache instances that AWS recommends that you purchase.</p>"
}
},
"Entity": {
"base": null,
"refs": {
"TagList$member": null
}
},
"ErrorMessage": {
"base": null,
"refs": {
"BillExpirationException$Message": null,
"DataUnavailableException$Message": null,
"InvalidNextTokenException$Message": null,
"LimitExceededException$Message": null,
"RequestChangedException$Message": null
}
},
"Estimated": {
"base": null,
"refs": {
"ResultByTime$Estimated": "<p>Whether this result is estimated.</p>"
}
},
"Expression": {
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
"refs": {
"Expression$Not": "<p>Return results that don't match a <code>Dimension</code> object.</p>",
"Expressions$member": null,
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>",
"GetCostForecastRequest$Filter": "<p>The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.</p>",
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p> <p>If you don't provide a <code>SERVICE</code> filter, Cost Explorer defaults to EC2.</p>",
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
}
},
"Expressions": {
"base": null,
"refs": {
"Expression$Or": "<p>Return results that match either <code>Dimension</code> object.</p>",
"Expression$And": "<p>Return results that match both <code>Dimension</code> objects.</p>"
}
},
"ForecastResult": {
"base": "<p>The forecast created for your query.</p>",
"refs": {
"ForecastResultsByTime$member": null
}
},
"ForecastResultsByTime": {
"base": null,
"refs": {
"GetCostForecastResponse$ForecastResultsByTime": "<p>The forecasts for your query, in order. For <code>DAILY</code> forecasts, this is a list of days. For <code>MONTHLY</code> forecasts, this is a list of months.</p>"
}
},
"GenericBoolean": {
"base": null,
"refs": {
"EC2InstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
"EC2InstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
"ESInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance.</p>",
"ESInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
"ElastiCacheInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance.</p>",
"ElastiCacheInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
"RDSInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
"RDSInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
"RedshiftInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance.</p>",
"RedshiftInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>"
}
},
"GenericString": {
"base": null,
"refs": {
"EC2InstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"EC2InstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
"EC2InstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"EC2InstanceDetails$AvailabilityZone": "<p>The Availability Zone of the recommended reservation.</p>",
"EC2InstanceDetails$Platform": "<p>The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.</p>",
"EC2InstanceDetails$Tenancy": "<p>Whether the recommended reservation is dedicated or shared.</p>",
"ESInstanceDetails$InstanceClass": "<p>The class of instance that AWS recommends.</p>",
"ESInstanceDetails$InstanceSize": "<p>The size of instance that AWS recommends.</p>",
"ESInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"ElastiCacheInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"ElastiCacheInstanceDetails$NodeType": "<p>The type of node that AWS recommends.</p>",
"ElastiCacheInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"ElastiCacheInstanceDetails$ProductDescription": "<p>The description of the recommended reservation.</p>",
"ForecastResult$MeanValue": "<p>The mean value of the forecast.</p>",
"ForecastResult$PredictionIntervalLowerBound": "<p>The lower limit for the prediction interval. </p>",
"ForecastResult$PredictionIntervalUpperBound": "<p>The upper limit for the prediction interval. </p>",
"GetReservationPurchaseRecommendationRequest$AccountId": "<p>The account ID that is associated with the recommendation. </p>",
"GetReservationPurchaseRecommendationRequest$Service": "<p>The specific service that you want recommendations for.</p>",
"RDSInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"RDSInstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
"RDSInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"RDSInstanceDetails$DatabaseEngine": "<p>The database engine that the recommended reservation supports.</p>",
"RDSInstanceDetails$DatabaseEdition": "<p>The database edition that the recommended reservation supports.</p>",
"RDSInstanceDetails$DeploymentOption": "<p>Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.</p>",
"RDSInstanceDetails$LicenseModel": "<p>The license model that the recommended reservation supports.</p>",
"RedshiftInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"RedshiftInstanceDetails$NodeType": "<p>The type of node that AWS recommends.</p>",
"RedshiftInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"ReservationPurchaseRecommendationDetail$AccountId": null,
"ReservationPurchaseRecommendationDetail$RecommendedNumberOfInstancesToPurchase": "<p>The number of instances that AWS recommends that you purchase.</p>",
"ReservationPurchaseRecommendationDetail$RecommendedNormalizedUnitsToPurchase": "<p>The number of normalized units that AWS recommends that you purchase.</p>",
"ReservationPurchaseRecommendationDetail$MinimumNumberOfInstancesUsedPerHour": "<p>The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "<p>The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MaximumNumberOfInstancesUsedPerHour": "<p>The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MaximumNormalizedUnitsUsedPerHour": "<p>The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageNumberOfInstancesUsedPerHour": "<p>The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageNormalizedUnitsUsedPerHour": "<p>The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageUtilization": "<p>The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedBreakEvenInMonths": "<p>How long AWS estimates that it takes for this instance to start saving you money, in months.</p>",
"ReservationPurchaseRecommendationDetail$CurrencyCode": "<p>The currency code that AWS used to calculate the costs for this instance.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsAmount": "<p>How much AWS estimates that this specific recommendation could save you in a month.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsPercentage": "<p>How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlyOnDemandCost": "<p>How much AWS estimates that you spend on On-Demand Instances in a month.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedReservationCostForLookbackPeriod": "<p>How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.</p>",
"ReservationPurchaseRecommendationDetail$UpfrontCost": "<p>How much purchasing this instance costs you upfront.</p>",
"ReservationPurchaseRecommendationDetail$RecurringStandardMonthlyCost": "<p>How much purchasing this instance costs you on a monthly basis.</p>",
"ReservationPurchaseRecommendationMetadata$RecommendationId": "<p>The ID for this specific recommendation.</p>",
"ReservationPurchaseRecommendationMetadata$GenerationTimestamp": "<p>The time stamp for when AWS made this recommendation.</p>",
"ReservationPurchaseRecommendationSummary$TotalEstimatedMonthlySavingsAmount": "<p>The total amount that AWS estimates that this recommendation could save you in a month.</p>",
"ReservationPurchaseRecommendationSummary$TotalEstimatedMonthlySavingsPercentage": "<p>The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.</p>",
"ReservationPurchaseRecommendationSummary$CurrencyCode": "<p>The currency code used for this recommendation.</p>"
}
},
"GetCostAndUsageRequest": {
"base": null,
"refs": {
}
},
"GetCostAndUsageResponse": {
"base": null,
"refs": {
}
},
"GetCostForecastRequest": {
"base": null,
"refs": {
}
},
"GetCostForecastResponse": {
"base": null,
"refs": {
}
},
"GetDimensionValuesRequest": {
"base": null,
"refs": {
}
},
"GetDimensionValuesResponse": {
"base": null,
"refs": {
}
},
"GetReservationCoverageRequest": {
"base": "<p>You can use the following request parameters to query for how much of your instance usage is covered by a reservation.</p>",
"refs": {
}
},
"GetReservationCoverageResponse": {
"base": null,
"refs": {
}
},
"GetReservationPurchaseRecommendationRequest": {
"base": null,
"refs": {
}
},
"GetReservationPurchaseRecommendationResponse": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationRequest": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationResponse": {
"base": null,
"refs": {
}
},
"GetTagsRequest": {
"base": null,
"refs": {
}
},
"GetTagsResponse": {
"base": null,
"refs": {
}
},
"Granularity": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. </p>",
"GetCostForecastRequest$Granularity": "<p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>",
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p>",
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p>"
}
},
"Group": {
"base": "<p>One level of grouped data within the results.</p>",
"refs": {
"Groups$member": null
}
},
"GroupDefinition": {
"base": "<p>Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.</p>",
"refs": {
"GroupDefinitions$member": null
}
},
"GroupDefinitionKey": {
"base": null,
"refs": {
"GroupDefinition$Key": "<p>The string that represents a key for a specified group.</p>"
}
},
"GroupDefinitionType": {
"base": null,
"refs": {
"GroupDefinition$Type": "<p>The string that represents the type of group.</p>"
}
},
"GroupDefinitions": {
"base": null,
"refs": {
"GetCostAndUsageRequest$GroupBy": "<p>You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.</p> <p>When you group by tag key, you get all tag values, including empty strings.</p> <p>Valid values are <code>AZ</code>, <code>INSTANCE_TYPE</code>, <code>LEGAL_ENTITY_NAME</code>, <code>LINKED_ACCOUNT</code>, <code>OPERATION</code>, <code>PLATFORM</code>, <code>PURCHASE_TYPE</code>, <code>SERVICE</code>, <code>TAGS</code>, <code>TENANCY</code>, and <code>USAGE_TYPE</code>.</p>",
"GetCostAndUsageResponse$GroupDefinitions": "<p>The groups that are specified by the <code>Filter</code> or <code>GroupBy</code> parameters in the request.</p>",
"GetReservationCoverageRequest$GroupBy": "<p>You can group the data by the following attributes:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul>",
"GetReservationUtilizationRequest$GroupBy": "<p>Groups only by <code>SUBSCRIPTION_ID</code>. Metadata is included.</p>"
}
},
"Groups": {
"base": null,
"refs": {
"ResultByTime$Groups": "<p>The groups that are included in this time period.</p>"
}
},
"InstanceDetails": {
"base": "<p>Details about the instances that AWS recommends that you purchase.</p>",
"refs": {
"ReservationPurchaseRecommendationDetail$InstanceDetails": "<p>Details about the instances that AWS recommends that you purchase.</p>"
}
},
"InvalidNextTokenException": {
"base": "<p>The pagination token is invalid. Try again without a pagination token.</p>",
"refs": {
}
},
"Key": {
"base": null,
"refs": {
"Keys$member": null
}
},
"Keys": {
"base": null,
"refs": {
"Group$Keys": "<p>The keys that are included in this group.</p>"
}
},
"LimitExceededException": {
"base": "<p>You made too many calls in a short period of time. Try again later.</p>",
"refs": {
}
},
"LookbackPeriodInDays": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$LookbackPeriodInDays": "<p>The number of previous days that you want AWS to consider when it calculates your recommendations.</p>",
"ReservationPurchaseRecommendation$LookbackPeriodInDays": "<p>How many days of previous usage that AWS considers when making this recommendation.</p>"
}
},
"Metric": {
"base": null,
"refs": {
"GetCostForecastRequest$Metric": "<p>Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values for a <code>GetCostForecast</code> call are the following:</p> <ul> <li> <p>AmortizedCost</p> </li> <li> <p>BlendedCost</p> </li> <li> <p>NetAmortizedCost</p> </li> <li> <p>NetUnblendedCost</p> </li> <li> <p>UnblendedCost</p> </li> </ul>"
}
},
"MetricAmount": {
"base": null,
"refs": {
"MetricValue$Amount": "<p>The actual number that represents the metric.</p>"
}
},
"MetricName": {
"base": null,
"refs": {
"MetricNames$member": null,
"Metrics$key": null
}
},
"MetricNames": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>NetAmortizedCost</code>, <code>NetUnblendedCost</code>, <code>NormalizedUsageAmount</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>. </p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
}
},
"MetricUnit": {
"base": null,
"refs": {
"MetricValue$Unit": "<p>The unit that the metric is given in.</p>"
}
},
"MetricValue": {
"base": "<p>The aggregated value for a metric.</p>",
"refs": {
"GetCostForecastResponse$Total": "<p>How much you are forecasted to spend over the forecast period, in <code>USD</code>.</p>",
"Metrics$value": null
}
},
"Metrics": {
"base": null,
"refs": {
"Group$Metrics": "<p>The metrics that are included in this group.</p>",
"ResultByTime$Total": "<p>The total amount of cost or usage accrued during the time period.</p>"
}
},
"NetRISavings": {
"base": null,
"refs": {
"ReservationAggregates$NetRISavings": "<p>How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting <code>TotalAmortizedFee</code> from <code>OnDemandCostOfRIHoursUsed</code>.</p>"
}
},
"NextPageToken": {
"base": null,
"refs": {
"GetCostAndUsageRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetCostAndUsageResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetDimensionValuesRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetDimensionValuesResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationCoverageRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationCoverageResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationPurchaseRecommendationRequest$NextPageToken": "<p>The pagination token that indicates the next set of results that you want to retrieve.</p>",
"GetReservationPurchaseRecommendationResponse$NextPageToken": "<p>The pagination token for the next set of retrievable results.</p>",
"GetReservationUtilizationRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationUtilizationResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>"
}
},
"NonNegativeInteger": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$PageSize": "<p>The number of recommendations that you want returned in a single response object.</p>"
}
},
"OfferingClass": {
"base": null,
"refs": {
"EC2Specification$OfferingClass": "<p>Whether you want a recommendation for standard or convertible reservations.</p>"
}
},
"OnDemandCostOfRIHoursUsed": {
"base": null,
"refs": {
"ReservationAggregates$OnDemandCostOfRIHoursUsed": "<p>How much your RIs would cost if charged On-Demand rates.</p>"
}
},
"OnDemandHours": {
"base": null,
"refs": {
"CoverageHours$OnDemandHours": "<p>The number of instance running hours that are covered by On-Demand Instances.</p>"
}
},
"PageSize": {
"base": null,
"refs": {
"GetDimensionValuesResponse$ReturnSize": "<p>The number of results that AWS returned at one time.</p>",
"GetDimensionValuesResponse$TotalSize": "<p>The total number of search results.</p>",
"GetTagsResponse$ReturnSize": "<p>The number of query results that AWS returns at a time.</p>",
"GetTagsResponse$TotalSize": "<p>The total number of query results.</p>"
}
},
"PaymentOption": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$PaymentOption": "<p>The reservation purchase option that you want recommendations for.</p>",
"ReservationPurchaseRecommendation$PaymentOption": "<p>The payment option for the reservation. For example, <code>AllUpfront</code> or <code>NoUpfront</code>.</p>"
}
},
"PredictionIntervalLevel": {
"base": null,
"refs": {
"GetCostForecastRequest$PredictionIntervalLevel": "<p>Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.</p>"
}
},
"PurchasedHours": {
"base": null,
"refs": {
"ReservationAggregates$PurchasedHours": "<p>How many RI hours that you purchased.</p>"
}
},
"RDSInstanceDetails": {
"base": "<p>Details about the RDS instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$RDSInstanceDetails": "<p>The RDS instances that AWS recommends that you purchase.</p>"
}
},
"RedshiftInstanceDetails": {
"base": "<p>Details about the Amazon Redshift instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$RedshiftInstanceDetails": "<p>The Amazon Redshift instances that AWS recommends that you purchase.</p>"
}
},
"RequestChangedException": {
"base": "<p>Your request parameters changed between pages. Try again with the old parameters or without a pagination token.</p>",
"refs": {
}
},
"ReservationAggregates": {
"base": "<p>The aggregated numbers for your Reserved Instance (RI) usage.</p>",
"refs": {
"GetReservationUtilizationResponse$Total": "<p>The total amount of time that you utilized your RIs.</p>",
"ReservationUtilizationGroup$Utilization": "<p>How much you used this group of RIs.</p>",
"UtilizationByTime$Total": "<p>The total number of RI hours that were used.</p>"
}
},
"ReservationCoverageGroup": {
"base": "<p>A group of reservations that share a set of attributes.</p>",
"refs": {
"ReservationCoverageGroups$member": null
}
},
"ReservationCoverageGroups": {
"base": null,
"refs": {
"CoverageByTime$Groups": "<p>The groups of instances that are covered by a reservation.</p>"
}
},
"ReservationGroupKey": {
"base": null,
"refs": {
"ReservationUtilizationGroup$Key": "<p>The key for a specific RI attribute.</p>"
}
},
"ReservationGroupValue": {
"base": null,
"refs": {
"ReservationUtilizationGroup$Value": "<p>The value of a specific RI attribute.</p>"
}
},
"ReservationPurchaseRecommendation": {
"base": "<p>A specific reservation that AWS recommends for purchase.</p>",
"refs": {
"ReservationPurchaseRecommendations$member": null
}
},
"ReservationPurchaseRecommendationDetail": {
"base": "<p>Details about your recommended reservation purchase.</p>",
"refs": {
"ReservationPurchaseRecommendationDetails$member": null
}
},
"ReservationPurchaseRecommendationDetails": {
"base": null,
"refs": {
"ReservationPurchaseRecommendation$RecommendationDetails": "<p>Details about the recommended purchases.</p>"
}
},
"ReservationPurchaseRecommendationMetadata": {
"base": "<p>Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.</p>",
"refs": {
"GetReservationPurchaseRecommendationResponse$Metadata": "<p>Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.</p>"
}
},
"ReservationPurchaseRecommendationSummary": {
"base": "<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates that you could save, and the total amount of reservation to purchase.</p>",
"refs": {
"ReservationPurchaseRecommendation$RecommendationSummary": "<p>A summary about the recommended purchase.</p>"
}
},
"ReservationPurchaseRecommendations": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationResponse$Recommendations": "<p>Recommendations for reservations to purchase.</p>"
}
},
"ReservationUtilizationGroup": {
"base": "<p>A group of Reserved Instances (RIs) that share a set of attributes.</p>",
"refs": {
"ReservationUtilizationGroups$member": null
}
},
"ReservationUtilizationGroups": {
"base": null,
"refs": {
"UtilizationByTime$Groups": "<p>The groups that are included in this utilization result.</p>"
}
},
"ReservedHours": {
"base": null,
"refs": {
"CoverageHours$ReservedHours": "<p>The number of instance running hours that are covered by reservations.</p>"
}
},
"ResultByTime": {
"base": "<p>The result that is associated with a time period.</p>",
"refs": {
"ResultsByTime$member": null
}
},
"ResultsByTime": {
"base": null,
"refs": {
"GetCostAndUsageResponse$ResultsByTime": "<p>The time period that is covered by the results in the response.</p>"
}
},
"SearchString": {
"base": null,
"refs": {
"GetDimensionValuesRequest$SearchString": "<p>The value that you want to search the filter values for.</p>",
"GetTagsRequest$SearchString": "<p>The value that you want to search for.</p>"
}
},
"ServiceSpecification": {
"base": "<p>Hardware specifications for the service that you want recommendations for.</p>",
"refs": {
"GetReservationPurchaseRecommendationRequest$ServiceSpecification": "<p>The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.</p>",
"ReservationPurchaseRecommendation$ServiceSpecification": "<p>Hardware specifications for the service that you want recommendations for.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"GetTagsRequest$TagKey": "<p>The key of the tag that you want to return values for.</p>",
"TagValues$Key": "<p>The key for a tag.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"GetTagsResponse$Tags": "<p>The tags that match your request.</p>"
}
},
"TagValues": {
"base": "<p>The values that are available for a tag.</p>",
"refs": {
"Expression$Tags": "<p>The specific <code>Tag</code> to use for <code>Expression</code>.</p>"
}
},
"TermInYears": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$TermInYears": "<p>The reservation term that you want recommendations for.</p>",
"ReservationPurchaseRecommendation$TermInYears": "<p>The term of the reservation that you want recommendations for, in years.</p>"
}
},
"TotalActualHours": {
"base": null,
"refs": {
"ReservationAggregates$TotalActualHours": "<p>The total number of RI hours that you used.</p>"
}
},
"TotalAmortizedFee": {
"base": null,
"refs": {
"ReservationAggregates$TotalAmortizedFee": "<p>The total cost of your RI, amortized over the RI period.</p>"
}
},
"TotalPotentialRISavings": {
"base": null,
"refs": {
"ReservationAggregates$TotalPotentialRISavings": "<p>How much you could save if you use your entire reservation.</p>"
}
},
"TotalRunningHours": {
"base": null,
"refs": {
"CoverageHours$TotalRunningHours": "<p>The total instance usage, in hours.</p>"
}
},
"UnusedHours": {
"base": null,
"refs": {
"ReservationAggregates$UnusedHours": "<p>The number of RI hours that you didn't use.</p>"
}
},
"UtilizationByTime": {
"base": "<p>The amount of utilization, in hours.</p>",
"refs": {
"UtilizationsByTime$member": null
}
},
"UtilizationPercentage": {
"base": null,
"refs": {
"ReservationAggregates$UtilizationPercentage": "<p>The percentage of RI time that you used.</p>"
}
},
"UtilizationsByTime": {
"base": null,
"refs": {
"GetReservationUtilizationResponse$UtilizationsByTime": "<p>The amount of time that you utilized your RIs.</p>"
}
},
"Value": {
"base": null,
"refs": {
"DimensionValuesWithAttributes$Value": "<p>The value of a dimension with a specific attribute.</p>",
"Values$member": null
}
},
"Values": {
"base": null,
"refs": {
"DimensionValues$Values": "<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p> <p>Valid values for the <code>SERVICE</code> dimension are <code>Amazon Elastic Compute Cloud - Compute</code>, <code>Amazon Elasticsearch Service</code>, <code>Amazon ElastiCache</code>, <code>Amazon Redshift</code>, and <code>Amazon Relational Database Service</code>.</p>",
"TagValues$Values": "<p>The specific value of a tag.</p>"
}
},
"YearMonthDay": {
"base": null,
"refs": {
"DateInterval$Start": "<p>The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, AWS retrieves cost and usage data starting at <code>2017-01-01</code> up to the end date.</p>",
"DateInterval$End": "<p>The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if <code>end</code> is <code>2017-05-01</code>, AWS retrieves cost and usage data from the start date up to, but not including, <code>2017-05-01</code>.</p>"
}
}
}
}