2020/12/22 - AWS Cost Explorer Service - 1 updated api methods
Changes This release adds additional metadata that may be applicable to the Rightsizing Recommendations.
{'Metadata': {'AdditionalMetadata': 'string'}}
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the AWS Billing and Cost Management User Guide .
See also: AWS API Documentation
Request Syntax
client.get_rightsizing_recommendation(
Filter={
'Or': [
{'... recursive ...'},
],
'And': [
{'... recursive ...'},
],
'Not': {'... recursive ...'},
'Dimensions': {
'Key': 'AZ'|'INSTANCE_TYPE'|'LINKED_ACCOUNT'|'LINKED_ACCOUNT_NAME'|'OPERATION'|'PURCHASE_TYPE'|'REGION'|'SERVICE'|'SERVICE_CODE'|'USAGE_TYPE'|'USAGE_TYPE_GROUP'|'RECORD_TYPE'|'OPERATING_SYSTEM'|'TENANCY'|'SCOPE'|'PLATFORM'|'SUBSCRIPTION_ID'|'LEGAL_ENTITY_NAME'|'DEPLOYMENT_OPTION'|'DATABASE_ENGINE'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID'|'RESOURCE_ID'|'RIGHTSIZING_TYPE'|'SAVINGS_PLANS_TYPE'|'SAVINGS_PLAN_ARN'|'PAYMENT_OPTION',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
'Tags': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
'CostCategories': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
}
},
Configuration={
'RecommendationTarget': 'SAME_INSTANCE_FAMILY'|'CROSS_INSTANCE_FAMILY',
'BenefitsConsidered': True|False
},
Service='string',
PageSize=123,
NextPageToken='string'
)
dict
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) . The Expression example looks like: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.
{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
Note
For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .
Or (list) --
Return results that match either Dimension object.
(dict) --
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) . The Expression example looks like: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.
{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
Note
For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .
And (list) --
Return results that match both Dimension objects.
(dict) --
Use Expression to filter by cost or by usage. There are two patterns:
Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) . The Expression example looks like: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.
{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
Note
For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .
Not (dict) --
Return results that don't match a Dimension object.
Dimensions (dict) --
The specific Dimension to use for Expression .
Key (string) --
The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
Values (list) --
The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
(string) --
MatchOptions (list) --
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .
(string) --
Tags (dict) --
The specific Tag to use for Expression .
Key (string) --
The key for the tag.
Values (list) --
The specific value of the tag.
(string) --
MatchOptions (list) --
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .
(string) --
CostCategories (dict) --
The filter based on CostCategory values.
Key (string) --
The unique name of the Cost Category.
Values (list) --
The specific value of the Cost Category.
(string) --
MatchOptions (list) --
The match options that you can use to filter your results. MatchOptions is only applicable for only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE .
(string) --
dict
Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
RecommendationTarget (string) -- [REQUIRED]
The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY .
BenefitsConsidered (boolean) -- [REQUIRED]
The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE .
string
[REQUIRED]
The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2 ".
integer
The number of recommendations that you want returned in a single response object.
string
The pagination token that indicates the next set of results that you want to retrieve.
dict
Response Syntax
{
'Metadata': {
'RecommendationId': 'string',
'GenerationTimestamp': 'string',
'LookbackPeriodInDays': 'SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
'AdditionalMetadata': 'string'
},
'Summary': {
'TotalRecommendationCount': 'string',
'EstimatedTotalMonthlySavingsAmount': 'string',
'SavingsCurrencyCode': 'string',
'SavingsPercentage': 'string'
},
'RightsizingRecommendations': [
{
'AccountId': 'string',
'CurrentInstance': {
'ResourceId': 'string',
'InstanceName': 'string',
'Tags': [
{
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
]
},
],
'ResourceDetails': {
'EC2ResourceDetails': {
'HourlyOnDemandRate': 'string',
'InstanceType': 'string',
'Platform': 'string',
'Region': 'string',
'Sku': 'string',
'Memory': 'string',
'NetworkPerformance': 'string',
'Storage': 'string',
'Vcpu': 'string'
}
},
'ResourceUtilization': {
'EC2ResourceUtilization': {
'MaxCpuUtilizationPercentage': 'string',
'MaxMemoryUtilizationPercentage': 'string',
'MaxStorageUtilizationPercentage': 'string',
'EBSResourceUtilization': {
'EbsReadOpsPerSecond': 'string',
'EbsWriteOpsPerSecond': 'string',
'EbsReadBytesPerSecond': 'string',
'EbsWriteBytesPerSecond': 'string'
}
}
},
'ReservationCoveredHoursInLookbackPeriod': 'string',
'SavingsPlansCoveredHoursInLookbackPeriod': 'string',
'OnDemandHoursInLookbackPeriod': 'string',
'TotalRunningHoursInLookbackPeriod': 'string',
'MonthlyCost': 'string',
'CurrencyCode': 'string'
},
'RightsizingType': 'TERMINATE'|'MODIFY',
'ModifyRecommendationDetail': {
'TargetInstances': [
{
'EstimatedMonthlyCost': 'string',
'EstimatedMonthlySavings': 'string',
'CurrencyCode': 'string',
'DefaultTargetInstance': True|False,
'ResourceDetails': {
'EC2ResourceDetails': {
'HourlyOnDemandRate': 'string',
'InstanceType': 'string',
'Platform': 'string',
'Region': 'string',
'Sku': 'string',
'Memory': 'string',
'NetworkPerformance': 'string',
'Storage': 'string',
'Vcpu': 'string'
}
},
'ExpectedResourceUtilization': {
'EC2ResourceUtilization': {
'MaxCpuUtilizationPercentage': 'string',
'MaxMemoryUtilizationPercentage': 'string',
'MaxStorageUtilizationPercentage': 'string',
'EBSResourceUtilization': {
'EbsReadOpsPerSecond': 'string',
'EbsWriteOpsPerSecond': 'string',
'EbsReadBytesPerSecond': 'string',
'EbsWriteBytesPerSecond': 'string'
}
}
}
},
]
},
'TerminateRecommendationDetail': {
'EstimatedMonthlySavings': 'string',
'CurrencyCode': 'string'
}
},
],
'NextPageToken': 'string',
'Configuration': {
'RecommendationTarget': 'SAME_INSTANCE_FAMILY'|'CROSS_INSTANCE_FAMILY',
'BenefitsConsidered': True|False
}
}
Response Structure
(dict) --
Metadata (dict) --
Information regarding this specific recommendation set.
RecommendationId (string) --
The ID for this specific recommendation.
GenerationTimestamp (string) --
The timestamp for when AWS made this recommendation.
LookbackPeriodInDays (string) --
How many days of previous usage that AWS considers when making this recommendation.
AdditionalMetadata (string) --
Additional metadata that may be applicable to the recommendation.
Summary (dict) --
Summary of this recommendation set.
TotalRecommendationCount (string) --
Total number of instance recommendations.
EstimatedTotalMonthlySavingsAmount (string) --
Estimated total savings resulting from modifications, on a monthly basis.
SavingsCurrencyCode (string) --
The currency code that AWS used to calculate the savings.
SavingsPercentage (string) --
Savings percentage based on the recommended modifications, relative to the total On-Demand costs associated with these instances.
RightsizingRecommendations (list) --
Recommendations to rightsize resources.
(dict) --
Recommendations to rightsize resources.
AccountId (string) --
The account that this recommendation is for.
CurrentInstance (dict) --
Context regarding the current instance.
ResourceId (string) --
Resource ID of the current instance.
InstanceName (string) --
The name you've given an instance. This field will show as blank if you haven't given the instance a name.
Tags (list) --
Cost allocation resource tags applied to the instance.
(dict) --
The values that are available for a tag.
Key (string) --
The key for the tag.
Values (list) --
The specific value of the tag.
(string) --
MatchOptions (list) --
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .
(string) --
ResourceDetails (dict) --
Details about the resource and utilization.
EC2ResourceDetails (dict) --
Details on the Amazon EC2 resource.
HourlyOnDemandRate (string) --
Hourly public On-Demand rate for the instance type.
InstanceType (string) --
The type of AWS instance.
Platform (string) --
The platform of the AWS instance. The platform is the specific combination of operating system, license model, and software on an instance.
Region (string) --
The AWS Region of the instance.
Sku (string) --
The SKU of the product.
Memory (string) --
Memory capacity of the AWS instance.
NetworkPerformance (string) --
Network performance capacity of the AWS instance.
Storage (string) --
The disk storage of the AWS instance (not EBS storage).
Vcpu (string) --
Number of VCPU cores in the AWS instance type.
ResourceUtilization (dict) --
Utilization information of the current instance during the lookback period.
EC2ResourceUtilization (dict) --
Utilization of current Amazon EC2 instance.
MaxCpuUtilizationPercentage (string) --
Maximum observed or expected CPU utilization of the instance.
MaxMemoryUtilizationPercentage (string) --
Maximum observed or expected memory utilization of the instance.
MaxStorageUtilizationPercentage (string) --
Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
EBSResourceUtilization (dict) --
The EBS field that contains a list of EBS metrics associated with the current instance.
EbsReadOpsPerSecond (string) --
The maximum number of read operations per second.
EbsWriteOpsPerSecond (string) --
The maximum number of write operations per second.
EbsReadBytesPerSecond (string) --
The maximum size of read operations per second
EbsWriteBytesPerSecond (string) --
The maximum size of write operations per second.
ReservationCoveredHoursInLookbackPeriod (string) --
Number of hours during the lookback period covered by reservations.
SavingsPlansCoveredHoursInLookbackPeriod (string) --
Number of hours during the lookback period covered by Savings Plans.
OnDemandHoursInLookbackPeriod (string) --
Number of hours during the lookback period billed at On-Demand rates.
TotalRunningHoursInLookbackPeriod (string) --
The total number of hours the instance ran during the lookback period.
MonthlyCost (string) --
Current On-Demand cost of operating this instance on a monthly basis.
CurrencyCode (string) --
The currency code that AWS used to calculate the costs for this instance.
RightsizingType (string) --
Recommendation to either terminate or modify the resource.
ModifyRecommendationDetail (dict) --
Details for modification recommendations.
TargetInstances (list) --
Identifies whether this instance type is the AWS default recommendation.
(dict) --
Details on recommended instance.
EstimatedMonthlyCost (string) --
Expected cost to operate this instance type on a monthly basis.
EstimatedMonthlySavings (string) --
Estimated savings resulting from modification, on a monthly basis.
CurrencyCode (string) --
The currency code that AWS used to calculate the costs for this instance.
DefaultTargetInstance (boolean) --
Indicates whether this recommendation is the defaulted AWS recommendation.
ResourceDetails (dict) --
Details on the target instance type.
EC2ResourceDetails (dict) --
Details on the Amazon EC2 resource.
HourlyOnDemandRate (string) --
Hourly public On-Demand rate for the instance type.
InstanceType (string) --
The type of AWS instance.
Platform (string) --
The platform of the AWS instance. The platform is the specific combination of operating system, license model, and software on an instance.
Region (string) --
The AWS Region of the instance.
Sku (string) --
The SKU of the product.
Memory (string) --
Memory capacity of the AWS instance.
NetworkPerformance (string) --
Network performance capacity of the AWS instance.
Storage (string) --
The disk storage of the AWS instance (not EBS storage).
Vcpu (string) --
Number of VCPU cores in the AWS instance type.
ExpectedResourceUtilization (dict) --
Expected utilization metrics for target instance type.
EC2ResourceUtilization (dict) --
Utilization of current Amazon EC2 instance.
MaxCpuUtilizationPercentage (string) --
Maximum observed or expected CPU utilization of the instance.
MaxMemoryUtilizationPercentage (string) --
Maximum observed or expected memory utilization of the instance.
MaxStorageUtilizationPercentage (string) --
Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
EBSResourceUtilization (dict) --
The EBS field that contains a list of EBS metrics associated with the current instance.
EbsReadOpsPerSecond (string) --
The maximum number of read operations per second.
EbsWriteOpsPerSecond (string) --
The maximum number of write operations per second.
EbsReadBytesPerSecond (string) --
The maximum size of read operations per second
EbsWriteBytesPerSecond (string) --
The maximum size of write operations per second.
TerminateRecommendationDetail (dict) --
Details for termination recommendations.
EstimatedMonthlySavings (string) --
Estimated savings resulting from modification, on a monthly basis.
CurrencyCode (string) --
The currency code that AWS used to calculate the costs for this instance.
NextPageToken (string) --
The token to retrieve the next set of results.
Configuration (dict) --
Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
RecommendationTarget (string) --
The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY .
BenefitsConsidered (boolean) --
The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE .