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.
", "readonly":true }, "GetRecommendation":{ "name":"GetRecommendation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRecommendationRequest"}, "output":{"shape":"GetRecommendationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.
The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the recommendationId, use the ListRecommendations API.
Returns cost efficiency metrics aggregated over time and optionally grouped by a specified dimension. The metrics provide insights into your cost optimization progress by tracking estimated savings, spending, and measures how effectively you're optimizing your Cloud resources.
The operation supports both daily and monthly time granularities and allows grouping results by account ID, Amazon Web Services Region. Results are returned as time-series data, enabling you to analyze trends in your cost optimization performance over the specified time period.
", "readonly":true }, "ListEnrollmentStatuses":{ "name":"ListEnrollmentStatuses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEnrollmentStatusesRequest"}, "output":{"shape":"ListEnrollmentStatusesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.
", "readonly":true }, "ListRecommendationSummaries":{ "name":"ListRecommendationSummaries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRecommendationSummariesRequest"}, "output":{"shape":"ListRecommendationSummariesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.
The following filters are not supported for this API: recommendationIds, resourceArns, and resourceIds.
Returns a list of recommendations.
", "readonly":true }, "UpdateEnrollmentStatus":{ "name":"UpdateEnrollmentStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateEnrollmentStatusRequest"}, "output":{"shape":"UpdateEnrollmentStatusResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
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.
" }, "UpdatePreferences":{ "name":"UpdatePreferences", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePreferencesRequest"}, "output":{"shape":"UpdatePreferencesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"You are not authorized to use this operation with the given parameters.
", "exception":true }, "AccountEnrollmentStatus":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"The Amazon Web Services account ID.
" }, "status":{ "shape":"EnrollmentStatus", "documentation":"The account enrollment status.
" }, "lastUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"The time when the account enrollment status was last updated.
" }, "createdTimestamp":{ "shape":"Timestamp", "documentation":"The time when the account enrollment status was created.
" } }, "documentation":"Describes the enrollment status of an organization's member accounts in Cost Optimization Hub.
" }, "AccountEnrollmentStatuses":{ "type":"list", "member":{"shape":"AccountEnrollmentStatus"} }, "AccountId":{ "type":"string", "pattern":"[0-9]{12}" }, "AccountIdList":{ "type":"list", "member":{"shape":"AccountId"}, "max":100, "min":1 }, "ActionType":{ "type":"string", "enum":[ "Rightsize", "Stop", "Upgrade", "PurchaseSavingsPlans", "PurchaseReservedInstances", "MigrateToGraviton", "Delete", "ScaleIn" ] }, "ActionTypeList":{ "type":"list", "member":{"shape":"ActionType"}, "max":100, "min":1 }, "AllocationStrategy":{ "type":"string", "enum":[ "Prioritized", "LowestPrice" ] }, "AuroraDbClusterStorage":{ "type":"structure", "members":{ "configuration":{ "shape":"AuroraDbClusterStorageConfiguration", "documentation":"The Aurora DB cluster storage configuration used for recommendations.
" }, "costCalculation":{"shape":"ResourceCostCalculation"} }, "documentation":"Contains the details of an Aurora DB cluster storage.
" }, "AuroraDbClusterStorageConfiguration":{ "type":"structure", "members":{ "storageType":{ "shape":"String", "documentation":"The storage type to associate with the Aurora DB cluster.
" } }, "documentation":"The Aurora DB cluster storage configuration used for recommendations.
" }, "BlockStoragePerformanceConfiguration":{ "type":"structure", "members":{ "iops":{ "shape":"Double", "documentation":"The number of I/O operations per second.
" }, "throughput":{ "shape":"Double", "documentation":"The throughput that the volume supports.
" } }, "documentation":"Describes the Amazon Elastic Block Store performance configuration of the current and recommended resource configuration for a recommendation.
" }, "Boolean":{ "type":"boolean", "box":true }, "ComputeConfiguration":{ "type":"structure", "members":{ "vCpu":{ "shape":"Double", "documentation":"The number of vCPU cores in the resource.
" }, "memorySizeInMB":{ "shape":"Integer", "documentation":"The memory size of the resource.
" }, "architecture":{ "shape":"String", "documentation":"The architecture of the resource.
" }, "platform":{ "shape":"String", "documentation":"The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
" } }, "documentation":"Describes the performance configuration for compute services such as Amazon EC2, Lambda, and ECS.
" }, "ComputeSavingsPlans":{ "type":"structure", "members":{ "configuration":{ "shape":"ComputeSavingsPlansConfiguration", "documentation":"Configuration details of the Compute Savings Plans to purchase.
" }, "costCalculation":{ "shape":"SavingsPlansCostCalculation", "documentation":"Cost impact of the Savings Plans purchase recommendation.
" } }, "documentation":"The Compute Savings Plans recommendation details.
" }, "ComputeSavingsPlansConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
The Savings Plans recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "hourlyCommitment":{ "shape":"String", "documentation":"The hourly commitment for the Savings Plans type.
" } }, "documentation":"The Compute Savings Plans configuration used for recommendations.
" }, "Datetime":{"type":"timestamp"}, "DbInstanceConfiguration":{ "type":"structure", "members":{ "dbInstanceClass":{ "shape":"String", "documentation":"The DB instance class of the DB instance.
" } }, "documentation":"The DB instance configuration used for recommendations.
" }, "Double":{ "type":"double", "box":true }, "DynamoDbReservedCapacity":{ "type":"structure", "members":{ "configuration":{ "shape":"DynamoDbReservedCapacityConfiguration", "documentation":"The DynamoDB reserved capacity configuration used for recommendations.
" }, "costCalculation":{"shape":"ReservedInstancesCostCalculation"} }, "documentation":"The DynamoDB reserved capacity recommendation details.
" }, "DynamoDbReservedCapacityConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved capacity recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing this reserved capacity costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing this reserved capacity costs you on a monthly basis.
" }, "numberOfCapacityUnitsToPurchase":{ "shape":"String", "documentation":"The number of reserved capacity units that Amazon Web Services recommends that you purchase.
" }, "capacityUnits":{ "shape":"String", "documentation":"The capacity unit of the recommended reservation.
" } }, "documentation":"The DynamoDB reserved capacity configuration used for recommendations.
" }, "EbsVolume":{ "type":"structure", "members":{ "configuration":{ "shape":"EbsVolumeConfiguration", "documentation":"The Amazon Elastic Block Store volume configuration used for recommendations.
" }, "costCalculation":{ "shape":"ResourceCostCalculation", "documentation":"Cost impact of the recommendation.
" } }, "documentation":"Describes the Amazon Elastic Block Store volume configuration of the current and recommended resource configuration for a recommendation.
" }, "EbsVolumeConfiguration":{ "type":"structure", "members":{ "storage":{ "shape":"StorageConfiguration", "documentation":"The disk storage of the Amazon Elastic Block Store volume.
" }, "performance":{ "shape":"BlockStoragePerformanceConfiguration", "documentation":"The Amazon Elastic Block Store performance configuration.
" }, "attachmentState":{ "shape":"String", "documentation":"The Amazon Elastic Block Store attachment state.
" } }, "documentation":"The Amazon Elastic Block Store volume configuration used for recommendations.
" }, "Ec2AutoScalingGroup":{ "type":"structure", "members":{ "configuration":{ "shape":"Ec2AutoScalingGroupConfiguration", "documentation":"The EC2 Auto Scaling group configuration used for recommendations.
" }, "costCalculation":{ "shape":"ResourceCostCalculation", "documentation":"Cost impact of the recommendation.
" } }, "documentation":"The EC2 Auto Scaling group recommendation details.
" }, "Ec2AutoScalingGroupConfiguration":{ "type":"structure", "members":{ "instance":{ "shape":"InstanceConfiguration", "documentation":"Details about the instance for the EC2 Auto Scaling group with a single instance type.
" }, "mixedInstances":{ "shape":"MixedInstanceConfigurationList", "documentation":"A list of instance types for an EC2 Auto Scaling group with mixed instance types.
" }, "type":{ "shape":"Ec2AutoScalingGroupType", "documentation":"The type of EC2 Auto Scaling group, showing whether it consists of a single instance type or mixed instance types.
" }, "allocationStrategy":{ "shape":"AllocationStrategy", "documentation":"The strategy used for allocating instances, based on a predefined priority order or based on the lowest available price.
" } }, "documentation":"The EC2 Auto Scaling group configuration used for recommendations.
" }, "Ec2AutoScalingGroupType":{ "type":"string", "enum":[ "SingleInstanceType", "MixedInstanceTypes" ] }, "Ec2Instance":{ "type":"structure", "members":{ "configuration":{ "shape":"Ec2InstanceConfiguration", "documentation":"The EC2 instance configuration used for recommendations.
" }, "costCalculation":{ "shape":"ResourceCostCalculation", "documentation":"Cost impact of the recommendation.
" } }, "documentation":"Describes the EC2 instance configuration of the current and recommended resource configuration for a recommendation.
" }, "Ec2InstanceConfiguration":{ "type":"structure", "members":{ "instance":{ "shape":"InstanceConfiguration", "documentation":"Details about the instance.
" } }, "documentation":"The EC2 instance configuration used for recommendations.
" }, "Ec2InstanceSavingsPlans":{ "type":"structure", "members":{ "configuration":{ "shape":"Ec2InstanceSavingsPlansConfiguration", "documentation":"The EC2 instance Savings Plans configuration used for recommendations.
" }, "costCalculation":{ "shape":"SavingsPlansCostCalculation", "documentation":"Cost impact of the Savings Plans purchase recommendation.
" } }, "documentation":"The EC2 instance Savings Plans recommendation details.
" }, "Ec2InstanceSavingsPlansConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The Savings Plans recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "hourlyCommitment":{ "shape":"String", "documentation":"The hourly commitment for the Savings Plans type.
" }, "instanceFamily":{ "shape":"String", "documentation":"The instance family of the recommended Savings Plans.
" }, "savingsPlansRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" } }, "documentation":"The EC2 instance Savings Plans configuration used for recommendations.
" }, "Ec2ReservedInstances":{ "type":"structure", "members":{ "configuration":{ "shape":"Ec2ReservedInstancesConfiguration", "documentation":"The EC2 reserved instances configuration used for recommendations.
" }, "costCalculation":{ "shape":"ReservedInstancesCostCalculation", "documentation":"Cost impact of the purchase recommendation.
" } }, "documentation":"The EC2 reserved instances recommendation details.
" }, "Ec2ReservedInstancesConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved instances recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing this instance costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing these reserved instances costs you on a monthly basis.
" }, "normalizedUnitsToPurchase":{ "shape":"String", "documentation":"The number of normalized units that Amazon Web Services recommends that you purchase.
" }, "numberOfInstancesToPurchase":{ "shape":"String", "documentation":"The number of instances that Amazon Web Services recommends that you purchase.
" }, "offeringClass":{ "shape":"String", "documentation":"Indicates whether the recommendation is for standard or convertible reservations.
" }, "instanceFamily":{ "shape":"String", "documentation":"The instance family of the recommended reservation.
" }, "instanceType":{ "shape":"String", "documentation":"The type of instance that Amazon Web Services recommends.
" }, "currentGeneration":{ "shape":"String", "documentation":"Determines whether the recommendation is for a current generation instance.
" }, "platform":{ "shape":"String", "documentation":"The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
" }, "tenancy":{ "shape":"String", "documentation":"Determines whether the recommended reservation is dedicated or shared.
" }, "sizeFlexEligible":{ "shape":"Boolean", "documentation":"Determines whether the recommendation is size flexible.
" } }, "documentation":"The EC2 reserved instances configuration used for recommendations.
" }, "EcsService":{ "type":"structure", "members":{ "configuration":{ "shape":"EcsServiceConfiguration", "documentation":"The ECS service configuration used for recommendations.
" }, "costCalculation":{ "shape":"ResourceCostCalculation", "documentation":"Cost impact of the recommendation.
" } }, "documentation":"The ECS service recommendation details.
" }, "EcsServiceConfiguration":{ "type":"structure", "members":{ "compute":{ "shape":"ComputeConfiguration", "documentation":"Details about the compute configuration.
" } }, "documentation":"The ECS service configuration used for recommendations.
" }, "EfficiencyMetricsByGroup":{ "type":"structure", "members":{ "metricsByTime":{ "shape":"MetricsByTimeList", "documentation":"A list of time-series data points containing efficiency metrics for this group. Each data point includes an efficiency score, estimated savings, spending, and a timestamp corresponding to the specified granularity. This field is null when efficiency metrics cannot be calculated for the group, in which case the message field provides an explanation.
" }, "group":{ "shape":"String", "documentation":"The value of the grouping dimension for this set of metrics. For example, if grouped by account ID, this field contains the account ID. If no grouping is specified, this field is empty.
" }, "message":{ "shape":"String", "documentation":"An explanation of why efficiency metrics could not be calculated for this group when the metricsByTime field is null. Common reasons include insufficient or inconclusive cost and usage data during the specified time period. This field is null or empty when metrics are successfully calculated.
" } }, "documentation":"Contains cost efficiency metrics for a specific group over time. The group is defined by the grouping dimension specified in the request, such as account ID, Amazon Web Services Region.
" }, "EfficiencyMetricsByGroupList":{ "type":"list", "member":{ "shape":"EfficiencyMetricsByGroup", "documentation":"An individual group's cost efficiency metrics over time.
" }, "documentation":"A list of cost efficiency metrics grouped by the specified dimension.
" }, "ElastiCacheReservedInstances":{ "type":"structure", "members":{ "configuration":{ "shape":"ElastiCacheReservedInstancesConfiguration", "documentation":"The ElastiCache reserved instances configuration used for recommendations.
" }, "costCalculation":{ "shape":"ReservedInstancesCostCalculation", "documentation":"Cost impact of the purchase recommendation.
" } }, "documentation":"The ElastiCache reserved instances recommendation details.
" }, "ElastiCacheReservedInstancesConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved instances recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing this instance costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing these reserved instances costs you on a monthly basis.
" }, "normalizedUnitsToPurchase":{ "shape":"String", "documentation":"The number of normalized units that Amazon Web Services recommends that you purchase.
" }, "numberOfInstancesToPurchase":{ "shape":"String", "documentation":"The number of instances that Amazon Web Services recommends that you purchase.
" }, "instanceFamily":{ "shape":"String", "documentation":"The instance family of the recommended reservation.
" }, "instanceType":{ "shape":"String", "documentation":"The type of instance that Amazon Web Services recommends.
" }, "currentGeneration":{ "shape":"String", "documentation":"Determines whether the recommendation is for a current generation instance.
" }, "sizeFlexEligible":{ "shape":"Boolean", "documentation":"Determines whether the recommendation is size flexible.
" } }, "documentation":"The ElastiCache reserved instances configuration used for recommendations.
" }, "EnrollmentStatus":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "EstimatedDiscounts":{ "type":"structure", "members":{ "savingsPlansDiscount":{ "shape":"Double", "documentation":"Estimated Savings Plans discounts.
" }, "reservedInstancesDiscount":{ "shape":"Double", "documentation":"Estimated reserved instance discounts.
" }, "otherDiscount":{ "shape":"Double", "documentation":"Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount.
Estimated discount details of the current and recommended resource configuration for a recommendation.
" }, "Filter":{ "type":"structure", "members":{ "restartNeeded":{ "shape":"Boolean", "documentation":"Whether or not implementing the recommendation requires a restart.
" }, "rollbackPossible":{ "shape":"Boolean", "documentation":"Whether or not implementing the recommendation can be rolled back.
" }, "implementationEfforts":{ "shape":"ImplementationEffortList", "documentation":"The effort required to implement the recommendation.
" }, "accountIds":{ "shape":"AccountIdList", "documentation":"The account to which the recommendation applies.
" }, "regions":{ "shape":"RegionList", "documentation":"The Amazon Web Services Region of the resource.
" }, "resourceTypes":{ "shape":"ResourceTypeList", "documentation":"The resource type of the recommendation.
" }, "actionTypes":{ "shape":"ActionTypeList", "documentation":"The type of action you can take by adopting the recommendation.
" }, "tags":{ "shape":"TagList", "documentation":"A list of tags assigned to the recommendation.
" }, "resourceIds":{ "shape":"ResourceIdList", "documentation":"The resource ID of the recommendation.
" }, "resourceArns":{ "shape":"ResourceArnList", "documentation":"The Amazon Resource Name (ARN) of the recommendation.
" }, "recommendationIds":{ "shape":"RecommendationIdList", "documentation":"The IDs for the recommendations.
" } }, "documentation":"Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.
" }, "GetPreferencesRequest":{ "type":"structure", "members":{} }, "GetPreferencesResponse":{ "type":"structure", "members":{ "savingsEstimationMode":{ "shape":"SavingsEstimationMode", "documentation":"Retrieves the status of the \"savings estimation mode\" preference.
" }, "memberAccountDiscountVisibility":{ "shape":"MemberAccountDiscountVisibility", "documentation":"Retrieves the status of the \"member account discount visibility\" preference.
" }, "preferredCommitment":{ "shape":"PreferredCommitment", "documentation":"Retrieves the current preferences for how Reserved Instances and Savings Plans cost-saving opportunities are prioritized in terms of payment option and term length.
" } } }, "GetRecommendationRequest":{ "type":"structure", "required":["recommendationId"], "members":{ "recommendationId":{ "shape":"String", "documentation":"The ID for the recommendation.
" } } }, "GetRecommendationResponse":{ "type":"structure", "members":{ "recommendationId":{ "shape":"String", "documentation":"The ID for the recommendation.
" }, "resourceId":{ "shape":"String", "documentation":"The unique identifier for the resource. This is the same as the Amazon Resource Name (ARN), if available.
" }, "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the resource.
" }, "accountId":{ "shape":"String", "documentation":"The account to which the recommendation applies.
" }, "currencyCode":{ "shape":"String", "documentation":"The currency code used for the recommendation.
" }, "recommendationLookbackPeriodInDays":{ "shape":"Integer", "documentation":"The lookback period that's used to generate the recommendation.
" }, "costCalculationLookbackPeriodInDays":{ "shape":"Integer", "documentation":"The lookback period used to calculate cost impact for a recommendation.
" }, "estimatedSavingsPercentage":{ "shape":"Double", "documentation":"The estimated savings percentage relative to the total cost over the cost calculation lookback period.
" }, "estimatedSavingsOverCostCalculationLookbackPeriod":{ "shape":"Double", "documentation":"The estimated savings amount over the lookback period used to calculate cost impact for a recommendation.
" }, "currentResourceType":{ "shape":"ResourceType", "documentation":"The type of resource.
" }, "recommendedResourceType":{ "shape":"ResourceType", "documentation":"The resource type of the recommendation.
" }, "region":{ "shape":"String", "documentation":"The Amazon Web Services Region of the resource.
" }, "source":{ "shape":"Source", "documentation":"The source of the recommendation.
" }, "lastRefreshTimestamp":{ "shape":"Datetime", "documentation":"The time when the recommendation was last generated.
" }, "estimatedMonthlySavings":{ "shape":"Double", "documentation":"The estimated monthly savings amount for the recommendation.
" }, "estimatedMonthlyCost":{ "shape":"Double", "documentation":"The estimated monthly cost of the current resource. For Reserved Instances and Savings Plans, it refers to the cost for eligible usage.
" }, "implementationEffort":{ "shape":"ImplementationEffort", "documentation":"The effort required to implement the recommendation.
" }, "restartNeeded":{ "shape":"Boolean", "documentation":"Whether or not implementing the recommendation requires a restart.
" }, "actionType":{ "shape":"ActionType", "documentation":"The type of action you can take by adopting the recommendation.
" }, "rollbackPossible":{ "shape":"Boolean", "documentation":"Whether or not implementing the recommendation can be rolled back.
" }, "currentResourceDetails":{ "shape":"ResourceDetails", "documentation":"The details for the resource.
" }, "recommendedResourceDetails":{ "shape":"ResourceDetails", "documentation":"The details about the recommended resource.
" }, "tags":{ "shape":"TagList", "documentation":"A list of tags associated with the resource for which the recommendation exists.
" } } }, "GranularityType":{ "type":"string", "documentation":"The time granularity for aggregating the cost efficiency metrics.
", "enum":[ "Daily", "Monthly" ] }, "ImplementationEffort":{ "type":"string", "enum":[ "VeryLow", "Low", "Medium", "High", "VeryHigh" ] }, "ImplementationEffortList":{ "type":"list", "member":{"shape":"ImplementationEffort"}, "max":100, "min":1 }, "InstanceConfiguration":{ "type":"structure", "members":{ "type":{ "shape":"String", "documentation":"The instance type of the configuration.
" } }, "documentation":"The instance configuration used for recommendations.
" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"An error on the server occurred during the processing of your request. Try again later.
", "exception":true, "fault":true }, "LambdaFunction":{ "type":"structure", "members":{ "configuration":{ "shape":"LambdaFunctionConfiguration", "documentation":"The Lambda function configuration used for recommendations.
" }, "costCalculation":{ "shape":"ResourceCostCalculation", "documentation":"Cost impact of the recommendation.
" } }, "documentation":"The Lambda function recommendation details.
" }, "LambdaFunctionConfiguration":{ "type":"structure", "members":{ "compute":{ "shape":"ComputeConfiguration", "documentation":"Details about the compute configuration.
" } }, "documentation":"The Lambda function configuration used for recommendations.
" }, "ListEfficiencyMetricsRequest":{ "type":"structure", "required":[ "granularity", "timePeriod" ], "members":{ "groupBy":{ "shape":"String", "documentation":"The dimension by which to group the cost efficiency metrics. Valid values include account ID, Amazon Web Services Region. When no grouping is specified, metrics are aggregated across all resources in the specified time period.
" }, "granularity":{ "shape":"GranularityType", "documentation":"The time granularity for the cost efficiency metrics. Specify Daily for metrics aggregated by day, or Monthly for metrics aggregated by month.
The time period for which to retrieve the cost efficiency metrics. The start date is inclusive and the end date is exclusive. Dates can be specified in either YYYY-MM-DD format or YYYY-MM format depending on the desired granularity.
" }, "maxResults":{ "shape":"ListEfficiencyMetricsRequestMaxResultsInteger", "documentation":"The maximum number of groups to return in the response. Valid values range from 0 to 1000. Use in conjunction with nextToken to paginate through results when the total number of groups exceeds this limit.
The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next page of results. This value is returned in the response when the number of groups exceeds the specified maxResults value.
A list of cost efficiency metrics grouped by the specified dimension. Each group contains time-series data points with cost efficiency, potential savings, and optimzable spend for the specified time period.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next page of results. When this value is present in the response, additional groups are available. Pass this token in the nextToken parameter of a subsequent request to retrieve the next page.
Indicates whether to return the enrollment status for the organization.
" }, "accountId":{ "shape":"AccountId", "documentation":"The account ID of a member account in the organization.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next set of results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of objects that are returned for the request.
" } } }, "ListEnrollmentStatusesResponse":{ "type":"structure", "members":{ "items":{ "shape":"AccountEnrollmentStatuses", "documentation":"The enrollment status of a specific account ID, including creation and last updated timestamps.
" }, "includeMemberAccounts":{ "shape":"Boolean", "documentation":"The enrollment status of all member accounts in the organization if the account is the management account or delegated administrator.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next set of results.
" } } }, "ListRecommendationSummariesRequest":{ "type":"structure", "required":["groupBy"], "members":{ "filter":{"shape":"Filter"}, "groupBy":{ "shape":"String", "documentation":"The grouping of recommendations by a dimension.
" }, "maxResults":{ "shape":"ListRecommendationSummariesRequestMaxResultsInteger", "documentation":"The maximum number of recommendations to be returned for the request.
" }, "metrics":{ "shape":"SummaryMetricsList", "documentation":"Additional metrics to be returned for the request. The only valid value is savingsPercentage.
The token to retrieve the next set of results.
" } } }, "ListRecommendationSummariesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":1000, "min":0 }, "ListRecommendationSummariesResponse":{ "type":"structure", "members":{ "estimatedTotalDedupedSavings":{ "shape":"Double", "documentation":"The total overall savings for the aggregated view.
" }, "items":{ "shape":"RecommendationSummariesList", "documentation":"A list of all savings recommendations.
" }, "groupBy":{ "shape":"String", "documentation":"The dimension used to group the recommendations by.
" }, "currencyCode":{ "shape":"String", "documentation":"The currency code used for the recommendation.
" }, "metrics":{ "shape":"SummaryMetricsResult", "documentation":"The results or descriptions for the additional metrics, based on whether the metrics were or were not requested.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next set of results.
" } } }, "ListRecommendationsRequest":{ "type":"structure", "members":{ "filter":{ "shape":"Filter", "documentation":"The constraints that you want all returned recommendations to match.
" }, "orderBy":{ "shape":"OrderBy", "documentation":"The ordering of recommendations by a dimension.
" }, "includeAllRecommendations":{ "shape":"PrimitiveBoolean", "documentation":"List of all recommendations for a resource, or a single recommendation if de-duped by resourceId.
The maximum number of recommendations that are returned for the request.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next set of results.
" } } }, "ListRecommendationsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":1000, "min":0 }, "ListRecommendationsResponse":{ "type":"structure", "members":{ "items":{ "shape":"RecommendationList", "documentation":"List of all savings recommendations.
" }, "nextToken":{ "shape":"String", "documentation":"The token to retrieve the next set of results.
" } } }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":0 }, "MemberAccountDiscountVisibility":{ "type":"string", "enum":[ "All", "None" ] }, "MemoryDbReservedInstances":{ "type":"structure", "members":{ "configuration":{ "shape":"MemoryDbReservedInstancesConfiguration", "documentation":"The MemoryDB reserved instances configuration used for recommendations.
" }, "costCalculation":{"shape":"ReservedInstancesCostCalculation"} }, "documentation":"The MemoryDB reserved instances recommendation details.
While the API reference uses \"MemoryDB reserved instances\", the user guide and other documentation refer to them as \"MemoryDB reserved nodes\", as the terms are used interchangeably.
The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved instances recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing these reserved instances costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing these reserved instances costs you on a monthly basis.
" }, "normalizedUnitsToPurchase":{ "shape":"String", "documentation":"The number of normalized units that Amazon Web Services recommends that you purchase.
" }, "numberOfInstancesToPurchase":{ "shape":"String", "documentation":"The number of instances that Amazon Web Services recommends that you purchase.
" }, "instanceType":{ "shape":"String", "documentation":"The type of instance that Amazon Web Services recommends.
" }, "instanceFamily":{ "shape":"String", "documentation":"The instance family of the recommended reservation.
" }, "sizeFlexEligible":{ "shape":"Boolean", "documentation":"Determines whether the recommendation is size flexible.
" }, "currentGeneration":{ "shape":"String", "documentation":"Determines whether the recommendation is for a current generation instance.
" } }, "documentation":"The MemoryDB reserved instances configuration used for recommendations.
While the API reference uses \"MemoryDB reserved instances\", the user guide and other documentation refer to them as \"MemoryDB reserved nodes\", as the terms are used interchangeably.
The efficiency score for this time period. The score represents a measure of how effectively the cloud resources are being optimized, with higher scores indicating better optimization performance.
" }, "savings":{ "shape":"Double", "documentation":"The estimated savings amount for this time period, representing the potential cost reduction achieved through optimization recommendations.
" }, "spend":{ "shape":"Double", "documentation":"The total spending amount for this time period.
" }, "timestamp":{ "shape":"String", "documentation":"The timestamp for this data point. The format depends on the granularity: YYYY-MM-DD for daily metrics, or YYYY-MM for monthly metrics.
" } }, "documentation":"Contains efficiency metrics for a specific point in time, including an efficiency score, potential savings, optimizable spend, and timestamp.
" }, "MetricsByTimeList":{ "type":"list", "member":{ "shape":"MetricsByTime", "documentation":"A single time-series data point containing efficiency metrics.
" }, "documentation":"A list of time-series efficiency metric data points.
" }, "MixedInstanceConfiguration":{ "type":"structure", "members":{ "type":{ "shape":"String", "documentation":"The instance type of the configuration.
" } }, "documentation":"The configuration for the EC2 Auto Scaling group with mixed instance types.
" }, "MixedInstanceConfigurationList":{ "type":"list", "member":{"shape":"MixedInstanceConfiguration"} }, "NatGateway":{ "type":"structure", "members":{ "configuration":{ "shape":"NatGatewayConfiguration", "documentation":"The NAT Gateway configuration used for recommendations.
" }, "costCalculation":{"shape":"ResourceCostCalculation"} }, "documentation":"The NAT Gateway recommendation details.
" }, "NatGatewayConfiguration":{ "type":"structure", "members":{ "activeConnectionCount":{ "shape":"Long", "documentation":"The number of active connections through the NAT Gateway.
" }, "packetsInFromSource":{ "shape":"Long", "documentation":"The number of packets received from the source through the NAT Gateway.
" }, "packetsInFromDestination":{ "shape":"Long", "documentation":"The number of packets received from the destination through the NAT Gateway.
" } }, "documentation":"The NAT Gateway configuration used for recommendations.
" }, "OpenSearchReservedInstances":{ "type":"structure", "members":{ "configuration":{ "shape":"OpenSearchReservedInstancesConfiguration", "documentation":"The OpenSearch reserved instances configuration used for recommendations.
" }, "costCalculation":{ "shape":"ReservedInstancesCostCalculation", "documentation":"Cost impact of the purchase recommendation.
" } }, "documentation":"The OpenSearch reserved instances recommendation details.
" }, "OpenSearchReservedInstancesConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved instances recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing this instance costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing these reserved instances costs you on a monthly basis.
" }, "normalizedUnitsToPurchase":{ "shape":"String", "documentation":"The number of normalized units that Amazon Web Services recommends that you purchase.
" }, "numberOfInstancesToPurchase":{ "shape":"String", "documentation":"The number of instances that Amazon Web Services recommends that you purchase.
" }, "instanceType":{ "shape":"String", "documentation":"The type of instance that Amazon Web Services recommends.
" }, "currentGeneration":{ "shape":"String", "documentation":"Determines whether the recommendation is for a current generation instance.
" }, "sizeFlexEligible":{ "shape":"Boolean", "documentation":"Determines whether the recommendation is size flexible.
" } }, "documentation":"The OpenSearch reserved instances configuration used for recommendations.
" }, "Order":{ "type":"string", "enum":[ "Asc", "Desc" ] }, "OrderBy":{ "type":"structure", "members":{ "dimension":{ "shape":"String", "documentation":"Sorts by dimension values.
" }, "order":{ "shape":"Order", "documentation":"The order that's used to sort the data.
" } }, "documentation":"Defines how rows will be sorted in the response.
" }, "PaymentOption":{ "type":"string", "enum":[ "AllUpfront", "PartialUpfront", "NoUpfront" ] }, "PreferredCommitment":{ "type":"structure", "members":{ "term":{ "shape":"Term", "documentation":"The preferred length of the commitment period. If the value is null, it will default to ThreeYears (highest savings) where applicable.
The preferred upfront payment structure for commitments. If the value is null, it will default to AllUpfront (highest savings) where applicable.
The preferred configuration for Reserved Instances and Savings Plans commitment-based discounts, consisting of a payment option and a commitment duration.
" }, "PrimitiveBoolean":{"type":"boolean"}, "RdsDbInstance":{ "type":"structure", "members":{ "configuration":{ "shape":"RdsDbInstanceConfiguration", "documentation":"The Amazon RDS DB instance configuration used for recommendations.
" }, "costCalculation":{"shape":"ResourceCostCalculation"} }, "documentation":"Contains the details of an Amazon RDS DB instance.
" }, "RdsDbInstanceConfiguration":{ "type":"structure", "members":{ "instance":{ "shape":"DbInstanceConfiguration", "documentation":"Details about the instance configuration.
" } }, "documentation":"The Amazon RDS DB instance configuration used for recommendations.
" }, "RdsDbInstanceStorage":{ "type":"structure", "members":{ "configuration":{ "shape":"RdsDbInstanceStorageConfiguration", "documentation":"The Amazon RDS DB instance storage configuration used for recommendations.
" }, "costCalculation":{"shape":"ResourceCostCalculation"} }, "documentation":"Contains the details of an Amazon RDS DB instance storage.
" }, "RdsDbInstanceStorageConfiguration":{ "type":"structure", "members":{ "storageType":{ "shape":"String", "documentation":"The storage type to associate with the DB instance.
" }, "allocatedStorageInGb":{ "shape":"Double", "documentation":"The new amount of storage in GB to allocate for the DB instance.
" }, "iops":{ "shape":"Double", "documentation":"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
" }, "storageThroughput":{ "shape":"Double", "documentation":"The storage throughput for the DB instance.
" } }, "documentation":"The Amazon RDS DB instance storage configuration used for recommendations.
" }, "RdsReservedInstances":{ "type":"structure", "members":{ "configuration":{ "shape":"RdsReservedInstancesConfiguration", "documentation":"The RDS reserved instances configuration used for recommendations.
" }, "costCalculation":{ "shape":"ReservedInstancesCostCalculation", "documentation":"Cost impact of the purchase recommendation.
" } }, "documentation":"The RDS reserved instances recommendation details.
" }, "RdsReservedInstancesConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved instances recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing this instance costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing this instance costs you on a monthly basis.
" }, "normalizedUnitsToPurchase":{ "shape":"String", "documentation":"The number of normalized units that Amazon Web Services recommends that you purchase.
" }, "numberOfInstancesToPurchase":{ "shape":"String", "documentation":"The number of instances that Amazon Web Services recommends that you purchase.
" }, "instanceFamily":{ "shape":"String", "documentation":"The instance family of the recommended reservation.
" }, "instanceType":{ "shape":"String", "documentation":"The type of instance that Amazon Web Services recommends.
" }, "sizeFlexEligible":{ "shape":"Boolean", "documentation":"Determines whether the recommendation is size flexible.
" }, "currentGeneration":{ "shape":"String", "documentation":"Determines whether the recommendation is for a current generation instance.
" }, "licenseModel":{ "shape":"String", "documentation":"The license model that the recommended reservation supports.
" }, "databaseEdition":{ "shape":"String", "documentation":"The database edition that the recommended reservation supports.
" }, "databaseEngine":{ "shape":"String", "documentation":"The database engine that the recommended reservation supports.
" }, "deploymentOption":{ "shape":"String", "documentation":"Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
" } }, "documentation":"The RDS reserved instances configuration used for recommendations.
" }, "Recommendation":{ "type":"structure", "members":{ "recommendationId":{ "shape":"String", "documentation":"The ID for the recommendation.
" }, "accountId":{ "shape":"String", "documentation":"The account to which the recommendation applies.
" }, "region":{ "shape":"String", "documentation":"The Amazon Web Services Region of the resource.
" }, "resourceId":{ "shape":"String", "documentation":"The resource ID for the recommendation.
" }, "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) for the recommendation.
" }, "currentResourceType":{ "shape":"String", "documentation":"The current resource type.
" }, "recommendedResourceType":{ "shape":"String", "documentation":"The recommended resource type.
" }, "estimatedMonthlySavings":{ "shape":"Double", "documentation":"The estimated monthly savings amount for the recommendation.
" }, "estimatedSavingsPercentage":{ "shape":"Double", "documentation":"The estimated savings percentage relative to the total cost over the cost calculation lookback period.
" }, "estimatedMonthlyCost":{ "shape":"Double", "documentation":"The estimated monthly cost of the current resource. For Reserved Instances and Savings Plans, it refers to the cost for eligible usage.
" }, "currencyCode":{ "shape":"String", "documentation":"The currency code used for the recommendation.
" }, "implementationEffort":{ "shape":"String", "documentation":"The effort required to implement the recommendation.
" }, "restartNeeded":{ "shape":"Boolean", "documentation":"Whether or not implementing the recommendation requires a restart.
" }, "actionType":{ "shape":"String", "documentation":"The type of tasks that can be carried out by this action.
" }, "rollbackPossible":{ "shape":"Boolean", "documentation":"Whether or not implementing the recommendation can be rolled back.
" }, "currentResourceSummary":{ "shape":"String", "documentation":"Describes the current resource.
" }, "recommendedResourceSummary":{ "shape":"String", "documentation":"Describes the recommended resource.
" }, "lastRefreshTimestamp":{ "shape":"Datetime", "documentation":"The time when the recommendation was last generated.
" }, "recommendationLookbackPeriodInDays":{ "shape":"Integer", "documentation":"The lookback period that's used to generate the recommendation.
" }, "source":{ "shape":"Source", "documentation":"The source of the recommendation.
" }, "tags":{ "shape":"TagList", "documentation":"A list of tags assigned to the recommendation.
" } }, "documentation":"Describes a recommendation.
" }, "RecommendationIdList":{ "type":"list", "member":{"shape":"String"}, "max":100, "min":1 }, "RecommendationList":{ "type":"list", "member":{"shape":"Recommendation"} }, "RecommendationSummariesList":{ "type":"list", "member":{"shape":"RecommendationSummary"} }, "RecommendationSummary":{ "type":"structure", "members":{ "group":{ "shape":"String", "documentation":"The grouping of recommendations.
" }, "estimatedMonthlySavings":{ "shape":"Double", "documentation":"The estimated total savings resulting from modifications, on a monthly basis.
" }, "recommendationCount":{ "shape":"Integer", "documentation":"The total number of instance recommendations.
" } }, "documentation":"The summary of rightsizing recommendations, including de-duped savings from all types of recommendations.
" }, "RedshiftReservedInstances":{ "type":"structure", "members":{ "configuration":{ "shape":"RedshiftReservedInstancesConfiguration", "documentation":"The Redshift reserved instances configuration used for recommendations.
" }, "costCalculation":{ "shape":"ReservedInstancesCostCalculation", "documentation":"Cost impact of the purchase recommendation.
" } }, "documentation":"The Redshift reserved instances recommendation details.
" }, "RedshiftReservedInstancesConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "service":{ "shape":"String", "documentation":"The service for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The reserved instances recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "reservedInstancesRegion":{ "shape":"String", "documentation":"The Amazon Web Services Region of the commitment.
" }, "upfrontCost":{ "shape":"String", "documentation":"How much purchasing this instance costs you upfront.
" }, "monthlyRecurringCost":{ "shape":"String", "documentation":"How much purchasing these reserved instances costs you on a monthly basis.
" }, "normalizedUnitsToPurchase":{ "shape":"String", "documentation":"The number of normalized units that Amazon Web Services recommends that you purchase.
" }, "numberOfInstancesToPurchase":{ "shape":"String", "documentation":"The number of instances that Amazon Web Services recommends that you purchase.
" }, "instanceFamily":{ "shape":"String", "documentation":"The instance family of the recommended reservation.
" }, "instanceType":{ "shape":"String", "documentation":"The type of instance that Amazon Web Services recommends.
" }, "sizeFlexEligible":{ "shape":"Boolean", "documentation":"Determines whether the recommendation is size flexible.
" }, "currentGeneration":{ "shape":"String", "documentation":"Determines whether the recommendation is for a current generation instance.
" } }, "documentation":"The Redshift reserved instances configuration used for recommendations.
" }, "RegionList":{ "type":"list", "member":{"shape":"String"}, "max":100, "min":1 }, "ReservedInstancesCostCalculation":{ "type":"structure", "members":{ "pricing":{ "shape":"ReservedInstancesPricing", "documentation":"Pricing details of the purchase recommendation.
" } }, "documentation":"Cost impact of the purchase recommendation.
" }, "ReservedInstancesPricing":{ "type":"structure", "members":{ "estimatedOnDemandCost":{ "shape":"Double", "documentation":"The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
" }, "monthlyReservationEligibleCost":{ "shape":"Double", "documentation":"The cost of paying for the recommended reserved instance monthly.
" }, "savingsPercentage":{ "shape":"Double", "documentation":"The savings percentage relative to the total On-Demand costs that are associated with this instance.
" }, "estimatedMonthlyAmortizedReservationCost":{ "shape":"Double", "documentation":"The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
" } }, "documentation":"Pricing details for your recommended reserved instance.
" }, "ResourceArnList":{ "type":"list", "member":{"shape":"String"}, "max":100, "min":1 }, "ResourceCostCalculation":{ "type":"structure", "members":{ "usages":{ "shape":"UsageList", "documentation":"Usage details of the resource recommendation.
" }, "pricing":{ "shape":"ResourcePricing", "documentation":"Pricing details of the resource recommendation.
" } }, "documentation":"Cost impact of the resource recommendation.
" }, "ResourceDetails":{ "type":"structure", "members":{ "lambdaFunction":{ "shape":"LambdaFunction", "documentation":"The Lambda function recommendation details.
" }, "ecsService":{ "shape":"EcsService", "documentation":"The ECS service recommendation details.
" }, "ec2Instance":{ "shape":"Ec2Instance", "documentation":"The EC2 instance recommendation details.
" }, "ebsVolume":{ "shape":"EbsVolume", "documentation":"The Amazon Elastic Block Store volume recommendation details.
" }, "ec2AutoScalingGroup":{ "shape":"Ec2AutoScalingGroup", "documentation":"The EC2 Auto Scaling group recommendation details.
" }, "ec2ReservedInstances":{ "shape":"Ec2ReservedInstances", "documentation":"The EC2 reserved instances recommendation details.
" }, "rdsReservedInstances":{ "shape":"RdsReservedInstances", "documentation":"The RDS reserved instances recommendation details.
" }, "elastiCacheReservedInstances":{ "shape":"ElastiCacheReservedInstances", "documentation":"The ElastiCache reserved instances recommendation details.
" }, "openSearchReservedInstances":{ "shape":"OpenSearchReservedInstances", "documentation":"The OpenSearch reserved instances recommendation details.
" }, "redshiftReservedInstances":{ "shape":"RedshiftReservedInstances", "documentation":"The Redshift reserved instances recommendation details.
" }, "ec2InstanceSavingsPlans":{ "shape":"Ec2InstanceSavingsPlans", "documentation":"The EC2 instance Savings Plans recommendation details.
" }, "computeSavingsPlans":{ "shape":"ComputeSavingsPlans", "documentation":"The Compute Savings Plans recommendation details.
" }, "sageMakerSavingsPlans":{ "shape":"SageMakerSavingsPlans", "documentation":"The SageMaker AI Savings Plans recommendation details.
" }, "rdsDbInstance":{ "shape":"RdsDbInstance", "documentation":"The DB instance recommendation details.
" }, "rdsDbInstanceStorage":{ "shape":"RdsDbInstanceStorage", "documentation":"The DB instance storage recommendation details.
" }, "auroraDbClusterStorage":{ "shape":"AuroraDbClusterStorage", "documentation":"The Aurora DB cluster storage recommendation details.
" }, "dynamoDbReservedCapacity":{ "shape":"DynamoDbReservedCapacity", "documentation":"The DynamoDB reserved capacity recommendation details.
" }, "memoryDbReservedInstances":{ "shape":"MemoryDbReservedInstances", "documentation":"The MemoryDB reserved instances recommendation details.
" }, "natGateway":{ "shape":"NatGateway", "documentation":"The NAT Gateway recommendation details.
" } }, "documentation":"Contains detailed information about the specified resource.
", "union":true }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"}, "max":100, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The identifier of the resource that was not found.
" } }, "documentation":"The specified Amazon Resource Name (ARN) in the request doesn't exist.
", "exception":true }, "ResourcePricing":{ "type":"structure", "members":{ "estimatedCostBeforeDiscounts":{ "shape":"Double", "documentation":"The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
" }, "estimatedNetUnusedAmortizedCommitments":{ "shape":"Double", "documentation":"The estimated net unused amortized commitment for the recommendation.
" }, "estimatedDiscounts":{ "shape":"EstimatedDiscounts", "documentation":"The estimated discounts for a recommendation.
" }, "estimatedCostAfterDiscounts":{ "shape":"Double", "documentation":"The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
" } }, "documentation":"Contains pricing information about the specified resource.
" }, "ResourceType":{ "type":"string", "enum":[ "Ec2Instance", "LambdaFunction", "EbsVolume", "EcsService", "Ec2AutoScalingGroup", "Ec2InstanceSavingsPlans", "ComputeSavingsPlans", "SageMakerSavingsPlans", "Ec2ReservedInstances", "RdsReservedInstances", "OpenSearchReservedInstances", "RedshiftReservedInstances", "ElastiCacheReservedInstances", "RdsDbInstanceStorage", "RdsDbInstance", "AuroraDbClusterStorage", "DynamoDbReservedCapacity", "MemoryDbReservedInstances", "NatGateway" ] }, "ResourceTypeList":{ "type":"list", "member":{"shape":"ResourceType"}, "max":100, "min":1 }, "SageMakerSavingsPlans":{ "type":"structure", "members":{ "configuration":{ "shape":"SageMakerSavingsPlansConfiguration", "documentation":"The SageMaker Savings Plans configuration used for recommendations.
" }, "costCalculation":{ "shape":"SavingsPlansCostCalculation", "documentation":"Cost impact of the Savings Plans purchase recommendation.
" } }, "documentation":"The SageMaker Savings Plans recommendation details.
" }, "SageMakerSavingsPlansConfiguration":{ "type":"structure", "members":{ "accountScope":{ "shape":"String", "documentation":"The account scope for which you want recommendations.
" }, "term":{ "shape":"String", "documentation":"The Savings Plans recommendation term in years.
" }, "paymentOption":{ "shape":"String", "documentation":"The payment option for the commitment.
" }, "hourlyCommitment":{ "shape":"String", "documentation":"The hourly commitment for the Savings Plans type.
" } }, "documentation":"The SageMaker Savings Plans configuration used for recommendations.
" }, "SavingsEstimationMode":{ "type":"string", "enum":[ "BeforeDiscounts", "AfterDiscounts" ] }, "SavingsPlansCostCalculation":{ "type":"structure", "members":{ "pricing":{ "shape":"SavingsPlansPricing", "documentation":"Pricing details of the purchase recommendation.
" } }, "documentation":"Cost impact of the purchase recommendation.
" }, "SavingsPlansPricing":{ "type":"structure", "members":{ "monthlySavingsPlansEligibleCost":{ "shape":"Double", "documentation":"The cost of paying for the recommended Savings Plans monthly.
" }, "estimatedMonthlyCommitment":{ "shape":"Double", "documentation":"Estimated monthly commitment for the Savings Plans.
" }, "savingsPercentage":{ "shape":"Double", "documentation":"Estimated savings as a percentage of your overall costs after buying the Savings Plans.
" }, "estimatedOnDemandCost":{ "shape":"Double", "documentation":"Estimated On-Demand cost you will pay after buying the Savings Plans.
" } }, "documentation":"Pricing information about a Savings Plans.
" }, "Source":{ "type":"string", "enum":[ "ComputeOptimizer", "CostExplorer" ] }, "StorageConfiguration":{ "type":"structure", "members":{ "type":{ "shape":"String", "documentation":"The storage type.
" }, "sizeInGb":{ "shape":"Double", "documentation":"The storage volume.
" } }, "documentation":"The storage configuration used for recommendations.
" }, "String":{"type":"string"}, "SummaryMetrics":{ "type":"string", "enum":["SavingsPercentage"] }, "SummaryMetricsList":{ "type":"list", "member":{"shape":"SummaryMetrics"}, "max":100, "min":1 }, "SummaryMetricsResult":{ "type":"structure", "members":{ "savingsPercentage":{ "shape":"String", "documentation":"The savings percentage based on your Amazon Web Services spend over the past 30 days.
Savings percentage is only supported when filtering by Region, account ID, or tags.
The results or descriptions for the additional metrics, based on whether the metrics were or were not requested.
" }, "Tag":{ "type":"structure", "members":{ "key":{ "shape":"String", "documentation":"The key that's associated with the tag.
" }, "value":{ "shape":"String", "documentation":"The value that's associated with the tag.
" } }, "documentation":"The tag structure that contains a tag key and value.
" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":100, "min":1 }, "Term":{ "type":"string", "enum":[ "OneYear", "ThreeYears" ] }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The request was denied due to request throttling.
", "exception":true }, "TimePeriod":{ "type":"structure", "required":[ "start", "end" ], "members":{ "start":{ "shape":"String", "documentation":"The beginning of the time period (inclusive). Specify the date in ISO 8601 format, such as 2024-01-01.
" }, "end":{ "shape":"String", "documentation":"The end of the time period (exclusive). Specify the date in ISO 8601 format, such as 2024-12-31.
" } }, "documentation":"Specifies a date range for retrieving efficiency metrics. The start date is inclusive and the end date is exclusive.
" }, "Timestamp":{"type":"timestamp"}, "UpdateEnrollmentStatusRequest":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"EnrollmentStatus", "documentation":"Sets the account status.
" }, "includeMemberAccounts":{ "shape":"Boolean", "documentation":"Indicates whether to enroll member accounts of the organization if the account is the management account or delegated administrator.
" } } }, "UpdateEnrollmentStatusResponse":{ "type":"structure", "members":{ "status":{ "shape":"String", "documentation":"The enrollment status of the account.
" } } }, "UpdatePreferencesRequest":{ "type":"structure", "members":{ "savingsEstimationMode":{ "shape":"SavingsEstimationMode", "documentation":"Sets the \"savings estimation mode\" preference.
" }, "memberAccountDiscountVisibility":{ "shape":"MemberAccountDiscountVisibility", "documentation":"Sets the \"member account discount visibility\" preference.
" }, "preferredCommitment":{ "shape":"PreferredCommitment", "documentation":"Sets the preferences for how Reserved Instances and Savings Plans cost-saving opportunities are prioritized in terms of payment option and term length.
" } } }, "UpdatePreferencesResponse":{ "type":"structure", "members":{ "savingsEstimationMode":{ "shape":"SavingsEstimationMode", "documentation":"Shows the status of the \"savings estimation mode\" preference.
" }, "memberAccountDiscountVisibility":{ "shape":"MemberAccountDiscountVisibility", "documentation":"Shows the status of the \"member account discount visibility\" preference.
" }, "preferredCommitment":{ "shape":"PreferredCommitment", "documentation":"Shows the updated preferences for how Reserved Instances and Savings Plans cost-saving opportunities are prioritized in terms of payment option and term length.
" } } }, "Usage":{ "type":"structure", "members":{ "usageType":{ "shape":"String", "documentation":"The usage type.
" }, "usageAmount":{ "shape":"Double", "documentation":"The usage amount.
" }, "operation":{ "shape":"String", "documentation":"The operation value.
" }, "productCode":{ "shape":"String", "documentation":"The product code.
" }, "unit":{ "shape":"String", "documentation":"The usage unit.
" } }, "documentation":"Details about the usage.
" }, "UsageList":{ "type":"list", "member":{"shape":"Usage"} }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason for the validation exception.
" }, "fields":{ "shape":"ValidationExceptionDetails", "documentation":"The list of fields that are invalid.
" } }, "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "exception":true }, "ValidationExceptionDetail":{ "type":"structure", "required":[ "fieldName", "message" ], "members":{ "fieldName":{ "shape":"String", "documentation":"The field name where the invalid entry was detected.
" }, "message":{ "shape":"String", "documentation":"A message with the reason for the validation exception error.
" } }, "documentation":"The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
" }, "ValidationExceptionDetails":{ "type":"list", "member":{"shape":"ValidationExceptionDetail"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "FieldValidationFailed", "Other" ] } }, "documentation":"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.
The Cost Optimization Hub API provides the following endpoint:
https://cost-optimization-hub.us-east-1.amazonaws.com