2023/11/27 - Cost Optimization Hub - 7 new api methods
Changes This release launches Cost Optimization Hub, a new AWS Billing and Cost Management feature that helps you consolidate and prioritize cost optimization recommendations across your AWS Organizations member accounts and AWS Regions, so that you can get the most out of your AWS spend.
Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.
See also: AWS API Documentation
Request Syntax
client.list_enrollment_statuses(
accountId='string',
includeOrganizationInfo=True|False,
maxResults=123,
nextToken='string'
)
string
The enrollment status of a specific account ID in the organization.
boolean
Indicates whether to return the enrollment status for the organization.
integer
The maximum number of objects that are returned for the request.
string
The token to retrieve the next set of results.
dict
Response Syntax
{
'items': [
{
'accountId': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastUpdatedTimestamp': datetime(2015, 1, 1),
'status': 'Active'|'Inactive'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The account enrollment statuses.
(dict) --
Describes the enrollment status of an organization's member accounts in Cost Optimization Hub.
accountId (string) --
The Amazon Web Services account ID.
createdTimestamp (datetime) --
The time when the account enrollment status was created.
lastUpdatedTimestamp (datetime) --
The time when the account enrollment status was last updated.
status (string) --
The account enrollment status.
nextToken (string) --
The token to retrieve the next set of results.
Returns a list of recommendations.
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
filter={
'accountIds': [
'string',
],
'actionTypes': [
'Rightsize'|'Stop'|'Upgrade'|'PurchaseSavingsPlans'|'PurchaseReservedInstances'|'MigrateToGraviton',
],
'implementationEfforts': [
'VeryLow'|'Low'|'Medium'|'High'|'VeryHigh',
],
'recommendationIds': [
'string',
],
'regions': [
'string',
],
'resourceArns': [
'string',
],
'resourceIds': [
'string',
],
'resourceTypes': [
'Ec2Instance'|'LambdaFunction'|'EbsVolume'|'EcsService'|'Ec2AutoScalingGroup'|'Ec2InstanceSavingsPlans'|'ComputeSavingsPlans'|'SageMakerSavingsPlans'|'Ec2ReservedInstances'|'RdsReservedInstances'|'OpenSearchReservedInstances'|'RedshiftReservedInstances'|'ElastiCacheReservedInstances',
],
'restartNeeded': True|False,
'rollbackPossible': True|False,
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
includeAllRecommendations=True|False,
maxResults=123,
nextToken='string',
orderBy={
'dimension': 'string',
'order': 'Asc'|'Desc'
}
)
dict
The constraints that you want all returned recommendations to match.
accountIds (list) --
The account that the recommendation is for.
(string) --
actionTypes (list) --
The type of action you can take by adopting the recommendation.
(string) --
implementationEfforts (list) --
The effort required to implement the recommendation.
(string) --
recommendationIds (list) --
The IDs for the recommendations.
(string) --
regions (list) --
The Amazon Web Services Region of the resource.
(string) --
resourceArns (list) --
The Amazon Resource Name (ARN) of the recommendation.
(string) --
resourceIds (list) --
The resource ID of the recommendation.
(string) --
resourceTypes (list) --
The resource type of the recommendation.
(string) --
restartNeeded (boolean) --
Whether or not implementing the recommendation requires a restart.
rollbackPossible (boolean) --
Whether or not implementing the recommendation can be rolled back.
tags (list) --
A list of tags assigned to the recommendation.
(dict) --
The tag structure that contains a tag key and value.
key (string) --
The key that's associated with the tag.
value (string) --
The value that's associated with the tag.
boolean
List of all recommendations for a resource, or a single recommendation if de-duped by resourceId .
integer
The maximum number of recommendations that are returned for the request.
string
The token to retrieve the next set of results.
dict
The ordering of recommendations by a dimension.
dimension (string) --
Sorts by dimension values.
order (string) --
The order that's used to sort the data.
dict
Response Syntax
{
'items': [
{
'accountId': 'string',
'actionType': 'string',
'currencyCode': 'string',
'currentResourceSummary': 'string',
'currentResourceType': 'string',
'estimatedMonthlyCost': 123.0,
'estimatedMonthlySavings': 123.0,
'estimatedSavingsPercentage': 123.0,
'implementationEffort': 'string',
'lastRefreshTimestamp': datetime(2015, 1, 1),
'recommendationId': 'string',
'recommendationLookbackPeriodInDays': 123,
'recommendedResourceSummary': 'string',
'recommendedResourceType': 'string',
'region': 'string',
'resourceArn': 'string',
'resourceId': 'string',
'restartNeeded': True|False,
'rollbackPossible': True|False,
'source': 'ComputeOptimizer'|'CostExplorer',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of all savings recommendations.
(dict) --
Describes a recommendation.
accountId (string) --
The account that the recommendation is for.
actionType (string) --
The type of tasks that can be carried out by this action.
currencyCode (string) --
The currency code used for the recommendation.
currentResourceSummary (string) --
Describes the current resource.
currentResourceType (string) --
The current resource type.
estimatedMonthlyCost (float) --
The estimated monthly cost for the recommendation.
estimatedMonthlySavings (float) --
The estimated monthly savings amount for the recommendation.
estimatedSavingsPercentage (float) --
The estimated savings percentage relative to the total cost over the cost calculation lookback period.
implementationEffort (string) --
The effort required to implement the recommendation.
lastRefreshTimestamp (datetime) --
The time when the recommendation was last generated.
recommendationId (string) --
The ID for the recommendation.
recommendationLookbackPeriodInDays (integer) --
The lookback period that's used to generate the recommendation.
recommendedResourceSummary (string) --
Describes the recommended resource.
recommendedResourceType (string) --
The recommended resource type.
region (string) --
The Amazon Web Services Region of the resource.
resourceArn (string) --
The Amazon Resource Name (ARN) for the recommendation.
resourceId (string) --
The resource ID for the recommendation.
restartNeeded (boolean) --
Whether or not implementing the recommendation requires a restart.
rollbackPossible (boolean) --
Whether or not implementing the recommendation can be rolled back.
source (string) --
The source of the recommendation.
tags (list) --
A list of tags assigned to the recommendation.
(dict) --
The tag structure that contains a tag key and value.
key (string) --
The key that's associated with the tag.
value (string) --
The value that's associated with the tag.
nextToken (string) --
The token to retrieve the next set of results.
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.
See also: AWS API Documentation
Request Syntax
client.update_preferences(
memberAccountDiscountVisibility='All'|'None',
savingsEstimationMode='BeforeDiscounts'|'AfterDiscounts'
)
string
Sets the "member account discount visibility" preference.
string
Sets the "savings estimation mode" preference.
dict
Response Syntax
{
'memberAccountDiscountVisibility': 'All'|'None',
'savingsEstimationMode': 'BeforeDiscounts'|'AfterDiscounts'
}
Response Structure
(dict) --
memberAccountDiscountVisibility (string) --
Shows the status of the "member account discount visibility" preference.
savingsEstimationMode (string) --
Shows the status of the "savings estimation mode" preference.
Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.
Note
The following filters are not supported for this API: recommendationIds , resourceArns , and resourceIds .
See also: AWS API Documentation
Request Syntax
client.list_recommendation_summaries(
filter={
'accountIds': [
'string',
],
'actionTypes': [
'Rightsize'|'Stop'|'Upgrade'|'PurchaseSavingsPlans'|'PurchaseReservedInstances'|'MigrateToGraviton',
],
'implementationEfforts': [
'VeryLow'|'Low'|'Medium'|'High'|'VeryHigh',
],
'recommendationIds': [
'string',
],
'regions': [
'string',
],
'resourceArns': [
'string',
],
'resourceIds': [
'string',
],
'resourceTypes': [
'Ec2Instance'|'LambdaFunction'|'EbsVolume'|'EcsService'|'Ec2AutoScalingGroup'|'Ec2InstanceSavingsPlans'|'ComputeSavingsPlans'|'SageMakerSavingsPlans'|'Ec2ReservedInstances'|'RdsReservedInstances'|'OpenSearchReservedInstances'|'RedshiftReservedInstances'|'ElastiCacheReservedInstances',
],
'restartNeeded': True|False,
'rollbackPossible': True|False,
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
groupBy='string',
maxResults=123,
nextToken='string'
)
dict
Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.
accountIds (list) --
The account that the recommendation is for.
(string) --
actionTypes (list) --
The type of action you can take by adopting the recommendation.
(string) --
implementationEfforts (list) --
The effort required to implement the recommendation.
(string) --
recommendationIds (list) --
The IDs for the recommendations.
(string) --
regions (list) --
The Amazon Web Services Region of the resource.
(string) --
resourceArns (list) --
The Amazon Resource Name (ARN) of the recommendation.
(string) --
resourceIds (list) --
The resource ID of the recommendation.
(string) --
resourceTypes (list) --
The resource type of the recommendation.
(string) --
restartNeeded (boolean) --
Whether or not implementing the recommendation requires a restart.
rollbackPossible (boolean) --
Whether or not implementing the recommendation can be rolled back.
tags (list) --
A list of tags assigned to the recommendation.
(dict) --
The tag structure that contains a tag key and value.
key (string) --
The key that's associated with the tag.
value (string) --
The value that's associated with the tag.
string
[REQUIRED]
The grouping of recommendations by a dimension.
integer
The maximum number of recommendations that are returned for the request.
string
The token to retrieve the next set of results.
dict
Response Syntax
{
'currencyCode': 'string',
'estimatedTotalDedupedSavings': 123.0,
'groupBy': 'string',
'items': [
{
'estimatedMonthlySavings': 123.0,
'group': 'string',
'recommendationCount': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
currencyCode (string) --
The currency code used for the recommendation.
estimatedTotalDedupedSavings (float) --
The total overall savings for the aggregated view.
groupBy (string) --
The dimension used to group the recommendations by.
items (list) --
List of all savings recommendations.
(dict) --
The summary of rightsizing recommendations, including de-duped savings from all types of recommendations.
estimatedMonthlySavings (float) --
The estimated total savings resulting from modifications, on a monthly basis.
group (string) --
The grouping of recommendations.
recommendationCount (integer) --
The total number of instance recommendations.
nextToken (string) --
The token to retrieve the next set of results.
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.
See also: AWS API Documentation
Request Syntax
client.get_preferences()
dict
Response Syntax
{
'memberAccountDiscountVisibility': 'All'|'None',
'savingsEstimationMode': 'BeforeDiscounts'|'AfterDiscounts'
}
Response Structure
(dict) --
memberAccountDiscountVisibility (string) --
Retrieves the status of the "member account discount visibility" preference.
savingsEstimationMode (string) --
Retrieves the status of the "savings estimation mode" preference.
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.
See also: AWS API Documentation
Request Syntax
client.get_recommendation(
recommendationId='string'
)
string
[REQUIRED]
The ID for the recommendation.
dict
Response Syntax
{
'accountId': 'string',
'actionType': 'Rightsize'|'Stop'|'Upgrade'|'PurchaseSavingsPlans'|'PurchaseReservedInstances'|'MigrateToGraviton',
'costCalculationLookbackPeriodInDays': 123,
'currencyCode': 'string',
'currentResourceDetails': {
'computeSavingsPlans': {
'configuration': {
'accountScope': 'string',
'hourlyCommitment': 'string',
'paymentOption': 'string',
'term': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyCommitment': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlySavingsPlansEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'ebsVolume': {
'configuration': {
'attachmentState': 'string',
'performance': {
'iops': 123.0,
'throughput': 123.0
},
'storage': {
'sizeInGb': 123.0,
'type': 'string'
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'ec2AutoScalingGroup': {
'configuration': {
'instance': {
'type': 'string'
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'ec2Instance': {
'configuration': {
'instance': {
'type': 'string'
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'ec2InstanceSavingsPlans': {
'configuration': {
'accountScope': 'string',
'hourlyCommitment': 'string',
'instanceFamily': 'string',
'paymentOption': 'string',
'savingsPlansRegion': 'string',
'term': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyCommitment': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlySavingsPlansEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'ec2ReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'offeringClass': 'string',
'paymentOption': 'string',
'platform': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'tenancy': 'string',
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'ecsService': {
'configuration': {
'compute': {
'architecture': 'string',
'memorySizeInMB': 123,
'platform': 'string',
'vCpu': 123.0
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'elastiCacheReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'lambdaFunction': {
'configuration': {
'compute': {
'architecture': 'string',
'memorySizeInMB': 123,
'platform': 'string',
'vCpu': 123.0
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'openSearchReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'rdsReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'databaseEdition': 'string',
'databaseEngine': 'string',
'deploymentOption': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'licenseModel': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'redshiftReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'sageMakerSavingsPlans': {
'configuration': {
'accountScope': 'string',
'hourlyCommitment': 'string',
'paymentOption': 'string',
'term': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyCommitment': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlySavingsPlansEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
}
},
'currentResourceType': 'Ec2Instance'|'LambdaFunction'|'EbsVolume'|'EcsService'|'Ec2AutoScalingGroup'|'Ec2InstanceSavingsPlans'|'ComputeSavingsPlans'|'SageMakerSavingsPlans'|'Ec2ReservedInstances'|'RdsReservedInstances'|'OpenSearchReservedInstances'|'RedshiftReservedInstances'|'ElastiCacheReservedInstances',
'estimatedMonthlyCost': 123.0,
'estimatedMonthlySavings': 123.0,
'estimatedSavingsOverCostCalculationLookbackPeriod': 123.0,
'estimatedSavingsPercentage': 123.0,
'implementationEffort': 'VeryLow'|'Low'|'Medium'|'High'|'VeryHigh',
'lastRefreshTimestamp': datetime(2015, 1, 1),
'recommendationId': 'string',
'recommendationLookbackPeriodInDays': 123,
'recommendedResourceDetails': {
'computeSavingsPlans': {
'configuration': {
'accountScope': 'string',
'hourlyCommitment': 'string',
'paymentOption': 'string',
'term': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyCommitment': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlySavingsPlansEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'ebsVolume': {
'configuration': {
'attachmentState': 'string',
'performance': {
'iops': 123.0,
'throughput': 123.0
},
'storage': {
'sizeInGb': 123.0,
'type': 'string'
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'ec2AutoScalingGroup': {
'configuration': {
'instance': {
'type': 'string'
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'ec2Instance': {
'configuration': {
'instance': {
'type': 'string'
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'ec2InstanceSavingsPlans': {
'configuration': {
'accountScope': 'string',
'hourlyCommitment': 'string',
'instanceFamily': 'string',
'paymentOption': 'string',
'savingsPlansRegion': 'string',
'term': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyCommitment': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlySavingsPlansEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'ec2ReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'offeringClass': 'string',
'paymentOption': 'string',
'platform': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'tenancy': 'string',
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'ecsService': {
'configuration': {
'compute': {
'architecture': 'string',
'memorySizeInMB': 123,
'platform': 'string',
'vCpu': 123.0
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'elastiCacheReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'lambdaFunction': {
'configuration': {
'compute': {
'architecture': 'string',
'memorySizeInMB': 123,
'platform': 'string',
'vCpu': 123.0
}
},
'costCalculation': {
'pricing': {
'estimatedCostAfterDiscounts': 123.0,
'estimatedCostBeforeDiscounts': 123.0,
'estimatedDiscounts': {
'otherDiscount': 123.0,
'reservedInstancesDiscount': 123.0,
'savingsPlansDiscount': 123.0
},
'estimatedNetUnusedAmortizedCommitments': 123.0
},
'usages': [
{
'operation': 'string',
'productCode': 'string',
'unit': 'string',
'usageAmount': 123.0,
'usageType': 'string'
},
]
}
},
'openSearchReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'rdsReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'databaseEdition': 'string',
'databaseEngine': 'string',
'deploymentOption': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'licenseModel': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'redshiftReservedInstances': {
'configuration': {
'accountScope': 'string',
'currentGeneration': 'string',
'instanceFamily': 'string',
'instanceType': 'string',
'monthlyRecurringCost': 'string',
'normalizedUnitsToPurchase': 'string',
'numberOfInstancesToPurchase': 'string',
'paymentOption': 'string',
'reservedInstancesRegion': 'string',
'service': 'string',
'sizeFlexEligible': True|False,
'term': 'string',
'upfrontCost': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyAmortizedReservationCost': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlyReservationEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
},
'sageMakerSavingsPlans': {
'configuration': {
'accountScope': 'string',
'hourlyCommitment': 'string',
'paymentOption': 'string',
'term': 'string'
},
'costCalculation': {
'pricing': {
'estimatedMonthlyCommitment': 123.0,
'estimatedOnDemandCost': 123.0,
'monthlySavingsPlansEligibleCost': 123.0,
'savingsPercentage': 123.0
}
}
}
},
'recommendedResourceType': 'Ec2Instance'|'LambdaFunction'|'EbsVolume'|'EcsService'|'Ec2AutoScalingGroup'|'Ec2InstanceSavingsPlans'|'ComputeSavingsPlans'|'SageMakerSavingsPlans'|'Ec2ReservedInstances'|'RdsReservedInstances'|'OpenSearchReservedInstances'|'RedshiftReservedInstances'|'ElastiCacheReservedInstances',
'region': 'string',
'resourceArn': 'string',
'resourceId': 'string',
'restartNeeded': True|False,
'rollbackPossible': True|False,
'source': 'ComputeOptimizer'|'CostExplorer',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
accountId (string) --
The account that the recommendation is for.
actionType (string) --
The type of action you can take by adopting the recommendation.
costCalculationLookbackPeriodInDays (integer) --
The lookback period used to calculate cost impact for a recommendation.
currencyCode (string) --
The currency code used for the recommendation.
currentResourceDetails (dict) --
The details for the resource.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: computeSavingsPlans, ebsVolume, ec2AutoScalingGroup, ec2Instance, ec2InstanceSavingsPlans, ec2ReservedInstances, ecsService, elastiCacheReservedInstances, lambdaFunction, openSearchReservedInstances, rdsReservedInstances, redshiftReservedInstances, sageMakerSavingsPlans. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
computeSavingsPlans (dict) --
The Compute Savings Plans recommendation details.
configuration (dict) --
Configuration details of the Compute Savings Plans to purchase.
accountScope (string) --
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 PAYER . If the value is LINKED , recommendations are calculated for individual member accounts only.
hourlyCommitment (string) --
The hourly commitment for the Savings Plans type.
paymentOption (string) --
The payment option for the commitment.
term (string) --
The Savings Plans recommendation term in years.
costCalculation (dict) --
Cost impact of the Savings Plans purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyCommitment (float) --
Estimated monthly commitment for the Savings Plan.
estimatedOnDemandCost (float) --
Estimated On-Demand cost you will pay after buying the Savings Plan.
monthlySavingsPlansEligibleCost (float) --
The cost of paying for the recommended Savings Plan monthly.
savingsPercentage (float) --
Estimated savings as a percentage of your overall costs after buying the Savings Plan.
ebsVolume (dict) --
The Amazon Elastic Block Store volume recommendation details.
configuration (dict) --
The Amazon Elastic Block Store volume configuration used for recommendations.
attachmentState (string) --
The Amazon Elastic Block Store attachment state.
performance (dict) --
The Amazon Elastic Block Store performance configuration.
iops (float) --
The number of I/O operations per second.
throughput (float) --
The throughput that the volume supports.
storage (dict) --
The disk storage of the Amazon Elastic Block Store volume.
sizeInGb (float) --
The storage volume.
type (string) --
The storage type.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
ec2AutoScalingGroup (dict) --
The EC2 Auto Scaling group recommendation details.
configuration (dict) --
The EC2 Auto Scaling group configuration used for recommendations.
instance (dict) --
Details about the instance.
type (string) --
Details about the type.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
ec2Instance (dict) --
The EC2 instance recommendation details.
configuration (dict) --
The EC2 instance configuration used for recommendations.
instance (dict) --
Details about the instance.
type (string) --
Details about the type.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
ec2InstanceSavingsPlans (dict) --
The EC2 instance Savings Plans recommendation details.
configuration (dict) --
The EC2 instance Savings Plans configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
hourlyCommitment (string) --
The hourly commitment for the Savings Plans type.
instanceFamily (string) --
The instance family of the recommended Savings Plan.
paymentOption (string) --
The payment option for the commitment.
savingsPlansRegion (string) --
The Amazon Web Services Region of the commitment.
term (string) --
The Savings Plans recommendation term in years.
costCalculation (dict) --
Cost impact of the Savings Plans purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyCommitment (float) --
Estimated monthly commitment for the Savings Plan.
estimatedOnDemandCost (float) --
Estimated On-Demand cost you will pay after buying the Savings Plan.
monthlySavingsPlansEligibleCost (float) --
The cost of paying for the recommended Savings Plan monthly.
savingsPercentage (float) --
Estimated savings as a percentage of your overall costs after buying the Savings Plan.
ec2ReservedInstances (dict) --
The EC2 reserved instances recommendation details.
configuration (dict) --
The EC2 reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
offeringClass (string) --
Indicates whether the recommendation is for standard or convertible reservations.
paymentOption (string) --
The payment option for the commitment.
platform (string) --
The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
tenancy (string) --
Determines whether the recommended reservation is dedicated or shared.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
ecsService (dict) --
The ECS service recommendation details.
configuration (dict) --
The ECS service configuration used for recommendations.
compute (dict) --
Details about the compute configuration.
architecture (string) --
The architecture of the resource.
memorySizeInMB (integer) --
The memory size of the resource.
platform (string) --
The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
vCpu (float) --
The number of vCPU cores in the resource.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
elastiCacheReservedInstances (dict) --
The ElastiCache reserved instances recommendation details.
configuration (dict) --
The ElastiCache reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
lambdaFunction (dict) --
The Lambda function recommendation details.
configuration (dict) --
The Lambda function configuration used for recommendations.
compute (dict) --
Details about the compute configuration.
architecture (string) --
The architecture of the resource.
memorySizeInMB (integer) --
The memory size of the resource.
platform (string) --
The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
vCpu (float) --
The number of vCPU cores in the resource.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
openSearchReservedInstances (dict) --
The OpenSearch reserved instances recommendation details.
configuration (dict) --
The OpenSearch reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
rdsReservedInstances (dict) --
The RDS reserved instances recommendation details.
configuration (dict) --
The RDS reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
databaseEdition (string) --
The database edition that the recommended reservation supports.
databaseEngine (string) --
The database engine that the recommended reservation supports.
deploymentOption (string) --
Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
licenseModel (string) --
The license model that the recommended reservation supports.
monthlyRecurringCost (string) --
How much purchasing this instance costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
redshiftReservedInstances (dict) --
The Redshift reserved instances recommendation details.
configuration (dict) --
The Redshift reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
sageMakerSavingsPlans (dict) --
The SageMaker Savings Plans recommendation details.
configuration (dict) --
The SageMaker Savings Plans configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
hourlyCommitment (string) --
The hourly commitment for the Savings Plans type.
paymentOption (string) --
The payment option for the commitment.
term (string) --
The Savings Plans recommendation term in years.
costCalculation (dict) --
Cost impact of the Savings Plans purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyCommitment (float) --
Estimated monthly commitment for the Savings Plan.
estimatedOnDemandCost (float) --
Estimated On-Demand cost you will pay after buying the Savings Plan.
monthlySavingsPlansEligibleCost (float) --
The cost of paying for the recommended Savings Plan monthly.
savingsPercentage (float) --
Estimated savings as a percentage of your overall costs after buying the Savings Plan.
currentResourceType (string) --
The type of resource.
estimatedMonthlyCost (float) --
The estimated monthly cost of the recommendation.
estimatedMonthlySavings (float) --
The estimated monthly savings amount for the recommendation.
estimatedSavingsOverCostCalculationLookbackPeriod (float) --
The estimated savings amount over the lookback period used to calculate cost impact for a recommendation.
estimatedSavingsPercentage (float) --
The estimated savings percentage relative to the total cost over the cost calculation lookback period.
implementationEffort (string) --
The effort required to implement the recommendation.
lastRefreshTimestamp (datetime) --
The time when the recommendation was last generated.
recommendationId (string) --
The ID for the recommendation.
recommendationLookbackPeriodInDays (integer) --
The lookback period that's used to generate the recommendation.
recommendedResourceDetails (dict) --
The details about the recommended resource.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: computeSavingsPlans, ebsVolume, ec2AutoScalingGroup, ec2Instance, ec2InstanceSavingsPlans, ec2ReservedInstances, ecsService, elastiCacheReservedInstances, lambdaFunction, openSearchReservedInstances, rdsReservedInstances, redshiftReservedInstances, sageMakerSavingsPlans. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
computeSavingsPlans (dict) --
The Compute Savings Plans recommendation details.
configuration (dict) --
Configuration details of the Compute Savings Plans to purchase.
accountScope (string) --
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 PAYER . If the value is LINKED , recommendations are calculated for individual member accounts only.
hourlyCommitment (string) --
The hourly commitment for the Savings Plans type.
paymentOption (string) --
The payment option for the commitment.
term (string) --
The Savings Plans recommendation term in years.
costCalculation (dict) --
Cost impact of the Savings Plans purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyCommitment (float) --
Estimated monthly commitment for the Savings Plan.
estimatedOnDemandCost (float) --
Estimated On-Demand cost you will pay after buying the Savings Plan.
monthlySavingsPlansEligibleCost (float) --
The cost of paying for the recommended Savings Plan monthly.
savingsPercentage (float) --
Estimated savings as a percentage of your overall costs after buying the Savings Plan.
ebsVolume (dict) --
The Amazon Elastic Block Store volume recommendation details.
configuration (dict) --
The Amazon Elastic Block Store volume configuration used for recommendations.
attachmentState (string) --
The Amazon Elastic Block Store attachment state.
performance (dict) --
The Amazon Elastic Block Store performance configuration.
iops (float) --
The number of I/O operations per second.
throughput (float) --
The throughput that the volume supports.
storage (dict) --
The disk storage of the Amazon Elastic Block Store volume.
sizeInGb (float) --
The storage volume.
type (string) --
The storage type.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
ec2AutoScalingGroup (dict) --
The EC2 Auto Scaling group recommendation details.
configuration (dict) --
The EC2 Auto Scaling group configuration used for recommendations.
instance (dict) --
Details about the instance.
type (string) --
Details about the type.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
ec2Instance (dict) --
The EC2 instance recommendation details.
configuration (dict) --
The EC2 instance configuration used for recommendations.
instance (dict) --
Details about the instance.
type (string) --
Details about the type.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
ec2InstanceSavingsPlans (dict) --
The EC2 instance Savings Plans recommendation details.
configuration (dict) --
The EC2 instance Savings Plans configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
hourlyCommitment (string) --
The hourly commitment for the Savings Plans type.
instanceFamily (string) --
The instance family of the recommended Savings Plan.
paymentOption (string) --
The payment option for the commitment.
savingsPlansRegion (string) --
The Amazon Web Services Region of the commitment.
term (string) --
The Savings Plans recommendation term in years.
costCalculation (dict) --
Cost impact of the Savings Plans purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyCommitment (float) --
Estimated monthly commitment for the Savings Plan.
estimatedOnDemandCost (float) --
Estimated On-Demand cost you will pay after buying the Savings Plan.
monthlySavingsPlansEligibleCost (float) --
The cost of paying for the recommended Savings Plan monthly.
savingsPercentage (float) --
Estimated savings as a percentage of your overall costs after buying the Savings Plan.
ec2ReservedInstances (dict) --
The EC2 reserved instances recommendation details.
configuration (dict) --
The EC2 reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
offeringClass (string) --
Indicates whether the recommendation is for standard or convertible reservations.
paymentOption (string) --
The payment option for the commitment.
platform (string) --
The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
tenancy (string) --
Determines whether the recommended reservation is dedicated or shared.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
ecsService (dict) --
The ECS service recommendation details.
configuration (dict) --
The ECS service configuration used for recommendations.
compute (dict) --
Details about the compute configuration.
architecture (string) --
The architecture of the resource.
memorySizeInMB (integer) --
The memory size of the resource.
platform (string) --
The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
vCpu (float) --
The number of vCPU cores in the resource.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
elastiCacheReservedInstances (dict) --
The ElastiCache reserved instances recommendation details.
configuration (dict) --
The ElastiCache reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
lambdaFunction (dict) --
The Lambda function recommendation details.
configuration (dict) --
The Lambda function configuration used for recommendations.
compute (dict) --
Details about the compute configuration.
architecture (string) --
The architecture of the resource.
memorySizeInMB (integer) --
The memory size of the resource.
platform (string) --
The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
vCpu (float) --
The number of vCPU cores in the resource.
costCalculation (dict) --
Cost impact of the recommendation.
pricing (dict) --
Pricing details of the resource recommendation.
estimatedCostAfterDiscounts (float) --
The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
estimatedCostBeforeDiscounts (float) --
The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
estimatedDiscounts (dict) --
The estimated discounts for a recommendation.
otherDiscount (float) --
Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount .
reservedInstancesDiscount (float) --
Estimated reserved instance discounts.
savingsPlansDiscount (float) --
Estimated Savings Plans discounts.
estimatedNetUnusedAmortizedCommitments (float) --
The estimated net unused amortized commitment for the recommendation.
usages (list) --
Usage details of the resource recommendation.
(dict) --
Details about the usage.
operation (string) --
The operation value.
productCode (string) --
The product code.
unit (string) --
The usage unit.
usageAmount (float) --
The usage amount.
usageType (string) --
The usage type.
openSearchReservedInstances (dict) --
The OpenSearch reserved instances recommendation details.
configuration (dict) --
The OpenSearch reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
rdsReservedInstances (dict) --
The RDS reserved instances recommendation details.
configuration (dict) --
The RDS reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
databaseEdition (string) --
The database edition that the recommended reservation supports.
databaseEngine (string) --
The database engine that the recommended reservation supports.
deploymentOption (string) --
Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
licenseModel (string) --
The license model that the recommended reservation supports.
monthlyRecurringCost (string) --
How much purchasing this instance costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
redshiftReservedInstances (dict) --
The Redshift reserved instances recommendation details.
configuration (dict) --
The Redshift reserved instances configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
currentGeneration (string) --
Determines whether the recommendation is for a current generation instance.
instanceFamily (string) --
The instance family of the recommended reservation.
instanceType (string) --
The type of instance that Amazon Web Services recommends.
monthlyRecurringCost (string) --
How much purchasing reserved instances costs you on a monthly basis.
normalizedUnitsToPurchase (string) --
The number of normalized units that Amazon Web Services recommends that you purchase.
numberOfInstancesToPurchase (string) --
The number of instances that Amazon Web Services recommends that you purchase.
paymentOption (string) --
The payment option for the commitment.
reservedInstancesRegion (string) --
The Amazon Web Services Region of the commitment.
service (string) --
The service that you want your recommendations for.
sizeFlexEligible (boolean) --
Determines whether the recommendation is size flexible.
term (string) --
The reserved instances recommendation term in years.
upfrontCost (string) --
How much purchasing this instance costs you upfront.
costCalculation (dict) --
Cost impact of the purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyAmortizedReservationCost (float) --
The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
estimatedOnDemandCost (float) --
The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
monthlyReservationEligibleCost (float) --
The cost of paying for the recommended reserved instance monthly.
savingsPercentage (float) --
The savings percentage relative to the total On-Demand costs that are associated with this instance.
sageMakerSavingsPlans (dict) --
The SageMaker Savings Plans recommendation details.
configuration (dict) --
The SageMaker Savings Plans configuration used for recommendations.
accountScope (string) --
The account scope that you want your recommendations for.
hourlyCommitment (string) --
The hourly commitment for the Savings Plans type.
paymentOption (string) --
The payment option for the commitment.
term (string) --
The Savings Plans recommendation term in years.
costCalculation (dict) --
Cost impact of the Savings Plans purchase recommendation.
pricing (dict) --
Pricing details of the purchase recommendation.
estimatedMonthlyCommitment (float) --
Estimated monthly commitment for the Savings Plan.
estimatedOnDemandCost (float) --
Estimated On-Demand cost you will pay after buying the Savings Plan.
monthlySavingsPlansEligibleCost (float) --
The cost of paying for the recommended Savings Plan monthly.
savingsPercentage (float) --
Estimated savings as a percentage of your overall costs after buying the Savings Plan.
recommendedResourceType (string) --
The resource type of the recommendation.
region (string) --
The Amazon Web Services Region of the resource.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource.
resourceId (string) --
The unique identifier for the resource. This is the same as the Amazon Resource Name (ARN), if available.
restartNeeded (boolean) --
Whether or not implementing the recommendation requires a restart.
rollbackPossible (boolean) --
Whether or not implementing the recommendation can be rolled back.
source (string) --
The source of the recommendation.
tags (list) --
A list of tags associated with the resource for which the recommendation exists.
(dict) --
The tag structure that contains a tag key and value.
key (string) --
The key that's associated with the tag.
value (string) --
The value that's associated with the tag.
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.
See also: AWS API Documentation
Request Syntax
client.update_enrollment_status(
includeMemberAccounts=True|False,
status='Active'|'Inactive'
)
boolean
Indicates whether to enroll member accounts of the organization if the account is the management account.
string
[REQUIRED]
Sets the account status.
dict
Response Syntax
{
'status': 'string'
}
Response Structure
(dict) --
status (string) --
The enrollment status of the account.