2023/11/27 - AWS Compute Optimizer - 14 updated api methods
Changes This release enables AWS Compute Optimizer to analyze and generate recommendations with customization and discounts preferences.
{'recommendationPreferenceNames': {'LookBackPeriodPreference',
'PreferredResources',
'UtilizationPreferences'}}
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'|'LookBackPeriodPreference'|'PreferredResources'|'UtilizationPreferences',
]
)
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) --
{'fieldsToExport': {'EffectiveRecommendationPreferencesLookBackPeriod',
'EffectiveRecommendationPreferencesPreferredResources',
'EffectiveRecommendationPreferencesSavingsEstimationMode',
'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts',
'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'}}
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) (.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 Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_auto_scaling_group_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType'|'InferredWorkloadTypes',
'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'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'EffectiveRecommendationPreferencesCpuVendorArchitectures'|'EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics'|'EffectiveRecommendationPreferencesInferredWorkloadTypes'|'InferredWorkloadTypes'|'RecommendationOptionsMigrationEffort'|'CurrentInstanceGpuInfo'|'RecommendationOptionsInstanceGpuInfo'|'UtilizationMetricsGpuPercentageMaximum'|'UtilizationMetricsGpuMemoryPercentageMaximum'|'RecommendationOptionsProjectedUtilizationMetricsGpuPercentageMaximum'|'RecommendationOptionsProjectedUtilizationMetricsGpuMemoryPercentageMaximum'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts'|'EffectiveRecommendationPreferencesPreferredResources'|'EffectiveRecommendationPreferencesLookBackPeriod',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False,
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
list
The IDs of the Amazon Web Services 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 to specify a filter that exports 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. 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 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 permissions 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 Amazon Web Services Organizations trusted access in the 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
An object to specify the preferences for the Auto Scaling group recommendations to export.
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
{
'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': {'EffectiveRecommendationPreferencesSavingsEstimationMode',
'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts',
'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'}}
Exports optimization recommendations for Amazon EBS volumes.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.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 EBS volume export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_ebs_volume_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'VolumeArn'|'Finding'|'UtilizationMetricsVolumeReadOpsPerSecondMaximum'|'UtilizationMetricsVolumeWriteOpsPerSecondMaximum'|'UtilizationMetricsVolumeReadBytesPerSecondMaximum'|'UtilizationMetricsVolumeWriteBytesPerSecondMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationVolumeType'|'CurrentConfigurationVolumeBaselineIOPS'|'CurrentConfigurationVolumeBaselineThroughput'|'CurrentConfigurationVolumeBurstIOPS'|'CurrentConfigurationVolumeBurstThroughput'|'CurrentConfigurationVolumeSize'|'CurrentMonthlyPrice'|'RecommendationOptionsConfigurationVolumeType'|'RecommendationOptionsConfigurationVolumeBaselineIOPS'|'RecommendationOptionsConfigurationVolumeBaselineThroughput'|'RecommendationOptionsConfigurationVolumeBurstIOPS'|'RecommendationOptionsConfigurationVolumeBurstThroughput'|'RecommendationOptionsConfigurationVolumeSize'|'RecommendationOptionsMonthlyPrice'|'RecommendationOptionsPerformanceRisk'|'LastRefreshTimestamp'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'RootVolume'|'Tags'|'CurrentConfigurationRootVolume'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume 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 to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
(dict) --
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized ).
You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume 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 Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
The valid values are Optimized , or NotOptimized .
(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.
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 Amazon Web Services Organizations trusted access in the 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) --
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.
{'fieldsToExport': {'EffectiveRecommendationPreferencesLookBackPeriod',
'EffectiveRecommendationPreferencesPreferredResources',
'EffectiveRecommendationPreferencesSavingsEstimationMode',
'EffectiveRecommendationPreferencesUtilizationPreferences',
'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts',
'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'}}
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) (.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 Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_ec2_instance_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType'|'InferredWorkloadTypes',
'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'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'EffectiveRecommendationPreferencesCpuVendorArchitectures'|'EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics'|'EffectiveRecommendationPreferencesInferredWorkloadTypes'|'InferredWorkloadTypes'|'RecommendationOptionsMigrationEffort'|'EffectiveRecommendationPreferencesExternalMetricsSource'|'InstanceState'|'Tags'|'ExternalMetricStatusCode'|'ExternalMetricStatusReason'|'CurrentInstanceGpuInfo'|'RecommendationOptionsInstanceGpuInfo'|'UtilizationMetricsGpuPercentageMaximum'|'UtilizationMetricsGpuMemoryPercentageMaximum'|'RecommendationOptionsProjectedUtilizationMetricsGpuPercentageMaximum'|'RecommendationOptionsProjectedUtilizationMetricsGpuMemoryPercentageMaximum'|'Idle'|'EffectiveRecommendationPreferencesPreferredResources'|'EffectiveRecommendationPreferencesLookBackPeriod'|'EffectiveRecommendationPreferencesUtilizationPreferences'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False,
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
list
The IDs of the Amazon Web Services 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 to specify a filter that exports 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. 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 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 permissions 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 Amazon Web Services Organizations trusted access in the 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
An object to specify the preferences for the Amazon EC2 instance recommendations to export.
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
{
'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': {'EffectiveRecommendationPreferencesSavingsEstimationMode',
'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts',
'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'}}
Exports optimization recommendations for Amazon ECS services on Fargate.
Recommendations are exported in a CSV file, and its metadata in a 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 only have one Amazon ECS service export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_ecs_service_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCode',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'ServiceArn'|'LookbackPeriodInDays'|'LastRefreshTimestamp'|'LaunchType'|'CurrentPerformanceRisk'|'CurrentServiceConfigurationMemory'|'CurrentServiceConfigurationCpu'|'CurrentServiceConfigurationTaskDefinitionArn'|'CurrentServiceConfigurationAutoScalingConfiguration'|'CurrentServiceContainerConfigurations'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'Finding'|'FindingReasonCodes'|'RecommendationOptionsMemory'|'RecommendationOptionsCpu'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'RecommendationOptionsContainerRecommendations'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'Tags'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the 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 Amazon ECS service recommendations.
(dict) --
Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the GetECSServiceRecommendations 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 Amazon ECS service recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service 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 Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service 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:
If you specify the name parameter as Finding , specify Optimized , NotOptimized , or Unavailable .
If you specify the name parameter as FindingReasonCode , specify CPUUnderprovisioned , CPUOverprovisioned , MemoryUnderprovisioned , or MemoryOverprovisioned .
(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.
The CSV file is the only export file format currently supported.
boolean
If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the 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.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
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.
{'fieldsToExport': {'EffectiveRecommendationPreferencesSavingsEstimationMode',
'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts',
'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'}}
Exports optimization recommendations for Lambda functions.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.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 Lambda function export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_lambda_function_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCode',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'FunctionArn'|'FunctionVersion'|'Finding'|'FindingReasonCodes'|'NumberOfInvocations'|'UtilizationMetricsDurationMaximum'|'UtilizationMetricsDurationAverage'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsMemoryAverage'|'LookbackPeriodInDays'|'CurrentConfigurationMemorySize'|'CurrentConfigurationTimeout'|'CurrentCostTotal'|'CurrentCostAverage'|'RecommendationOptionsConfigurationMemorySize'|'RecommendationOptionsCostLow'|'RecommendationOptionsCostHigh'|'RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound'|'RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound'|'RecommendationOptionsProjectedUtilizationMetricsDurationExpected'|'LastRefreshTimestamp'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'Tags'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the Amazon Web Services accounts for which to export Lambda function 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 to specify a filter that exports a more specific set of Lambda function recommendations.
(dict) --
Describes a filter that returns a more specific list of Lambda function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized ).
Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned ).
You can filter your Lambda function recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Lambda function recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Lambda function 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 Lambda function recommendations. Use this filter to find all of your Lambda function recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Lambda function 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:
Specify Optimized , NotOptimized , or Unavailable if you specify the name parameter as Finding .
Specify MemoryOverprovisioned , MemoryUnderprovisioned , InsufficientData , or Inconclusive if you specify the name parameter as FindingReasonCode .
(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.
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 Amazon Web Services Organizations trusted access in the 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) --
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.
{'autoScalingGroupRecommendations': {'effectiveRecommendationPreferences': {'lookBackPeriod': 'DAYS_14 '
'| '
'DAYS_32 '
'| '
'DAYS_93',
'preferredResources': [{'effectiveIncludeList': ['string'],
'excludeList': ['string'],
'includeList': ['string'],
'name': 'Ec2InstanceTypes'}],
'savingsEstimationMode': {'source': 'PublicPricing '
'| '
'CostExplorerRightsizing '
'| '
'CostOptimizationHub'},
'utilizationPreferences': [{'metricName': 'CpuUtilization',
'metricParameters': {'headroom': 'PERCENT_30 '
'| '
'PERCENT_20 '
'| '
'PERCENT_0',
'threshold': 'P90 '
'| '
'P95 '
'| '
'P99_5'}}]},
'recommendationOptions': {'savingsOpportunityAfterDiscounts': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'}}}}
Returns Auto Scaling group recommendations.
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 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'|'InferredWorkloadTypes',
'values': [
'string',
]
},
],
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
list
The ID of the Amazon Web Services 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 to specify 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. 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) --
dict
An object to specify the preferences for the Auto Scaling group 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',
'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'|'GPU_PERCENTAGE'|'GPU_MEMORY_PERCENTAGE',
'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'|'GPU_PERCENTAGE'|'GPU_MEMORY_PERCENTAGE',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'migrationEffort': 'VeryLow'|'Low'|'Medium'|'High',
'instanceGpuInfo': {
'gpus': [
{
'gpuCount': 123,
'gpuMemorySizeInMiB': 123
},
]
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'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'
},
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93',
'utilizationPreferences': [
{
'metricName': 'CpuUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_0'
}
},
],
'preferredResources': [
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'effectiveIncludeList': [
'string',
],
'excludeList': [
'string',
]
},
],
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
}
},
'inferredWorkloadTypes': [
'AmazonEmr'|'ApacheCassandra'|'ApacheHadoop'|'Memcached'|'Nginx'|'PostgreSql'|'Redis'|'Kafka'|'SQLServer',
],
'currentInstanceGpuInfo': {
'gpus': [
{
'gpuCount': 123,
'gpuMemorySizeInMiB': 123
},
]
}
},
],
'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 Amazon Web Services 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 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.
GPU - The percentage of allocated GPUs that currently run on the instance.
GPU_MEMORY - The percentage of total GPU memory that currently runs on the instance.
Note
The GPU and GPU_MEMORY metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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 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.
GPU - The percentage of allocated GPUs that currently run on the instance.
GPU_MEMORY - The percentage of total GPU memory that currently runs on the instance.
Note
The GPU and GPU_MEMORY metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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.
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 - 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 Auto Scaling group recommendation option.
The top recommendation option is ranked as 1 .
savingsOpportunity (dict) --
An object that describes the savings opportunity for the Auto Scaling group 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.
instanceGpuInfo (dict) --
Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.
gpus (list) --
Describes the GPU accelerators for the instance type.
(dict) --
Describes the GPU accelerators for the instance type.
gpuCount (integer) --
The number of GPUs for the instance type.
gpuMemorySizeInMiB (integer) --
The total size of the memory for the GPU accelerators for the instance type, in MiB.
savingsOpportunityAfterDiscounts (dict) --
An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s Auto Scaling group recommendations.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
lastRefreshTimestamp (datetime) --
The timestamp of when the Auto Scaling group recommendation was last generated.
currentPerformanceRisk (string) --
The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.
effectiveRecommendationPreferences (dict) --
An object that describes the effective recommendation preferences for the Auto Scaling group.
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.
lookBackPeriod (string) --
The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
utilizationPreferences (list) --
The resource’s CPU utilization threshold preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.
Note
This preference is only available for the Amazon EC2 instance resource type.
(dict) --
The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
Note
This preference is only available for the Amazon EC2 instance resource type.
metricName (string) --
The name of the resource utilization metric name to customize.
Note
Compute Optimizer only supports CpuUtilization .
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom threshold value in percentage used for the specified metric parameter.
preferredResources (list) --
The resource type values that are considered as candidates when generating rightsizing recommendations.
(dict) --
Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
Note
Compute Optimizer only supports Amazon EC2 instance types.
name (string) --
The name of the preferred resource list.
includeList (list) --
The list of preferred resource values that you want considered as rightsizing recommendation candidates.
(string) --
effectiveIncludeList (list) --
The expanded version of your preferred resource's include list.
(string) --
excludeList (list) --
The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
(string) --
savingsEstimationMode (dict) --
Describes the savings estimation mode applied for calculating savings opportunity for a resource.
source (string) --
Describes the source for calculating the savings opportunity for Amazon EC2 instances.
inferredWorkloadTypes (list) --
The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
AmazonEmr - Infers that Amazon EMR might be running on the instances.
ApacheCassandra - Infers that Apache Cassandra might be running on the instances.
ApacheHadoop - Infers that Apache Hadoop might be running on the instances.
Memcached - Infers that Memcached might be running on the instances.
NGINX - Infers that NGINX might be running on the instances.
PostgreSql - Infers that PostgreSQL might be running on the instances.
Redis - Infers that Redis might be running on the instances.
Kafka - Infers that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
(string) --
currentInstanceGpuInfo (dict) --
Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.
gpus (list) --
Describes the GPU accelerators for the instance type.
(dict) --
Describes the GPU accelerators for the instance type.
gpuCount (integer) --
The number of GPUs for the instance type.
gpuMemorySizeInMiB (integer) --
The total size of the memory for the GPU accelerators for the instance type, in MiB.
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.
{'volumeRecommendations': {'effectiveRecommendationPreferences': {'savingsEstimationMode': {'source': 'PublicPricing '
'| '
'CostExplorerRightsizing '
'| '
'CostOptimizationHub'}},
'volumeRecommendationOptions': {'savingsOpportunityAfterDiscounts': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'}}}}
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
Compute Optimizer generates recommendations for Amazon EBS volumes 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_ebs_volume_recommendations(
volumeArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
list
The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
(string) --
string
The token to advance to the next page of volume recommendations.
integer
The maximum number of volume 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 volume recommendations.
(dict) --
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized ).
You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume 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 Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
The valid values are Optimized , or NotOptimized .
(string) --
list
The ID of the Amazon Web Services account for which to return volume 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 volume recommendations.
Only one account ID can be specified per request.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'volumeRecommendations': [
{
'volumeArn': 'string',
'accountId': 'string',
'currentConfiguration': {
'volumeType': 'string',
'volumeSize': 123,
'volumeBaselineIOPS': 123,
'volumeBurstIOPS': 123,
'volumeBaselineThroughput': 123,
'volumeBurstThroughput': 123,
'rootVolume': True|False
},
'finding': 'Optimized'|'NotOptimized',
'utilizationMetrics': [
{
'name': 'VolumeReadOpsPerSecond'|'VolumeWriteOpsPerSecond'|'VolumeReadBytesPerSecond'|'VolumeWriteBytesPerSecond',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'volumeRecommendationOptions': [
{
'configuration': {
'volumeType': 'string',
'volumeSize': 123,
'volumeBaselineIOPS': 123,
'volumeBurstIOPS': 123,
'volumeBaselineThroughput': 123,
'volumeBurstThroughput': 123,
'rootVolume': True|False
},
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1),
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'effectiveRecommendationPreferences': {
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
}
}
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of volume recommendations.
This value is null when there are no more pages of volume recommendations to return.
volumeRecommendations (list) --
An array of objects that describe volume recommendations.
(dict) --
Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
volumeArn (string) --
The Amazon Resource Name (ARN) of the current volume.
accountId (string) --
The Amazon Web Services account ID of the volume.
currentConfiguration (dict) --
An array of objects that describe the current configuration of the volume.
volumeType (string) --
The volume type.
This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
volumeSize (integer) --
The size of the volume, in GiB.
volumeBaselineIOPS (integer) --
The baseline IOPS of the volume.
volumeBurstIOPS (integer) --
The burst IOPS of the volume.
volumeBaselineThroughput (integer) --
The baseline throughput of the volume.
volumeBurstThroughput (integer) --
The burst throughput of the volume.
rootVolume (boolean) --
Contains the image used to boot the instance during launch.
finding (string) --
The finding classification of the volume.
Findings for volumes include:
NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the volume.
(dict) --
Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.
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:
VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time. Unit: Count
VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time. Unit: Count
VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time. Unit: Bytes
VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time. Unit: Bytes
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 volume.
volumeRecommendationOptions (list) --
An array of objects that describe the recommendation options for the volume.
(dict) --
Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
configuration (dict) --
An array of objects that describe a volume configuration.
volumeType (string) --
The volume type.
This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
volumeSize (integer) --
The size of the volume, in GiB.
volumeBaselineIOPS (integer) --
The baseline IOPS of the volume.
volumeBurstIOPS (integer) --
The burst IOPS of the volume.
volumeBaselineThroughput (integer) --
The baseline throughput of the volume.
volumeBurstThroughput (integer) --
The burst throughput of the volume.
rootVolume (boolean) --
Contains the image used to boot the instance during launch.
performanceRisk (float) --
The performance risk of the volume recommendation option.
Performance risk is the likelihood of the recommended volume type meeting the performance requirement of your workload.
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 volume recommendation option.
The top recommendation option is ranked as 1 .
savingsOpportunity (dict) --
An object that describes the savings opportunity for the EBS volume 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.
savingsOpportunityAfterDiscounts (dict) --
An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost after applying the specific discounts. This saving can be achieved by adopting Compute Optimizer’s Amazon EBS volume recommendations.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon EBS volume recommendations. This saving includes any applicable discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
lastRefreshTimestamp (datetime) --
The timestamp of when the volume recommendation was last generated.
currentPerformanceRisk (string) --
The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.
tags (list) --
A list of tags assigned to your Amazon EBS volume 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.
effectiveRecommendationPreferences (dict) --
Describes the effective recommendation preferences for Amazon EBS volume.
savingsEstimationMode (dict) --
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes.
source (string) --
Describes the source for calculating the savings opportunity for Amazon EBS volumes.
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 volume.
(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.
{'instanceRecommendations': {'effectiveRecommendationPreferences': {'lookBackPeriod': 'DAYS_14 '
'| '
'DAYS_32 '
'| '
'DAYS_93',
'preferredResources': [{'effectiveIncludeList': ['string'],
'excludeList': ['string'],
'includeList': ['string'],
'name': 'Ec2InstanceTypes'}],
'savingsEstimationMode': {'source': 'PublicPricing '
'| '
'CostExplorerRightsizing '
'| '
'CostOptimizationHub'},
'utilizationPreferences': [{'metricName': 'CpuUtilization',
'metricParameters': {'headroom': 'PERCENT_30 '
'| '
'PERCENT_20 '
'| '
'PERCENT_0',
'threshold': 'P90 '
'| '
'P95 '
'| '
'P99_5'}}]},
'recommendationOptions': {'savingsOpportunityAfterDiscounts': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'}}}}
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'|'GPUUnderprovisioned'|'GPUOverprovisioned'|'GPUMemoryUnderprovisioned'|'GPUMemoryOverprovisioned',
],
'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'|'GPU_PERCENTAGE'|'GPU_MEMORY_PERCENTAGE',
'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'|'GPU_PERCENTAGE'|'GPU_MEMORY_PERCENTAGE',
'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',
'instanceGpuInfo': {
'gpus': [
{
'gpuCount': 123,
'gpuMemorySizeInMiB': 123
},
]
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'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'
},
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93',
'utilizationPreferences': [
{
'metricName': 'CpuUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_0'
}
},
],
'preferredResources': [
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'effectiveIncludeList': [
'string',
],
'excludeList': [
'string',
]
},
],
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
}
},
'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'
},
'currentInstanceGpuInfo': {
'gpus': [
{
'gpuCount': 123,
'gpuMemorySizeInMiB': 123
},
]
},
'idle': 'True'|'False'
},
],
'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.
GPU - The percentage of allocated GPUs that currently run on the instance.
GPU_MEMORY - The percentage of total GPU memory that currently runs on the instance.
Note
The GPU and GPU_MEMORY metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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.
GPU - The percentage of allocated GPUs that currently run on the instance.
GPU_MEMORY - The percentage of total GPU memory that currently runs on the instance.
Note
The GPU and GPU_MEMORY metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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.
instanceGpuInfo (dict) --
Describes the GPU accelerator settings for the recommended instance type.
gpus (list) --
Describes the GPU accelerators for the instance type.
(dict) --
Describes the GPU accelerators for the instance type.
gpuCount (integer) --
The number of GPUs for the instance type.
gpuMemorySizeInMiB (integer) --
The total size of the memory for the GPU accelerators for the instance type, in MiB.
savingsOpportunityAfterDiscounts (dict) --
An object that describes the savings opportunity for the instance recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s EC2 instance recommendations.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on pricing after applying the Savings Plans and Reserved Instances discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
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.
lookBackPeriod (string) --
The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
utilizationPreferences (list) --
The resource’s CPU utilization threshold preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.
Note
This preference is only available for the Amazon EC2 instance resource type.
(dict) --
The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
Note
This preference is only available for the Amazon EC2 instance resource type.
metricName (string) --
The name of the resource utilization metric name to customize.
Note
Compute Optimizer only supports CpuUtilization .
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom threshold value in percentage used for the specified metric parameter.
preferredResources (list) --
The resource type values that are considered as candidates when generating rightsizing recommendations.
(dict) --
Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
Note
Compute Optimizer only supports Amazon EC2 instance types.
name (string) --
The name of the preferred resource list.
includeList (list) --
The list of preferred resource values that you want considered as rightsizing recommendation candidates.
(string) --
effectiveIncludeList (list) --
The expanded version of your preferred resource's include list.
(string) --
excludeList (list) --
The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
(string) --
savingsEstimationMode (dict) --
Describes the savings estimation mode applied for calculating savings opportunity for a resource.
source (string) --
Describes the source for calculating the savings opportunity for Amazon EC2 instances.
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.
currentInstanceGpuInfo (dict) --
Describes the GPU accelerator settings for the current instance type.
gpus (list) --
Describes the GPU accelerators for the instance type.
(dict) --
Describes the GPU accelerators for the instance type.
gpuCount (integer) --
The number of GPUs for the instance type.
gpuMemorySizeInMiB (integer) --
The total size of the memory for the GPU accelerators for the instance type, in MiB.
idle (string) --
Describes if an Amazon EC2 instance is idle.
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.
{'ecsServiceRecommendations': {'effectiveRecommendationPreferences': {'savingsEstimationMode': {'source': 'PublicPricing '
'| '
'CostExplorerRightsizing '
'| '
'CostOptimizationHub'}},
'serviceRecommendationOptions': {'savingsOpportunityAfterDiscounts': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'}}}}
Returns Amazon ECS service recommendations.
Compute Optimizer generates recommendations for Amazon ECS services on Fargate 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_ecs_service_recommendations(
serviceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'FindingReasonCode',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
list
The ARN that identifies the Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
(string) --
string
The token to advance to the next page of Amazon ECS service recommendations.
integer
The maximum number of Amazon ECS service 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 Amazon ECS service recommendations.
(dict) --
Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the GetECSServiceRecommendations 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 Amazon ECS service recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service 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 Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service 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:
If you specify the name parameter as Finding , specify Optimized , NotOptimized , or Unavailable .
If you specify the name parameter as FindingReasonCode , specify CPUUnderprovisioned , CPUOverprovisioned , MemoryUnderprovisioned , or MemoryOverprovisioned .
(string) --
list
Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.
You can only specify one account ID per request.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'ecsServiceRecommendations': [
{
'serviceArn': 'string',
'accountId': 'string',
'currentServiceConfiguration': {
'memory': 123,
'cpu': 123,
'containerConfigurations': [
{
'containerName': 'string',
'memorySizeConfiguration': {
'memory': 123,
'memoryReservation': 123
},
'cpu': 123
},
],
'autoScalingConfiguration': 'TargetTrackingScalingCpu'|'TargetTrackingScalingMemory',
'taskDefinitionArn': 'string'
},
'utilizationMetrics': [
{
'name': 'Cpu'|'Memory',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookbackPeriodInDays': 123.0,
'launchType': 'EC2'|'Fargate',
'lastRefreshTimestamp': datetime(2015, 1, 1),
'finding': 'Optimized'|'Underprovisioned'|'Overprovisioned',
'findingReasonCodes': [
'MemoryOverprovisioned'|'MemoryUnderprovisioned'|'CPUOverprovisioned'|'CPUUnderprovisioned',
],
'serviceRecommendationOptions': [
{
'memory': 123,
'cpu': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'projectedUtilizationMetrics': [
{
'name': 'Cpu'|'Memory',
'statistic': 'Maximum'|'Average',
'lowerBoundValue': 123.0,
'upperBoundValue': 123.0
},
],
'containerRecommendations': [
{
'containerName': 'string',
'memorySizeConfiguration': {
'memory': 123,
'memoryReservation': 123
},
'cpu': 123
},
],
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'effectiveRecommendationPreferences': {
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
}
}
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to advance to the next page of Amazon ECS service recommendations.
ecsServiceRecommendations (list) --
An array of objects that describe the Amazon ECS service recommendations.
(dict) --
Describes an Amazon ECS service recommendation.
serviceArn (string) --
The Amazon Resource Name (ARN) of the current Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
accountId (string) --
The Amazon Web Services account ID of the Amazon ECS service.
currentServiceConfiguration (dict) --
The configuration of the current Amazon ECS service.
memory (integer) --
The amount of memory used by the tasks in the Amazon ECS service.
cpu (integer) --
The number of CPU units used by the tasks in the Amazon ECS service.
containerConfigurations (list) --
The container configurations within a task of an Amazon ECS service.
(dict) --
Describes the container configurations within the tasks of your Amazon ECS service.
containerName (string) --
The name of the container.
memorySizeConfiguration (dict) --
The memory size configurations for the container.
memory (integer) --
The amount of memory in the container.
memoryReservation (integer) --
The limit of memory reserve for the container.
cpu (integer) --
The number of CPU units reserved for the container.
autoScalingConfiguration (string) --
Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.
The Auto Scaling configuration methods include:
TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.
TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.
For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide .
taskDefinitionArn (string) --
The task definition ARN used by the tasks in the Amazon ECS service.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the Amazon ECS service.
(dict) --
Describes the utilization metric of an Amazon ECS service.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
name (string) --
The name of the utilization metric.
The following utilization metrics are available:
Cpu — The amount of CPU capacity that's used in the service.
Memory — The amount of memory that's used in the service.
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 the Amazon ECS service utilization metrics were analyzed.
launchType (string) --
The launch type the Amazon ECS service is using.
Note
Compute Optimizer only supports the Fargate launch type.
lastRefreshTimestamp (datetime) --
The timestamp of when the Amazon ECS service recommendation was last generated.
finding (string) --
The finding classification of an Amazon ECS service.
Findings for Amazon ECS services include:
Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.
Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.
Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.
findingReasonCodes (list) --
The reason for the finding classification of an Amazon ECS service.
Finding reason codes for Amazon ECS services include:
CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.
CPUOverprovisioned — The service 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 service during the look-back period.
MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.
MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.
(string) --
serviceRecommendationOptions (list) --
An array of objects that describe the recommendation options for the Amazon ECS service.
(dict) --
Describes the recommendation options for an Amazon ECS service.
memory (integer) --
The memory size of the Amazon ECS service recommendation option.
cpu (integer) --
The CPU size of the Amazon ECS service recommendation option.
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.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the Amazon ECS service recommendation option.
(dict) --
Describes the projected utilization metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
name (string) --
The name of the projected utilization metric.
The following utilization metrics are available:
Cpu — The percentage of allocated compute units that are currently in use on the service tasks.
Memory — The percentage of memory that's currently in use on the service tasks.
statistic (string) --
The statistic of the projected 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.
lowerBoundValue (float) --
The lower bound values for the projected utilization metrics.
upperBoundValue (float) --
The upper bound values for the projected utilization metrics.
containerRecommendations (list) --
The CPU and memory size recommendations for the containers within the task of your Amazon ECS service.
(dict) --
The CPU and memory recommendations for a container within the tasks of your Amazon ECS service.
containerName (string) --
The name of the container.
memorySizeConfiguration (dict) --
The recommended memory size configurations for the container.
memory (integer) --
The amount of memory in the container.
memoryReservation (integer) --
The limit of memory reserve for the container.
cpu (integer) --
The recommended number of CPU units reserved for the container.
savingsOpportunityAfterDiscounts (dict) --
Describes the savings opportunity for Amazon ECS service recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings for Amazon ECS services.
currentPerformanceRisk (string) --
The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.
tags (list) --
A list of tags assigned to your Amazon ECS service 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.
effectiveRecommendationPreferences (dict) --
Describes the effective recommendation preferences for Amazon ECS services.
savingsEstimationMode (dict) --
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon ECS services.
source (string) --
Describes the source for calculating the savings opportunity for Amazon ECS services.
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.
{'lookBackPeriod': 'DAYS_14 | DAYS_32 | DAYS_93',
'preferredResources': [{'effectiveIncludeList': ['string'],
'excludeList': ['string'],
'includeList': ['string'],
'name': 'Ec2InstanceTypes'}],
'utilizationPreferences': [{'metricName': 'CpuUtilization',
'metricParameters': {'headroom': 'PERCENT_30 | '
'PERCENT_20 | '
'PERCENT_0',
'threshold': 'P90 | P95 | '
'P99_5'}}]}
Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.
When you create a recommendation preference, you can set its status to Active or Inactive . Use this action to view the recommendation preferences that are in effect, or Active .
See also: AWS API Documentation
Request Syntax
client.get_effective_recommendation_preferences(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.
dict
Response Syntax
{
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'externalMetricsPreference': {
'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
},
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93',
'utilizationPreferences': [
{
'metricName': 'CpuUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_0'
}
},
],
'preferredResources': [
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'effectiveIncludeList': [
'string',
],
'excludeList': [
'string',
]
},
]
}
Response Structure
(dict) --
enhancedInfrastructureMetrics (string) --
The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.
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.
To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide .
externalMetricsPreference (dict) --
The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.
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.
To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide .
source (string) --
Contains the source options for external metrics preferences.
lookBackPeriod (string) --
The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.
utilizationPreferences (list) --
The resource’s CPU utilization threshold preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.
To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.
(dict) --
The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
Note
This preference is only available for the Amazon EC2 instance resource type.
metricName (string) --
The name of the resource utilization metric name to customize.
Note
Compute Optimizer only supports CpuUtilization .
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom threshold value in percentage used for the specified metric parameter.
preferredResources (list) --
The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.
To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.
(dict) --
Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
Note
Compute Optimizer only supports Amazon EC2 instance types.
name (string) --
The name of the preferred resource list.
includeList (list) --
The list of preferred resource values that you want considered as rightsizing recommendation candidates.
(string) --
effectiveIncludeList (list) --
The expanded version of your preferred resource's include list.
(string) --
excludeList (list) --
The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
(string) --
{'lambdaFunctionRecommendations': {'effectiveRecommendationPreferences': {'savingsEstimationMode': {'source': 'PublicPricing '
'| '
'CostExplorerRightsizing '
'| '
'CostOptimizationHub'}},
'memorySizeRecommendationOptions': {'savingsOpportunityAfterDiscounts': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'}}}}
Returns Lambda function recommendations.
Compute Optimizer generates recommendations for functions 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_lambda_function_recommendations(
functionArns=[
'string',
],
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCode',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
The Amazon Resource Name (ARN) of the functions for which to return recommendations.
You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest ( $LATEST ) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the Lambda Developer Guide .
(string) --
list
The ID of the Amazon Web Services account for which to return function 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 function recommendations.
Only one account ID can be specified per request.
(string) --
list
An array of objects to specify a filter that returns a more specific list of function recommendations.
(dict) --
Describes a filter that returns a more specific list of Lambda function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized ).
Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned ).
You can filter your Lambda function recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Lambda function recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Lambda function 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 Lambda function recommendations. Use this filter to find all of your Lambda function recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Lambda function 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:
Specify Optimized , NotOptimized , or Unavailable if you specify the name parameter as Finding .
Specify MemoryOverprovisioned , MemoryUnderprovisioned , InsufficientData , or Inconclusive if you specify the name parameter as FindingReasonCode .
(string) --
string
The token to advance to the next page of function recommendations.
integer
The maximum number of function recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'nextToken': 'string',
'lambdaFunctionRecommendations': [
{
'functionArn': 'string',
'functionVersion': 'string',
'accountId': 'string',
'currentMemorySize': 123,
'numberOfInvocations': 123,
'utilizationMetrics': [
{
'name': 'Duration'|'Memory',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookbackPeriodInDays': 123.0,
'lastRefreshTimestamp': datetime(2015, 1, 1),
'finding': 'Optimized'|'NotOptimized'|'Unavailable',
'findingReasonCodes': [
'MemoryOverprovisioned'|'MemoryUnderprovisioned'|'InsufficientData'|'Inconclusive',
],
'memorySizeRecommendationOptions': [
{
'rank': 123,
'memorySize': 123,
'projectedUtilizationMetrics': [
{
'name': 'Duration',
'statistic': 'LowerBound'|'UpperBound'|'Expected',
'value': 123.0
},
],
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'effectiveRecommendationPreferences': {
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
}
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of function recommendations.
This value is null when there are no more pages of function recommendations to return.
lambdaFunctionRecommendations (list) --
An array of objects that describe function recommendations.
(dict) --
Describes an Lambda function recommendation.
functionArn (string) --
The Amazon Resource Name (ARN) of the current function.
functionVersion (string) --
The version number of the current function.
accountId (string) --
The Amazon Web Services account ID of the function.
currentMemorySize (integer) --
The amount of memory, in MB, that's allocated to the current function.
numberOfInvocations (integer) --
The number of times your function code was applied during the look-back period.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the function.
(dict) --
Describes a utilization metric of an Lambda function.
name (string) --
The name of the utilization metric.
The following utilization metrics are available:
Duration - The amount of time that your function code spends processing an event.
Memory - The amount of memory used per invocation.
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 function.
lastRefreshTimestamp (datetime) --
The timestamp of when the function recommendation was last generated.
finding (string) --
The finding classification of the function.
Findings for functions include:
Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the InsufficientData and Inconclusive finding reason codes.
Note
Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
findingReasonCodes (list) --
The reason for the finding classification of the function.
Note
Functions that have a finding classification of Optimized don't have a finding reason code.
Finding reason codes for functions include:
MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide . This finding reason code is part of the Unavailable finding classification.
Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
(string) --
memorySizeRecommendationOptions (list) --
An array of objects that describe the memory configuration recommendation options for the function.
(dict) --
Describes a recommendation option for an Lambda function.
rank (integer) --
The rank of the function recommendation option.
The top recommendation option is ranked as 1 .
memorySize (integer) --
The memory size, in MB, of the function recommendation option.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the function recommendation option.
(dict) --
Describes a projected utilization metric of an Lambda function recommendation option.
name (string) --
The name of the projected utilization metric.
statistic (string) --
The statistic of the projected utilization metric.
value (float) --
The values of the projected utilization metrics.
savingsOpportunity (dict) --
An object that describes the savings opportunity for the Lambda function 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.
savingsOpportunityAfterDiscounts (dict) --
An object that describes the savings opportunity for the Lambda recommendation option which includes Saving Plans discounts. Savings opportunity includes the estimated monthly savings and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
currentPerformanceRisk (string) --
The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
tags (list) --
A list of tags assigned to your Lambda function 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.
effectiveRecommendationPreferences (dict) --
Describes the effective recommendation preferences for Lambda functions.
savingsEstimationMode (dict) --
Describes the savings estimation mode applied for calculating savings opportunity for Lambda functions.
source (string) --
Describes the source for calculation of savings opportunity for Lambda functions.
{'recommendationPreferencesDetails': {'lookBackPeriod': 'DAYS_14 | DAYS_32 | '
'DAYS_93',
'preferredResources': [{'effectiveIncludeList': ['string'],
'excludeList': ['string'],
'includeList': ['string'],
'name': 'Ec2InstanceTypes'}],
'savingsEstimationMode': 'AfterDiscounts '
'| '
'BeforeDiscounts',
'utilizationPreferences': [{'metricName': 'CpuUtilization',
'metricParameters': {'headroom': 'PERCENT_30 '
'| '
'PERCENT_20 '
'| '
'PERCENT_0',
'threshold': 'P90 '
'| '
'P95 '
'| '
'P99_5'}}]}}
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'
},
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93',
'utilizationPreferences': [
{
'metricName': 'CpuUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_0'
}
},
],
'preferredResources': [
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'effectiveIncludeList': [
'string',
],
'excludeList': [
'string',
]
},
],
'savingsEstimationMode': 'AfterDiscounts'|'BeforeDiscounts'
},
]
}
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.
lookBackPeriod (string) --
The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
utilizationPreferences (list) --
The preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.
Note
This preference is only available for the Amazon EC2 instance resource type.
(dict) --
The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
Note
This preference is only available for the Amazon EC2 instance resource type.
metricName (string) --
The name of the resource utilization metric name to customize.
Note
Compute Optimizer only supports CpuUtilization .
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom threshold value in percentage used for the specified metric parameter.
preferredResources (list) --
The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
(dict) --
Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
Note
Compute Optimizer only supports Amazon EC2 instance types.
name (string) --
The name of the preferred resource list.
includeList (list) --
The list of preferred resource values that you want considered as rightsizing recommendation candidates.
(string) --
effectiveIncludeList (list) --
The expanded version of your preferred resource's include list.
(string) --
excludeList (list) --
The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
(string) --
savingsEstimationMode (string) --
Describes the savings estimation mode used for calculating savings opportunity.
Only the account manager or delegated administrator of your organization can activate this preference.
{'lookBackPeriod': 'DAYS_14 | DAYS_32 | DAYS_93',
'preferredResources': [{'excludeList': ['string'],
'includeList': ['string'],
'name': 'Ec2InstanceTypes'}],
'savingsEstimationMode': 'AfterDiscounts | BeforeDiscounts',
'utilizationPreferences': [{'metricName': 'CpuUtilization',
'metricParameters': {'headroom': 'PERCENT_30 | '
'PERCENT_20 | '
'PERCENT_0',
'threshold': 'P90 | P95 | '
'P99_5'}}]}
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'
},
lookBackPeriod='DAYS_14'|'DAYS_32'|'DAYS_93',
utilizationPreferences=[
{
'metricName': 'CpuUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_0'
}
},
],
preferredResources=[
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'excludeList': [
'string',
]
},
],
savingsEstimationMode='AfterDiscounts'|'BeforeDiscounts'
)
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.
string
The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14 .
Note
You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.
list
The preference to control the resource’s CPU utilization thresholds - threshold and headroom. When this preference isn't specified, we use the following default values:
P99_5 for threshold
PERCENT_17 for headroom
Note
You can only set this preference for the Amazon EC2 instance resource type.
(dict) --
The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
Note
This preference is only available for the Amazon EC2 instance resource type.
metricName (string) --
The name of the resource utilization metric name to customize.
Note
Compute Optimizer only supports CpuUtilization .
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom threshold value in percentage used for the specified metric parameter.
list
The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList . If the preference is an empty set of resource type values, an error occurs.
Note
You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.
(dict) --
The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList . If the preference is an empty set of resource type values, an error occurs. For more information, see Rightsizing recommendation preferences in the Compute Optimizer User Guide .
Note
This preference is only available for the Amazon EC2 instance and Auto Scaling group resource types.
Compute Optimizer only supports the customization of Ec2InstanceTypes .
name (string) --
The type of preferred resource to customize.
Note
Compute Optimizer only supports the customization of Ec2InstanceTypes .
includeList (list) --
The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
(string) --
excludeList (list) --
The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
(string) --
string
The status of the savings estimation mode preference to create or update.
Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.
Only the account manager or delegated administrator of your organization can activate this preference.
For more information, see Savings estimation mode in the Compute Optimizer User Guide .
dict
Response Syntax
{}
Response Structure
(dict) --