2021/05/24 - AWS Compute Optimizer - 5 updated api methods
Changes Adds support for 1) additional instance types, 2) additional instance metrics, 3) finding reasons for instance recommendations, and 4) platform differences between a current instance and a recommended instance type.
{'fieldsToExport': {'UtilizationMetricsDiskReadBytesPerSecondMaximum',
'UtilizationMetricsDiskReadOpsPerSecondMaximum',
'UtilizationMetricsDiskWriteBytesPerSecondMaximum',
'UtilizationMetricsDiskWriteOpsPerSecondMaximum',
'UtilizationMetricsNetworkInBytesPerSecondMaximum',
'UtilizationMetricsNetworkOutBytesPerSecondMaximum',
'UtilizationMetricsNetworkPacketsInPerSecondMaximum',
'UtilizationMetricsNetworkPacketsOutPerSecondMaximum'},
'filters': {'name': {'FindingReasonCodes'}}}
Exports optimization recommendations for Auto Scaling groups.
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 Auto Scaling group export job in progress per AWS Region.
See also: AWS API Documentation
Request Syntax
client.export_auto_scaling_group_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'AutoScalingGroupArn'|'AutoScalingGroupName'|'Finding'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEbsReadOpsPerSecondMaximum'|'UtilizationMetricsEbsWriteOpsPerSecondMaximum'|'UtilizationMetricsEbsReadBytesPerSecondMaximum'|'UtilizationMetricsEbsWriteBytesPerSecondMaximum'|'UtilizationMetricsDiskReadOpsPerSecondMaximum'|'UtilizationMetricsDiskWriteOpsPerSecondMaximum'|'UtilizationMetricsDiskReadBytesPerSecondMaximum'|'UtilizationMetricsDiskWriteBytesPerSecondMaximum'|'UtilizationMetricsNetworkInBytesPerSecondMaximum'|'UtilizationMetricsNetworkOutBytesPerSecondMaximum'|'UtilizationMetricsNetworkPacketsInPerSecondMaximum'|'UtilizationMetricsNetworkPacketsOutPerSecondMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationInstanceType'|'CurrentConfigurationDesiredCapacity'|'CurrentConfigurationMinSize'|'CurrentConfigurationMaxSize'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsConfigurationInstanceType'|'RecommendationOptionsConfigurationDesiredCapacity'|'RecommendationOptionsConfigurationMinSize'|'RecommendationOptionsConfigurationMaxSize'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'LastRefreshTimestamp',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the AWS accounts for which to export Auto Scaling group 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 cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
(string) --
list
An array of objects that describe a filter to export a more specific set of Auto Scaling group 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 (e.g., Underprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., Ec2Instance ).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (e.g., CPUUnderprovisioned ).
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 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]
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the 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.
The only export file format currently supported is Csv .
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 AWS Organizations trusted access in the AWS Compute Optimizer User Guide .
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
s3Destination (dict) --
An object that describes the destination Amazon S3 bucket of a recommendations export 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.
{'fieldsToExport': {'FindingReasonCodes',
'RecommendationOptionsPlatformDifferences',
'UtilizationMetricsDiskReadBytesPerSecondMaximum',
'UtilizationMetricsDiskReadOpsPerSecondMaximum',
'UtilizationMetricsDiskWriteBytesPerSecondMaximum',
'UtilizationMetricsDiskWriteOpsPerSecondMaximum',
'UtilizationMetricsNetworkInBytesPerSecondMaximum',
'UtilizationMetricsNetworkOutBytesPerSecondMaximum',
'UtilizationMetricsNetworkPacketsInPerSecondMaximum',
'UtilizationMetricsNetworkPacketsOutPerSecondMaximum'},
'filters': {'name': {'FindingReasonCodes'}}}
Exports optimization recommendations for Amazon EC2 instances.
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 Amazon EC2 instance export job in progress per AWS Region.
See also: AWS API Documentation
Request Syntax
client.export_ec2_instance_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'InstanceArn'|'InstanceName'|'Finding'|'FindingReasonCodes'|'LookbackPeriodInDays'|'CurrentInstanceType'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEbsReadOpsPerSecondMaximum'|'UtilizationMetricsEbsWriteOpsPerSecondMaximum'|'UtilizationMetricsEbsReadBytesPerSecondMaximum'|'UtilizationMetricsEbsWriteBytesPerSecondMaximum'|'UtilizationMetricsDiskReadOpsPerSecondMaximum'|'UtilizationMetricsDiskWriteOpsPerSecondMaximum'|'UtilizationMetricsDiskReadBytesPerSecondMaximum'|'UtilizationMetricsDiskWriteBytesPerSecondMaximum'|'UtilizationMetricsNetworkInBytesPerSecondMaximum'|'UtilizationMetricsNetworkOutBytesPerSecondMaximum'|'UtilizationMetricsNetworkPacketsInPerSecondMaximum'|'UtilizationMetricsNetworkPacketsOutPerSecondMaximum'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsInstanceType'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPlatformDifferences'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationsSourcesRecommendationSourceArn'|'RecommendationsSourcesRecommendationSourceType'|'LastRefreshTimestamp',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the AWS accounts for which to export 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 export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
(string) --
list
An array of objects that describe a filter to export a more specific set 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 (e.g., Underprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., Ec2Instance ).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (e.g., CPUUnderprovisioned ).
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 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]
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the 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.
The only export file format currently supported is Csv .
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 AWS Organizations trusted access in the AWS Compute Optimizer User Guide .
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
s3Destination (dict) --
An object that describes the destination Amazon S3 bucket of a recommendations export 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.
{'filters': {'name': {'FindingReasonCodes'}}}
Response {'autoScalingGroupRecommendations': {'recommendationOptions': {'projectedUtilizationMetrics': {'name': {'DISK_READ_BYTES_PER_SECOND',
'DISK_READ_OPS_PER_SECOND',
'DISK_WRITE_BYTES_PER_SECOND',
'DISK_WRITE_OPS_PER_SECOND',
'NETWORK_IN_BYTES_PER_SECOND',
'NETWORK_OUT_BYTES_PER_SECOND',
'NETWORK_PACKETS_IN_PER_SECOND',
'NETWORK_PACKETS_OUT_PER_SECOND'}}},
'utilizationMetrics': {'name': {'DISK_READ_BYTES_PER_SECOND',
'DISK_READ_OPS_PER_SECOND',
'DISK_WRITE_BYTES_PER_SECOND',
'DISK_WRITE_OPS_PER_SECOND',
'NETWORK_IN_BYTES_PER_SECOND',
'NETWORK_OUT_BYTES_PER_SECOND',
'NETWORK_PACKETS_IN_PER_SECOND',
'NETWORK_PACKETS_OUT_PER_SECOND'}}}}
Returns Auto Scaling group recommendations.
AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.get_auto_scaling_group_recommendations(
accountIds=[
'string',
],
autoScalingGroupArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
]
)
list
The ID of the AWS account for which to return Auto Scaling group 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 Auto Scaling group recommendations.
Only one account ID can be specified per request.
(string) --
list
The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
(string) --
string
The token to advance to the next page of Auto Scaling group recommendations.
integer
The maximum number of Auto Scaling group 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 that describe a filter that returns a more specific list of Auto Scaling group 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 (e.g., Underprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., Ec2Instance ).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (e.g., CPUUnderprovisioned ).
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) --
dict
Response Syntax
{
'nextToken': 'string',
'autoScalingGroupRecommendations': [
{
'accountId': 'string',
'autoScalingGroupArn': 'string',
'autoScalingGroupName': 'string',
'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'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,
'currentConfiguration': {
'desiredCapacity': 123,
'minSize': 123,
'maxSize': 123,
'instanceType': 'string'
},
'recommendationOptions': [
{
'configuration': {
'desiredCapacity': 123,
'minSize': 123,
'maxSize': 123,
'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
},
],
'performanceRisk': 123.0,
'rank': 123
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1)
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of Auto Scaling group recommendations.
This value is null when there are no more pages of Auto Scaling group recommendations to return.
autoScalingGroupRecommendations (list) --
An array of objects that describe Auto Scaling group recommendations.
(dict) --
Describes an Auto Scaling group recommendation.
accountId (string) --
The AWS account ID of the Auto Scaling group.
autoScalingGroupArn (string) --
The Amazon Resource Name (ARN) of the Auto Scaling group.
autoScalingGroupName (string) --
The name of the Auto Scaling group.
finding (string) --
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
**NotOptimized ** —An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload.
**Optimized ** —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the Auto Scaling group.
(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, AWS Command Line Interface (AWS 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 AWS 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 Auto Scaling group.
currentConfiguration (dict) --
An array of objects that describe the current configuration of the Auto Scaling group.
desiredCapacity (integer) --
The desired capacity, or number of instances, for the Auto Scaling group.
minSize (integer) --
The minimum size, or minimum number of instances, for the Auto Scaling group.
maxSize (integer) --
The maximum size, or maximum number of instances, for the Auto Scaling group.
instanceType (string) --
The instance type for the Auto Scaling group.
recommendationOptions (list) --
An array of objects that describe the recommendation options for the Auto Scaling group.
(dict) --
Describes a recommendation option for an Auto Scaling group.
configuration (dict) --
An array of objects that describe an Auto Scaling group configuration.
desiredCapacity (integer) --
The desired capacity, or number of instances, for the Auto Scaling group.
minSize (integer) --
The minimum size, or minimum number of instances, for the Auto Scaling group.
maxSize (integer) --
The maximum size, or maximum number of instances, for the Auto Scaling group.
instanceType (string) --
The instance type for the Auto Scaling group.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the Auto Scaling group 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, AWS Command Line Interface (AWS 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 AWS 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.
performanceRisk (float) --
The performance risk of the Auto Scaling group configuration recommendation.
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 to 5, 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 recommended resource meets the performance requirements of your workload before migrating your resource.
rank (integer) --
The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as 1 .
lastRefreshTimestamp (datetime) --
The time stamp of when the Auto Scaling group recommendation was last refreshed.
errors (list) --
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.
(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.
{'filters': {'name': {'FindingReasonCodes'}}}
Response {'instanceRecommendations': {'findingReasonCodes': ['CPUOverprovisioned | '
'CPUUnderprovisioned | '
'MemoryOverprovisioned | '
'MemoryUnderprovisioned | '
'EBSThroughputOverprovisioned '
'| '
'EBSThroughputUnderprovisioned '
'| EBSIOPSOverprovisioned '
'| EBSIOPSUnderprovisioned '
'| '
'NetworkBandwidthOverprovisioned '
'| '
'NetworkBandwidthUnderprovisioned '
'| '
'NetworkPPSOverprovisioned '
'| '
'NetworkPPSUnderprovisioned '
'| DiskIOPSOverprovisioned '
'| '
'DiskIOPSUnderprovisioned '
'| '
'DiskThroughputOverprovisioned '
'| '
'DiskThroughputUnderprovisioned'],
'recommendationOptions': {'platformDifferences': ['Hypervisor '
'| '
'NetworkInterface '
'| '
'StorageInterface '
'| '
'InstanceStoreAvailability '
'| '
'VirtualizationType'],
'projectedUtilizationMetrics': {'name': {'DISK_READ_BYTES_PER_SECOND',
'DISK_READ_OPS_PER_SECOND',
'DISK_WRITE_BYTES_PER_SECOND',
'DISK_WRITE_OPS_PER_SECOND',
'NETWORK_IN_BYTES_PER_SECOND',
'NETWORK_OUT_BYTES_PER_SECOND',
'NETWORK_PACKETS_IN_PER_SECOND',
'NETWORK_PACKETS_OUT_PER_SECOND'}}},
'utilizationMetrics': {'name': {'DISK_READ_BYTES_PER_SECOND',
'DISK_READ_OPS_PER_SECOND',
'DISK_WRITE_BYTES_PER_SECOND',
'DISK_WRITE_OPS_PER_SECOND',
'NETWORK_IN_BYTES_PER_SECOND',
'NETWORK_OUT_BYTES_PER_SECOND',
'NETWORK_PACKETS_IN_PER_SECOND',
'NETWORK_PACKETS_OUT_PER_SECOND'}}}}
Returns Amazon EC2 instance recommendations.
AWS 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 AWS 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',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
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 that describe 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 (e.g., Underprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., Ec2Instance ).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (e.g., CPUUnderprovisioned ).
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 AWS 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
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',
],
'performanceRisk': 123.0,
'rank': 123
},
],
'recommendationSources': [
{
'recommendationSourceArn': 'string',
'recommendationSourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1)
},
],
'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 AWS 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, AWS 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 AWS 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 VolumeReadOps and VolumeWriteOps 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 VolumeReadOps and VolumeWriteOps 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 VolumeReadBytes and VolumeWriteBytes 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 VolumeReadBytes and VolumeWriteBytes 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, AWS Command Line Interface (AWS 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 AWS 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, AWS Command Line Interface (AWS 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 AWS 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 will need to 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 AWS 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 .
(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 to 5 , 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 .
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 time stamp of when the instance recommendation was last refreshed.
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.
{'recommendedOptionProjectedMetrics': {'projectedMetrics': {'name': {'DISK_READ_BYTES_PER_SECOND',
'DISK_READ_OPS_PER_SECOND',
'DISK_WRITE_BYTES_PER_SECOND',
'DISK_WRITE_OPS_PER_SECOND',
'NETWORK_IN_BYTES_PER_SECOND',
'NETWORK_OUT_BYTES_PER_SECOND',
'NETWORK_PACKETS_IN_PER_SECOND',
'NETWORK_PACKETS_OUT_PER_SECOND'}}}}
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. 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 .
See also: AWS API Documentation
Request Syntax
client.get_ec2_recommendation_projected_metrics(
instanceArn='string',
stat='Maximum'|'Average',
period=123,
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
string
[REQUIRED]
The statistic of the projected metrics.
integer
[REQUIRED]
The granularity, in seconds, of the projected metrics data points.
datetime
[REQUIRED]
The time stamp of the first projected metrics data point to return.
datetime
[REQUIRED]
The time stamp of the last projected metrics data point to return.
dict
Response Syntax
{
'recommendedOptionProjectedMetrics': [
{
'recommendedInstanceType': 'string',
'rank': 123,
'projectedMetrics': [
{
'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',
'timestamps': [
datetime(2015, 1, 1),
],
'values': [
123.0,
]
},
]
},
]
}
Response Structure
(dict) --
recommendedOptionProjectedMetrics (list) --
An array of objects that describe a projected metrics.
(dict) --
Describes a projected utilization metric of a recommendation option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. 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 .
recommendedInstanceType (string) --
The recommended instance type.
rank (integer) --
The rank of the recommendation option projected metric.
The top recommendation option is ranked as 1 .
The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.
projectedMetrics (list) --
An array of objects that describe a projected utilization metric.
(dict) --
Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period.
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.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. 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 .
name (string) --
The name of the projected utilization metric.
The following projected utilization metrics are returned:
Cpu - The projected percentage of allocated EC2 compute units that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the processing power required to run an application on the recommendation option. 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 would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option. 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 .
timestamps (list) --
The time stamps of the projected utilization metric.
(datetime) --
values (list) --
The values of the projected utilization metrics.
(float) --