Table of Contents
ComputeOptimizer.Client¶A low-level client representing AWS Compute Optimizer
Compute Optimizer is a service that analyzes the configuration and utilization metrics of your Amazon Web Services compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, and Amazon EBS volumes. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, in addition to projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the Compute Optimizer User Guide .
import boto3
client = boto3.client('compute-optimizer')
These are the available methods:
can_paginate()close()delete_recommendation_preferences()describe_recommendation_export_jobs()export_auto_scaling_group_recommendations()export_ebs_volume_recommendations()export_ec2_instance_recommendations()export_lambda_function_recommendations()get_auto_scaling_group_recommendations()get_ebs_volume_recommendations()get_ec2_instance_recommendations()get_ec2_recommendation_projected_metrics()get_effective_recommendation_preferences()get_enrollment_status()get_enrollment_statuses_for_organization()get_lambda_function_recommendations()get_paginator()get_recommendation_preferences()get_recommendation_summaries()get_waiter()put_recommendation_preferences()update_enrollment_status()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
delete_recommendation_preferences(**kwargs)¶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
response = client.delete_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
recommendationPreferenceNames=[
'EnhancedInfrastructureMetrics'|'InferredWorkloadTypes',
]
)
[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 .
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 .
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.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.
[REQUIRED]
The name of the recommendation preference to delete.
Enhanced infrastructure metrics (EnhancedInfrastructureMetrics ) is the only feature that can be activated through preferences. Therefore, it is also the only recommendation preference that can be deleted.
dict
Response Syntax
{}
Response Structure
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptiondescribe_recommendation_export_jobs(**kwargs)¶Describes recommendation export jobs created in the last seven days.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
See also: AWS API Documentation
Request Syntax
response = client.describe_recommendation_export_jobs(
jobIds=[
'string',
],
filters=[
{
'name': 'ResourceType'|'JobStatus',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
The identification numbers of the export jobs to return.
An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
All export jobs created in the last seven days are returned if this parameter is omitted.
An array of objects to specify a filter that returns a more specific list of export jobs.
Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
Specify ResourceType to return export jobs of a specific resource type (for example, Ec2Instance ).
Specify JobStatus to return export jobs with a specific status (e.g, Complete ).
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Ec2Instance or AutoScalingGroup if you specify the name parameter as ResourceType . There is no filter for EBS volumes because volume recommendations cannot be exported at this time.Queued , InProgress , Complete , or Failed if you specify the name parameter as JobStatus .The maximum number of export jobs to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'recommendationExportJobs': [
{
'jobId': 'string',
'destination': {
's3': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
},
'resourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable',
'status': 'Queued'|'InProgress'|'Complete'|'Failed',
'creationTimestamp': datetime(2015, 1, 1),
'lastUpdatedTimestamp': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recommendationExportJobs (list) --
An array of objects that describe recommendation export jobs.
(dict) --
Describes a recommendation export job.
Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
jobId (string) --
The identification number of the export job.
destination (dict) --
An object that describes the destination of the export file.
s3 (dict) --
An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
resourceType (string) --
The resource type of the exported recommendations.
status (string) --
The status of the export job.
creationTimestamp (datetime) --
The timestamp of when the export job was created.
lastUpdatedTimestamp (datetime) --
The timestamp of when the export job was last updated.
failureReason (string) --
The reason for an export job failure.
nextToken (string) --
The token to use to advance to the next page of export jobs.
This value is null when there are no more pages of export jobs to return.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionexport_auto_scaling_group_recommendations(**kwargs)¶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
response = client.export_auto_scaling_group_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'AutoScalingGroupArn'|'AutoScalingGroupName'|'Finding'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEbsReadOpsPerSecondMaximum'|'UtilizationMetricsEbsWriteOpsPerSecondMaximum'|'UtilizationMetricsEbsReadBytesPerSecondMaximum'|'UtilizationMetricsEbsWriteBytesPerSecondMaximum'|'UtilizationMetricsDiskReadOpsPerSecondMaximum'|'UtilizationMetricsDiskWriteOpsPerSecondMaximum'|'UtilizationMetricsDiskReadBytesPerSecondMaximum'|'UtilizationMetricsDiskWriteBytesPerSecondMaximum'|'UtilizationMetricsNetworkInBytesPerSecondMaximum'|'UtilizationMetricsNetworkOutBytesPerSecondMaximum'|'UtilizationMetricsNetworkPacketsInPerSecondMaximum'|'UtilizationMetricsNetworkPacketsOutPerSecondMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationInstanceType'|'CurrentConfigurationDesiredCapacity'|'CurrentConfigurationMinSize'|'CurrentConfigurationMaxSize'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsConfigurationInstanceType'|'RecommendationOptionsConfigurationDesiredCapacity'|'RecommendationOptionsConfigurationMinSize'|'RecommendationOptionsConfigurationMaxSize'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'LastRefreshTimestamp'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'EffectiveRecommendationPreferencesCpuVendorArchitectures'|'EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics'|'EffectiveRecommendationPreferencesInferredWorkloadTypes'|'InferredWorkloadTypes'|'RecommendationOptionsMigrationEffort',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False,
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
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.
An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.
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.
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 ).
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:
Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.Underprovisioned , Overprovisioned , or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType .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.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 .
[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 .
The name of the Amazon S3 bucket to use as the destination for an export job.
The Amazon S3 bucket prefix for an export job.
The format of the export file.
The only export file format currently supported is Csv .
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.
An object to specify the preferences for the Auto Scaling group recommendations to export.
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionComputeOptimizer.Client.exceptions.LimitExceededExceptionexport_ebs_volume_recommendations(**kwargs)¶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
response = 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',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
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.
An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
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.
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized ).
The value of the filter.
The valid values are Optimized , or NotOptimized .
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 .
[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 .
The name of the Amazon S3 bucket to use as the destination for an export job.
The Amazon S3 bucket prefix for an export job.
The format of the export file.
The only export file format currently supported is Csv .
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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionComputeOptimizer.Client.exceptions.LimitExceededExceptionexport_ec2_instance_recommendations(**kwargs)¶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
response = client.export_ec2_instance_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'InstanceArn'|'InstanceName'|'Finding'|'FindingReasonCodes'|'LookbackPeriodInDays'|'CurrentInstanceType'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEbsReadOpsPerSecondMaximum'|'UtilizationMetricsEbsWriteOpsPerSecondMaximum'|'UtilizationMetricsEbsReadBytesPerSecondMaximum'|'UtilizationMetricsEbsWriteBytesPerSecondMaximum'|'UtilizationMetricsDiskReadOpsPerSecondMaximum'|'UtilizationMetricsDiskWriteOpsPerSecondMaximum'|'UtilizationMetricsDiskReadBytesPerSecondMaximum'|'UtilizationMetricsDiskWriteBytesPerSecondMaximum'|'UtilizationMetricsNetworkInBytesPerSecondMaximum'|'UtilizationMetricsNetworkOutBytesPerSecondMaximum'|'UtilizationMetricsNetworkPacketsInPerSecondMaximum'|'UtilizationMetricsNetworkPacketsOutPerSecondMaximum'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsInstanceType'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPlatformDifferences'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationsSourcesRecommendationSourceArn'|'RecommendationsSourcesRecommendationSourceType'|'LastRefreshTimestamp'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'EffectiveRecommendationPreferencesCpuVendorArchitectures'|'EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics'|'EffectiveRecommendationPreferencesInferredWorkloadTypes'|'InferredWorkloadTypes'|'RecommendationOptionsMigrationEffort',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False,
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
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.
An array of objects to specify a filter that exports a more specific set of instance recommendations.
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.
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 ).
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:
Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.Underprovisioned , Overprovisioned , or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType .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.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 .
[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 .
The name of the Amazon S3 bucket to use as the destination for an export job.
The Amazon S3 bucket prefix for an export job.
The format of the export file.
The only export file format currently supported is Csv .
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.
An object to specify the preferences for the Amazon EC2 instance recommendations to export.
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionComputeOptimizer.Client.exceptions.LimitExceededExceptionexport_lambda_function_recommendations(**kwargs)¶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
response = 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',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
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.
An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.
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.
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 ).
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Optimized , NotOptimized , or Unavailable if you specify the name parameter as Finding .MemoryOverprovisioned , MemoryUnderprovisioned , InsufficientData , or Inconclusive if you specify the name parameter as FindingReasonCode .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 .
[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 .
The name of the Amazon S3 bucket to use as the destination for an export job.
The Amazon S3 bucket prefix for an export job.
The format of the export file.
The only export file format currently supported is Csv .
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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionComputeOptimizer.Client.exceptions.LimitExceededExceptionget_auto_scaling_group_recommendations(**kwargs)¶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
response = client.get_auto_scaling_group_recommendations(
accountIds=[
'string',
],
autoScalingGroupArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
],
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
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.
The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
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.
An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.
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.
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 ).
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:
Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.Underprovisioned , Overprovisioned , or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType .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.An object to specify the preferences for the Auto Scaling group recommendations to return in the response.
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
dict
Response Syntax
{
'nextToken': 'string',
'autoScalingGroupRecommendations': [
{
'accountId': 'string',
'autoScalingGroupArn': 'string',
'autoScalingGroupName': 'string',
'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'utilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'currentConfiguration': {
'desiredCapacity': 123,
'minSize': 123,
'maxSize': 123,
'instanceType': 'string'
},
'recommendationOptions': [
{
'configuration': {
'desiredCapacity': 123,
'minSize': 123,
'maxSize': 123,
'instanceType': 'string'
},
'projectedUtilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'migrationEffort': 'VeryLow'|'Low'|'Medium'|'High'
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1),
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'effectiveRecommendationPreferences': {
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
],
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'inferredWorkloadTypes': 'Active'|'Inactive'
},
'inferredWorkloadTypes': [
'AmazonEmr'|'ApacheCassandra'|'ApacheHadoop'|'Memcached'|'Nginx'|'PostgreSql'|'Redis',
]
},
],
'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: PercentMemory - 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: PercentNote
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: BytesEBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: BytesDISK_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: PercentMemory - 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: PercentNote
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: BytesEBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: BytesDISK_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, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
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.
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:
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.
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.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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_ebs_volume_recommendations(**kwargs)¶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
response = client.get_ebs_volume_recommendations(
volumeArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
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.
An array of objects to specify a filter that returns a more specific list of volume recommendations.
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.
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized ).
The value of the filter.
The valid values are Optimized , or NotOptimized .
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.
dict
Response Syntax
{
'nextToken': 'string',
'volumeRecommendations': [
{
'volumeArn': 'string',
'accountId': 'string',
'currentConfiguration': {
'volumeType': 'string',
'volumeSize': 123,
'volumeBaselineIOPS': 123,
'volumeBurstIOPS': 123,
'volumeBaselineThroughput': 123,
'volumeBurstThroughput': 123
},
'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
},
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1),
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High'
},
],
'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.
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: CountVolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time. Unit: CountVolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time. Unit: BytesVolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time. Unit: Bytesstatistic (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.
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, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
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.
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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_ec2_instance_recommendations(**kwargs)¶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
response = client.get_ec2_instance_recommendations(
instanceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'FindingReasonCodes'|'RecommendationSourceType',
'values': [
'string',
]
},
],
accountIds=[
'string',
],
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
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.
An array of objects to specify a filter that returns a more specific list of instance recommendations.
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.
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 ).
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:
Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.Underprovisioned , Overprovisioned , or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType .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.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.
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
dict
Response Syntax
{
'nextToken': 'string',
'instanceRecommendations': [
{
'instanceArn': 'string',
'accountId': 'string',
'instanceName': 'string',
'currentInstanceType': 'string',
'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'findingReasonCodes': [
'CPUOverprovisioned'|'CPUUnderprovisioned'|'MemoryOverprovisioned'|'MemoryUnderprovisioned'|'EBSThroughputOverprovisioned'|'EBSThroughputUnderprovisioned'|'EBSIOPSOverprovisioned'|'EBSIOPSUnderprovisioned'|'NetworkBandwidthOverprovisioned'|'NetworkBandwidthUnderprovisioned'|'NetworkPPSOverprovisioned'|'NetworkPPSUnderprovisioned'|'DiskIOPSOverprovisioned'|'DiskIOPSUnderprovisioned'|'DiskThroughputOverprovisioned'|'DiskThroughputUnderprovisioned',
],
'utilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'recommendationOptions': [
{
'instanceType': 'string',
'projectedUtilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'platformDifferences': [
'Hypervisor'|'NetworkInterface'|'StorageInterface'|'InstanceStoreAvailability'|'VirtualizationType'|'Architecture',
],
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'migrationEffort': 'VeryLow'|'Low'|'Medium'|'High'
},
],
'recommendationSources': [
{
'recommendationSourceArn': 'string',
'recommendationSourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1),
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'effectiveRecommendationPreferences': {
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
],
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'inferredWorkloadTypes': 'Active'|'Inactive'
},
'inferredWorkloadTypes': [
'AmazonEmr'|'ApacheCassandra'|'ApacheHadoop'|'Memcached'|'Nginx'|'PostgreSql'|'Redis',
]
},
],
'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 VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.EBSThroughputUnderprovisioned ** — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.EBSIOPSOverprovisioned ** — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.EBSIOPSUnderprovisioned ** — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.NetworkBandwidthOverprovisioned ** — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period.NetworkBandwidthUnderprovisioned ** — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.NetworkPPSOverprovisioned ** — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.NetworkPPSUnderprovisioned ** — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.DiskIOPSOverprovisioned ** — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.DiskIOPSUnderprovisioned ** — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.DiskThroughputOverprovisioned ** — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.DiskThroughputUnderprovisioned ** — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.Note
For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide . For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide .
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: PercentMemory - 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: PercentNote
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: BytesEBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: BytesDISK_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: PercentMemory - 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: PercentNote
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: CountEBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: BytesEBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: BytesDISK_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 .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, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
migrationEffort (string) --
The level of effort required to migrate from the current instance type to the recommended instance type.
For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.
recommendationSources (list) --
An array of objects that describe the source resource of the recommendation.
(dict) --
Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
recommendationSourceArn (string) --
The Amazon Resource Name (ARN) of the recommendation source.
recommendationSourceType (string) --
The resource type of the recommendation source.
lastRefreshTimestamp (datetime) --
The timestamp of when the instance recommendation was last generated.
currentPerformanceRisk (string) --
The risk of the current instance not meeting the performance needs of its workloads. The higher the risk, the more likely the current instance cannot meet the performance requirements of its workload.
effectiveRecommendationPreferences (dict) --
An object that describes the effective recommendation preferences for the instance.
cpuVendorArchitectures (list) --
Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
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.
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.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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_ec2_recommendation_projected_metrics(**kwargs)¶Returns the projected utilization metrics of Amazon EC2 instance recommendations.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
See also: AWS API Documentation
Request Syntax
response = client.get_ec2_recommendation_projected_metrics(
instanceArn='string',
stat='Maximum'|'Average',
period=123,
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
[REQUIRED]
The statistic of the projected metrics.
[REQUIRED]
The granularity, in seconds, of the projected metrics data points.
[REQUIRED]
The timestamp of the first projected metrics data point to return.
[REQUIRED]
The timestamp of the last projected metrics data point to return.
An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
dict
Response Syntax
{
'recommendedOptionProjectedMetrics': [
{
'recommendedInstanceType': 'string',
'rank': 123,
'projectedMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND'|'DISK_READ_OPS_PER_SECOND'|'DISK_WRITE_OPS_PER_SECOND'|'DISK_READ_BYTES_PER_SECOND'|'DISK_WRITE_BYTES_PER_SECOND'|'NETWORK_IN_BYTES_PER_SECOND'|'NETWORK_OUT_BYTES_PER_SECOND'|'NETWORK_PACKETS_IN_PER_SECOND'|'NETWORK_PACKETS_OUT_PER_SECOND',
'timestamps': [
datetime(2015, 1, 1),
],
'values': [
123.0,
]
},
]
},
]
}
Response Structure
(dict) --
recommendedOptionProjectedMetrics (list) --
An array of objects that describes projected metrics.
(dict) --
Describes a projected utilization metric of a recommendation option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
recommendedInstanceType (string) --
The recommended instance type.
rank (integer) --
The rank of the recommendation option projected metric.
The top recommendation option is ranked as 1 .
The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.
projectedMetrics (list) --
An array of objects that describe a projected utilization metric.
(dict) --
Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
name (string) --
The name of the projected utilization metric.
The following projected utilization metrics are returned:
Cpu - The projected percentage of allocated EC2 compute units that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the processing power required to run an application on the recommendation option. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: PercentMemory - The percentage of memory that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option. Units: PercentNote
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
timestamps (list) --
The timestamps of the projected utilization metric.
values (list) --
The values of the projected utilization metrics.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_effective_recommendation_preferences(**kwargs)¶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
response = client.get_effective_recommendation_preferences(
resourceArn='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.
{
'enhancedInfrastructureMetrics': 'Active'|'Inactive'
}
Response Structure
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 .
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_enrollment_status()¶Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.
See also: AWS API Documentation
Request Syntax
response = client.get_enrollment_status()
{
'status': 'Active'|'Inactive'|'Pending'|'Failed',
'statusReason': 'string',
'memberAccountsEnrolled': True|False,
'lastUpdatedTimestamp': datetime(2015, 1, 1),
'numberOfMemberAccountsOptedIn': 123
}
Response Structure
The enrollment status of the account.
The reason for the enrollment status of the account.
For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.
The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
The count of organization member accounts that are opted in to the service, if your account is an organization management account.
Exceptions
ComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_enrollment_statuses_for_organization(**kwargs)¶Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
See also: AWS API Documentation
Request Syntax
response = client.get_enrollment_statuses_for_organization(
filters=[
{
'name': 'Status',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
An array of objects to specify a filter that returns a more specific list of account enrollment statuses.
Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.
The name of the filter.
Specify Status to return accounts with a specific enrollment status (for example, Active ).
The value of the filter.
The valid values are Active , Inactive , Pending , and Failed .
The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'accountEnrollmentStatuses': [
{
'accountId': 'string',
'status': 'Active'|'Inactive'|'Pending'|'Failed',
'statusReason': 'string',
'lastUpdatedTimestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
accountEnrollmentStatuses (list) --
An array of objects that describe the enrollment statuses of organization member accounts.
(dict) --
Describes the enrollment status of an organization's member accounts in Compute Optimizer.
accountId (string) --
The Amazon Web Services account ID.
status (string) --
The account enrollment status.
statusReason (string) --
The reason for the account enrollment status.
For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
lastUpdatedTimestamp (datetime) --
The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
nextToken (string) --
The token to use to advance to the next page of account enrollment statuses.
This value is null when there are no more pages of account enrollment statuses to return.
Exceptions
ComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_lambda_function_recommendations(**kwargs)¶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
response = client.get_lambda_function_recommendations(
functionArns=[
'string',
],
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'FindingReasonCode',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
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 .
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.
An array of objects to specify a filter that returns a more specific list of function recommendations.
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.
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 ).
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Optimized , NotOptimized , or Unavailable if you specify the name parameter as Finding .MemoryOverprovisioned , MemoryUnderprovisioned , InsufficientData , or Inconclusive if you specify the name parameter as FindingReasonCode .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
}
}
},
],
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High'
},
]
}
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.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, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionComputeOptimizer.Client.exceptions.LimitExceededExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_recommendation_preferences(**kwargs)¶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
response = client.get_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
nextToken='string',
maxResults=123
)
[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 .
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 .
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.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.
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',
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'inferredWorkloadTypes': 'Active'|'Inactive'
},
]
}
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.
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) --
The status of the inferred workload types recommendation 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.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_recommendation_summaries(**kwargs)¶Returns the optimization findings for an account.
It returns the number of:
Underprovisioned , Overprovisioned , or Optimized .NotOptimized , or Optimized .NotOptimized , or Optimized .NotOptimized , or Optimized .See also: AWS API Documentation
Request Syntax
response = client.get_recommendation_summaries(
accountIds=[
'string',
],
nextToken='string',
maxResults=123
)
The ID of the Amazon Web Services account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
The maximum number of recommendation summaries to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationSummaries': [
{
'summaries': [
{
'name': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'value': 123.0,
'reasonCodeSummaries': [
{
'name': 'MemoryOverprovisioned'|'MemoryUnderprovisioned',
'value': 123.0
},
]
},
],
'recommendationResourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction',
'accountId': 'string',
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'currentPerformanceRiskRatings': {
'high': 123,
'medium': 123,
'low': 123,
'veryLow': 123
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of recommendation summaries.
This value is null when there are no more pages of recommendation summaries to return.
recommendationSummaries (list) --
An array of objects that summarize a recommendation.
(dict) --
A summary of a recommendation.
summaries (list) --
An array of objects that describe a recommendation summary.
(dict) --
The summary of a recommendation.
name (string) --
The finding classification of the recommendation.
value (float) --
The value of the recommendation summary.
reasonCodeSummaries (list) --
An array of objects that summarize a finding reason code.
(dict) --
A summary of a finding reason code.
name (string) --
The name of the finding reason code.
value (float) --
The value of the finding reason code summary.
recommendationResourceType (string) --
The resource type that the recommendation summary applies to.
accountId (string) --
The Amazon Web Services account ID of the recommendation summary.
savingsOpportunity (dict) --
An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
currentPerformanceRiskRatings (dict) --
An object that describes the performance risk ratings for a given resource type.
high (integer) --
A count of the applicable resource types with a high performance risk rating.
medium (integer) --
A count of the applicable resource types with a medium performance risk rating.
low (integer) --
A count of the applicable resource types with a low performance risk rating.
veryLow (integer) --
A count of the applicable resource types with a very low performance risk rating.
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
put_recommendation_preferences(**kwargs)¶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
response = client.put_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
enhancedInfrastructureMetrics='Active'|'Inactive',
inferredWorkloadTypes='Active'|'Inactive'
)
[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 .
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.
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.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.
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 .
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
Response Syntax
{}
Response Structure
Exceptions
ComputeOptimizer.Client.exceptions.OptInRequiredExceptionComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.ResourceNotFoundExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionupdate_enrollment_status(**kwargs)¶Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide .
When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_enrollment_status(
status='Active'|'Inactive'|'Pending'|'Failed',
includeMemberAccounts=True|False
)
[REQUIRED]
The new enrollment status of the account.
The following status options are available:
Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide .Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.Note
The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.
dict
Response Syntax
{
'status': 'Active'|'Inactive'|'Pending'|'Failed',
'statusReason': 'string'
}
Response Structure
(dict) --
status (string) --
The enrollment status of the account.
statusReason (string) --
The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
Exceptions
ComputeOptimizer.Client.exceptions.InternalServerExceptionComputeOptimizer.Client.exceptions.ServiceUnavailableExceptionComputeOptimizer.Client.exceptions.AccessDeniedExceptionComputeOptimizer.Client.exceptions.InvalidParameterValueExceptionComputeOptimizer.Client.exceptions.MissingAuthenticationTokenComputeOptimizer.Client.exceptions.ThrottlingExceptionThe available paginators are: