1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2022-07-26", 5 "endpointPrefix":"cost-optimization-hub", 6 "jsonVersion":"1.0", 7 "protocol":"json", 8 "serviceFullName":"Cost Optimization Hub", 9 "serviceId":"Cost Optimization Hub", 10 "signatureVersion":"v4", 11 "signingName":"cost-optimization-hub", 12 "targetPrefix":"CostOptimizationHubService", 13 "uid":"cost-optimization-hub-2022-07-26" 14 }, 15 "operations":{ 16 "GetPreferences":{ 17 "name":"GetPreferences", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/" 21 }, 22 "input":{"shape":"GetPreferencesRequest"}, 23 "output":{"shape":"GetPreferencesResponse"}, 24 "errors":[ 25 {"shape":"ValidationException"}, 26 {"shape":"InternalServerException"}, 27 {"shape":"AccessDeniedException"}, 28 {"shape":"ThrottlingException"} 29 ], 30 "documentation":"<p>Returns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example.</p>" 31 }, 32 "GetRecommendation":{ 33 "name":"GetRecommendation", 34 "http":{ 35 "method":"POST", 36 "requestUri":"/" 37 }, 38 "input":{"shape":"GetRecommendationRequest"}, 39 "output":{"shape":"GetRecommendationResponse"}, 40 "errors":[ 41 {"shape":"ValidationException"}, 42 {"shape":"InternalServerException"}, 43 {"shape":"AccessDeniedException"}, 44 {"shape":"ResourceNotFoundException"}, 45 {"shape":"ThrottlingException"} 46 ], 47 "documentation":"<p>Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.</p> <p>The <code>recommendationId</code> is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the <code>recommendationId</code>, use the <code>ListRecommendations</code> API.</p>" 48 }, 49 "ListEnrollmentStatuses":{ 50 "name":"ListEnrollmentStatuses", 51 "http":{ 52 "method":"POST", 53 "requestUri":"/" 54 }, 55 "input":{"shape":"ListEnrollmentStatusesRequest"}, 56 "output":{"shape":"ListEnrollmentStatusesResponse"}, 57 "errors":[ 58 {"shape":"ValidationException"}, 59 {"shape":"InternalServerException"}, 60 {"shape":"AccessDeniedException"}, 61 {"shape":"ThrottlingException"} 62 ], 63 "documentation":"<p>Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.</p>" 64 }, 65 "ListRecommendationSummaries":{ 66 "name":"ListRecommendationSummaries", 67 "http":{ 68 "method":"POST", 69 "requestUri":"/" 70 }, 71 "input":{"shape":"ListRecommendationSummariesRequest"}, 72 "output":{"shape":"ListRecommendationSummariesResponse"}, 73 "errors":[ 74 {"shape":"ValidationException"}, 75 {"shape":"InternalServerException"}, 76 {"shape":"AccessDeniedException"}, 77 {"shape":"ThrottlingException"} 78 ], 79 "documentation":"<p>Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.</p> <note> <p>The following filters are not supported for this API: <code>recommendationIds</code>, <code>resourceArns</code>, and <code>resourceIds</code>.</p> </note>" 80 }, 81 "ListRecommendations":{ 82 "name":"ListRecommendations", 83 "http":{ 84 "method":"POST", 85 "requestUri":"/" 86 }, 87 "input":{"shape":"ListRecommendationsRequest"}, 88 "output":{"shape":"ListRecommendationsResponse"}, 89 "errors":[ 90 {"shape":"ValidationException"}, 91 {"shape":"InternalServerException"}, 92 {"shape":"AccessDeniedException"}, 93 {"shape":"ThrottlingException"} 94 ], 95 "documentation":"<p>Returns a list of recommendations.</p>" 96 }, 97 "UpdateEnrollmentStatus":{ 98 "name":"UpdateEnrollmentStatus", 99 "http":{ 100 "method":"POST", 101 "requestUri":"/" 102 }, 103 "input":{"shape":"UpdateEnrollmentStatusRequest"}, 104 "output":{"shape":"UpdateEnrollmentStatusResponse"}, 105 "errors":[ 106 {"shape":"ValidationException"}, 107 {"shape":"InternalServerException"}, 108 {"shape":"AccessDeniedException"}, 109 {"shape":"ThrottlingException"} 110 ], 111 "documentation":"<p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.</p> <p>If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.</p> <p>You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.</p>" 112 }, 113 "UpdatePreferences":{ 114 "name":"UpdatePreferences", 115 "http":{ 116 "method":"POST", 117 "requestUri":"/" 118 }, 119 "input":{"shape":"UpdatePreferencesRequest"}, 120 "output":{"shape":"UpdatePreferencesResponse"}, 121 "errors":[ 122 {"shape":"ValidationException"}, 123 {"shape":"InternalServerException"}, 124 {"shape":"AccessDeniedException"}, 125 {"shape":"ThrottlingException"} 126 ], 127 "documentation":"<p>Updates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented.</p>" 128 } 129 }, 130 "shapes":{ 131 "AccessDeniedException":{ 132 "type":"structure", 133 "required":["message"], 134 "members":{ 135 "message":{"shape":"String"} 136 }, 137 "documentation":"<p>You are not authorized to use this operation with the given parameters.</p>", 138 "exception":true 139 }, 140 "AccountEnrollmentStatus":{ 141 "type":"structure", 142 "members":{ 143 "accountId":{ 144 "shape":"AccountId", 145 "documentation":"<p>The Amazon Web Services account ID.</p>" 146 }, 147 "createdTimestamp":{ 148 "shape":"Timestamp", 149 "documentation":"<p>The time when the account enrollment status was created.</p>" 150 }, 151 "lastUpdatedTimestamp":{ 152 "shape":"Timestamp", 153 "documentation":"<p>The time when the account enrollment status was last updated.</p>" 154 }, 155 "status":{ 156 "shape":"EnrollmentStatus", 157 "documentation":"<p>The account enrollment status.</p>" 158 } 159 }, 160 "documentation":"<p>Describes the enrollment status of an organization's member accounts in Cost Optimization Hub.</p>" 161 }, 162 "AccountEnrollmentStatuses":{ 163 "type":"list", 164 "member":{"shape":"AccountEnrollmentStatus"} 165 }, 166 "AccountId":{ 167 "type":"string", 168 "pattern":"^[0-9]{12}$" 169 }, 170 "AccountIdList":{ 171 "type":"list", 172 "member":{"shape":"AccountId"}, 173 "max":100, 174 "min":1 175 }, 176 "ActionType":{ 177 "type":"string", 178 "enum":[ 179 "Rightsize", 180 "Stop", 181 "Upgrade", 182 "PurchaseSavingsPlans", 183 "PurchaseReservedInstances", 184 "MigrateToGraviton" 185 ] 186 }, 187 "ActionTypeList":{ 188 "type":"list", 189 "member":{"shape":"ActionType"}, 190 "max":100, 191 "min":1 192 }, 193 "BlockStoragePerformanceConfiguration":{ 194 "type":"structure", 195 "members":{ 196 "iops":{ 197 "shape":"Double", 198 "documentation":"<p>The number of I/O operations per second.</p>" 199 }, 200 "throughput":{ 201 "shape":"Double", 202 "documentation":"<p>The throughput that the volume supports.</p>" 203 } 204 }, 205 "documentation":"<p>Describes the Amazon Elastic Block Store performance configuration of the current and recommended resource configuration for a recommendation.</p>" 206 }, 207 "Boolean":{ 208 "type":"boolean", 209 "box":true 210 }, 211 "ComputeConfiguration":{ 212 "type":"structure", 213 "members":{ 214 "architecture":{ 215 "shape":"String", 216 "documentation":"<p>The architecture of the resource.</p>" 217 }, 218 "memorySizeInMB":{ 219 "shape":"Integer", 220 "documentation":"<p>The memory size of the resource.</p>" 221 }, 222 "platform":{ 223 "shape":"String", 224 "documentation":"<p>The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.</p>" 225 }, 226 "vCpu":{ 227 "shape":"Double", 228 "documentation":"<p>The number of vCPU cores in the resource.</p>" 229 } 230 }, 231 "documentation":"<p>Describes the performance configuration for compute services such as Amazon EC2, Lambda, and ECS.</p>" 232 }, 233 "ComputeSavingsPlans":{ 234 "type":"structure", 235 "members":{ 236 "configuration":{ 237 "shape":"ComputeSavingsPlansConfiguration", 238 "documentation":"<p>Configuration details of the Compute Savings Plans to purchase.</p>" 239 }, 240 "costCalculation":{ 241 "shape":"SavingsPlansCostCalculation", 242 "documentation":"<p>Cost impact of the Savings Plans purchase recommendation.</p>" 243 } 244 }, 245 "documentation":"<p>The Compute Savings Plans recommendation details.</p>" 246 }, 247 "ComputeSavingsPlansConfiguration":{ 248 "type":"structure", 249 "members":{ 250 "accountScope":{ 251 "shape":"String", 252 "documentation":"<p>The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for individual member accounts only.</p>" 253 }, 254 "hourlyCommitment":{ 255 "shape":"String", 256 "documentation":"<p>The hourly commitment for the Savings Plans type.</p>" 257 }, 258 "paymentOption":{ 259 "shape":"String", 260 "documentation":"<p>The payment option for the commitment.</p>" 261 }, 262 "term":{ 263 "shape":"String", 264 "documentation":"<p>The Savings Plans recommendation term in years.</p>" 265 } 266 }, 267 "documentation":"<p>The Compute Savings Plans configuration used for recommendations.</p>" 268 }, 269 "Datetime":{"type":"timestamp"}, 270 "Double":{ 271 "type":"double", 272 "box":true 273 }, 274 "EbsVolume":{ 275 "type":"structure", 276 "members":{ 277 "configuration":{ 278 "shape":"EbsVolumeConfiguration", 279 "documentation":"<p>The Amazon Elastic Block Store volume configuration used for recommendations.</p>" 280 }, 281 "costCalculation":{ 282 "shape":"ResourceCostCalculation", 283 "documentation":"<p>Cost impact of the recommendation.</p>" 284 } 285 }, 286 "documentation":"<p>Describes the Amazon Elastic Block Store volume configuration of the current and recommended resource configuration for a recommendation.</p>" 287 }, 288 "EbsVolumeConfiguration":{ 289 "type":"structure", 290 "members":{ 291 "attachmentState":{ 292 "shape":"String", 293 "documentation":"<p>The Amazon Elastic Block Store attachment state.</p>" 294 }, 295 "performance":{ 296 "shape":"BlockStoragePerformanceConfiguration", 297 "documentation":"<p>The Amazon Elastic Block Store performance configuration.</p>" 298 }, 299 "storage":{ 300 "shape":"StorageConfiguration", 301 "documentation":"<p>The disk storage of the Amazon Elastic Block Store volume.</p>" 302 } 303 }, 304 "documentation":"<p>The Amazon Elastic Block Store volume configuration used for recommendations.</p>" 305 }, 306 "Ec2AutoScalingGroup":{ 307 "type":"structure", 308 "members":{ 309 "configuration":{ 310 "shape":"Ec2AutoScalingGroupConfiguration", 311 "documentation":"<p>The EC2 Auto Scaling group configuration used for recommendations.</p>" 312 }, 313 "costCalculation":{ 314 "shape":"ResourceCostCalculation", 315 "documentation":"<p>Cost impact of the recommendation.</p>" 316 } 317 }, 318 "documentation":"<p>The EC2 Auto Scaling group recommendation details.</p>" 319 }, 320 "Ec2AutoScalingGroupConfiguration":{ 321 "type":"structure", 322 "members":{ 323 "instance":{ 324 "shape":"InstanceConfiguration", 325 "documentation":"<p>Details about the instance.</p>" 326 } 327 }, 328 "documentation":"<p>The EC2 auto scaling group configuration used for recommendations.</p>" 329 }, 330 "Ec2Instance":{ 331 "type":"structure", 332 "members":{ 333 "configuration":{ 334 "shape":"Ec2InstanceConfiguration", 335 "documentation":"<p>The EC2 instance configuration used for recommendations.</p>" 336 }, 337 "costCalculation":{ 338 "shape":"ResourceCostCalculation", 339 "documentation":"<p>Cost impact of the recommendation.</p>" 340 } 341 }, 342 "documentation":"<p>Describes the EC2 instance configuration of the current and recommended resource configuration for a recommendation.</p>" 343 }, 344 "Ec2InstanceConfiguration":{ 345 "type":"structure", 346 "members":{ 347 "instance":{ 348 "shape":"InstanceConfiguration", 349 "documentation":"<p>Details about the instance.</p>" 350 } 351 }, 352 "documentation":"<p>The EC2 instance configuration used for recommendations.</p>" 353 }, 354 "Ec2InstanceSavingsPlans":{ 355 "type":"structure", 356 "members":{ 357 "configuration":{ 358 "shape":"Ec2InstanceSavingsPlansConfiguration", 359 "documentation":"<p>The EC2 instance Savings Plans configuration used for recommendations.</p>" 360 }, 361 "costCalculation":{ 362 "shape":"SavingsPlansCostCalculation", 363 "documentation":"<p>Cost impact of the Savings Plans purchase recommendation.</p>" 364 } 365 }, 366 "documentation":"<p>The EC2 instance Savings Plans recommendation details.</p>" 367 }, 368 "Ec2InstanceSavingsPlansConfiguration":{ 369 "type":"structure", 370 "members":{ 371 "accountScope":{ 372 "shape":"String", 373 "documentation":"<p>The account scope that you want your recommendations for.</p>" 374 }, 375 "hourlyCommitment":{ 376 "shape":"String", 377 "documentation":"<p>The hourly commitment for the Savings Plans type.</p>" 378 }, 379 "instanceFamily":{ 380 "shape":"String", 381 "documentation":"<p>The instance family of the recommended Savings Plan.</p>" 382 }, 383 "paymentOption":{ 384 "shape":"String", 385 "documentation":"<p>The payment option for the commitment.</p>" 386 }, 387 "savingsPlansRegion":{ 388 "shape":"String", 389 "documentation":"<p>The Amazon Web Services Region of the commitment.</p>" 390 }, 391 "term":{ 392 "shape":"String", 393 "documentation":"<p>The Savings Plans recommendation term in years.</p>" 394 } 395 }, 396 "documentation":"<p>The EC2 instance Savings Plans configuration used for recommendations.</p>" 397 }, 398 "Ec2ReservedInstances":{ 399 "type":"structure", 400 "members":{ 401 "configuration":{ 402 "shape":"Ec2ReservedInstancesConfiguration", 403 "documentation":"<p>The EC2 reserved instances configuration used for recommendations.</p>" 404 }, 405 "costCalculation":{ 406 "shape":"ReservedInstancesCostCalculation", 407 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 408 } 409 }, 410 "documentation":"<p>The EC2 reserved instances recommendation details.</p>" 411 }, 412 "Ec2ReservedInstancesConfiguration":{ 413 "type":"structure", 414 "members":{ 415 "accountScope":{ 416 "shape":"String", 417 "documentation":"<p>The account scope that you want your recommendations for.</p>" 418 }, 419 "currentGeneration":{ 420 "shape":"String", 421 "documentation":"<p>Determines whether the recommendation is for a current generation instance.</p>" 422 }, 423 "instanceFamily":{ 424 "shape":"String", 425 "documentation":"<p>The instance family of the recommended reservation.</p>" 426 }, 427 "instanceType":{ 428 "shape":"String", 429 "documentation":"<p>The type of instance that Amazon Web Services recommends.</p>" 430 }, 431 "monthlyRecurringCost":{ 432 "shape":"String", 433 "documentation":"<p>How much purchasing reserved instances costs you on a monthly basis.</p>" 434 }, 435 "normalizedUnitsToPurchase":{ 436 "shape":"String", 437 "documentation":"<p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>" 438 }, 439 "numberOfInstancesToPurchase":{ 440 "shape":"String", 441 "documentation":"<p>The number of instances that Amazon Web Services recommends that you purchase.</p>" 442 }, 443 "offeringClass":{ 444 "shape":"String", 445 "documentation":"<p>Indicates whether the recommendation is for standard or convertible reservations.</p>" 446 }, 447 "paymentOption":{ 448 "shape":"String", 449 "documentation":"<p>The payment option for the commitment.</p>" 450 }, 451 "platform":{ 452 "shape":"String", 453 "documentation":"<p>The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.</p>" 454 }, 455 "reservedInstancesRegion":{ 456 "shape":"String", 457 "documentation":"<p>The Amazon Web Services Region of the commitment.</p>" 458 }, 459 "service":{ 460 "shape":"String", 461 "documentation":"<p>The service that you want your recommendations for.</p>" 462 }, 463 "sizeFlexEligible":{ 464 "shape":"Boolean", 465 "documentation":"<p>Determines whether the recommendation is size flexible.</p>" 466 }, 467 "tenancy":{ 468 "shape":"String", 469 "documentation":"<p>Determines whether the recommended reservation is dedicated or shared.</p>" 470 }, 471 "term":{ 472 "shape":"String", 473 "documentation":"<p>The reserved instances recommendation term in years.</p>" 474 }, 475 "upfrontCost":{ 476 "shape":"String", 477 "documentation":"<p>How much purchasing this instance costs you upfront.</p>" 478 } 479 }, 480 "documentation":"<p>The EC2 reserved instances configuration used for recommendations.</p>" 481 }, 482 "EcsService":{ 483 "type":"structure", 484 "members":{ 485 "configuration":{ 486 "shape":"EcsServiceConfiguration", 487 "documentation":"<p>The ECS service configuration used for recommendations.</p>" 488 }, 489 "costCalculation":{ 490 "shape":"ResourceCostCalculation", 491 "documentation":"<p>Cost impact of the recommendation.</p>" 492 } 493 }, 494 "documentation":"<p>The ECS service recommendation details.</p>" 495 }, 496 "EcsServiceConfiguration":{ 497 "type":"structure", 498 "members":{ 499 "compute":{ 500 "shape":"ComputeConfiguration", 501 "documentation":"<p>Details about the compute configuration.</p>" 502 } 503 }, 504 "documentation":"<p>The ECS service configuration used for recommendations.</p>" 505 }, 506 "ElastiCacheReservedInstances":{ 507 "type":"structure", 508 "members":{ 509 "configuration":{ 510 "shape":"ElastiCacheReservedInstancesConfiguration", 511 "documentation":"<p>The ElastiCache reserved instances configuration used for recommendations.</p>" 512 }, 513 "costCalculation":{ 514 "shape":"ReservedInstancesCostCalculation", 515 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 516 } 517 }, 518 "documentation":"<p>The ElastiCache reserved instances recommendation details.</p>" 519 }, 520 "ElastiCacheReservedInstancesConfiguration":{ 521 "type":"structure", 522 "members":{ 523 "accountScope":{ 524 "shape":"String", 525 "documentation":"<p>The account scope that you want your recommendations for.</p>" 526 }, 527 "currentGeneration":{ 528 "shape":"String", 529 "documentation":"<p>Determines whether the recommendation is for a current generation instance.</p>" 530 }, 531 "instanceFamily":{ 532 "shape":"String", 533 "documentation":"<p>The instance family of the recommended reservation.</p>" 534 }, 535 "instanceType":{ 536 "shape":"String", 537 "documentation":"<p>The type of instance that Amazon Web Services recommends.</p>" 538 }, 539 "monthlyRecurringCost":{ 540 "shape":"String", 541 "documentation":"<p>How much purchasing reserved instances costs you on a monthly basis.</p>" 542 }, 543 "normalizedUnitsToPurchase":{ 544 "shape":"String", 545 "documentation":"<p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>" 546 }, 547 "numberOfInstancesToPurchase":{ 548 "shape":"String", 549 "documentation":"<p>The number of instances that Amazon Web Services recommends that you purchase.</p>" 550 }, 551 "paymentOption":{ 552 "shape":"String", 553 "documentation":"<p>The payment option for the commitment.</p>" 554 }, 555 "reservedInstancesRegion":{ 556 "shape":"String", 557 "documentation":"<p>The Amazon Web Services Region of the commitment.</p>" 558 }, 559 "service":{ 560 "shape":"String", 561 "documentation":"<p>The service that you want your recommendations for.</p>" 562 }, 563 "sizeFlexEligible":{ 564 "shape":"Boolean", 565 "documentation":"<p>Determines whether the recommendation is size flexible.</p>" 566 }, 567 "term":{ 568 "shape":"String", 569 "documentation":"<p>The reserved instances recommendation term in years.</p>" 570 }, 571 "upfrontCost":{ 572 "shape":"String", 573 "documentation":"<p>How much purchasing this instance costs you upfront.</p>" 574 } 575 }, 576 "documentation":"<p>The ElastiCache reserved instances configuration used for recommendations.</p>" 577 }, 578 "EnrollmentStatus":{ 579 "type":"string", 580 "enum":[ 581 "Active", 582 "Inactive" 583 ] 584 }, 585 "EstimatedDiscounts":{ 586 "type":"structure", 587 "members":{ 588 "otherDiscount":{ 589 "shape":"Double", 590 "documentation":"<p>Estimated other discounts include all discounts that are not itemized. Itemized discounts include <code>reservedInstanceDiscount</code> and <code>savingsPlansDiscount</code>.</p>" 591 }, 592 "reservedInstancesDiscount":{ 593 "shape":"Double", 594 "documentation":"<p>Estimated reserved instance discounts.</p>" 595 }, 596 "savingsPlansDiscount":{ 597 "shape":"Double", 598 "documentation":"<p>Estimated Savings Plans discounts.</p>" 599 } 600 }, 601 "documentation":"<p>Estimated discount details of the current and recommended resource configuration for a recommendation.</p>" 602 }, 603 "Filter":{ 604 "type":"structure", 605 "members":{ 606 "accountIds":{ 607 "shape":"AccountIdList", 608 "documentation":"<p>The account that the recommendation is for.</p>" 609 }, 610 "actionTypes":{ 611 "shape":"ActionTypeList", 612 "documentation":"<p>The type of action you can take by adopting the recommendation.</p>" 613 }, 614 "implementationEfforts":{ 615 "shape":"ImplementationEffortList", 616 "documentation":"<p>The effort required to implement the recommendation.</p>" 617 }, 618 "recommendationIds":{ 619 "shape":"RecommendationIdList", 620 "documentation":"<p>The IDs for the recommendations.</p>" 621 }, 622 "regions":{ 623 "shape":"RegionList", 624 "documentation":"<p>The Amazon Web Services Region of the resource.</p>" 625 }, 626 "resourceArns":{ 627 "shape":"ResourceArnList", 628 "documentation":"<p>The Amazon Resource Name (ARN) of the recommendation.</p>" 629 }, 630 "resourceIds":{ 631 "shape":"ResourceIdList", 632 "documentation":"<p>The resource ID of the recommendation.</p>" 633 }, 634 "resourceTypes":{ 635 "shape":"ResourceTypeList", 636 "documentation":"<p>The resource type of the recommendation.</p>" 637 }, 638 "restartNeeded":{ 639 "shape":"Boolean", 640 "documentation":"<p>Whether or not implementing the recommendation requires a restart.</p>" 641 }, 642 "rollbackPossible":{ 643 "shape":"Boolean", 644 "documentation":"<p>Whether or not implementing the recommendation can be rolled back.</p>" 645 }, 646 "tags":{ 647 "shape":"TagList", 648 "documentation":"<p>A list of tags assigned to the recommendation.</p>" 649 } 650 }, 651 "documentation":"<p>Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.</p>" 652 }, 653 "GetPreferencesRequest":{ 654 "type":"structure", 655 "members":{ 656 } 657 }, 658 "GetPreferencesResponse":{ 659 "type":"structure", 660 "members":{ 661 "memberAccountDiscountVisibility":{ 662 "shape":"MemberAccountDiscountVisibility", 663 "documentation":"<p>Retrieves the status of the \"member account discount visibility\" preference.</p>" 664 }, 665 "savingsEstimationMode":{ 666 "shape":"SavingsEstimationMode", 667 "documentation":"<p>Retrieves the status of the \"savings estimation mode\" preference.</p>" 668 } 669 } 670 }, 671 "GetRecommendationRequest":{ 672 "type":"structure", 673 "required":["recommendationId"], 674 "members":{ 675 "recommendationId":{ 676 "shape":"String", 677 "documentation":"<p>The ID for the recommendation.</p>" 678 } 679 } 680 }, 681 "GetRecommendationResponse":{ 682 "type":"structure", 683 "members":{ 684 "accountId":{ 685 "shape":"String", 686 "documentation":"<p>The account that the recommendation is for.</p>" 687 }, 688 "actionType":{ 689 "shape":"ActionType", 690 "documentation":"<p>The type of action you can take by adopting the recommendation.</p>" 691 }, 692 "costCalculationLookbackPeriodInDays":{ 693 "shape":"Integer", 694 "documentation":"<p>The lookback period used to calculate cost impact for a recommendation.</p>" 695 }, 696 "currencyCode":{ 697 "shape":"String", 698 "documentation":"<p>The currency code used for the recommendation.</p>" 699 }, 700 "currentResourceDetails":{ 701 "shape":"ResourceDetails", 702 "documentation":"<p>The details for the resource.</p>" 703 }, 704 "currentResourceType":{ 705 "shape":"ResourceType", 706 "documentation":"<p>The type of resource.</p>" 707 }, 708 "estimatedMonthlyCost":{ 709 "shape":"Double", 710 "documentation":"<p>The estimated monthly cost of the recommendation.</p>" 711 }, 712 "estimatedMonthlySavings":{ 713 "shape":"Double", 714 "documentation":"<p>The estimated monthly savings amount for the recommendation.</p>" 715 }, 716 "estimatedSavingsOverCostCalculationLookbackPeriod":{ 717 "shape":"Double", 718 "documentation":"<p>The estimated savings amount over the lookback period used to calculate cost impact for a recommendation.</p>" 719 }, 720 "estimatedSavingsPercentage":{ 721 "shape":"Double", 722 "documentation":"<p>The estimated savings percentage relative to the total cost over the cost calculation lookback period.</p>" 723 }, 724 "implementationEffort":{ 725 "shape":"ImplementationEffort", 726 "documentation":"<p>The effort required to implement the recommendation.</p>" 727 }, 728 "lastRefreshTimestamp":{ 729 "shape":"Datetime", 730 "documentation":"<p>The time when the recommendation was last generated.</p>" 731 }, 732 "recommendationId":{ 733 "shape":"String", 734 "documentation":"<p>The ID for the recommendation.</p>" 735 }, 736 "recommendationLookbackPeriodInDays":{ 737 "shape":"Integer", 738 "documentation":"<p>The lookback period that's used to generate the recommendation.</p>" 739 }, 740 "recommendedResourceDetails":{ 741 "shape":"ResourceDetails", 742 "documentation":"<p>The details about the recommended resource.</p>" 743 }, 744 "recommendedResourceType":{ 745 "shape":"ResourceType", 746 "documentation":"<p>The resource type of the recommendation.</p>" 747 }, 748 "region":{ 749 "shape":"String", 750 "documentation":"<p>The Amazon Web Services Region of the resource.</p>" 751 }, 752 "resourceArn":{ 753 "shape":"String", 754 "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>" 755 }, 756 "resourceId":{ 757 "shape":"String", 758 "documentation":"<p>The unique identifier for the resource. This is the same as the Amazon Resource Name (ARN), if available.</p>" 759 }, 760 "restartNeeded":{ 761 "shape":"Boolean", 762 "documentation":"<p>Whether or not implementing the recommendation requires a restart.</p>" 763 }, 764 "rollbackPossible":{ 765 "shape":"Boolean", 766 "documentation":"<p>Whether or not implementing the recommendation can be rolled back.</p>" 767 }, 768 "source":{ 769 "shape":"Source", 770 "documentation":"<p>The source of the recommendation.</p>" 771 }, 772 "tags":{ 773 "shape":"TagList", 774 "documentation":"<p>A list of tags associated with the resource for which the recommendation exists.</p>" 775 } 776 } 777 }, 778 "ImplementationEffort":{ 779 "type":"string", 780 "enum":[ 781 "VeryLow", 782 "Low", 783 "Medium", 784 "High", 785 "VeryHigh" 786 ] 787 }, 788 "ImplementationEffortList":{ 789 "type":"list", 790 "member":{"shape":"ImplementationEffort"}, 791 "max":100, 792 "min":1 793 }, 794 "InstanceConfiguration":{ 795 "type":"structure", 796 "members":{ 797 "type":{ 798 "shape":"String", 799 "documentation":"<p>Details about the type.</p>" 800 } 801 }, 802 "documentation":"<p>The Instance configuration used for recommendations.</p>" 803 }, 804 "Integer":{ 805 "type":"integer", 806 "box":true 807 }, 808 "InternalServerException":{ 809 "type":"structure", 810 "required":["message"], 811 "members":{ 812 "message":{"shape":"String"} 813 }, 814 "documentation":"<p>An error on the server occurred during the processing of your request. Try again later.</p>", 815 "exception":true, 816 "fault":true 817 }, 818 "LambdaFunction":{ 819 "type":"structure", 820 "members":{ 821 "configuration":{ 822 "shape":"LambdaFunctionConfiguration", 823 "documentation":"<p>The Lambda function configuration used for recommendations.</p>" 824 }, 825 "costCalculation":{ 826 "shape":"ResourceCostCalculation", 827 "documentation":"<p>Cost impact of the recommendation.</p>" 828 } 829 }, 830 "documentation":"<p>The Lambda function recommendation details.</p>" 831 }, 832 "LambdaFunctionConfiguration":{ 833 "type":"structure", 834 "members":{ 835 "compute":{ 836 "shape":"ComputeConfiguration", 837 "documentation":"<p>Details about the compute configuration.</p>" 838 } 839 }, 840 "documentation":"<p>The Lambda function configuration used for recommendations.</p>" 841 }, 842 "ListEnrollmentStatusesRequest":{ 843 "type":"structure", 844 "members":{ 845 "accountId":{ 846 "shape":"AccountId", 847 "documentation":"<p>The account ID of a member account in the organization.</p>" 848 }, 849 "includeOrganizationInfo":{ 850 "shape":"PrimitiveBoolean", 851 "documentation":"<p>Indicates whether to return the enrollment status for the organization.</p>" 852 }, 853 "maxResults":{ 854 "shape":"MaxResults", 855 "documentation":"<p>The maximum number of objects that are returned for the request.</p>" 856 }, 857 "nextToken":{ 858 "shape":"String", 859 "documentation":"<p>The token to retrieve the next set of results.</p>" 860 } 861 } 862 }, 863 "ListEnrollmentStatusesResponse":{ 864 "type":"structure", 865 "members":{ 866 "includeMemberAccounts":{ 867 "shape":"Boolean", 868 "documentation":"<p>The enrollment status of all member accounts in the organization if the account is the management account.</p>" 869 }, 870 "items":{ 871 "shape":"AccountEnrollmentStatuses", 872 "documentation":"<p>The enrollment status of a specific account ID, including creation and last updated timestamps.</p>" 873 }, 874 "nextToken":{ 875 "shape":"String", 876 "documentation":"<p>The token to retrieve the next set of results.</p>" 877 } 878 } 879 }, 880 "ListRecommendationSummariesRequest":{ 881 "type":"structure", 882 "required":["groupBy"], 883 "members":{ 884 "filter":{"shape":"Filter"}, 885 "groupBy":{ 886 "shape":"String", 887 "documentation":"<p>The grouping of recommendations by a dimension.</p>" 888 }, 889 "maxResults":{ 890 "shape":"ListRecommendationSummariesRequestMaxResultsInteger", 891 "documentation":"<p>The maximum number of recommendations that are returned for the request.</p>" 892 }, 893 "nextToken":{ 894 "shape":"String", 895 "documentation":"<p>The token to retrieve the next set of results.</p>" 896 } 897 } 898 }, 899 "ListRecommendationSummariesRequestMaxResultsInteger":{ 900 "type":"integer", 901 "box":true, 902 "max":1000, 903 "min":0 904 }, 905 "ListRecommendationSummariesResponse":{ 906 "type":"structure", 907 "members":{ 908 "currencyCode":{ 909 "shape":"String", 910 "documentation":"<p>The currency code used for the recommendation.</p>" 911 }, 912 "estimatedTotalDedupedSavings":{ 913 "shape":"Double", 914 "documentation":"<p>The total overall savings for the aggregated view.</p>" 915 }, 916 "groupBy":{ 917 "shape":"String", 918 "documentation":"<p>The dimension used to group the recommendations by.</p>" 919 }, 920 "items":{ 921 "shape":"RecommendationSummariesList", 922 "documentation":"<p>List of all savings recommendations.</p>" 923 }, 924 "nextToken":{ 925 "shape":"String", 926 "documentation":"<p>The token to retrieve the next set of results.</p>" 927 } 928 } 929 }, 930 "ListRecommendationsRequest":{ 931 "type":"structure", 932 "members":{ 933 "filter":{ 934 "shape":"Filter", 935 "documentation":"<p>The constraints that you want all returned recommendations to match.</p>" 936 }, 937 "includeAllRecommendations":{ 938 "shape":"PrimitiveBoolean", 939 "documentation":"<p>List of all recommendations for a resource, or a single recommendation if de-duped by <code>resourceId</code>.</p>" 940 }, 941 "maxResults":{ 942 "shape":"ListRecommendationsRequestMaxResultsInteger", 943 "documentation":"<p>The maximum number of recommendations that are returned for the request.</p>" 944 }, 945 "nextToken":{ 946 "shape":"String", 947 "documentation":"<p>The token to retrieve the next set of results.</p>" 948 }, 949 "orderBy":{ 950 "shape":"OrderBy", 951 "documentation":"<p>The ordering of recommendations by a dimension.</p>" 952 } 953 } 954 }, 955 "ListRecommendationsRequestMaxResultsInteger":{ 956 "type":"integer", 957 "box":true, 958 "max":1000, 959 "min":0 960 }, 961 "ListRecommendationsResponse":{ 962 "type":"structure", 963 "members":{ 964 "items":{ 965 "shape":"RecommendationList", 966 "documentation":"<p>List of all savings recommendations.</p>" 967 }, 968 "nextToken":{ 969 "shape":"String", 970 "documentation":"<p>The token to retrieve the next set of results.</p>" 971 } 972 } 973 }, 974 "MaxResults":{ 975 "type":"integer", 976 "box":true, 977 "max":100, 978 "min":0 979 }, 980 "MemberAccountDiscountVisibility":{ 981 "type":"string", 982 "enum":[ 983 "All", 984 "None" 985 ] 986 }, 987 "OpenSearchReservedInstances":{ 988 "type":"structure", 989 "members":{ 990 "configuration":{ 991 "shape":"OpenSearchReservedInstancesConfiguration", 992 "documentation":"<p>The OpenSearch reserved instances configuration used for recommendations.</p>" 993 }, 994 "costCalculation":{ 995 "shape":"ReservedInstancesCostCalculation", 996 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 997 } 998 }, 999 "documentation":"<p>The OpenSearch reserved instances recommendation details.</p>" 1000 }, 1001 "OpenSearchReservedInstancesConfiguration":{ 1002 "type":"structure", 1003 "members":{ 1004 "accountScope":{ 1005 "shape":"String", 1006 "documentation":"<p>The account scope that you want your recommendations for.</p>" 1007 }, 1008 "currentGeneration":{ 1009 "shape":"String", 1010 "documentation":"<p>Determines whether the recommendation is for a current generation instance.</p>" 1011 }, 1012 "instanceType":{ 1013 "shape":"String", 1014 "documentation":"<p>The type of instance that Amazon Web Services recommends.</p>" 1015 }, 1016 "monthlyRecurringCost":{ 1017 "shape":"String", 1018 "documentation":"<p>How much purchasing reserved instances costs you on a monthly basis.</p>" 1019 }, 1020 "normalizedUnitsToPurchase":{ 1021 "shape":"String", 1022 "documentation":"<p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>" 1023 }, 1024 "numberOfInstancesToPurchase":{ 1025 "shape":"String", 1026 "documentation":"<p>The number of instances that Amazon Web Services recommends that you purchase.</p>" 1027 }, 1028 "paymentOption":{ 1029 "shape":"String", 1030 "documentation":"<p>The payment option for the commitment.</p>" 1031 }, 1032 "reservedInstancesRegion":{ 1033 "shape":"String", 1034 "documentation":"<p>The Amazon Web Services Region of the commitment.</p>" 1035 }, 1036 "service":{ 1037 "shape":"String", 1038 "documentation":"<p>The service that you want your recommendations for.</p>" 1039 }, 1040 "sizeFlexEligible":{ 1041 "shape":"Boolean", 1042 "documentation":"<p>Determines whether the recommendation is size flexible.</p>" 1043 }, 1044 "term":{ 1045 "shape":"String", 1046 "documentation":"<p>The reserved instances recommendation term in years.</p>" 1047 }, 1048 "upfrontCost":{ 1049 "shape":"String", 1050 "documentation":"<p>How much purchasing this instance costs you upfront.</p>" 1051 } 1052 }, 1053 "documentation":"<p>The OpenSearch reserved instances configuration used for recommendations.</p>" 1054 }, 1055 "Order":{ 1056 "type":"string", 1057 "enum":[ 1058 "Asc", 1059 "Desc" 1060 ] 1061 }, 1062 "OrderBy":{ 1063 "type":"structure", 1064 "members":{ 1065 "dimension":{ 1066 "shape":"String", 1067 "documentation":"<p>Sorts by dimension values.</p>" 1068 }, 1069 "order":{ 1070 "shape":"Order", 1071 "documentation":"<p>The order that's used to sort the data.</p>" 1072 } 1073 }, 1074 "documentation":"<p>Defines how rows will be sorted in the response.</p>" 1075 }, 1076 "PrimitiveBoolean":{"type":"boolean"}, 1077 "RdsReservedInstances":{ 1078 "type":"structure", 1079 "members":{ 1080 "configuration":{ 1081 "shape":"RdsReservedInstancesConfiguration", 1082 "documentation":"<p>The RDS reserved instances configuration used for recommendations.</p>" 1083 }, 1084 "costCalculation":{ 1085 "shape":"ReservedInstancesCostCalculation", 1086 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 1087 } 1088 }, 1089 "documentation":"<p>The RDS reserved instances recommendation details.</p>" 1090 }, 1091 "RdsReservedInstancesConfiguration":{ 1092 "type":"structure", 1093 "members":{ 1094 "accountScope":{ 1095 "shape":"String", 1096 "documentation":"<p>The account scope that you want your recommendations for.</p>" 1097 }, 1098 "currentGeneration":{ 1099 "shape":"String", 1100 "documentation":"<p>Determines whether the recommendation is for a current generation instance.</p>" 1101 }, 1102 "databaseEdition":{ 1103 "shape":"String", 1104 "documentation":"<p>The database edition that the recommended reservation supports.</p>" 1105 }, 1106 "databaseEngine":{ 1107 "shape":"String", 1108 "documentation":"<p>The database engine that the recommended reservation supports.</p>" 1109 }, 1110 "deploymentOption":{ 1111 "shape":"String", 1112 "documentation":"<p>Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.</p>" 1113 }, 1114 "instanceFamily":{ 1115 "shape":"String", 1116 "documentation":"<p>The instance family of the recommended reservation.</p>" 1117 }, 1118 "instanceType":{ 1119 "shape":"String", 1120 "documentation":"<p>The type of instance that Amazon Web Services recommends.</p>" 1121 }, 1122 "licenseModel":{ 1123 "shape":"String", 1124 "documentation":"<p>The license model that the recommended reservation supports.</p>" 1125 }, 1126 "monthlyRecurringCost":{ 1127 "shape":"String", 1128 "documentation":"<p>How much purchasing this instance costs you on a monthly basis.</p>" 1129 }, 1130 "normalizedUnitsToPurchase":{ 1131 "shape":"String", 1132 "documentation":"<p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>" 1133 }, 1134 "numberOfInstancesToPurchase":{ 1135 "shape":"String", 1136 "documentation":"<p>The number of instances that Amazon Web Services recommends that you purchase.</p>" 1137 }, 1138 "paymentOption":{ 1139 "shape":"String", 1140 "documentation":"<p>The payment option for the commitment.</p>" 1141 }, 1142 "reservedInstancesRegion":{ 1143 "shape":"String", 1144 "documentation":"<p>The Amazon Web Services Region of the commitment.</p>" 1145 }, 1146 "service":{ 1147 "shape":"String", 1148 "documentation":"<p>The service that you want your recommendations for.</p>" 1149 }, 1150 "sizeFlexEligible":{ 1151 "shape":"Boolean", 1152 "documentation":"<p>Determines whether the recommendation is size flexible.</p>" 1153 }, 1154 "term":{ 1155 "shape":"String", 1156 "documentation":"<p>The reserved instances recommendation term in years.</p>" 1157 }, 1158 "upfrontCost":{ 1159 "shape":"String", 1160 "documentation":"<p>How much purchasing this instance costs you upfront.</p>" 1161 } 1162 }, 1163 "documentation":"<p>The RDS reserved instances configuration used for recommendations.</p>" 1164 }, 1165 "Recommendation":{ 1166 "type":"structure", 1167 "members":{ 1168 "accountId":{ 1169 "shape":"String", 1170 "documentation":"<p>The account that the recommendation is for.</p>" 1171 }, 1172 "actionType":{ 1173 "shape":"String", 1174 "documentation":"<p>The type of tasks that can be carried out by this action.</p>" 1175 }, 1176 "currencyCode":{ 1177 "shape":"String", 1178 "documentation":"<p>The currency code used for the recommendation.</p>" 1179 }, 1180 "currentResourceSummary":{ 1181 "shape":"String", 1182 "documentation":"<p>Describes the current resource.</p>" 1183 }, 1184 "currentResourceType":{ 1185 "shape":"String", 1186 "documentation":"<p>The current resource type.</p>" 1187 }, 1188 "estimatedMonthlyCost":{ 1189 "shape":"Double", 1190 "documentation":"<p>The estimated monthly cost for the recommendation.</p>" 1191 }, 1192 "estimatedMonthlySavings":{ 1193 "shape":"Double", 1194 "documentation":"<p>The estimated monthly savings amount for the recommendation.</p>" 1195 }, 1196 "estimatedSavingsPercentage":{ 1197 "shape":"Double", 1198 "documentation":"<p>The estimated savings percentage relative to the total cost over the cost calculation lookback period.</p>" 1199 }, 1200 "implementationEffort":{ 1201 "shape":"String", 1202 "documentation":"<p>The effort required to implement the recommendation.</p>" 1203 }, 1204 "lastRefreshTimestamp":{ 1205 "shape":"Datetime", 1206 "documentation":"<p>The time when the recommendation was last generated.</p>" 1207 }, 1208 "recommendationId":{ 1209 "shape":"String", 1210 "documentation":"<p>The ID for the recommendation.</p>" 1211 }, 1212 "recommendationLookbackPeriodInDays":{ 1213 "shape":"Integer", 1214 "documentation":"<p>The lookback period that's used to generate the recommendation.</p>" 1215 }, 1216 "recommendedResourceSummary":{ 1217 "shape":"String", 1218 "documentation":"<p>Describes the recommended resource.</p>" 1219 }, 1220 "recommendedResourceType":{ 1221 "shape":"String", 1222 "documentation":"<p>The recommended resource type.</p>" 1223 }, 1224 "region":{ 1225 "shape":"String", 1226 "documentation":"<p>The Amazon Web Services Region of the resource.</p>" 1227 }, 1228 "resourceArn":{ 1229 "shape":"String", 1230 "documentation":"<p>The Amazon Resource Name (ARN) for the recommendation.</p>" 1231 }, 1232 "resourceId":{ 1233 "shape":"String", 1234 "documentation":"<p>The resource ID for the recommendation.</p>" 1235 }, 1236 "restartNeeded":{ 1237 "shape":"Boolean", 1238 "documentation":"<p>Whether or not implementing the recommendation requires a restart.</p>" 1239 }, 1240 "rollbackPossible":{ 1241 "shape":"Boolean", 1242 "documentation":"<p>Whether or not implementing the recommendation can be rolled back.</p>" 1243 }, 1244 "source":{ 1245 "shape":"Source", 1246 "documentation":"<p>The source of the recommendation.</p>" 1247 }, 1248 "tags":{ 1249 "shape":"TagList", 1250 "documentation":"<p>A list of tags assigned to the recommendation.</p>" 1251 } 1252 }, 1253 "documentation":"<p>Describes a recommendation.</p>" 1254 }, 1255 "RecommendationIdList":{ 1256 "type":"list", 1257 "member":{"shape":"String"}, 1258 "max":100, 1259 "min":1 1260 }, 1261 "RecommendationList":{ 1262 "type":"list", 1263 "member":{"shape":"Recommendation"} 1264 }, 1265 "RecommendationSummariesList":{ 1266 "type":"list", 1267 "member":{"shape":"RecommendationSummary"} 1268 }, 1269 "RecommendationSummary":{ 1270 "type":"structure", 1271 "members":{ 1272 "estimatedMonthlySavings":{ 1273 "shape":"Double", 1274 "documentation":"<p>The estimated total savings resulting from modifications, on a monthly basis.</p>" 1275 }, 1276 "group":{ 1277 "shape":"String", 1278 "documentation":"<p>The grouping of recommendations.</p>" 1279 }, 1280 "recommendationCount":{ 1281 "shape":"Integer", 1282 "documentation":"<p>The total number of instance recommendations.</p>" 1283 } 1284 }, 1285 "documentation":"<p>The summary of rightsizing recommendations, including de-duped savings from all types of recommendations.</p>" 1286 }, 1287 "RedshiftReservedInstances":{ 1288 "type":"structure", 1289 "members":{ 1290 "configuration":{ 1291 "shape":"RedshiftReservedInstancesConfiguration", 1292 "documentation":"<p>The Redshift reserved instances configuration used for recommendations.</p>" 1293 }, 1294 "costCalculation":{ 1295 "shape":"ReservedInstancesCostCalculation", 1296 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 1297 } 1298 }, 1299 "documentation":"<p>The Redshift reserved instances recommendation details.</p>" 1300 }, 1301 "RedshiftReservedInstancesConfiguration":{ 1302 "type":"structure", 1303 "members":{ 1304 "accountScope":{ 1305 "shape":"String", 1306 "documentation":"<p>The account scope that you want your recommendations for.</p>" 1307 }, 1308 "currentGeneration":{ 1309 "shape":"String", 1310 "documentation":"<p>Determines whether the recommendation is for a current generation instance.</p>" 1311 }, 1312 "instanceFamily":{ 1313 "shape":"String", 1314 "documentation":"<p>The instance family of the recommended reservation.</p>" 1315 }, 1316 "instanceType":{ 1317 "shape":"String", 1318 "documentation":"<p>The type of instance that Amazon Web Services recommends.</p>" 1319 }, 1320 "monthlyRecurringCost":{ 1321 "shape":"String", 1322 "documentation":"<p>How much purchasing reserved instances costs you on a monthly basis.</p>" 1323 }, 1324 "normalizedUnitsToPurchase":{ 1325 "shape":"String", 1326 "documentation":"<p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>" 1327 }, 1328 "numberOfInstancesToPurchase":{ 1329 "shape":"String", 1330 "documentation":"<p>The number of instances that Amazon Web Services recommends that you purchase.</p>" 1331 }, 1332 "paymentOption":{ 1333 "shape":"String", 1334 "documentation":"<p>The payment option for the commitment.</p>" 1335 }, 1336 "reservedInstancesRegion":{ 1337 "shape":"String", 1338 "documentation":"<p>The Amazon Web Services Region of the commitment.</p>" 1339 }, 1340 "service":{ 1341 "shape":"String", 1342 "documentation":"<p>The service that you want your recommendations for.</p>" 1343 }, 1344 "sizeFlexEligible":{ 1345 "shape":"Boolean", 1346 "documentation":"<p>Determines whether the recommendation is size flexible.</p>" 1347 }, 1348 "term":{ 1349 "shape":"String", 1350 "documentation":"<p>The reserved instances recommendation term in years.</p>" 1351 }, 1352 "upfrontCost":{ 1353 "shape":"String", 1354 "documentation":"<p>How much purchasing this instance costs you upfront.</p>" 1355 } 1356 }, 1357 "documentation":"<p>The Redshift reserved instances configuration used for recommendations.</p>" 1358 }, 1359 "RegionList":{ 1360 "type":"list", 1361 "member":{"shape":"String"}, 1362 "max":100, 1363 "min":1 1364 }, 1365 "ReservedInstancesCostCalculation":{ 1366 "type":"structure", 1367 "members":{ 1368 "pricing":{ 1369 "shape":"ReservedInstancesPricing", 1370 "documentation":"<p>Pricing details of the purchase recommendation.</p>" 1371 } 1372 }, 1373 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 1374 }, 1375 "ReservedInstancesPricing":{ 1376 "type":"structure", 1377 "members":{ 1378 "estimatedMonthlyAmortizedReservationCost":{ 1379 "shape":"Double", 1380 "documentation":"<p>The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.</p>" 1381 }, 1382 "estimatedOnDemandCost":{ 1383 "shape":"Double", 1384 "documentation":"<p>The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.</p>" 1385 }, 1386 "monthlyReservationEligibleCost":{ 1387 "shape":"Double", 1388 "documentation":"<p>The cost of paying for the recommended reserved instance monthly.</p>" 1389 }, 1390 "savingsPercentage":{ 1391 "shape":"Double", 1392 "documentation":"<p>The savings percentage relative to the total On-Demand costs that are associated with this instance.</p>" 1393 } 1394 }, 1395 "documentation":"<p>Pricing details for your recommended reserved instance.</p>" 1396 }, 1397 "ResourceArnList":{ 1398 "type":"list", 1399 "member":{"shape":"String"}, 1400 "max":100, 1401 "min":1 1402 }, 1403 "ResourceCostCalculation":{ 1404 "type":"structure", 1405 "members":{ 1406 "pricing":{ 1407 "shape":"ResourcePricing", 1408 "documentation":"<p>Pricing details of the resource recommendation.</p>" 1409 }, 1410 "usages":{ 1411 "shape":"UsageList", 1412 "documentation":"<p>Usage details of the resource recommendation.</p>" 1413 } 1414 }, 1415 "documentation":"<p>Cost impact of the resource recommendation.</p>" 1416 }, 1417 "ResourceDetails":{ 1418 "type":"structure", 1419 "members":{ 1420 "computeSavingsPlans":{ 1421 "shape":"ComputeSavingsPlans", 1422 "documentation":"<p>The Compute Savings Plans recommendation details.</p>" 1423 }, 1424 "ebsVolume":{ 1425 "shape":"EbsVolume", 1426 "documentation":"<p>The Amazon Elastic Block Store volume recommendation details.</p>" 1427 }, 1428 "ec2AutoScalingGroup":{ 1429 "shape":"Ec2AutoScalingGroup", 1430 "documentation":"<p>The EC2 Auto Scaling group recommendation details.</p>" 1431 }, 1432 "ec2Instance":{ 1433 "shape":"Ec2Instance", 1434 "documentation":"<p>The EC2 instance recommendation details.</p>" 1435 }, 1436 "ec2InstanceSavingsPlans":{ 1437 "shape":"Ec2InstanceSavingsPlans", 1438 "documentation":"<p>The EC2 instance Savings Plans recommendation details.</p>" 1439 }, 1440 "ec2ReservedInstances":{ 1441 "shape":"Ec2ReservedInstances", 1442 "documentation":"<p>The EC2 reserved instances recommendation details.</p>" 1443 }, 1444 "ecsService":{ 1445 "shape":"EcsService", 1446 "documentation":"<p>The ECS service recommendation details.</p>" 1447 }, 1448 "elastiCacheReservedInstances":{ 1449 "shape":"ElastiCacheReservedInstances", 1450 "documentation":"<p>The ElastiCache reserved instances recommendation details.</p>" 1451 }, 1452 "lambdaFunction":{ 1453 "shape":"LambdaFunction", 1454 "documentation":"<p>The Lambda function recommendation details.</p>" 1455 }, 1456 "openSearchReservedInstances":{ 1457 "shape":"OpenSearchReservedInstances", 1458 "documentation":"<p>The OpenSearch reserved instances recommendation details.</p>" 1459 }, 1460 "rdsReservedInstances":{ 1461 "shape":"RdsReservedInstances", 1462 "documentation":"<p>The RDS reserved instances recommendation details.</p>" 1463 }, 1464 "redshiftReservedInstances":{ 1465 "shape":"RedshiftReservedInstances", 1466 "documentation":"<p>The Redshift reserved instances recommendation details.</p>" 1467 }, 1468 "sageMakerSavingsPlans":{ 1469 "shape":"SageMakerSavingsPlans", 1470 "documentation":"<p>The SageMaker Savings Plans recommendation details.</p>" 1471 } 1472 }, 1473 "documentation":"<p>Contains detailed information about the specified resource.</p>", 1474 "union":true 1475 }, 1476 "ResourceIdList":{ 1477 "type":"list", 1478 "member":{"shape":"String"}, 1479 "max":100, 1480 "min":1 1481 }, 1482 "ResourceNotFoundException":{ 1483 "type":"structure", 1484 "required":[ 1485 "message", 1486 "resourceId" 1487 ], 1488 "members":{ 1489 "message":{"shape":"String"}, 1490 "resourceId":{ 1491 "shape":"String", 1492 "documentation":"<p>The identifier of the resource that was not found.</p>" 1493 } 1494 }, 1495 "documentation":"<p>The specified Amazon Resource Name (ARN) in the request doesn't exist.</p>", 1496 "exception":true 1497 }, 1498 "ResourcePricing":{ 1499 "type":"structure", 1500 "members":{ 1501 "estimatedCostAfterDiscounts":{ 1502 "shape":"Double", 1503 "documentation":"<p>The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.</p>" 1504 }, 1505 "estimatedCostBeforeDiscounts":{ 1506 "shape":"Double", 1507 "documentation":"<p>The savings estimate using Amazon Web Services public pricing without incorporating any discounts.</p>" 1508 }, 1509 "estimatedDiscounts":{ 1510 "shape":"EstimatedDiscounts", 1511 "documentation":"<p>The estimated discounts for a recommendation.</p>" 1512 }, 1513 "estimatedNetUnusedAmortizedCommitments":{ 1514 "shape":"Double", 1515 "documentation":"<p>The estimated net unused amortized commitment for the recommendation.</p>" 1516 } 1517 }, 1518 "documentation":"<p>Contains pricing information about the specified resource.</p>" 1519 }, 1520 "ResourceType":{ 1521 "type":"string", 1522 "enum":[ 1523 "Ec2Instance", 1524 "LambdaFunction", 1525 "EbsVolume", 1526 "EcsService", 1527 "Ec2AutoScalingGroup", 1528 "Ec2InstanceSavingsPlans", 1529 "ComputeSavingsPlans", 1530 "SageMakerSavingsPlans", 1531 "Ec2ReservedInstances", 1532 "RdsReservedInstances", 1533 "OpenSearchReservedInstances", 1534 "RedshiftReservedInstances", 1535 "ElastiCacheReservedInstances" 1536 ] 1537 }, 1538 "ResourceTypeList":{ 1539 "type":"list", 1540 "member":{"shape":"ResourceType"}, 1541 "max":100, 1542 "min":1 1543 }, 1544 "SageMakerSavingsPlans":{ 1545 "type":"structure", 1546 "members":{ 1547 "configuration":{ 1548 "shape":"SageMakerSavingsPlansConfiguration", 1549 "documentation":"<p>The SageMaker Savings Plans configuration used for recommendations.</p>" 1550 }, 1551 "costCalculation":{ 1552 "shape":"SavingsPlansCostCalculation", 1553 "documentation":"<p>Cost impact of the Savings Plans purchase recommendation.</p>" 1554 } 1555 }, 1556 "documentation":"<p>The SageMaker Savings Plans recommendation details.</p>" 1557 }, 1558 "SageMakerSavingsPlansConfiguration":{ 1559 "type":"structure", 1560 "members":{ 1561 "accountScope":{ 1562 "shape":"String", 1563 "documentation":"<p>The account scope that you want your recommendations for.</p>" 1564 }, 1565 "hourlyCommitment":{ 1566 "shape":"String", 1567 "documentation":"<p>The hourly commitment for the Savings Plans type.</p>" 1568 }, 1569 "paymentOption":{ 1570 "shape":"String", 1571 "documentation":"<p>The payment option for the commitment.</p>" 1572 }, 1573 "term":{ 1574 "shape":"String", 1575 "documentation":"<p>The Savings Plans recommendation term in years.</p>" 1576 } 1577 }, 1578 "documentation":"<p>The SageMaker Savings Plans configuration used for recommendations.</p>" 1579 }, 1580 "SavingsEstimationMode":{ 1581 "type":"string", 1582 "enum":[ 1583 "BeforeDiscounts", 1584 "AfterDiscounts" 1585 ] 1586 }, 1587 "SavingsPlansCostCalculation":{ 1588 "type":"structure", 1589 "members":{ 1590 "pricing":{ 1591 "shape":"SavingsPlansPricing", 1592 "documentation":"<p>Pricing details of the purchase recommendation.</p>" 1593 } 1594 }, 1595 "documentation":"<p>Cost impact of the purchase recommendation.</p>" 1596 }, 1597 "SavingsPlansPricing":{ 1598 "type":"structure", 1599 "members":{ 1600 "estimatedMonthlyCommitment":{ 1601 "shape":"Double", 1602 "documentation":"<p>Estimated monthly commitment for the Savings Plan.</p>" 1603 }, 1604 "estimatedOnDemandCost":{ 1605 "shape":"Double", 1606 "documentation":"<p>Estimated On-Demand cost you will pay after buying the Savings Plan.</p>" 1607 }, 1608 "monthlySavingsPlansEligibleCost":{ 1609 "shape":"Double", 1610 "documentation":"<p>The cost of paying for the recommended Savings Plan monthly.</p>" 1611 }, 1612 "savingsPercentage":{ 1613 "shape":"Double", 1614 "documentation":"<p>Estimated savings as a percentage of your overall costs after buying the Savings Plan.</p>" 1615 } 1616 }, 1617 "documentation":"<p>Pricing information about a Savings Plan.</p>" 1618 }, 1619 "Source":{ 1620 "type":"string", 1621 "enum":[ 1622 "ComputeOptimizer", 1623 "CostExplorer" 1624 ] 1625 }, 1626 "StorageConfiguration":{ 1627 "type":"structure", 1628 "members":{ 1629 "sizeInGb":{ 1630 "shape":"Double", 1631 "documentation":"<p>The storage volume.</p>" 1632 }, 1633 "type":{ 1634 "shape":"String", 1635 "documentation":"<p>The storage type.</p>" 1636 } 1637 }, 1638 "documentation":"<p>The storage configuration used for recommendations.</p>" 1639 }, 1640 "String":{"type":"string"}, 1641 "Tag":{ 1642 "type":"structure", 1643 "members":{ 1644 "key":{ 1645 "shape":"String", 1646 "documentation":"<p>The key that's associated with the tag.</p>" 1647 }, 1648 "value":{ 1649 "shape":"String", 1650 "documentation":"<p>The value that's associated with the tag.</p>" 1651 } 1652 }, 1653 "documentation":"<p>The tag structure that contains a tag key and value.</p>" 1654 }, 1655 "TagList":{ 1656 "type":"list", 1657 "member":{"shape":"Tag"}, 1658 "max":100, 1659 "min":1 1660 }, 1661 "ThrottlingException":{ 1662 "type":"structure", 1663 "members":{ 1664 "message":{"shape":"String"} 1665 }, 1666 "documentation":"<p>The request was denied due to request throttling.</p>", 1667 "exception":true 1668 }, 1669 "Timestamp":{"type":"timestamp"}, 1670 "UpdateEnrollmentStatusRequest":{ 1671 "type":"structure", 1672 "required":["status"], 1673 "members":{ 1674 "includeMemberAccounts":{ 1675 "shape":"Boolean", 1676 "documentation":"<p>Indicates whether to enroll member accounts of the organization if the account is the management account.</p>" 1677 }, 1678 "status":{ 1679 "shape":"EnrollmentStatus", 1680 "documentation":"<p>Sets the account status.</p>" 1681 } 1682 } 1683 }, 1684 "UpdateEnrollmentStatusResponse":{ 1685 "type":"structure", 1686 "members":{ 1687 "status":{ 1688 "shape":"String", 1689 "documentation":"<p>The enrollment status of the account.</p>" 1690 } 1691 } 1692 }, 1693 "UpdatePreferencesRequest":{ 1694 "type":"structure", 1695 "members":{ 1696 "memberAccountDiscountVisibility":{ 1697 "shape":"MemberAccountDiscountVisibility", 1698 "documentation":"<p>Sets the \"member account discount visibility\" preference.</p>" 1699 }, 1700 "savingsEstimationMode":{ 1701 "shape":"SavingsEstimationMode", 1702 "documentation":"<p>Sets the \"savings estimation mode\" preference.</p>" 1703 } 1704 } 1705 }, 1706 "UpdatePreferencesResponse":{ 1707 "type":"structure", 1708 "members":{ 1709 "memberAccountDiscountVisibility":{ 1710 "shape":"MemberAccountDiscountVisibility", 1711 "documentation":"<p>Shows the status of the \"member account discount visibility\" preference.</p>" 1712 }, 1713 "savingsEstimationMode":{ 1714 "shape":"SavingsEstimationMode", 1715 "documentation":"<p>Shows the status of the \"savings estimation mode\" preference.</p>" 1716 } 1717 } 1718 }, 1719 "Usage":{ 1720 "type":"structure", 1721 "members":{ 1722 "operation":{ 1723 "shape":"String", 1724 "documentation":"<p>The operation value.</p>" 1725 }, 1726 "productCode":{ 1727 "shape":"String", 1728 "documentation":"<p>The product code.</p>" 1729 }, 1730 "unit":{ 1731 "shape":"String", 1732 "documentation":"<p>The usage unit.</p>" 1733 }, 1734 "usageAmount":{ 1735 "shape":"Double", 1736 "documentation":"<p>The usage amount.</p>" 1737 }, 1738 "usageType":{ 1739 "shape":"String", 1740 "documentation":"<p>The usage type.</p>" 1741 } 1742 }, 1743 "documentation":"<p>Details about the usage.</p>" 1744 }, 1745 "UsageList":{ 1746 "type":"list", 1747 "member":{"shape":"Usage"} 1748 }, 1749 "ValidationException":{ 1750 "type":"structure", 1751 "required":["message"], 1752 "members":{ 1753 "fields":{ 1754 "shape":"ValidationExceptionDetails", 1755 "documentation":"<p>The list of fields that are invalid.</p>" 1756 }, 1757 "message":{"shape":"String"}, 1758 "reason":{ 1759 "shape":"ValidationExceptionReason", 1760 "documentation":"<p>The reason for the validation exception.</p>" 1761 } 1762 }, 1763 "documentation":"<p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>", 1764 "exception":true 1765 }, 1766 "ValidationExceptionDetail":{ 1767 "type":"structure", 1768 "required":[ 1769 "fieldName", 1770 "message" 1771 ], 1772 "members":{ 1773 "fieldName":{ 1774 "shape":"String", 1775 "documentation":"<p>The field name where the invalid entry was detected.</p>" 1776 }, 1777 "message":{ 1778 "shape":"String", 1779 "documentation":"<p>A message with the reason for the validation exception error.</p>" 1780 } 1781 }, 1782 "documentation":"<p>The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.</p>" 1783 }, 1784 "ValidationExceptionDetails":{ 1785 "type":"list", 1786 "member":{"shape":"ValidationExceptionDetail"} 1787 }, 1788 "ValidationExceptionReason":{ 1789 "type":"string", 1790 "enum":[ 1791 "FieldValidationFailed", 1792 "Other" 1793 ] 1794 } 1795 }, 1796 "documentation":"<p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p> <p>The Cost Optimization Hub API provides the following endpoint:</p> <ul> <li> <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p> </li> </ul>" 1797} 1798