2023/08/28 - AWS Compute Optimizer - 2 new 6 updated api methods
Changes This release enables AWS Compute Optimizer to analyze and generate licensing optimization recommendations for sql server running on EC2 instances.
Export optimization recommendations for your licenses.
Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide .
You can have only one license export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_license_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCode'|'LicenseName',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'ResourceArn'|'LookbackPeriodInDays'|'LastRefreshTimestamp'|'Finding'|'FindingReasonCodes'|'CurrentLicenseConfigurationNumberOfCores'|'CurrentLicenseConfigurationInstanceType'|'CurrentLicenseConfigurationOperatingSystem'|'CurrentLicenseConfigurationLicenseName'|'CurrentLicenseConfigurationLicenseEdition'|'CurrentLicenseConfigurationLicenseModel'|'CurrentLicenseConfigurationLicenseVersion'|'CurrentLicenseConfigurationMetricsSource'|'RecommendationOptionsOperatingSystem'|'RecommendationOptionsLicenseEdition'|'RecommendationOptionsLicenseModel'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'Tags',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the Amazon Web Services accounts for which to export license recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter is omitted, recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
(string) --
list
An array of objects to specify a filter that exports a more specific set of license recommendations.
(dict) --
Describes a filter that returns a more specific list of license recommendations. Use this filter with the GetLicenseRecommendation action.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
Specify FindingReasonCode to return recommendations with a specific finding reason code.
You can filter your license recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your license recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all license recommendations that have a tag with the key of Owner and the value of TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your license recommendations. Use this filter to find all of your license recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your license recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
If you specify the name parameter as Finding , then specify Optimized , NotOptimized , or InsufficentMetrics .
If you specify the name parameter as FindingReasonCode , then specify Optimized , LicenseOverprovisioned , InvalidCloudwatchApplicationInsights , or CloudwatchApplicationInsightsError .
(string) --
list
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide .
(string) --
dict
[REQUIRED]
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide .
bucket (string) --
The name of the Amazon S3 bucket to use as the destination for an export job.
keyPrefix (string) --
The Amazon S3 bucket prefix for an export job.
string
The format of the export file.
A CSV file is the only export format currently supported.
boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide .
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file .
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
s3Destination (dict) --
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
Returns license recommendations for Amazon EC2 instances that run on a specific license.
Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.get_license_recommendations(
resourceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'FindingReasonCode'|'LicenseName',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
list
The ARN that identifies the Amazon EC2 instance.
The following is the format of the ARN:
arn:aws:ec2:region:aws_account_id:instance/instance-id
(string) --
string
The token to advance to the next page of license recommendations.
integer
The maximum number of license recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
list
An array of objects to specify a filter that returns a more specific list of license recommendations.
(dict) --
Describes a filter that returns a more specific list of license recommendations. Use this filter with the GetLicenseRecommendation action.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
Specify FindingReasonCode to return recommendations with a specific finding reason code.
You can filter your license recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your license recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all license recommendations that have a tag with the key of Owner and the value of TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your license recommendations. Use this filter to find all of your license recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your license recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
If you specify the name parameter as Finding , then specify Optimized , NotOptimized , or InsufficentMetrics .
If you specify the name parameter as FindingReasonCode , then specify Optimized , LicenseOverprovisioned , InvalidCloudwatchApplicationInsights , or CloudwatchApplicationInsightsError .
(string) --
list
The ID of the Amazon Web Services account for which to return license recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return license recommendations.
Only one account ID can be specified per request.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'licenseRecommendations': [
{
'resourceArn': 'string',
'accountId': 'string',
'currentLicenseConfiguration': {
'numberOfCores': 123,
'instanceType': 'string',
'operatingSystem': 'string',
'licenseEdition': 'Enterprise'|'Standard'|'Free'|'NoLicenseEditionFound',
'licenseName': 'SQLServer',
'licenseModel': 'LicenseIncluded'|'BringYourOwnLicense',
'licenseVersion': 'string',
'metricsSource': [
{
'provider': 'CloudWatchApplicationInsights',
'providerArn': 'string'
},
]
},
'lookbackPeriodInDays': 123.0,
'lastRefreshTimestamp': datetime(2015, 1, 1),
'finding': 'InsufficientMetrics'|'Optimized'|'NotOptimized',
'findingReasonCodes': [
'InvalidCloudWatchApplicationInsightsSetup'|'CloudWatchApplicationInsightsError'|'LicenseOverprovisioned'|'Optimized',
],
'licenseRecommendationOptions': [
{
'rank': 123,
'operatingSystem': 'string',
'licenseEdition': 'Enterprise'|'Standard'|'Free'|'NoLicenseEditionFound',
'licenseModel': 'LicenseIncluded'|'BringYourOwnLicense',
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of license recommendations.
licenseRecommendations (list) --
An array of objects that describe license recommendations.
(dict) --
Describes a license recommendation for an EC2 instance.
resourceArn (string) --
The ARN that identifies the Amazon EC2 instance.
accountId (string) --
The Amazon Web Services account ID of the license.
currentLicenseConfiguration (dict) --
An object that describes the current configuration of an instance that runs on a license.
numberOfCores (integer) --
The current number of cores associated with the instance.
instanceType (string) --
The instance type used in the license.
operatingSystem (string) --
The operating system of the instance.
licenseEdition (string) --
The edition of the license for the application that runs on the instance.
licenseName (string) --
The name of the license for the application that runs on the instance.
licenseModel (string) --
The license type associated with the instance.
licenseVersion (string) --
The version of the license for the application that runs on the instance.
metricsSource (list) --
The list of metric sources required to generate recommendations for commercial software licenses.
(dict) --
The list of metric sources required to generate recommendations for commercial software licenses.
provider (string) --
The name of the metric source provider.
providerArn (string) --
The ARN of the metric source provider.
lookbackPeriodInDays (float) --
The number of days for which utilization metrics were analyzed for an instance that runs on a license.
lastRefreshTimestamp (datetime) --
The timestamp of when the license recommendation was last generated.
finding (string) --
The finding classification for an instance that runs on a license.
Findings include:
InsufficentMetrics — When Compute Optimizer detects that your CloudWatch Application Insights isn't enabled or is enabled with insufficient permissions.
NotOptimized — When Compute Optimizer detects that your EC2 infrastructure isn't using any of the SQL server license features you're paying for, a license is considered not optimized.
Optimized — When Compute Optimizer detects that all specifications of your license meet the performance requirements of your workload.
findingReasonCodes (list) --
The reason for the finding classification for an instance that runs on a license.
Finding reason codes include:
Optimized — All specifications of your license meet the performance requirements of your workload.
LicenseOverprovisioned — A license is considered over-provisioned when your license can be downgraded while still meeting the performance requirements of your workload.
InvalidCloudwatchApplicationInsights — CloudWatch Application Insights isn't configured properly.
CloudwatchApplicationInsightsError — There is a CloudWatch Application Insights error.
(string) --
licenseRecommendationOptions (list) --
An array of objects that describe the license recommendation options.
(dict) --
Describes the recommendation options for licenses.
rank (integer) --
The rank of the license recommendation option.
The top recommendation option is ranked as 1 .
operatingSystem (string) --
The operating system of a license recommendation option.
licenseEdition (string) --
The recommended edition of the license for the application that runs on the instance.
licenseModel (string) --
The recommended license type associated with the instance.
savingsOpportunity (dict) --
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Warning
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide .
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
tags (list) --
A list of tags assigned to an EC2 instance.
(dict) --
A list of tag key and value pairs that you define.
key (string) --
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
errors (list) --
An array of objects that describe errors of the request.
(dict) --
Describes an error experienced when getting recommendations.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
identifier (string) --
The ID of the error.
code (string) --
The error code.
message (string) --
The message, or reason, for the error.
{'resourceType': {'License'}}
Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.delete_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
recommendationPreferenceNames=[
'EnhancedInfrastructureMetrics'|'InferredWorkloadTypes'|'ExternalMetricsPreference',
]
)
string
[REQUIRED]
The target resource type of the recommendation preference to delete.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
Note
The valid values for this parameter are Ec2Instance and AutoScalingGroup .
dict
An object that describes the scope of the recommendation preference to delete.
You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS .
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
list
[REQUIRED]
The name of the recommendation preference to delete.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'recommendationExportJobs': {'resourceType': {'License'}}}
Describes recommendation export jobs created in the last seven days.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
See also: AWS API Documentation
Request Syntax
client.describe_recommendation_export_jobs(
jobIds=[
'string',
],
filters=[
{
'name': 'ResourceType'|'JobStatus',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
The identification numbers of the export jobs to return.
An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
All export jobs created in the last seven days are returned if this parameter is omitted.
(string) --
list
An array of objects to specify a filter that returns a more specific list of export jobs.
(dict) --
Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
name (string) --
The name of the filter.
Specify ResourceType to return export jobs of a specific resource type (for example, Ec2Instance ).
Specify JobStatus to return export jobs with a specific status (e.g, Complete ).
values (list) --
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as ResourceType . There is no filter for EBS volumes because volume recommendations cannot be exported at this time.
Specify Queued , InProgress , Complete , or Failed if you specify the name parameter as JobStatus .
(string) --
string
The token to advance to the next page of export jobs.
integer
The maximum number of export jobs to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'recommendationExportJobs': [
{
'jobId': 'string',
'destination': {
's3': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
},
'resourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License',
'status': 'Queued'|'InProgress'|'Complete'|'Failed',
'creationTimestamp': datetime(2015, 1, 1),
'lastUpdatedTimestamp': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recommendationExportJobs (list) --
An array of objects that describe recommendation export jobs.
(dict) --
Describes a recommendation export job.
Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
jobId (string) --
The identification number of the export job.
destination (dict) --
An object that describes the destination of the export file.
s3 (dict) --
An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
resourceType (string) --
The resource type of the exported recommendations.
status (string) --
The status of the export job.
creationTimestamp (datetime) --
The timestamp of when the export job was created.
lastUpdatedTimestamp (datetime) --
The timestamp of when the export job was last updated.
failureReason (string) --
The reason for an export job failure.
nextToken (string) --
The token to use to advance to the next page of export jobs.
This value is null when there are no more pages of export jobs to return.
{'instanceRecommendations': {'recommendationSources': {'recommendationSourceType': {'License'}}}}
Returns Amazon EC2 instance recommendations.
Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.get_ec2_instance_recommendations(
instanceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType'|'InferredWorkloadTypes',
'values': [
'string',
]
},
],
accountIds=[
'string',
],
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
list
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
(string) --
string
The token to advance to the next page of instance recommendations.
integer
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
list
An array of objects to specify a filter that returns a more specific list of instance recommendations.
(dict) --
Describes a filter that returns a more specific list of recommendations. Use this filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with the DescribeRecommendationExportJobs action.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification. For example, Underprovisioned .
Specify RecommendationSourceType to return recommendations of a specific resource type. For example, Ec2Instance .
Specify FindingReasonCodes to return recommendations with a specific finding reason code. For example, CPUUnderprovisioned .
Specify InferredWorkloadTypes to return recommendations of a specific inferred workload. For example, Redis .
You can filter your EC2 instance recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all recommendations that have a tag with the key of Owner and the value of TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your recommendations. Use this filter to find all of your recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that you wish to filter results for:
Specify Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.
Specify Underprovisioned , Overprovisioned , or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.
Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType .
Specify one of the following options if you specify the name parameter as FindingReasonCodes :
**CPUOverprovisioned ** — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload.
**CPUUnderprovisioned ** — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance.
**MemoryOverprovisioned ** — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload.
**MemoryUnderprovisioned ** — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance.
**EBSThroughputOverprovisioned ** — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload.
**EBSThroughputUnderprovisioned ** — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance.
**EBSIOPSOverprovisioned ** — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload.
**EBSIOPSUnderprovisioned ** — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance.
**NetworkBandwidthOverprovisioned ** — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload.
**NetworkBandwidthUnderprovisioned ** — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
**NetworkPPSOverprovisioned ** — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload.
**NetworkPPSUnderprovisioned ** — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance.
**DiskIOPSOverprovisioned ** — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload.
**DiskIOPSUnderprovisioned ** — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance.
**DiskThroughputOverprovisioned ** — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload.
**DiskThroughputUnderprovisioned ** — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance.
(string) --
list
The ID of the Amazon Web Services account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
(string) --
dict
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
cpuVendorArchitectures (list) --
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'instanceRecommendations': [
{
'instanceArn': 'string',
'accountId': 'string',
'instanceName': 'string',
'currentInstanceType': 'string',
'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'findingReasonCodes': [
'CPUOverprovisioned'|'CPUUnderprovisioned'|'MemoryOverprovisioned'|'MemoryUnderprovisioned'|'EBSThroughputOverprovisioned'|'EBSThroughputUnderprovisioned'|'EBSIOPSOverprovisioned'|'EBSIOPSUnderprovisioned'|'NetworkBandwidthOverprovisioned'|'NetworkBandwidthUnderprovisioned'|'NetworkPPSOverprovisioned'|'NetworkPPSUnderprovisioned'|'DiskIOPSOverprovisioned'|'DiskIOPSUnderprovisioned'|'DiskThroughputOverprovisioned'|'DiskThroughputUnderprovisioned',
],
'utilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'recommendationOptions': [
{
'instanceType': 'string',
'projectedUtilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'platformDifferences': [
'Hypervisor'|'NetworkInterface'|'StorageInterface'|'InstanceStoreAvailability'|'VirtualizationType'|'Architecture',
],
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'migrationEffort': 'VeryLow'|'Low'|'Medium'|'High'
},
],
'recommendationSources': [
{
'recommendationSourceArn': 'string',
'recommendationSourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'EcsService'|'License'
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1),
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'effectiveRecommendationPreferences': {
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
],
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'inferredWorkloadTypes': 'Active'|'Inactive',
'externalMetricsPreference': {
'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
}
},
'inferredWorkloadTypes': [
'AmazonEmr'|'ApacheCassandra'|'ApacheHadoop'|'Memcached'|'Nginx'|'PostgreSql'|'Redis'|'Kafka'|'SQLServer',
],
'instanceState': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'externalMetricStatus': {
'statusCode': 'NO_EXTERNAL_METRIC_SET'|'INTEGRATION_SUCCESS'|'DATADOG_INTEGRATION_ERROR'|'DYNATRACE_INTEGRATION_ERROR'|'NEWRELIC_INTEGRATION_ERROR'|'INSTANA_INTEGRATION_ERROR'|'INSUFFICIENT_DATADOG_METRICS'|'INSUFFICIENT_DYNATRACE_METRICS'|'INSUFFICIENT_NEWRELIC_METRICS'|'INSUFFICIENT_INSTANA_METRICS',
'statusReason': 'string'
}
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
instanceRecommendations (list) --
An array of objects that describe instance recommendations.
(dict) --
Describes an Amazon EC2 instance recommendation.
instanceArn (string) --
The Amazon Resource Name (ARN) of the current instance.
accountId (string) --
The Amazon Web Services account ID of the instance.
instanceName (string) --
The name of the current instance.
currentInstanceType (string) --
The instance type of the current instance.
finding (string) --
The finding classification of the instance.
Findings for instances include:
**Underprovisioned ** —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
**Overprovisioned ** —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
**Optimized ** —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. For optimized resources, Compute Optimizer might recommend a new generation instance type.
findingReasonCodes (list) --
The reason for the finding classification of the instance.
Finding reason codes for instances include:
**CPUOverprovisioned ** — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
**CPUUnderprovisioned ** — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
**MemoryOverprovisioned ** — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
**MemoryUnderprovisioned ** — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
Note
Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide . On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace.
**EBSThroughputOverprovisioned ** — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period.
**EBSThroughputUnderprovisioned ** — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period.
**EBSIOPSOverprovisioned ** — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period.
**EBSIOPSUnderprovisioned ** — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period.
**NetworkBandwidthOverprovisioned ** — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period.
**NetworkBandwidthUnderprovisioned ** — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
**NetworkPPSOverprovisioned ** — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
**NetworkPPSUnderprovisioned ** — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
**DiskIOPSOverprovisioned ** — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
**DiskIOPSUnderprovisioned ** — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
**DiskThroughputOverprovisioned ** — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
**DiskThroughputUnderprovisioned ** — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
Note
For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide . For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide .
(string) --
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the instance.
(dict) --
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
name (string) --
The name of the utilization metric.
The following utilization metrics are available:
Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent
Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent
Note
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count
EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count
EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes
EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes
DISK_READ_OPS_PER_SECOND - The completed read operations from all instance store volumes available to the instance in a specified period of time. If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_OPS_PER_SECOND - The completed write operations from all instance store volumes available to the instance in a specified period of time. If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application. If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application. If there are no instance store volumes, either the value is 0 or the metric is not reported.
NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance.
NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance.
NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance.
NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance.
statistic (string) --
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide . You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide .
value (float) --
The value of the utilization metric.
lookBackPeriodInDays (float) --
The number of days for which utilization metrics were analyzed for the instance.
recommendationOptions (list) --
An array of objects that describe the recommendation options for the instance.
(dict) --
Describes a recommendation option for an Amazon EC2 instance.
instanceType (string) --
The instance type of the instance recommendation.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the instance recommendation option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
(dict) --
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
name (string) --
The name of the utilization metric.
The following utilization metrics are available:
Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent
Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent
Note
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count
EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count
EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes
EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes
DISK_READ_OPS_PER_SECOND - The completed read operations from all instance store volumes available to the instance in a specified period of time. If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_OPS_PER_SECOND - The completed write operations from all instance store volumes available to the instance in a specified period of time. If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application. If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application. If there are no instance store volumes, either the value is 0 or the metric is not reported.
NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance.
NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance.
NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance.
NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance.
statistic (string) --
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide . You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide .
value (float) --
The value of the utilization metric.
platformDifferences (list) --
Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.
Platform differences include:
**Hypervisor ** — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux , or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows .
**NetworkInterface ** — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux , or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows .
**StorageInterface ** — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux , or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows .
**InstanceStoreAvailability ** — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base . For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux , or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows .
**VirtualizationType ** — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux , or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows .
**Architecture ** — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types .
(string) --
performanceRisk (float) --
The performance risk of the instance recommendation option.
Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.
The value ranges from 0 - 4 , with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.
rank (integer) --
The rank of the instance recommendation option.
The top recommendation option is ranked as 1 .
savingsOpportunity (dict) --
An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
migrationEffort (string) --
The level of effort required to migrate from the current instance type to the recommended instance type.
For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.
recommendationSources (list) --
An array of objects that describe the source resource of the recommendation.
(dict) --
Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
recommendationSourceArn (string) --
The Amazon Resource Name (ARN) of the recommendation source.
recommendationSourceType (string) --
The resource type of the recommendation source.
lastRefreshTimestamp (datetime) --
The timestamp of when the instance recommendation was last generated.
currentPerformanceRisk (string) --
The risk of the current instance not meeting the performance needs of its workloads. The higher the risk, the more likely the current instance cannot meet the performance requirements of its workload.
effectiveRecommendationPreferences (dict) --
An object that describes the effective recommendation preferences for the instance.
cpuVendorArchitectures (list) --
Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.
(string) --
enhancedInfrastructureMetrics (string) --
Describes the activation status of the enhanced infrastructure metrics preference.
A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide .
inferredWorkloadTypes (string) --
Describes the activation status of the inferred workload types preference.
A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not yet applied to recommendations.
externalMetricsPreference (dict) --
An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.
source (string) --
Contains the source options for external metrics preferences.
inferredWorkloadTypes (list) --
The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
AmazonEmr - Infers that Amazon EMR might be running on the instance.
ApacheCassandra - Infers that Apache Cassandra might be running on the instance.
ApacheHadoop - Infers that Apache Hadoop might be running on the instance.
Memcached - Infers that Memcached might be running on the instance.
NGINX - Infers that NGINX might be running on the instance.
PostgreSql - Infers that PostgreSQL might be running on the instance.
Redis - Infers that Redis might be running on the instance.
Kafka - Infers that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
(string) --
instanceState (string) --
The state of the instance when the recommendation was generated.
tags (list) --
A list of tags assigned to your Amazon EC2 instance recommendations.
(dict) --
A list of tag key and value pairs that you define.
key (string) --
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
externalMetricStatus (dict) --
An object that describes Compute Optimizer's integration status with your external metrics provider.
statusCode (string) --
The status code for Compute Optimizer's integration with an external metrics provider.
statusReason (string) --
The reason for Compute Optimizer's integration status with your external metric provider.
errors (list) --
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
(dict) --
Describes an error experienced when getting recommendations.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
identifier (string) --
The ID of the error.
code (string) --
The error code.
message (string) --
The message, or reason, for the error.
{'resourceType': {'License'}}
Response {'recommendationPreferencesDetails': {'resourceType': {'License'}}}
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the scope parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.get_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The target resource type of the recommendation preference for which to return preferences.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
Note
The valid values for this parameter are Ec2Instance and AutoScalingGroup .
dict
An object that describes the scope of the recommendation preference to return.
You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS .
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
string
The token to advance to the next page of recommendation preferences.
integer
The maximum number of recommendation preferences to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationPreferencesDetails': [
{
'scope': {
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
'resourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License',
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'inferredWorkloadTypes': 'Active'|'Inactive',
'externalMetricsPreference': {
'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of recommendation preferences.
This value is null when there are no more pages of recommendation preferences to return.
recommendationPreferencesDetails (list) --
An array of objects that describe recommendation preferences.
(dict) --
Describes a recommendation preference.
scope (dict) --
An object that describes the scope of the recommendation preference.
Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS .
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
resourceType (string) --
The target resource type of the recommendation preference to create.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
enhancedInfrastructureMetrics (string) --
The status of the enhanced infrastructure metrics recommendation preference.
When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide .
inferredWorkloadTypes (string) --
The status of the inferred workload types recommendation preference.
When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
externalMetricsPreference (dict) --
An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.
source (string) --
Contains the source options for external metrics preferences.
{'recommendationSummaries': {'recommendationResourceType': {'License'}}}
Returns the optimization findings for an account.
It returns the number of:
Amazon EC2 instances in an account that are Underprovisioned , Overprovisioned , or Optimized .
Auto Scaling groups in an account that are NotOptimized , or Optimized .
Amazon EBS volumes in an account that are NotOptimized , or Optimized .
Lambda functions in an account that are NotOptimized , or Optimized .
Amazon ECS services in an account that are Underprovisioned , Overprovisioned , or Optimized .
See also: AWS API Documentation
Request Syntax
client.get_recommendation_summaries(
accountIds=[
'string',
],
nextToken='string',
maxResults=123
)
list
The ID of the Amazon Web Services account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
(string) --
string
The token to advance to the next page of recommendation summaries.
integer
The maximum number of recommendation summaries to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationSummaries': [
{
'summaries': [
{
'name': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'value': 123.0,
'reasonCodeSummaries': [
{
'name': 'MemoryOverprovisioned'|'MemoryUnderprovisioned',
'value': 123.0
},
]
},
],
'recommendationResourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'EcsService'|'License',
'accountId': 'string',
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'currentPerformanceRiskRatings': {
'high': 123,
'medium': 123,
'low': 123,
'veryLow': 123
},
'inferredWorkloadSavings': [
{
'inferredWorkloadTypes': [
'AmazonEmr'|'ApacheCassandra'|'ApacheHadoop'|'Memcached'|'Nginx'|'PostgreSql'|'Redis'|'Kafka'|'SQLServer',
],
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of recommendation summaries.
This value is null when there are no more pages of recommendation summaries to return.
recommendationSummaries (list) --
An array of objects that summarize a recommendation.
(dict) --
A summary of a recommendation.
summaries (list) --
An array of objects that describe a recommendation summary.
(dict) --
The summary of a recommendation.
name (string) --
The finding classification of the recommendation.
value (float) --
The value of the recommendation summary.
reasonCodeSummaries (list) --
An array of objects that summarize a finding reason code.
(dict) --
A summary of a finding reason code.
name (string) --
The name of the finding reason code.
value (float) --
The value of the finding reason code summary.
recommendationResourceType (string) --
The resource type that the recommendation summary applies to.
accountId (string) --
The Amazon Web Services account ID of the recommendation summary.
savingsOpportunity (dict) --
An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
currentPerformanceRiskRatings (dict) --
An object that describes the performance risk ratings for a given resource type.
high (integer) --
A count of the applicable resource types with a high performance risk rating.
medium (integer) --
A count of the applicable resource types with a medium performance risk rating.
low (integer) --
A count of the applicable resource types with a low performance risk rating.
veryLow (integer) --
A count of the applicable resource types with a very low performance risk rating.
inferredWorkloadSavings (list) --
An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes . The array contains the top three savings opportunites for the instances running inferred workload types.
(dict) --
The estimated monthly savings after you adjust the configurations of your instances running on the inferred workload types to the recommended configurations. If the inferredWorkloadTypes list contains multiple entries, then the savings are the sum of the monthly savings from instances that run the exact combination of the inferred workload types.
inferredWorkloadTypes (list) --
The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
AmazonEmr - Infers that Amazon EMR might be running on the instance.
ApacheCassandra - Infers that Apache Cassandra might be running on the instance.
ApacheHadoop - Infers that Apache Hadoop might be running on the instance.
Memcached - Infers that Memcached might be running on the instance.
NGINX - Infers that NGINX might be running on the instance.
PostgreSql - Infers that PostgreSQL might be running on the instance.
Redis - Infers that Redis might be running on the instance.
Kafka - Infers that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
(string) --
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
{'resourceType': {'License'}}
Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.put_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
enhancedInfrastructureMetrics='Active'|'Inactive',
inferredWorkloadTypes='Active'|'Inactive',
externalMetricsPreference={
'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
}
)
string
[REQUIRED]
The target resource type of the recommendation preference to create.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
Note
The valid values for this parameter are Ec2Instance and AutoScalingGroup .
dict
An object that describes the scope of the recommendation preference to create.
You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide .
Note
You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS .
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
string
The status of the enhanced infrastructure metrics recommendation preference to create or update.
Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide .
string
The status of the inferred workload types recommendation preference to create or update.
Note
The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.
Specify the Inactive status to deactivate the feature, or specify Active to activate it.
For more information, see Inferred workload types in the Compute Optimizer User Guide .
dict
The provider of the external metrics recommendation preference to create or update.
Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.
This preference can only be set for the Ec2Instance resource type.
For more information, see External metrics ingestion in the Compute Optimizer User Guide .
source (string) --
Contains the source options for external metrics preferences.
dict
Response Syntax
{}
Response Structure
(dict) --