Smaws_Client_ComputeOptimizer.Typestype nonrec volume_configuration = {root_volume : root_volume option;Contains the image used to boot the instance during launch.
*)volume_burst_throughput : volume_burst_throughput option;The burst throughput of the volume.
*)volume_baseline_throughput : volume_baseline_throughput option;The baseline throughput of the volume.
*)volume_burst_iop_s : volume_burst_iop_s option;The burst IOPS of the volume.
*)volume_baseline_iop_s : volume_baseline_iop_s option;The baseline IOPS of the volume.
*)volume_size : volume_size option;The size of the volume, in GiB.
*)volume_type : volume_type option;The volume type.
The volume types can be the following:
gp2 and gp3io1, io2, and io2 Block Expressst1sc1standard}Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.
type nonrec ebs_utilization_metric = {value : metric_value option;The value of the utilization metric.
*)statistic : metric_statistic option;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.
name : ebs_metric_name option;The name of the utilization metric.
The following utilization metrics are available:
VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
Unit: Count
VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
Unit: Count
VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
Unit: Bytes
VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
Unit: Bytes
VolumeIOPSExceeded - Indicates whether the volume's provisioned IOPS performance was exceeded in a specified period of time. A value of 1 means the provisioned IOPS were exceeded; a value of 0 means they were not.
Unit: None
VolumeThroughputExceeded - Indicates whether the volume's provisioned throughput performance was exceeded in a specified period of time. A value of 1 means the provisioned throughput was exceeded; a value of 0 means it was not.
Unit: None
}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.
type nonrec ebs_utilization_metrics = ebs_utilization_metric listtype nonrec estimated_monthly_savings = {value : value option;The value of the estimated monthly savings.
*)currency : currency option;The currency of the estimated monthly savings.
*)}Describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.
For more information, see Estimated monthly savings and savings opportunities in the Compute Optimizer User Guide.
type nonrec savings_opportunity = {estimated_monthly_savings : estimated_monthly_savings option;An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
*)}Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.
type nonrec ebs_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings.
*)currency : currency option;The currency of the estimated monthly savings.
*)}An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EBS volume recommendations. This includes any applicable discounts.
type nonrec ebs_savings_opportunity_after_discounts = {estimated_monthly_savings : ebs_estimated_monthly_savings option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon EBS volume recommendations. This saving includes any applicable discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost after applying the specific discounts. This saving can be achieved by adopting Compute Optimizer’s Amazon EBS volume recommendations.
*)}Describes the savings opportunity for Amazon EBS volume recommendations after applying specific discounts.
type nonrec volume_recommendation_option = {savings_opportunity_after_discounts : ebs_savings_opportunity_after_discounts
option;An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage.
*)savings_opportunity : savings_opportunity option;An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
*)rank : rank option;The rank of the volume recommendation option.
The top recommendation option is ranked as 1.
performance_risk : performance_risk option;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.
configuration : volume_configuration option;An array of objects that describe a volume configuration.
*)}Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
type nonrec volume_recommendation_options = volume_recommendation_option listtype nonrec ebs_savings_estimation_mode = {source : ebs_savings_estimation_mode_source option;Describes the source for calculating the savings opportunity for Amazon EBS volumes.
*)}Describes the savings estimation mode used for calculating savings opportunity for Amazon EBS volumes.
type nonrec ebs_effective_recommendation_preferences = {look_back_period : look_back_period_preference option;The number of days for which utilization metrics were analyzed for the volume.
*)savings_estimation_mode : ebs_savings_estimation_mode option;Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes.
*)}Describes the effective recommendation preferences for Amazon EBS volumes.
type nonrec tag = {value : tag_value option;One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
*)key : tag_key option;One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
*)}A list of tag key and value pairs that you define.
type nonrec tags = tag listtype nonrec volume_recommendation = {effective_recommendation_preferences : ebs_effective_recommendation_preferences
option;Describes the effective recommendation preferences for Amazon EBS volume.
*)current_performance_risk : current_performance_risk option;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.
*)last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the volume recommendation was last generated.
*)volume_recommendation_options : volume_recommendation_options option;An array of objects that describe the recommendation options for the volume.
*)look_back_period_in_days : look_back_period_in_days option;The number of days for which utilization metrics were analyzed for the volume.
*)utilization_metrics : ebs_utilization_metrics option;An array of objects that describe the utilization metrics of the volume.
*)finding : ebs_finding option;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.current_configuration : volume_configuration option;An array of objects that describe the current configuration of the volume.
*)account_id : account_id option;The Amazon Web Services account ID of the volume.
*)volume_arn : volume_arn option;The Amazon Resource Name (ARN) of the current volume.
*)}Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
type nonrec volume_recommendations = volume_recommendation listtype nonrec volume_arns = volume_arn listtype nonrec very_low = Smaws_Lib.CoreTypes.Int64.ttype nonrec customizable_metric_parameters = {headroom : customizable_metric_headroom option;The headroom value in percentage used for the specified metric parameter.
The following lists the valid values for CPU and memory utilization.
PERCENT_30 | PERCENT_20 | PERCENT_0PERCENT_30 | PERCENT_20 | PERCENT_10threshold : customizable_metric_threshold option;The threshold value used for the specified metric parameter.
You can only specify the threshold value for CPU utilization.
*)}Defines the various metric parameters that can be customized, such as threshold and headroom.
type nonrec utilization_preference = {metric_parameters : customizable_metric_parameters option;The parameters to set when customizing the resource utilization thresholds.
*)metric_name : customizable_metric_name option;The name of the resource utilization metric name to customize.
*)}The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom.
This preference is only available for the Amazon EC2 instance resource type.
type nonrec utilization_preferences = utilization_preference listtype nonrec metric_name = | GPU_MEMORY_PERCENTAGE| GPU_PERCENTAGE| NETWORK_PACKETS_OUT_PER_SECOND| NETWORK_PACKETS_IN_PER_SECOND| NETWORK_OUT_BYTES_PER_SECOND| NETWORK_IN_BYTES_PER_SECOND| DISK_WRITE_BYTES_PER_SECOND| DISK_READ_BYTES_PER_SECOND| DISK_WRITE_OPS_PER_SECOND| DISK_READ_OPS_PER_SECOND| EBS_WRITE_BYTES_PER_SECOND| EBS_READ_BYTES_PER_SECOND| EBS_WRITE_OPS_PER_SECOND| EBS_READ_OPS_PER_SECOND| MEMORY| CPUtype nonrec utilization_metric = {value : metric_value option;The value of the utilization metric.
*)statistic : metric_statistic option;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.
name : metric_name option;The name of the utilization metric.
The following utilization metrics are available:
Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance.
Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.
Units: Percent
Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance.
Units: Percent
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
GPU - The percentage of allocated GPUs that currently run on the instance.GPU_MEMORY - The percentage of total GPU memory that currently runs on the instance.
The GPU and GPU_MEMORY metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU utilization with the CloudWatch Agent.
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time.
Unit: Count
EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time.
Unit: Count
EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time.
Unit: Bytes
EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time.
Unit: Bytes
DISK_READ_OPS_PER_SECOND - The completed read operations from all instance store volumes available to the instance in a specified period of time.
If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_OPS_PER_SECOND - The completed write operations from all instance store volumes available to the instance in a specified period of time.
If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or the metric is not reported.
NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance.NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance.NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance.NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance.}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.
type nonrec utilization_metrics = utilization_metric listtype nonrec update_enrollment_status_response = {status_reason : status_reason option;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.
status : status option;The enrollment status of the account.
*)}type nonrec update_enrollment_status_request = {include_member_accounts : include_member_accounts option;Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
*)status : status;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.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.
}The request was denied due to request throttling.
The request has failed due to a temporary failure of the server.
The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
The value supplied for the input parameter is out of range or not valid.
An internal error has occurred. Try your call again.
You do not have sufficient access to perform this action.
type nonrec timestamps = timestamp listtype nonrec reason_code_summary = {value : summary_value option;The value of the finding reason code summary.
*)name : finding_reason_code option;The name of the finding reason code.
*)}A summary of a finding reason code.
type nonrec reason_code_summaries = reason_code_summary listtype nonrec summary = {reason_code_summaries : reason_code_summaries option;An array of objects that summarize a finding reason code.
*)value : summary_value option;The value of the recommendation summary.
*)name : finding option;The finding classification of the recommendation.
*)}The summary of a recommendation.
type nonrec summaries = summary listtype nonrec memory_size_configuration = {memory_reservation : nullable_memory_reservation option;The limit of memory reserve for the container.
*)memory : nullable_memory option;The amount of memory in the container.
*)}The memory size configurations of a container.
type nonrec container_configuration = {cpu : nullable_cpu option;The number of CPU units reserved for the container.
*)memory_size_configuration : memory_size_configuration option;The memory size configurations for the container.
*)container_name : container_name option;The name of the container.
*)}Describes the container configurations within the tasks of your Amazon ECS service.
type nonrec container_configurations = container_configuration listtype nonrec service_configuration = {task_definition_arn : task_definition_arn option;The task definition ARN used by the tasks in the Amazon ECS service.
*)auto_scaling_configuration : auto_scaling_configuration option;Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.
The Auto Scaling configuration methods include:
TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.
*)container_configurations : container_configurations option;The container configurations within a task of an Amazon ECS service.
*)cpu : nullable_cpu option;The number of CPU units used by the tasks in the Amazon ECS service.
*)memory : nullable_memory option;The amount of memory used by the tasks in the Amazon ECS service.
*)}The Amazon ECS service configurations used for recommendations.
type nonrec service_arns = service_arn listtype nonrec scope = {value : scope_value option;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.
*)name : scope_name option;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.}Describes the scope of a 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.
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.
type nonrec s3_destination_config = {key_prefix : destination_key_prefix option;The Amazon S3 bucket prefix for an export job.
*)bucket : destination_bucket option;The name of the Amazon S3 bucket to use as the destination for an export job.
*)}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.
type nonrec s3_destination = {metadata_key : metadata_key option;The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
*)key : destination_key option;The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
*)bucket : destination_bucket option;The name of the Amazon S3 bucket used as the destination of an export file.
*)}Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
A resource that is required for the action doesn't exist.
type nonrec resource_arns = resource_arn listtype nonrec metric_values = metric_value listtype nonrec projected_metric = {values : metric_values option;The values of the projected utilization metrics.
*)timestamps : timestamps option;The timestamps of the projected utilization metric.
*)name : metric_name option;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.
Memory - The percentage of memory that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option.
Units: Percent
The Memory metric is only returned for resources with the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
GPU - The projected percentage of allocated GPUs if you adjust your configurations to Compute Optimizer's recommendation option.GPU_MEMORY - The projected percentage of total GPU memory if you adjust your configurations to Compute Optimizer's recommendation option.
The GPU and GPU_MEMORY metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU utilization with the CloudWatch Agent.
}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.
The Cpu, Memory, GPU, and GPU_MEMORY metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, these metrics are only returned for resources with the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent and Enabling NVIDIA GPU utilization with the CloudWatch Agent.
type nonrec projected_metrics = projected_metric listtype nonrec recommended_option_projected_metric = {projected_metrics : projected_metrics option;An array of objects that describe a projected utilization metric.
*)rank : rank option;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.
recommended_instance_type : recommended_instance_type option;The recommended instance type.
*)}Describes a projected utilization metric of a recommendation option.
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.
type nonrec recommended_option_projected_metrics =
recommended_option_projected_metric listtype nonrec idle_summary = {value : summary_value option;The count of idle resources in the finding group.
*)name : idle_finding option;The name of the finding group for the idle resources.
*)}Describes the findings summary of the idle resources.
type nonrec idle_summaries = idle_summary listtype nonrec high = Smaws_Lib.CoreTypes.Int64.ttype nonrec medium = Smaws_Lib.CoreTypes.Int64.ttype nonrec low = Smaws_Lib.CoreTypes.Int64.ttype nonrec current_performance_risk_ratings = {very_low : very_low option;A count of the applicable resource types with a very low performance risk rating.
*)low : low option;A count of the applicable resource types with a low performance risk rating.
*)medium : medium option;A count of the applicable resource types with a medium performance risk rating.
*)high : high option;A count of the applicable resource types with a high performance risk rating.
*)}Describes the performance risk ratings for a given resource type.
Resources with a high or medium rating are at risk of not meeting the performance needs of their workloads, while resources with a low rating are performing well in their workloads.
type nonrec inferred_workload_types = inferred_workload_type listtype nonrec inferred_workload_saving = {estimated_monthly_savings : estimated_monthly_savings option;An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.
*)inferred_workload_types : inferred_workload_types option;The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
AmazonEmr - Infers that Amazon EMR might be running on the instance.ApacheCassandra - Infers that Apache Cassandra might be running on the instance.ApacheHadoop - Infers that Apache Hadoop might be running on the instance.Memcached - Infers that Memcached might be running on the instance.NGINX - Infers that NGINX might be running on the instance.PostgreSql - Infers that PostgreSQL might be running on the instance.Redis - Infers that Redis might be running on the instance.Kafka - Infers that Kafka might be running on the instance.SQLServer - Infers that SQLServer might be running on the instance.}The estimated monthly savings after you adjust the configurations of your instances running on the inferred workload types to the recommended configurations. If the inferredWorkloadTypes list contains multiple entries, then the savings are the sum of the monthly savings from instances that run the exact combination of the inferred workload types.
type nonrec inferred_workload_savings = inferred_workload_saving listtype nonrec recommendation_summary = {inferred_workload_savings : inferred_workload_savings option;An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top five savings opportunites for the instances that run inferred workload types.
current_performance_risk_ratings : current_performance_risk_ratings option;An object that describes the performance risk ratings for a given resource type.
*)aggregated_savings_opportunity : savings_opportunity option;idle_savings_opportunity : savings_opportunity option;savings_opportunity : savings_opportunity option;An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.
*)account_id : account_id option;The Amazon Web Services account ID of the recommendation summary.
*)recommendation_resource_type : recommendation_source_type option;The resource type that the recommendation summary applies to.
*)idle_summaries : idle_summaries option;Describes the findings summary of the idle resources.
*)summaries : summaries option;An array of objects that describe a recommendation summary.
*)}A summary of a recommendation.
type nonrec recommendation_summaries = recommendation_summary listtype nonrec recommendation_source = {recommendation_source_type : recommendation_source_type option;The resource type of the recommendation source.
*)recommendation_source_arn : recommendation_source_arn option;The Amazon Resource Name (ARN) of the recommendation source.
*)}Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
type nonrec recommendation_sources = recommendation_source listtype nonrec external_metrics_preference = {source : external_metrics_source option;Contains the source options for external metrics preferences.
*)}Describes the external metrics preferences for EC2 rightsizing recommendations.
type nonrec preferred_resource_values = preferred_resource_value listtype nonrec effective_preferred_resource = {exclude_list : preferred_resource_values option;The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
*)effective_include_list : preferred_resource_values option;The expanded version of your preferred resource's include list.
*)include_list : preferred_resource_values option;The list of preferred resource values that you want considered as rightsizing recommendation candidates.
*)name : preferred_resource_name option;The name of the preferred resource list.
*)}Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
Compute Optimizer only supports Amazon EC2 instance types.
type nonrec effective_preferred_resources = effective_preferred_resource listtype nonrec recommendation_preferences_detail = {savings_estimation_mode : savings_estimation_mode option;Describes the savings estimation mode used for calculating savings opportunity.
Only the account manager or delegated administrator of your organization can activate this preference.
*)preferred_resources : effective_preferred_resources option;The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
*)utilization_preferences : utilization_preferences option;The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. If the preference isn’t set, this object is null.
This preference is only available for the Amazon EC2 instance resource type.
*)look_back_period : look_back_period_preference option;The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
*)external_metrics_preference : external_metrics_preference option;An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.
inferred_workload_types : inferred_workload_types_preference option;The status of the inferred workload types recommendation preference.
When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
enhanced_infrastructure_metrics : enhanced_infrastructure_metrics option;The status of the enhanced infrastructure metrics recommendation preference.
When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
*)resource_type : resource_type option;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.
scope : scope option;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.
*)}Describes a recommendation preference.
type nonrec recommendation_preferences_details =
recommendation_preferences_detail listtype nonrec cpu_vendor_architectures = cpu_vendor_architecture listtype nonrec recommendation_preferences = {cpu_vendor_architectures : cpu_vendor_architectures option;Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton instance types only.GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton instance type recommendations only.ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton instance types only.}Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
type nonrec recommendation_preference_names =
recommendation_preference_name listtype nonrec gpu = {gpu_memory_size_in_mi_b : gpu_memory_size_in_mi_b option;The total size of the memory for the GPU accelerators for the instance type, in MiB.
*)gpu_count : gpu_count option;The number of GPUs for the instance type.
*)}Describes the GPU accelerators for the instance type.
type nonrec gpus = gpu listtype nonrec gpu_info = {gpus : gpus option;Describes the GPU accelerators for the instance type.
*)}Describes the GPU accelerator settings for the instance type.
type nonrec projected_utilization_metrics = utilization_metric listtype nonrec platform_differences = platform_difference listtype nonrec instance_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings.
*)currency : currency option;The currency of the estimated monthly savings.
*)}An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.
type nonrec instance_savings_opportunity_after_discounts = {estimated_monthly_savings : instance_estimated_monthly_savings option;An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on pricing after applying the Savings Plans and Reserved Instances discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s EC2 instance recommendations.
*)}Describes the savings opportunity for instance recommendations after applying the Savings Plans and Reserved Instances discounts.
Savings opportunity after discounts represents the estimated monthly savings you can achieve by implementing Compute Optimizer recommendations.
type nonrec instance_recommendation_option = {migration_effort : migration_effort option;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.
savings_opportunity_after_discounts : instance_savings_opportunity_after_discounts
option;An object that describes the savings opportunity for the instance recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.
*)savings_opportunity : savings_opportunity option;An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
*)rank : rank option;The rank of the instance recommendation option.
The top recommendation option is ranked as 1.
performance_risk : performance_risk option;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.
platform_differences : platform_differences option;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.projected_utilization_metrics : projected_utilization_metrics option;An array of objects that describe the projected utilization metrics of the instance recommendation option.
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.
instance_gpu_info : gpu_info option;Describes the GPU accelerator settings for the recommended instance type.
*)instance_type : instance_type option;The instance type of the instance recommendation.
*)}Describes a recommendation option for an Amazon EC2 instance.
type nonrec recommendation_options = instance_recommendation_option listtype nonrec export_destination = {s3 : s3_destination option;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.
*)}Describes the destination of the recommendations export and metadata files.
type nonrec recommendation_export_job = {failure_reason : failure_reason option;The reason for an export job failure.
*)last_updated_timestamp : last_updated_timestamp option;The timestamp of when the export job was last updated.
*)creation_timestamp : creation_timestamp option;The timestamp of when the export job was created.
*)status : job_status option;The status of the export job.
*)resource_type : resource_type option;The resource type of the exported recommendations.
*)destination : export_destination option;An object that describes the destination of the export file.
*)job_id : job_id option;The identification number of the export job.
*)}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.
type nonrec recommendation_export_jobs = recommendation_export_job listtype nonrec rds_storage_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings for DB instance storage.
*)currency : currency option;The currency of the estimated monthly savings.
*)}Describes the estimated monthly savings possible for DB instance storage by adopting Compute Optimizer recommendations. This is based on DB instance pricing after applying Savings Plans discounts.
type nonrec rds_storage_savings_opportunity_after_discounts = {estimated_monthly_savings : rds_storage_estimated_monthly_savings option;The estimated monthly savings possible by adopting Compute Optimizer’s DB instance storage recommendations. This includes any applicable Savings Plans discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s DB instance storage recommendations. This includes any applicable Savings Plans discounts.
*)}Describes the savings opportunity for Amazon RDS storage recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
type nonrec rds_storage_finding_reason_codes =
rds_storage_finding_reason_code listtype nonrec rds_savings_estimation_mode = {source : rds_savings_estimation_mode_source option;Describes the source for calculating the savings opportunity for DB instances.
*)}Describes the savings estimation mode used for calculating savings opportunity for DB instances.
type nonrec rds_instance_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings for DB instances.
*)currency : currency option;The currency of the estimated monthly savings.
*)}Describes the estimated monthly savings possible for DB instances by adopting Compute Optimizer recommendations. This is based on DB instance pricing after applying Savings Plans discounts.
type nonrec rds_instance_savings_opportunity_after_discounts = {estimated_monthly_savings : rds_instance_estimated_monthly_savings option;The estimated monthly savings possible by adopting Compute Optimizer’s DB instance recommendations. This includes any applicable Savings Plans discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s DB instance recommendations. This includes any applicable Savings Plans discounts.
*)}Describes the savings opportunity for DB instance recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
type nonrec rds_instance_finding_reason_code = | INSTANCE_STORAGE_WRITE_IOPS_UNDER_PROVISIONED| INSTANCE_STORAGE_READ_IOPS_UNDER_PROVISIONED| MEMORY_UNDER_PROVISIONED| DB_CLUSTER_WRITER_UNDER_PROVISIONED| NEW_ENGINE_VERSION_AVAILABLE| NEW_GENERATION_DB_INSTANCE_CLASS_AVAILABLE| EBS_THROUGHPUT_UNDER_PROVISIONED| NETWORK_BANDWIDTH_UNDER_PROVISIONED| CPU_UNDER_PROVISIONED| EBS_THROUGHPUT_OVER_PROVISIONED| EBS_IOPS_UNDER_PROVISIONED| EBS_IOPS_OVER_PROVISIONED| NETWORK_BANDWIDTH_OVER_PROVISIONED| CPU_OVER_PROVISIONEDtype nonrec rds_instance_finding_reason_codes =
rds_instance_finding_reason_code listtype nonrec rds_effective_recommendation_preferences = {savings_estimation_mode : rds_savings_estimation_mode option;Describes the savings estimation mode preference applied for calculating savings opportunity for DB instances.
*)look_back_period : look_back_period_preference option;The number of days the utilization metrics of the DB instance are analyzed.
*)enhanced_infrastructure_metrics : enhanced_infrastructure_metrics option;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.
*)cpu_vendor_architectures : cpu_vendor_architectures option;Describes the CPU vendor and architecture for DB instance recommendations.
*)}Describes the effective recommendation preferences for Amazon Aurora and RDS databases.
type nonrec rdsdb_metric_name = | VOLUME_WRITE_IOPS| VOLUME_BYTES_USED| VOLUME_READ_IOPS| WRITE_IOPS_EPHEMERAL_STORAGE| READ_IOPS_EPHEMERAL_STORAGE| AURORA_MEMORY_NUM_KILL_QUERY_TOTAL| AURORA_MEMORY_NUM_KILL_CONN_TOTAL| AURORA_MEMORY_NUM_DECLINED_SQL| AURORA_MEMORY_HEALTH_STATE| STORAGE_NETWORK_TRANSMIT_THROUGHPUT| STORAGE_NETWORK_RECEIVE_THROUGHPUT| DATABASE_CONNECTIONS| EBS_VOLUME_WRITE_THROUGHPUT| EBS_VOLUME_READ_THROUGHPUT| EBS_VOLUME_WRITE_IOPS| EBS_VOLUME_READ_IOPS| NETWORK_TRANSMIT_THROUGHPUT| NETWORK_RECEIVE_THROUGHPUT| EBS_VOLUME_STORAGE_SPACE_UTILIZATION| MEMORY| CPUtype nonrec rds_database_projected_metric = {values : metric_values option;The values for the projected metric.
*)timestamps : timestamps option;The timestamps of the projected metric.
*)name : rdsdb_metric_name option;The name of the projected metric.
*)}Describes the projected metrics of an Amazon Aurora and RDS database recommendation option.
To determine the performance difference between your current Amazon Aurora and RDS database and the recommended option, compare the metric data of your service against its projected metric data.
type nonrec rds_database_projected_metrics = rds_database_projected_metric listtype nonrec rds_database_recommended_option_projected_metric = {projected_metrics : rds_database_projected_metrics option;An array of objects that describe the projected metric.
*)rank : rank option;The rank identifier of the Amazon Aurora or RDS DB instance recommendation option.
*)recommended_db_instance_class : recommended_db_instance_class option;The recommended DB instance class for the Amazon Aurora or RDS database.
*)}Describes the projected metrics of an Amazon Aurora and RDS database recommendation option.
To determine the performance difference between your current Amazon Aurora and RDS database and the recommended option, compare the metric data of your service against its projected metric data.
type nonrec rds_database_recommended_option_projected_metrics =
rds_database_recommended_option_projected_metric listtype nonrec rdsdb_utilization_metric = {value : metric_value option;The value of the utilization metric.
*)statistic : rdsdb_metric_statistic option;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.
name : rdsdb_metric_name option;The name of the utilization metric.
*)}Describes the utilization metric of an Amazon Aurora and RDS database.
To determine the performance difference between your current DB instance and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
type nonrec rdsdb_utilization_metrics = rdsdb_utilization_metric listtype nonrec db_storage_configuration = {storage_throughput : nullable_storage_throughput option;The storage throughput of the DB storage.
*)max_allocated_storage : nullable_max_allocated_storage option;The maximum limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
*)iops : nullable_iop_s option;The provisioned IOPs of the DB storage.
*)allocated_storage : allocated_storage option;The size of the DB storage in gigabytes (GB).
*)storage_type : storage_type option;The type of DB storage.
*)}The configuration of the recommended RDS storage.
type nonrec rdsdb_storage_recommendation_option = {estimated_monthly_volume_io_ps_cost_variation : rds_estimated_monthly_volume_io_ps_cost_variation
option;The projected level of variation in monthly I/O costs for the DB storage recommendation option.
*)savings_opportunity_after_discounts : rds_storage_savings_opportunity_after_discounts
option;Describes the savings opportunity for DB storage recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
*)savings_opportunity : savings_opportunity option;rank : rank option;The rank identifier of the DB storage recommendation option.
*)storage_configuration : db_storage_configuration option;The recommended storage configuration.
*)}Describes the recommendation options for DB storage.
type nonrec rdsdb_storage_recommendation_options =
rdsdb_storage_recommendation_option listtype nonrec rdsdb_projected_utilization_metrics = rdsdb_utilization_metric listtype nonrec rdsdb_instance_recommendation_option = {savings_opportunity_after_discounts : rds_instance_savings_opportunity_after_discounts
option;Describes the savings opportunity for Amazon Aurora and RDS database recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
*)savings_opportunity : savings_opportunity option;rank : rank option;The rank identifier of the DB instance recommendation option.
*)performance_risk : performance_risk option;The performance risk of the DB instance recommendation option.
*)projected_utilization_metrics : rdsdb_projected_utilization_metrics option;An array of objects that describe the projected utilization metrics of the DB instance recommendation option.
*)db_instance_class : db_instance_class option;Describes the DB instance class recommendation option for your Amazon Aurora or RDS database.
*)}Describes the recommendation options for a DB instance.
type nonrec rdsdb_instance_recommendation_options =
rdsdb_instance_recommendation_option listtype nonrec rdsdb_recommendation = {last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the DB instance recommendation was last generated.
*)lookback_period_in_days : look_back_period_in_days option;The number of days the DB instance utilization metrics were analyzed.
*)effective_recommendation_preferences : rds_effective_recommendation_preferences
option;Describes the effective recommendation preferences for DB instances.
*)utilization_metrics : rdsdb_utilization_metrics option;An array of objects that describe the utilization metrics of the DB instance.
*)storage_recommendation_options : rdsdb_storage_recommendation_options option;An array of objects that describe the recommendation options for DB instance storage.
*)instance_recommendation_options : rdsdb_instance_recommendation_options option;An array of objects that describe the recommendation options for the RDS DB instance.
*)storage_finding_reason_codes : rds_storage_finding_reason_codes option;The reason for the finding classification of RDS DB instance storage.
*)current_storage_estimated_monthly_volume_io_ps_cost_variation : rds_estimated_monthly_volume_io_ps_cost_variation
option;The level of variation in monthly I/O costs for the current DB storage configuration.
*)current_instance_performance_risk : rds_current_instance_performance_risk
option;The performance risk for the current DB instance.
*)instance_finding_reason_codes : rds_instance_finding_reason_codes option;The reason for the finding classification of a DB instance.
*)storage_finding : rds_storage_finding option;The finding classification of Amazon RDS DB instance storage.
For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.
*)instance_finding : rds_instance_finding option;The finding classification of an Amazon Aurora and RDS DB instance.
For more information about finding classifications, see Finding classifications for Aurora and RDS databases in the Compute Optimizer User Guide.
*)idle : idle option;This indicates if the DB instance is idle or not.
*)db_cluster_identifier : db_cluster_identifier option;The identifier for DB cluster.
*)current_storage_configuration : db_storage_configuration option;The configuration of the current DB storage.
*)current_db_instance_class : current_db_instance_class option;The DB instance class of the current Aurora or RDS DB instance.
*)promotion_tier : promotion_tier option;The promotion tier for the Aurora instance.
*)engine_version : engine_version option;The database engine version.
*)engine : engine option;The engine of the DB instance.
*)account_id : account_id option;The Amazon Web Services account ID of the Amazon Aurora or RDS database.
*)resource_arn : resource_arn option;The ARN of the current Amazon Aurora or RDS database.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
}Describes an Amazon Aurora and RDS database recommendation.
type nonrec rdsdb_recommendations = rdsdb_recommendation listtype nonrec filter_values = filter_value listtype nonrec rdsdb_recommendation_filter = {values : filter_values option;The value of the filter.
*)name : rdsdb_recommendation_filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
You can filter your DB instance recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your DB instance recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all DB instance recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your DB instance recommendations. Use this filter to find all of your DB instance recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your DB instance recommendations with a tag key value of Owner or without any tag keys assigned.
}Describes a filter that returns a more specific list of DB instance recommendations. Use this filter with the GetECSServiceRecommendations action.
type nonrec rdsdb_recommendation_filters = rdsdb_recommendation_filter listtype nonrec preferred_resource = {exclude_list : preferred_resource_values option;The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
*)include_list : preferred_resource_values option;The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
*)name : preferred_resource_name option;The type of preferred resource to customize.
Compute Optimizer only supports the customization of Ec2InstanceTypes.
}The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs. For more information, see Rightsizing recommendation preferences in the Compute Optimizer User Guide.
Ec2InstanceTypes.type nonrec preferred_resources = preferred_resource listtype nonrec put_recommendation_preferences_request = {savings_estimation_mode : savings_estimation_mode option;The status of the savings estimation mode preference to create or update.
Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.
Only the account manager or delegated administrator of your organization can activate this preference.
For more information, see Savings estimation mode in the Compute Optimizer User Guide.
*)preferred_resources : preferred_resources option;The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs.
You can only set this preference for the Amazon EC2 instance, Auto Scaling group, Amazon EBS volume, Amazon ECS service, Amazon RDS DB instance, and Aurora DB cluster storage resource types.
*)utilization_preferences : utilization_preferences option;The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values.
CPU utilization:
P99_5 for thresholdPERCENT_20 for headroomMemory utilization:
PERCENT_20 for headroomlook_back_period : look_back_period_preference option;The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14.
You can only set this preference for the Amazon EC2 instance, Auto Scaling group, Amazon EBS volume, Amazon ECS service on Fargate, Amazon RDS DB instance, and Aurora DB cluster storage resource types.
external_metrics_preference : external_metrics_preference option;The provider of the external metrics recommendation preference to create or update.
Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.
This preference can only be set for the Ec2Instance resource type.
For more information, see External metrics ingestion in the Compute Optimizer User Guide.
*)inferred_workload_types : inferred_workload_types_preference option;The status of the inferred workload types recommendation preference to create or update.
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.
*)enhanced_infrastructure_metrics : enhanced_infrastructure_metrics option;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.
*)scope : scope option;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.
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.
resource_type : resource_type;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.
}The account is not opted in to Compute Optimizer.
type nonrec order_by = {order : order option;The order to sort the recommendations.
*)dimension : dimension option;The dimension values to sort the recommendations.
*)}Describes how the recommendations are ordered.
type nonrec number_of_invocations = Smaws_Lib.CoreTypes.Int64.ttype nonrec mixed_instance_types = mixed_instance_type listtype nonrec metric_source = {provider_arn : metric_provider_arn option;The ARN of the metric source provider.
*)provider : metric_source_provider option;The name of the metric source provider.
*)}The list of metric sources required to generate recommendations for commercial software licenses.
type nonrec metrics_source = metric_source listThe request exceeds a limit of the service.
type nonrec license_configuration = {metrics_source : metrics_source option;The list of metric sources required to generate recommendations for commercial software licenses.
*)license_version : license_version option;The version of the license for the application that runs on the instance.
*)license_model : license_model option;The license type associated with the instance.
*)license_name : license_name option;The name of the license for the application that runs on the instance.
*)license_edition : license_edition option;The edition of the license for the application that runs on the instance.
*)operating_system : operating_system option;The operating system of the instance.
*)instance_type : instance_type option;The instance type used in the license.
*)number_of_cores : number_of_cores option;The current number of cores associated with the instance.
*)}Describes the configuration of a license for an Amazon EC2 instance.
type nonrec license_finding_reason_codes = license_finding_reason_code listtype nonrec license_recommendation_option = {savings_opportunity : savings_opportunity option;license_model : license_model option;The recommended license type associated with the instance.
*)license_edition : license_edition option;The recommended edition of the license for the application that runs on the instance.
*)operating_system : operating_system option;The operating system of a license recommendation option.
*)rank : rank option;The rank of the license recommendation option.
The top recommendation option is ranked as 1.
}Describes the recommendation options for licenses.
type nonrec license_recommendation_options = license_recommendation_option listtype nonrec license_recommendation = {license_recommendation_options : license_recommendation_options option;An array of objects that describe the license recommendation options.
*)finding_reason_codes : license_finding_reason_codes option;The reason for the finding classification for an instance that runs on a license.
Finding reason codes include:
Optimized — All specifications of your license meet the performance requirements of your workload.LicenseOverprovisioned — A license is considered over-provisioned when your license can be downgraded while still meeting the performance requirements of your workload.InvalidCloudwatchApplicationInsights — CloudWatch Application Insights isn't configured properly.CloudwatchApplicationInsightsError — There is a CloudWatch Application Insights error.finding : license_finding option;The finding classification for an instance that runs on a license.
Findings include:
InsufficentMetrics — When Compute Optimizer detects that your CloudWatch Application Insights isn't enabled or is enabled with insufficient permissions.NotOptimized — When Compute Optimizer detects that your EC2 infrastructure isn't using any of the SQL server license features you're paying for, a license is considered not optimized.Optimized — When Compute Optimizer detects that all specifications of your license meet the performance requirements of your workload.last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the license recommendation was last generated.
*)lookback_period_in_days : look_back_period_in_days option;The number of days for which utilization metrics were analyzed for an instance that runs on a license.
*)current_license_configuration : license_configuration option;An object that describes the current configuration of an instance that runs on a license.
*)account_id : account_id option;The Amazon Web Services account ID of the license.
*)resource_arn : resource_arn option;The ARN that identifies the Amazon EC2 instance.
*)}Describes a license recommendation for an EC2 instance.
type nonrec license_recommendations = license_recommendation listtype nonrec license_recommendation_filter = {values : filter_values option;The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
name parameter as Finding, then specify Optimized, NotOptimized, or InsufficentMetrics.name parameter as FindingReasonCode, then specify Optimized, LicenseOverprovisioned, InvalidCloudwatchApplicationInsights, or CloudwatchApplicationInsightsError.name : license_recommendation_filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
Specify FindingReasonCode to return recommendations with a specific finding reason code.
You can filter your license recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your license recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all license recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your license recommendations. Use this filter to find all of your license recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your license recommendations with a tag key value of Owner or without any tag keys assigned.
}Describes a filter that returns a more specific list of license recommendations. Use this filter with the GetLicenseRecommendation action.
type nonrec license_recommendation_filters = license_recommendation_filter listtype nonrec lambda_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings.
*)currency : currency option;The currency of the estimated monthly savings.
*)}Describes the estimated monthly savings possible for Lambda functions by adopting Compute Optimizer recommendations. This is based on Lambda functions pricing after applying Savings Plans discounts.
type nonrec lambda_savings_opportunity_after_discounts = {estimated_monthly_savings : lambda_estimated_monthly_savings option;The estimated monthly savings possible by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.
*)}Describes the savings opportunity for Lambda functions recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
type nonrec lambda_savings_estimation_mode = {source : lambda_savings_estimation_mode_source option;Describes the source for calculation of savings opportunity for Lambda functions.
*)}Describes the savings estimation used for calculating savings opportunity for Lambda functions.
type nonrec lambda_function_utilization_metric = {value : metric_value option;The value of the utilization metric.
*)statistic : lambda_function_metric_statistic option;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.
name : lambda_function_metric_name option;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.}Describes a utilization metric of an Lambda function.
type nonrec lambda_function_utilization_metrics =
lambda_function_utilization_metric listtype nonrec lambda_function_recommendation_finding_reason_codes =
lambda_function_recommendation_finding_reason_code listtype nonrec lambda_function_memory_projected_metric = {value : metric_value option;The values of the projected utilization metrics.
*)statistic : lambda_function_memory_metric_statistic option;The statistic of the projected utilization metric.
*)name : lambda_function_memory_metric_name option;The name of the projected utilization metric.
*)}Describes a projected utilization metric of an Lambda function recommendation option.
type nonrec lambda_function_memory_projected_metrics =
lambda_function_memory_projected_metric listtype nonrec lambda_function_memory_recommendation_option = {savings_opportunity_after_discounts : lambda_savings_opportunity_after_discounts
option;An object that describes the savings opportunity for the Lambda recommendation option which includes Saving Plans discounts. Savings opportunity includes the estimated monthly savings and percentage.
*)savings_opportunity : savings_opportunity option;An object that describes the savings opportunity for the Lambda function recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
*)projected_utilization_metrics : lambda_function_memory_projected_metrics option;An array of objects that describe the projected utilization metrics of the function recommendation option.
*)memory_size : memory_size option;The memory size, in MB, of the function recommendation option.
*)rank : rank option;The rank of the function recommendation option.
The top recommendation option is ranked as 1.
}Describes a recommendation option for an Lambda function.
type nonrec lambda_function_memory_recommendation_options =
lambda_function_memory_recommendation_option listtype nonrec lambda_effective_recommendation_preferences = {savings_estimation_mode : lambda_savings_estimation_mode option;Describes the savings estimation mode applied for calculating savings opportunity for Lambda functions.
*)}Describes the effective recommendation preferences for Lambda functions.
type nonrec lambda_function_recommendation = {effective_recommendation_preferences : lambda_effective_recommendation_preferences
option;Describes the effective recommendation preferences for Lambda functions.
*)current_performance_risk : current_performance_risk option;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.
*)memory_size_recommendation_options : lambda_function_memory_recommendation_options
option;An array of objects that describe the memory configuration recommendation options for the function.
*)finding_reason_codes : lambda_function_recommendation_finding_reason_codes
option;The reason for the finding classification of the function.
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.finding : lambda_function_recommendation_finding option;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.
Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the function recommendation was last generated.
*)lookback_period_in_days : look_back_period_in_days option;The number of days for which utilization metrics were analyzed for the function.
*)utilization_metrics : lambda_function_utilization_metrics option;An array of objects that describe the utilization metrics of the function.
*)number_of_invocations : number_of_invocations option;The number of times your function code was applied during the look-back period.
*)current_memory_size : memory_size option;The amount of memory, in MB, that's allocated to the current function.
*)account_id : account_id option;The Amazon Web Services account ID of the function.
*)function_version : function_version option;The version number of the current function.
*)function_arn : function_arn option;The Amazon Resource Name (ARN) of the current function.
*)}Describes an Lambda function recommendation.
type nonrec lambda_function_recommendations =
lambda_function_recommendation listtype nonrec lambda_function_recommendation_filter = {values : filter_values option;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.name : lambda_function_recommendation_filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).
Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned).
You can filter your Lambda function recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Lambda function recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Lambda function recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your Lambda function recommendations. Use this filter to find all of your Lambda function recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Lambda function recommendations with a tag key value of Owner or without any tag keys assigned.
}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.
type nonrec lambda_function_recommendation_filters =
lambda_function_recommendation_filter listtype nonrec job_ids = job_id listtype nonrec job_filter = {values : filter_values option;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.name : job_filter_name option;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).
}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.
type nonrec job_filters = job_filter listtype nonrec instance_savings_estimation_mode = {source : instance_savings_estimation_mode_source option;Describes the source for calculating the savings opportunity for Amazon EC2 instances.
*)}Describes the savings estimation mode used for calculating savings opportunity for Amazon EC2 instances.
type nonrec instance_recommendation_finding_reason_code = | GPU_MEMORY_OVER_PROVISIONED| GPU_MEMORY_UNDER_PROVISIONED| GPU_OVER_PROVISIONED| GPU_UNDER_PROVISIONED| DISK_THROUGHPUT_UNDER_PROVISIONED| DISK_THROUGHPUT_OVER_PROVISIONED| DISK_IOPS_UNDER_PROVISIONED| DISK_IOPS_OVER_PROVISIONED| NETWORK_PPS_UNDER_PROVISIONED| NETWORK_PPS_OVER_PROVISIONED| NETWORK_BANDWIDTH_UNDER_PROVISIONED| NETWORK_BANDWIDTH_OVER_PROVISIONED| EBS_IOPS_UNDER_PROVISIONED| EBS_IOPS_OVER_PROVISIONED| EBS_THROUGHPUT_UNDER_PROVISIONED| EBS_THROUGHPUT_OVER_PROVISIONED| MEMORY_UNDER_PROVISIONED| MEMORY_OVER_PROVISIONED| CPU_UNDER_PROVISIONED| CPU_OVER_PROVISIONEDtype nonrec instance_recommendation_finding_reason_codes =
instance_recommendation_finding_reason_code listtype nonrec effective_recommendation_preferences = {savings_estimation_mode : instance_savings_estimation_mode option;Describes the savings estimation mode applied for calculating savings opportunity for a resource.
*)preferred_resources : effective_preferred_resources option;The resource type values that are considered as candidates when generating rightsizing recommendations.
*)utilization_preferences : utilization_preferences option;The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.
This preference is only available for the Amazon EC2 instance resource type.
*)look_back_period : look_back_period_preference option;The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
*)external_metrics_preference : external_metrics_preference option;An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.
inferred_workload_types : inferred_workload_types_preference option;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.
enhanced_infrastructure_metrics : enhanced_infrastructure_metrics option;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.
*)cpu_vendor_architectures : cpu_vendor_architectures option;Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton instance types only.GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton instance type recommendations only.ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton instance types only.}Describes the effective recommendation preferences for a resource.
type nonrec external_metric_status = {status_reason : external_metric_status_reason option;The reason for Compute Optimizer's integration status with your external metric provider.
*)status_code : external_metric_status_code option;The status code for Compute Optimizer's integration with an external metrics provider.
*)}Describes Compute Optimizer's integration status with your chosen external metric provider. For example, Datadog.
type nonrec instance_recommendation = {idle : instance_idle option;Describes if an Amazon EC2 instance is idle.
*)current_instance_gpu_info : gpu_info option;Describes the GPU accelerator settings for the current instance type.
*)external_metric_status : external_metric_status option;An object that describes Compute Optimizer's integration status with your external metrics provider.
*)instance_state : instance_state option;The state of the instance when the recommendation was generated.
*)inferred_workload_types : inferred_workload_types option;The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
AmazonEmr - Infers that Amazon EMR might be running on the instance.ApacheCassandra - Infers that Apache Cassandra might be running on the instance.ApacheHadoop - Infers that Apache Hadoop might be running on the instance.Memcached - Infers that Memcached might be running on the instance.NGINX - Infers that NGINX might be running on the instance.PostgreSql - Infers that PostgreSQL might be running on the instance.Redis - Infers that Redis might be running on the instance.Kafka - Infers that Kafka might be running on the instance.SQLServer - Infers that SQLServer might be running on the instance.effective_recommendation_preferences : effective_recommendation_preferences
option;An object that describes the effective recommendation preferences for the instance.
*)current_performance_risk : current_performance_risk option;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.
*)last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the instance recommendation was last generated.
*)recommendation_sources : recommendation_sources option;An array of objects that describe the source resource of the recommendation.
*)recommendation_options : recommendation_options option;An array of objects that describe the recommendation options for the instance.
*)look_back_period_in_days : look_back_period_in_days option;The number of days for which utilization metrics were analyzed for the instance.
*)utilization_metrics : utilization_metrics option;An array of objects that describe the utilization metrics of the instance.
*)finding_reason_codes : instance_recommendation_finding_reason_codes option;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.
Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period.EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period.EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period.EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period.NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period.NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.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.
*)finding : finding option;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.The valid values in your API responses appear as OVER_PROVISIONED, UNDER_PROVISIONED, or OPTIMIZED.
*)current_instance_type : current_instance_type option;The instance type of the current instance.
*)instance_name : instance_name option;The name of the current instance.
*)account_id : account_id option;The Amazon Web Services account ID of the instance.
*)instance_arn : instance_arn option;The Amazon Resource Name (ARN) of the current instance.
*)}Describes an Amazon EC2 instance recommendation.
type nonrec instance_recommendations = instance_recommendation listtype nonrec instance_arns = instance_arn listtype nonrec idle_metric_name = | CURR_CONNECTIONS| ELASTI_CACHE_PROCESSING_UNITS| SET_TYPE_CMDS| GET_TYPE_CMDS| INVOCATIONS| USER_CONNECTED| IS_IDLE| KEYSPACE_MISSES| KEYSPACE_HITS| CACHE_MISSES| CACHE_HITS| ENGINE_CPU_UTILIZATION| NEW_CONNECTIONS| CONSUMED_CHANGE_DATA_CAPTURE_UNITS| CONSUMED_WRITE_CAPACITY_UNITS| CONSUMED_READ_CAPACITY_UNITS| PACKETS_IN_FROM_DESTINATION| PACKETS_IN_FROM_SOURCE| ACTIVE_CONNECTION_COUNT| VOLUME_WRITE_OPS_PER_SECOND| VOLUME_READ_OPS_PER_SECOND| EBS_VOLUME_WRITE_IOPS| EBS_VOLUME_READ_IOPS| DATABASE_CONNECTIONS| NETWORK_IN_BYTES_PER_SECOND| NETWORK_OUT_BYTES_PER_SECOND| MEMORY| CPUtype nonrec idle_dimension_values = idle_dimension_value listtype nonrec idle_dimension = {values : idle_dimension_values option;The value of the dimension.
*)key : idle_dimension_key option;The name of the dimension key.
*)}Describes the dimension of an idle resource utilization metric.
type nonrec idle_dimensions = idle_dimension listtype nonrec idle_utilization_metric = {dimensions : idle_dimensions option;The dimensions of the utilization metric.
*)value : metric_value option;The value of the utilization metric.
*)statistic : metric_statistic option;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.
name : idle_metric_name option;The name of the utilization metric.
*)}Describes the utilization metric of an idle resource.
type nonrec idle_utilization_metrics = idle_utilization_metric listtype nonrec idle_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings for Idle resources.
*)currency : currency option;The currency of the estimated monthly savings.
*)}Describes the estimated monthly savings possible for idle resources by adopting Compute Optimizer recommendations.
type nonrec idle_savings_opportunity_after_discounts = {estimated_monthly_savings : idle_estimated_monthly_savings option;The estimated monthly savings possible by adopting Compute Optimizer's idle resource recommendations. This includes any applicable discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer's idle resource recommendations. This includes any applicable discounts.
*)}Describes the savings opportunity for idle resource recommendations after applying discounts.
Savings opportunity represents the estimated monthly savings after applying discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
type nonrec idle_savings_opportunity = {estimated_monthly_savings : idle_estimated_monthly_savings option;The estimated monthly savings possible by adopting Compute Optimizer's idle resource recommendations.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer's idle resource recommendations.
*)}Describes the savings opportunity for idle resource recommendations.
type nonrec idle_recommendation = {last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the idle resource recommendation was last generated.
*)look_back_period_in_days : look_back_period_in_days option;The number of days the idle resource utilization metrics were analyzed.
*)utilization_metrics : idle_utilization_metrics option;An array of objects that describe the utilization metrics of the idle resource.
*)savings_opportunity_after_discounts : idle_savings_opportunity_after_discounts
option;The savings opportunity for the idle resource after any applying discounts.
*)savings_opportunity : idle_savings_opportunity option;The savings opportunity for the idle resource.
*)finding_description : idle_finding_description option;A summary of the findings for the resource.
*)finding : idle_finding option;The finding classification of an idle resource.
*)account_id : account_id option;The Amazon Web Services account ID of the idle resource.
*)resource_type : idle_recommendation_resource_type option;The type of resource that is idle.
*)resource_id : resource_id option;The unique identifier for the resource.
*)resource_arn : resource_arn option;The ARN of the current idle resource.
*)}Describes an Idle resource recommendation.
type nonrec idle_recommendations = idle_recommendation listtype nonrec idle_recommendation_filter = {values : filter_values option;The value of the filter.
*)name : idle_recommendation_filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
You can filter your idle resource recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your idle resource recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all idle resource service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your idle resource recommendations. Use this filter to find all of your idle resource recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your idle resource service recommendations with a tag key value of Owner or without any tag keys assigned.
}Describes a filter that returns a more specific list of idle resource recommendations.
type nonrec idle_recommendation_filters = idle_recommendation_filter listtype nonrec idle_recommendation_error = {resource_type : idle_recommendation_resource_type option;The type of resource associated with the error.
*)message : message option;The error message.
*)code : code option;The error code.
*)identifier : identifier option;The ID of the error.
*)}Returns of list of resources that doesn't have idle recommendations.
type nonrec idle_recommendation_errors = idle_recommendation_error listtype nonrec get_recommendation_summaries_response = {recommendation_summaries : recommendation_summaries option;An array of objects that summarize a recommendation.
*)next_token : next_token option;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.
*)}type nonrec account_ids = account_id listtype nonrec get_recommendation_summaries_request = {max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of recommendation summaries.
*)account_ids : account_ids option;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.
*)}type nonrec get_recommendation_preferences_response = {recommendation_preferences_details : recommendation_preferences_details option;An array of objects that describe recommendation preferences.
*)next_token : next_token option;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.
*)}type nonrec get_recommendation_preferences_request = {max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of recommendation preferences.
*)scope : scope option;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.
*)resource_type : resource_type;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.
}type nonrec get_recommendation_error = {message : message option;The message, or reason, for the error.
*)code : code option;The error code.
*)identifier : identifier option;The ID of the error.
*)}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.
type nonrec get_recommendation_errors = get_recommendation_error listtype nonrec get_rds_database_recommendations_response = {errors : get_recommendation_errors option;An array of objects that describe errors of the request.
*)rds_db_recommendations : rdsdb_recommendations option;An array of objects that describe the Amazon Aurora and RDS database recommendations.
*)next_token : next_token option;The token to advance to the next page of Amazon Aurora and RDS database recommendations.
*)}type nonrec get_rds_database_recommendations_request = {recommendation_preferences : recommendation_preferences option;account_ids : account_ids option;Return the Amazon Aurora and RDS database recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon Aurora and RDS database recommendations to specific member accounts.
You can only specify one account ID per request.
*)filters : rdsdb_recommendation_filters option;An array of objects to specify a filter that returns a more specific list of Amazon Aurora and RDS database recommendations.
*)max_results : max_results option;The maximum number of Amazon Aurora and RDS database recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
next_token : next_token option;The token to advance to the next page of Amazon Aurora and RDS database recommendations.
*)resource_arns : resource_arns option;The ARN that identifies the Amazon Aurora or RDS database.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
The following is the format of a DB Cluster ARN:
arn:aws:rds:{region}:{accountId}:cluster:{resourceName}
}type nonrec get_rds_database_recommendation_projected_metrics_response = {recommended_option_projected_metrics : rds_database_recommended_option_projected_metrics
option;An array of objects that describes the projected metrics.
*)}type nonrec get_rds_database_recommendation_projected_metrics_request = {recommendation_preferences : recommendation_preferences option;end_time : timestamp;The timestamp of the last projected metrics data point to return.
*)start_time : timestamp;The timestamp of the first projected metrics data point to return.
*)period : period;The granularity, in seconds, of the projected metrics data points.
*)stat : metric_statistic;The statistic of the projected metrics.
*)resource_arn : resource_arn;The ARN that identifies the Amazon Aurora or RDS database.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
}type nonrec get_license_recommendations_response = {errors : get_recommendation_errors option;An array of objects that describe errors of the request.
*)license_recommendations : license_recommendations option;An array of objects that describe license recommendations.
*)next_token : next_token option;The token to use to advance to the next page of license recommendations.
*)}type nonrec get_license_recommendations_request = {account_ids : account_ids option;The ID of the Amazon Web Services account for which to return license recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return license recommendations.
Only one account ID can be specified per request.
*)filters : license_recommendation_filters option;An array of objects to specify a filter that returns a more specific list of license recommendations.
*)max_results : max_results option;The maximum number of license recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
next_token : next_token option;The token to advance to the next page of license recommendations.
*)resource_arns : resource_arns option;The ARN that identifies the Amazon EC2 instance.
The following is the format of the ARN:
arn:aws:ec2:region:aws_account_id:instance/instance-id
}type nonrec get_lambda_function_recommendations_response = {lambda_function_recommendations : lambda_function_recommendations option;An array of objects that describe function recommendations.
*)next_token : next_token option;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.
*)}type nonrec function_arns = function_arn listtype nonrec get_lambda_function_recommendations_request = {max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of function recommendations.
*)filters : lambda_function_recommendation_filters option;An array of objects to specify a filter that returns a more specific list of function recommendations.
*)account_ids : account_ids option;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.
*)function_arns : function_arns option;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.
}type nonrec get_idle_recommendations_response = {errors : idle_recommendation_errors option;An array of objects that describe errors of the request.
*)idle_recommendations : idle_recommendations option;An array of objects that describe the idle resource recommendations.
*)next_token : next_token option;The token to advance to the next page of idle resource recommendations.
*)}type nonrec get_idle_recommendations_request = {order_by : order_by option;The order to sort the idle resource recommendations.
*)account_ids : account_ids option;Return the idle resource recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.
You can only specify one account ID per request.
*)filters : idle_recommendation_filters option;An array of objects to specify a filter that returns a more specific list of idle resource recommendations.
*)max_results : idle_max_results option;The maximum number of idle resource recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
next_token : next_token option;The token to advance to the next page of idle resource recommendations.
*)resource_arns : resource_arns option;The ARN that identifies the idle resource.
*)}type nonrec account_enrollment_status = {last_updated_timestamp : last_updated_timestamp option;The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
*)status_reason : status_reason option;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.
status : status option;The account enrollment status.
*)account_id : account_id option;The Amazon Web Services account ID.
*)}Describes the enrollment status of an organization's member accounts in Compute Optimizer.
type nonrec account_enrollment_statuses = account_enrollment_status listtype nonrec get_enrollment_statuses_for_organization_response = {next_token : next_token option;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.
*)account_enrollment_statuses : account_enrollment_statuses option;An array of objects that describe the enrollment statuses of organization member accounts.
*)}type nonrec enrollment_filter = {values : filter_values option;The value of the filter.
The valid values are Active, Inactive, Pending, and Failed.
name : enrollment_filter_name option;The name of the filter.
Specify Status to return accounts with a specific enrollment status (for example, Active).
}Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.
type nonrec enrollment_filters = enrollment_filter listtype nonrec get_enrollment_statuses_for_organization_request = {max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of account enrollment statuses.
*)filters : enrollment_filters option;An array of objects to specify a filter that returns a more specific list of account enrollment statuses.
*)}type nonrec get_enrollment_status_response = {number_of_member_accounts_opted_in : number_of_member_accounts_opted_in option;The count of organization member accounts that are opted in to the service, if your account is an organization management account.
*)last_updated_timestamp : last_updated_timestamp option;The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
*)member_accounts_enrolled : member_accounts_enrolled option;Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.
*)status_reason : status_reason option;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.
status : status option;The enrollment status of the account.
*)}type nonrec get_effective_recommendation_preferences_response = {preferred_resources : effective_preferred_resources option;The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.
To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.
utilization_preferences : utilization_preferences option;The resource’s CPU and memory utilization preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.
To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.
look_back_period : look_back_period_preference option;The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEBSVolumeRecommendations, GetECSServiceRecommendations, or GetRDSDatabaseRecommendations actions.
external_metrics_preference : external_metrics_preference option;The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.
If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.
To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
*)enhanced_infrastructure_metrics : enhanced_infrastructure_metrics option;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.
*)}type nonrec get_effective_recommendation_preferences_request = {resource_arn : resource_arn;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.
*)}type nonrec ecs_service_utilization_metric = {value : metric_value option;The value of the utilization metric.
*)statistic : ecs_service_metric_statistic option;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.
name : ecs_service_metric_name option;The name of the utilization metric.
The following utilization metrics are available:
Cpu — The amount of CPU capacity that's used in the service.Memory — The amount of memory that's used in the service.}Describes the utilization metric of an Amazon ECS service.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
type nonrec ecs_service_utilization_metrics =
ecs_service_utilization_metric listtype nonrec ecs_service_recommendation_finding_reason_codes =
ecs_service_recommendation_finding_reason_code listtype nonrec ecs_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings for Amazon ECS services.
*)currency : currency option;The currency of the estimated monthly savings.
*)}Describes the estimated monthly savings possible for Amazon ECS services by adopting Compute Optimizer recommendations. This is based on Amazon ECS service pricing after applying Savings Plans discounts.
type nonrec ecs_savings_opportunity_after_discounts = {estimated_monthly_savings : ecs_estimated_monthly_savings option;The estimated monthly savings possible by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
*)}Describes the savings opportunity for Amazon ECS service recommendations after applying Savings Plans discounts.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
type nonrec ecs_service_projected_utilization_metric = {upper_bound_value : upper_bound_value option;The upper bound values for the projected utilization metrics.
*)lower_bound_value : lower_bound_value option;The lower bound values for the projected utilization metrics.
*)statistic : ecs_service_metric_statistic option;The statistic of the projected utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
name : ecs_service_metric_name option;The name of the projected utilization metric.
The following utilization metrics are available:
Cpu — The percentage of allocated compute units that are currently in use on the service tasks.Memory — The percentage of memory that's currently in use on the service tasks.}Describes the projected utilization metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
type nonrec ecs_service_projected_utilization_metrics =
ecs_service_projected_utilization_metric listtype nonrec container_recommendation = {cpu : nullable_cpu option;The recommended number of CPU units reserved for the container.
*)memory_size_configuration : memory_size_configuration option;The recommended memory size configurations for the container.
*)container_name : container_name option;The name of the container.
*)}The CPU and memory recommendations for a container within the tasks of your Amazon ECS service.
type nonrec container_recommendations = container_recommendation listtype nonrec ecs_service_recommendation_option = {container_recommendations : container_recommendations option;The CPU and memory size recommendations for the containers within the task of your Amazon ECS service.
*)projected_utilization_metrics : ecs_service_projected_utilization_metrics
option;An array of objects that describe the projected utilization metrics of the Amazon ECS service recommendation option.
*)savings_opportunity_after_discounts : ecs_savings_opportunity_after_discounts
option;Describes the savings opportunity for Amazon ECS service recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
*)savings_opportunity : savings_opportunity option;cpu : nullable_cpu option;The CPU size of the Amazon ECS service recommendation option.
*)memory : nullable_memory option;The memory size of the Amazon ECS service recommendation option.
*)}Describes the recommendation options for an Amazon ECS service.
type nonrec ecs_service_recommendation_options =
ecs_service_recommendation_option listtype nonrec ecs_savings_estimation_mode = {source : ecs_savings_estimation_mode_source option;Describes the source for calculating the savings opportunity for Amazon ECS services.
*)}Describes the savings estimation mode used for calculating savings opportunity for Amazon ECS services.
type nonrec ecs_effective_recommendation_preferences = {look_back_period : look_back_period_preference option;The number of days the Amazon ECS service utilization metrics were analyzed.
*)savings_estimation_mode : ecs_savings_estimation_mode option;Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon ECS services.
*)}Describes the effective recommendation preferences for Amazon ECS services.
type nonrec ecs_service_recommendation = {effective_recommendation_preferences : ecs_effective_recommendation_preferences
option;Describes the effective recommendation preferences for Amazon ECS services.
*)current_performance_risk : current_performance_risk option;The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.
*)service_recommendation_options : ecs_service_recommendation_options option;An array of objects that describe the recommendation options for the Amazon ECS service.
*)finding_reason_codes : ecs_service_recommendation_finding_reason_codes option;The reason for the finding classification of an Amazon ECS service.
Finding reason codes for Amazon ECS services include:
CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.finding : ecs_service_recommendation_finding option;The finding classification of an Amazon ECS service.
Findings for Amazon ECS services include:
Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the Amazon ECS service recommendation was last generated.
*)launch_type : ecs_service_launch_type option;The launch type the Amazon ECS service is using.
Compute Optimizer only supports the Fargate launch type.
*)lookback_period_in_days : look_back_period_in_days option;The number of days the Amazon ECS service utilization metrics were analyzed.
*)utilization_metrics : ecs_service_utilization_metrics option;An array of objects that describe the utilization metrics of the Amazon ECS service.
*)current_service_configuration : service_configuration option;The configuration of the current Amazon ECS service.
*)account_id : account_id option;The Amazon Web Services account ID of the Amazon ECS service.
*)service_arn : service_arn option;The Amazon Resource Name (ARN) of the current Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
}Describes an Amazon ECS service recommendation.
type nonrec ecs_service_recommendations = ecs_service_recommendation listtype nonrec get_ecs_service_recommendations_response = {errors : get_recommendation_errors option;An array of objects that describe errors of the request.
*)ecs_service_recommendations : ecs_service_recommendations option;An array of objects that describe the Amazon ECS service recommendations.
*)next_token : next_token option;The token to advance to the next page of Amazon ECS service recommendations.
*)}type nonrec ecs_service_recommendation_filter = {values : filter_values option;The value of the filter.
The valid values for this parameter are as follows:
name parameter as Finding, specify Optimized, Underprovisioned, or Overprovisioned.name parameter as FindingReasonCode, specify CPUUnderprovisioned, CPUOverprovisioned, MemoryUnderprovisioned, or MemoryOverprovisioned.name : ecs_service_recommendation_filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
Specify FindingReasonCode to return recommendations with a specific finding reason code.
You can filter your Amazon ECS service recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service recommendations with a tag key value of Owner or without any tag keys assigned.
}Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the GetECSServiceRecommendations action.
type nonrec ecs_service_recommendation_filters =
ecs_service_recommendation_filter listtype nonrec get_ecs_service_recommendations_request = {account_ids : account_ids option;Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.
You can only specify one account ID per request.
*)filters : ecs_service_recommendation_filters option;An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations.
*)max_results : max_results option;The maximum number of Amazon ECS service recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
next_token : next_token option;The token to advance to the next page of Amazon ECS service recommendations.
*)service_arns : service_arns option;The ARN that identifies the Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
}type nonrec ecs_service_projected_metric = {lower_bound_values : metric_values option;The lower bound values for the projected metric.
*)upper_bound_values : metric_values option;The upper bound values for the projected metric.
*)timestamps : timestamps option;The timestamps of the projected metric.
*)name : ecs_service_metric_name option;The name of the projected metric.
The following metrics are available:
Cpu — The percentage of allocated compute units that are currently in use on the service tasks.Memory — The percentage of memory that's currently in use on the service tasks.}Describes the projected metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.
type nonrec ecs_service_projected_metrics = ecs_service_projected_metric listtype nonrec ecs_service_recommended_option_projected_metric = {projected_metrics : ecs_service_projected_metrics option;An array of objects that describe the projected metric.
*)recommended_memory_size : memory_size option;The recommended memory size for the Amazon ECS service.
*)recommended_cpu_units : cpu_size option;The recommended CPU size for the Amazon ECS service.
*)}Describes the projected metrics of an Amazon ECS service recommendation option.
To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.
type nonrec ecs_service_recommended_option_projected_metrics =
ecs_service_recommended_option_projected_metric listtype nonrec get_ecs_service_recommendation_projected_metrics_response = {recommended_option_projected_metrics : ecs_service_recommended_option_projected_metrics
option;An array of objects that describes the projected metrics.
*)}type nonrec get_ecs_service_recommendation_projected_metrics_request = {end_time : timestamp;The timestamp of the last projected metrics data point to return.
*)start_time : timestamp;The timestamp of the first projected metrics data point to return.
*)period : period;The granularity, in seconds, of the projected metrics data points.
*)stat : metric_statistic;The statistic of the projected metrics.
*)service_arn : service_arn;The ARN that identifies the Amazon ECS service.
The following is the format of the ARN:
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
}type nonrec get_ec2_recommendation_projected_metrics_response = {recommended_option_projected_metrics : recommended_option_projected_metrics
option;An array of objects that describes projected metrics.
*)}type nonrec get_ec2_recommendation_projected_metrics_request = {recommendation_preferences : recommendation_preferences option;An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.
*)end_time : timestamp;The timestamp of the last projected metrics data point to return.
*)start_time : timestamp;The timestamp of the first projected metrics data point to return.
*)period : period;The granularity, in seconds, of the projected metrics data points.
*)stat : metric_statistic;The statistic of the projected metrics.
*)instance_arn : instance_arn;The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
*)}type nonrec get_ec2_instance_recommendations_response = {errors : get_recommendation_errors option;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.
*)instance_recommendations : instance_recommendations option;An array of objects that describe instance recommendations.
*)next_token : next_token option;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.
*)}type nonrec filter = {values : filter_values option;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.Specify one of the following options if you specify the name parameter as FindingReasonCodes:
CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload.CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance.MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload.MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance.EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload.EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance.EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload.EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance.NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload.NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload.NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance.DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload.DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance.DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload.DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance.name : filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification. For example, Underprovisioned.
Specify RecommendationSourceType to return recommendations of a specific resource type. For example, Ec2Instance.
Specify FindingReasonCodes to return recommendations with a specific finding reason code. For example, CPUUnderprovisioned.
Specify InferredWorkloadTypes to return recommendations of a specific inferred workload. For example, Redis.
You can filter your EC2 instance recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your recommendations. Use this filter to find all of your recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your recommendations with a tag key value of Owner or without any tag keys assigned.
}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.
type nonrec filters = filter listtype nonrec get_ec2_instance_recommendations_request = {recommendation_preferences : recommendation_preferences option;An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
*)account_ids : account_ids option;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.
*)filters : filters option;An array of objects to specify a filter that returns a more specific list of instance recommendations.
*)max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of instance recommendations.
*)instance_arns : instance_arns option;The Amazon Resource Name (ARN) of the instances for which to return recommendations.
*)}type nonrec get_ebs_volume_recommendations_response = {errors : get_recommendation_errors option;An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported volume.
*)volume_recommendations : volume_recommendations option;An array of objects that describe volume recommendations.
*)next_token : next_token option;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.
*)}type nonrec ebs_filter = {values : filter_values option;The value of the filter.
The valid values are Optimized, or NotOptimized.
name : ebs_filter_name option;The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).
You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.
}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.
type nonrec ebs_filters = ebs_filter listtype nonrec get_ebs_volume_recommendations_request = {account_ids : account_ids option;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.
*)filters : ebs_filters option;An array of objects to specify a filter that returns a more specific list of volume recommendations.
*)max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of volume recommendations.
*)volume_arns : volume_arns option;The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
*)}type nonrec auto_scaling_group_configuration = {mixed_instance_types : mixed_instance_types option;List the instance types within an EC2 Auto Scaling group that has mixed instance types.
*)type_ : asg_type option;Describes whether the EC2 Auto Scaling group has a single instance type or a mixed instance type configuration.
*)estimated_instance_hour_reduction_percentage : nullable_estimated_instance_hour_reduction_percentage
option;Describes the projected percentage reduction in instance hours after adopting the recommended configuration. This field is only available for EC2 Auto Scaling groups with scaling policies.
*)allocation_strategy : allocation_strategy option;Describes the allocation strategy that the EC2 Auto Scaling group uses. This field is only available for EC2 Auto Scaling groups with mixed instance types.
*)instance_type : nullable_instance_type option;The instance type for the EC2 Auto Scaling group.
*)max_size : max_size option;The maximum size, or maximum number of instances, for the EC2 Auto Scaling group.
*)min_size : min_size option;The minimum size, or minimum number of instances, for the EC2 Auto Scaling group.
*)desired_capacity : desired_capacity option;The desired capacity, or number of instances, for the EC2 Auto Scaling group.
*)}Describes the configuration of an EC2 Auto Scaling group.
type nonrec auto_scaling_group_estimated_monthly_savings = {value : value option;The value of the estimated monthly savings.
*)currency : currency option;The currency of the estimated monthly savings.
*)}An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances discounts.
type nonrec auto_scaling_group_savings_opportunity_after_discounts = {estimated_monthly_savings : auto_scaling_group_estimated_monthly_savings option;An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.
*)savings_opportunity_percentage : savings_opportunity_percentage option;The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s Auto Scaling group recommendations.
*)}Describes the savings opportunity for Auto Scaling group recommendations after applying the Savings Plans and Reserved Instances discounts.
Savings opportunity represents the estimated monthly savings you can achieve by implementing Compute Optimizer recommendations.
type nonrec auto_scaling_group_recommendation_option = {migration_effort : migration_effort option;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.
savings_opportunity_after_discounts : auto_scaling_group_savings_opportunity_after_discounts
option;An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.
*)savings_opportunity : savings_opportunity option;An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
*)rank : rank option;The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as 1.
performance_risk : performance_risk option;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.
projected_utilization_metrics : projected_utilization_metrics option;An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
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.
instance_gpu_info : gpu_info option;Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.
*)configuration : auto_scaling_group_configuration option;An array of objects that describe an Auto Scaling group configuration.
*)}Describes a recommendation option for an Auto Scaling group.
type nonrec auto_scaling_group_recommendation_options =
auto_scaling_group_recommendation_option listtype nonrec auto_scaling_group_recommendation = {inferred_workload_types : inferred_workload_types option;The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
AmazonEmr - Infers that Amazon EMR might be running on the instances.ApacheCassandra - Infers that Apache Cassandra might be running on the instances.ApacheHadoop - Infers that Apache Hadoop might be running on the instances.Memcached - Infers that Memcached might be running on the instances.NGINX - Infers that NGINX might be running on the instances.PostgreSql - Infers that PostgreSQL might be running on the instances.Redis - Infers that Redis might be running on the instances.Kafka - Infers that Kafka might be running on the instance.SQLServer - Infers that SQLServer might be running on the instance.effective_recommendation_preferences : effective_recommendation_preferences
option;An object that describes the effective recommendation preferences for the Auto Scaling group.
*)current_performance_risk : current_performance_risk option;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.
*)last_refresh_timestamp : last_refresh_timestamp option;The timestamp of when the Auto Scaling group recommendation was last generated.
*)recommendation_options : auto_scaling_group_recommendation_options option;An array of objects that describe the recommendation options for the Auto Scaling group.
*)current_instance_gpu_info : gpu_info option;Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.
*)current_configuration : auto_scaling_group_configuration option;An array of objects that describe the current configuration of the Auto Scaling group.
*)look_back_period_in_days : look_back_period_in_days option;The number of days for which utilization metrics were analyzed for the Auto Scaling group.
*)utilization_metrics : utilization_metrics option;An array of objects that describe the utilization metrics of the Auto Scaling group.
*)finding : finding option;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.auto_scaling_group_name : auto_scaling_group_name option;The name of the Auto Scaling group.
*)auto_scaling_group_arn : auto_scaling_group_arn option;The Amazon Resource Name (ARN) of the Auto Scaling group.
*)account_id : account_id option;The Amazon Web Services account ID of the Auto Scaling group.
*)}Describes an Auto Scaling group recommendation.
type nonrec auto_scaling_group_recommendations =
auto_scaling_group_recommendation listtype nonrec get_auto_scaling_group_recommendations_response = {errors : get_recommendation_errors option;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.
*)auto_scaling_group_recommendations : auto_scaling_group_recommendations option;An array of objects that describe Auto Scaling group recommendations.
*)next_token : next_token option;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.
*)}type nonrec auto_scaling_group_arns = auto_scaling_group_arn listtype nonrec get_auto_scaling_group_recommendations_request = {recommendation_preferences : recommendation_preferences option;An object to specify the preferences for the Auto Scaling group recommendations to return in the response.
*)filters : filters option;An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.
*)max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of Auto Scaling group recommendations.
*)auto_scaling_group_arns : auto_scaling_group_arns option;The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
*)account_ids : account_ids option;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.
*)}type nonrec exportable_volume_field = | EFFECTIVE_RECOMMENDATION_PREFERENCES_LOOKBACK_PERIOD| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| EFFECTIVE_RECOMMENDATION_PREFERENCES_SAVINGS_ESTIMATION_MODE| CURRENT_CONFIGURATION_ROOT_VOLUME| ROOT_VOLUME| TAGS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| CURRENT_PERFORMANCE_RISK| LAST_REFRESH_TIMESTAMP| RECOMMENDATION_OPTIONS_PERFORMANCE_RISK| RECOMMENDATION_OPTIONS_MONTHLY_PRICE| RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_SIZE| RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_BURST_THROUGHPUT| RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_BURST_IOPS| RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_BASELINE_THROUGHPUT| RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_BASELINE_IOPS| RECOMMENDATION_OPTIONS_CONFIGURATION_VOLUME_TYPE| CURRENT_MONTHLY_PRICE| CURRENT_CONFIGURATION_VOLUME_SIZE| CURRENT_CONFIGURATION_VOLUME_BURST_THROUGHPUT| CURRENT_CONFIGURATION_VOLUME_BURST_IOPS| CURRENT_CONFIGURATION_VOLUME_BASELINE_THROUGHPUT| CURRENT_CONFIGURATION_VOLUME_BASELINE_IOPS| CURRENT_CONFIGURATION_VOLUME_TYPE| LOOKBACK_PERIOD_IN_DAYS| UTILIZATION_METRICS_VOLUME_THROUGHPUT_EXCEEDED_MAXIMUM| UTILIZATION_METRICS_VOLUME_IOPS_EXCEEDED_MAXIMUM| UTILIZATION_METRICS_VOLUME_WRITE_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_VOLUME_READ_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_VOLUME_WRITE_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_VOLUME_READ_OPS_PER_SECOND_MAXIMUM| FINDING| VOLUME_ARN| ACCOUNT_IDtype nonrec exportable_volume_fields = exportable_volume_field listtype nonrec exportable_rdsdb_field = | PROMOTION_TIER| DB_CLUSTER_IDENTIFIER| TAGS| LAST_REFRESH_TIMESTAMP| EFFECTIVE_RECOMMENDATION_PREFERENCES_SAVINGS_ESTIMATION_MODE| EFFECTIVE_RECOMMENDATION_PREFERENCES_LOOKBACK_PERIOD| EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS| EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| STORAGE_RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| STORAGE_RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_CLUSTER_STORAGE_IO_ON_DEMAND_MONTHLY_COST| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_CLUSTER_STORAGE_ON_DEMAND_MONTHLY_COST| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_CLUSTER_INSTANCE_ON_DEMAND_MONTHLY_COST| STORAGE_RECOMMENDATION_OPTIONS_ON_DEMAND_MONTHLY_PRICE| INSTANCE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| INSTANCE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| INSTANCE_RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| INSTANCE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| INSTANCE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| INSTANCE_RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| INSTANCE_RECOMMENDATION_OPTIONS_INSTANCE_ON_DEMAND_HOURLY_PRICE| STORAGE_RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_VOLUME_IOPS_COST_VARIATION| STORAGE_RECOMMENDATION_OPTIONS_RANK| STORAGE_RECOMMENDATION_OPTIONS_STORAGE_THROUGHPUT| STORAGE_RECOMMENDATION_OPTIONS_IOPS| STORAGE_RECOMMENDATION_OPTIONS_MAX_ALLOCATED_STORAGE| STORAGE_RECOMMENDATION_OPTIONS_ALLOCATED_STORAGE| STORAGE_RECOMMENDATION_OPTIONS_STORAGE_TYPE| INSTANCE_RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM| INSTANCE_RECOMMENDATION_OPTIONS_PERFORMANCE_RISK| INSTANCE_RECOMMENDATION_OPTIONS_RANK| INSTANCE_RECOMMENDATION_OPTIONS_DB_INSTANCE_CLASS| STORAGE_FINDING_REASON_CODES| STORAGE_FINDING| INSTANCE_FINDING_REASON_CODES| INSTANCE_FINDING| UTILIZATION_METRICS_VOLUME_WRITE_IOPS_AVERAGE| UTILIZATION_METRICS_VOLUME_READ_IOPS_AVERAGE| UTILIZATION_METRICS_VOLUME_BYTES_USED_AVERAGE| UTILIZATION_METRICS_WRITE_IOPS_EPHEMERAL_STORAGE_MAXIMUM| UTILIZATION_METRICS_READ_IOPS_EPHEMERAL_STORAGE_MAXIMUM| UTILIZATION_METRICS_AURORA_MEMORY_NUM_KILL_QUERY_TOTAL_MAXIMUM| UTILIZATION_METRICS_AURORA_MEMORY_NUM_KILL_CONN_TOTAL_MAXIMUM| UTILIZATION_METRICS_AURORA_MEMORY_NUM_DECLINED_SQL_TOTAL_MAXIMUM| UTILIZATION_METRICS_AURORA_MEMORY_HEALTH_STATE_MAXIMUM| UTILIZATION_METRICS_STORAGE_NETWORK_TRANSMIT_THROUGHPUT_MAXIMUM| UTILIZATION_METRICS_STORAGE_NETWORK_RECEIVE_THROUGHPUT_MAXIMUM| UTILIZATION_METRICS_DATABASE_CONNECTIONS_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_WRITE_THROUGHPUT_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_READ_THROUGHPUT_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_WRITE_IOPS_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_READ_IOPS_MAXIMUM| UTILIZATION_METRICS_NETWORK_TRANSMIT_THROUGHPUT_MAXIMUM| UTILIZATION_METRICS_NETWORK_RECEIVE_THROUGHPUT_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_STORAGE_SPACE_UTILIZATION_MAXIMUM| UTILIZATION_METRICS_MEMORY_MAXIMUM| UTILIZATION_METRICS_CPU_MAXIMUM| CURRENT_INSTANCE_PERFORMANCE_RISK| CURRENT_STORAGE_ESTIMATED_CLUSTER_STORAGE_IO_ON_DEMAND_MONTHLY_COST| CURRENT_STORAGE_ESTIMATED_CLUSTER_STORAGE_ON_DEMAND_MONTHLY_COST| CURRENT_STORAGE_ESTIMATED_CLUSTER_INSTANCE_ON_DEMAND_MONTHLY_COST| LOOKBACK_PERIOD_IN_DAYS| CURRENT_STORAGE_ON_DEMAND_MONTHLY_PRICE| CURRENT_INSTANCE_ON_DEMAND_HOURLY_PRICE| CURRENT_STORAGE_ESTIMATED_MONTHLY_VOLUME_IOPS_COST_VARIATION| CURRENT_STORAGE_CONFIGURATION_STORAGE_THROUGHPUT| CURRENT_STORAGE_CONFIGURATION_IOPS| CURRENT_STORAGE_CONFIGURATION_MAX_ALLOCATED_STORAGE| CURRENT_STORAGE_CONFIGURATION_ALLOCATED_STORAGE| CURRENT_STORAGE_CONFIGURATION_STORAGE_TYPE| CURRENT_DB_INSTANCE_CLASS| CLUSTER_WRITER| MULTI_AZ_DB_INSTANCE| IDLE| ENGINE_VERSION| ENGINE| ACCOUNT_ID| RESOURCE_ARNtype nonrec exportable_rdsdb_fields = exportable_rdsdb_field listtype nonrec exportable_license_field = | TAGS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| RECOMMENDATION_OPTIONS_LICENSE_MODEL| RECOMMENDATION_OPTIONS_LICENSE_EDITION| RECOMMENDATION_OPTIONS_OPERATING_SYSTEM| CURRENT_LICENSE_CONFIGURATION_METRICS_SOURCE| CURRENT_LICENSE_CONFIGURATION_LICENSE_VERSION| CURRENT_LICENSE_CONFIGURATION_LICENSE_MODEL| CURRENT_LICENSE_CONFIGURATION_LICENSE_EDITION| CURRENT_LICENSE_CONFIGURATION_LICENSE_NAME| CURRENT_LICENSE_CONFIGURATION_OPERATING_SYSTEM| CURRENT_LICENSE_CONFIGURATION_INSTANCE_TYPE| CURRENT_LICENSE_CONFIGURATION_NUMBER_OF_CORES| LICENSE_FINDING_REASON_CODES| LICENSE_FINDING| LAST_REFRESH_TIMESTAMP| LOOKBACK_PERIOD_IN_DAYS| RESOURCE_ARN| ACCOUNT_IDtype nonrec exportable_license_fields = exportable_license_field listtype nonrec exportable_lambda_function_field = | RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| EFFECTIVE_RECOMMENDATION_PREFERENCES_SAVINGS_ESTIMATION_MODE| TAGS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| CURRENT_PERFORMANCE_RISK| LAST_REFRESH_TIMESTAMP| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_DURATION_EXPECTED| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_DURATION_UPPER_BOUND| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_DURATION_LOWER_BOUND| RECOMMENDATION_OPTIONS_COST_HIGH| RECOMMENDATION_OPTIONS_COST_LOW| RECOMMENDATION_OPTIONS_CONFIGURATION_MEMORY_SIZE| CURRENT_COST_AVERAGE| CURRENT_COST_TOTAL| CURRENT_CONFIGURATION_TIMEOUT| CURRENT_CONFIGURATION_MEMORY_SIZE| LOOKBACK_PERIOD_IN_DAYS| UTILIZATION_METRICS_MEMORY_AVERAGE| UTILIZATION_METRICS_MEMORY_MAXIMUM| UTILIZATION_METRICS_DURATION_AVERAGE| UTILIZATION_METRICS_DURATION_MAXIMUM| NUMBER_OF_INVOCATIONS| FINDING_REASON_CODES| FINDING| FUNCTION_VERSION| FUNCTION_ARN| ACCOUNT_IDtype nonrec exportable_lambda_function_fields =
exportable_lambda_function_field listtype nonrec exportable_instance_field = | RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| EFFECTIVE_RECOMMENDATION_PREFERENCES_SAVINGS_ESTIMATION_MODE| EFFECTIVE_RECOMMENDATION_PREFERENCES_UTILIZATION_PREFERENCES| EFFECTIVE_RECOMMENDATION_PREFERENCES_LOOKBACK_PERIOD| EFFECTIVE_RECOMMENDATION_PREFERENCES_PREFERRED_RESOURCES| IDLE| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_GPU_MEMORY_PERCENTAGE_MAXIMUM| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_GPU_PERCENTAGE_MAXIMUM| UTILIZATION_METRICS_GPU_MEMORY_PERCENTAGE_MAXIMUM| UTILIZATION_METRICS_GPU_PERCENTAGE_MAXIMUM| RECOMMENDATION_OPTIONS_INSTANCE_GPU_INFO| CURRENT_INSTANCE_GPU_INFO| EXTERNAL_METRIC_STATUS_REASON| EXTERNAL_METRIC_STATUS_CODE| INSTANCE_STATE| TAGS| EFFECTIVE_RECOMMENDATION_PREFERENCES_EXTERNAL_METRICS_SOURCE| RECOMMENDATION_OPTIONS_MIGRATION_EFFORT| INFERRED_WORKLOAD_TYPES| EFFECTIVE_RECOMMENDATION_PREFERENCES_INFERRED_WORKLOAD_TYPES| EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS| EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| CURRENT_PERFORMANCE_RISK| LAST_REFRESH_TIMESTAMP| RECOMMENDATIONS_SOURCES_RECOMMENDATION_SOURCE_TYPE| RECOMMENDATIONS_SOURCES_RECOMMENDATION_SOURCE_ARN| RECOMMENDATION_OPTIONS_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE| RECOMMENDATION_OPTIONS_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE| RECOMMENDATION_OPTIONS_ON_DEMAND_PRICE| RECOMMENDATION_OPTIONS_NETWORK| RECOMMENDATION_OPTIONS_STORAGE| RECOMMENDATION_OPTIONS_MEMORY| RECOMMENDATION_OPTIONS_VCPUS| RECOMMENDATION_OPTIONS_PERFORMANCE_RISK| RECOMMENDATION_OPTIONS_PLATFORM_DIFFERENCES| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_MEMORY_MAXIMUM| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM| RECOMMENDATION_OPTIONS_INSTANCE_TYPE| CURRENT_NETWORK| CURRENT_STORAGE| CURRENT_MEMORY| CURRENT_VCPUS| CURRENT_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE| CURRENT_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE| CURRENT_ON_DEMAND_PRICE| UTILIZATION_METRICS_NETWORK_PACKETS_OUT_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_PACKETS_IN_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_OUT_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_IN_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_WRITE_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_READ_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_WRITE_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_READ_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_WRITE_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_READ_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_WRITE_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_READ_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_MEMORY_MAXIMUM| UTILIZATION_METRICS_CPU_MAXIMUM| CURRENT_INSTANCE_TYPE| LOOKBACK_PERIOD_IN_DAYS| Finding_Reason_Codes| FINDING| INSTANCE_NAME| INSTANCE_ARN| ACCOUNT_IDtype nonrec exportable_instance_fields = exportable_instance_field listtype nonrec exportable_idle_field = | TAGS| FINDING_DESCRIPTION| FINDING| UTILIZATION_METRICS_DATABASE_CONNECTIONS_SUM| UTILIZATION_METRICS_CURR_CONNECTIONS_SUM| UTILIZATION_METRICS_ELASTI_CACHE_PROCESSING_UNITS_SUM| UTILIZATION_METRICS_SET_TYPE_CMDS_SUM| UTILIZATION_METRICS_GET_TYPE_CMDS_SUM| UTILIZATION_METRICS_INVOCATIONS_SUM| UTILIZATION_METRICS_USER_CONNECTED_SUM| UTILIZATION_METRICS_IS_IDLE_MINIMUM| UTILIZATION_METRICS_KEYSPACE_MISSES_SUM| UTILIZATION_METRICS_KEYSPACE_HITS_SUM| UTILIZATION_METRICS_CACHE_MISSES_SUM| UTILIZATION_METRICS_CACHE_HITS_SUM| UTILIZATION_METRICS_ENGINE_CPU_UTILIZATION_MAXIMUM| UTILIZATION_METRICS_NEW_CONNECTIONS_SUM| UTILIZATION_METRICS_CONSUMED_WRITE_CAPACITY_UNITS_SUM| UTILIZATION_METRICS_CONSUMED_READ_CAPACITY_UNITS_SUM| UTILIZATION_METRICS_PACKETS_IN_FROM_DESTINATION_MAXIMUM| UTILIZATION_METRICS_PACKETS_IN_FROM_SOURCE_MAXIMUM| UTILIZATION_METRICS_ACTIVE_CONNECTION_COUNT_MAXIMUM| UTILIZATION_METRICS_VOLUME_WRITE_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_VOLUME_READ_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_WRITE_IOPS_MAXIMUM| UTILIZATION_METRICS_EBS_VOLUME_READ_IOPS_MAXIMUM| UTILIZATION_METRICS_DATABASE_CONNECTIONS_MAXIMUM| UTILIZATION_METRICS_NETWORK_IN_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_OUT_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_MEMORY_MAXIMUM| UTILIZATION_METRICS_CPU_MAXIMUM| SAVINGS_OPPORTUNITY_AFTER_DISCOUNT| SAVINGS_OPPORTUNITY| LOOKBACK_PERIOD_IN_DAYS| LAST_REFRESH_TIMESTAMP| RESOURCE_TYPE| RESOURCE_ID| RESOURCE_ARN| ACCOUNT_IDtype nonrec exportable_idle_fields = exportable_idle_field listtype nonrec exportable_ecs_service_field = | EFFECTIVE_RECOMMENDATION_PREFERENCES_LOOKBACK_PERIOD| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| EFFECTIVE_RECOMMENDATION_PREFERENCES_SAVINGS_ESTIMATION_MODE| TAGS| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_MEMORY_MAXIMUM| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM| RECOMMENDATION_OPTIONS_CONTAINER_RECOMMENDATIONS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| RECOMMENDATION_OPTIONS_CPU| RECOMMENDATION_OPTIONS_MEMORY| FINDING_REASON_CODES| FINDING| UTILIZATION_METRICS_MEMORY_MAXIMUM| UTILIZATION_METRICS_CPU_MAXIMUM| CURRENT_SERVICE_CONTAINER_CONFIGURATIONS| CURRENT_SERVICE_CONFIGURATION_AUTO_SCALING_CONFIGURATION| CURRENT_SERVICE_CONFIGURATION_TASK_DEFINITION_ARN| CURRENT_SERVICE_CONFIGURATION_CPU| CURRENT_SERVICE_CONFIGURATION_MEMORY| CURRENT_PERFORMANCE_RISK| LAUNCH_TYPE| LAST_REFRESH_TIMESTAMP| LOOKBACK_PERIOD_IN_DAYS| SERVICE_ARN| ACCOUNT_IDtype nonrec exportable_ecs_service_fields = exportable_ecs_service_field listtype nonrec exportable_auto_scaling_group_field = | RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY_AFTER_DISCOUNTS| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_AFTER_DISCOUNTS_PERCENTAGE| EFFECTIVE_RECOMMENDATION_PREFERENCES_SAVINGS_ESTIMATION_MODE| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_GPU_MEMORY_MAXIMUM| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_GPU_MAXIMUM| UTILIZATION_METRICS_GPU_MEMORY_PERCENTAGE_MAXIMUM| UTILIZATION_METRICS_GPU_PERCENTAGE_MAXIMUM| RECOMMENDATION_OPTIONS_INSTANCE_GPU_INFO| CURRENT_INSTANCE_GPU_INFO| RECOMMENDATION_OPTIONS_MIGRATION_EFFORT| INFERRED_WORKLOAD_TYPES| EFFECTIVE_RECOMMENDATION_PREFERENCES_LOOKBACK_PERIOD| EFFECTIVE_RECOMMENDATION_PREFERENCES_PREFERRED_RESOURCES| EFFECTIVE_RECOMMENDATION_PREFERENCES_INFERRED_WORKLOAD_TYPES| EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS| EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE| RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY| RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE| CURRENT_PERFORMANCE_RISK| LAST_REFRESH_TIMESTAMP| RECOMMENDATION_OPTIONS_NETWORK| RECOMMENDATION_OPTIONS_STORAGE| RECOMMENDATION_OPTIONS_MEMORY| RECOMMENDATION_OPTIONS_VCPUS| RECOMMENDATION_OPTIONS_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE| RECOMMENDATION_OPTIONS_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE| RECOMMENDATION_OPTIONS_ON_DEMAND_PRICE| RECOMMENDATION_OPTIONS_PERFORMANCE_RISK| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_MEMORY_MAXIMUM| RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM| RECOMMENDATION_OPTIONS_CONFIGURATION_TYPE| RECOMMENDATION_OPTIONS_CONFIGURATION_MIXED_INSTANCE_TYPES| RECOMMENDATION_OPTIONS_CONFIGURATION_ALLOCATION_STRATEGY| RECOMMENDATION_OPTIONS_CONFIGURATION_ESTIMATED_INSTANCE_HOUR_REDUCTION_PERCENTAGE| RECOMMENDATION_OPTIONS_CONFIGURATION_MAX_SIZE| RECOMMENDATION_OPTIONS_CONFIGURATION_MIN_SIZE| RECOMMENDATION_OPTIONS_CONFIGURATION_DESIRED_CAPACITY| RECOMMENDATION_OPTIONS_CONFIGURATION_INSTANCE_TYPE| CURRENT_NETWORK| CURRENT_STORAGE| CURRENT_MEMORY| CURRENT_VCPUS| CURRENT_STANDARD_THREE_YEAR_NO_UPFRONT_RESERVED_PRICE| CURRENT_STANDARD_ONE_YEAR_NO_UPFRONT_RESERVED_PRICE| CURRENT_ON_DEMAND_PRICE| CURRENT_CONFIGURATION_TYPE| CURRENT_CONFIGURATION_MIXED_INSTANCE_TYPES| CURRENT_CONFIGURATION_ALLOCATION_STRATEGY| CURRENT_CONFIGURATION_MAX_SIZE| CURRENT_CONFIGURATION_MIN_SIZE| CURRENT_CONFIGURATION_DESIRED_CAPACITY| CURRENT_CONFIGURATION_INSTANCE_TYPE| LOOKBACK_PERIOD_IN_DAYS| UTILIZATION_METRICS_NETWORK_PACKETS_OUT_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_PACKETS_IN_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_OUT_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_NETWORK_IN_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_WRITE_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_READ_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_WRITE_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_DISK_READ_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_WRITE_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_READ_BYTES_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_WRITE_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_EBS_READ_OPS_PER_SECOND_MAXIMUM| UTILIZATION_METRICS_MEMORY_MAXIMUM| UTILIZATION_METRICS_CPU_MAXIMUM| FINDING| AUTO_SCALING_GROUP_NAME| AUTO_SCALING_GROUP_ARN| ACCOUNT_IDtype nonrec exportable_auto_scaling_group_fields =
exportable_auto_scaling_group_field listtype nonrec export_rds_database_recommendations_response = {s3_destination : s3_destination option;job_id : job_id option;The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
}type nonrec export_rds_database_recommendations_request = {recommendation_preferences : recommendation_preferences option;include_member_accounts : include_member_accounts option;If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
*)file_format : file_format option;The format of the export file.
The CSV file is the only export file format currently supported.
*)s3_destination_config : s3_destination_config;fields_to_export : exportable_rdsdb_fields option;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.
*)filters : rdsdb_recommendation_filters option;An array of objects to specify a filter that exports a more specific set of Amazon Aurora and RDS recommendations.
*)account_ids : account_ids option;The Amazon Web Services account IDs for the export Amazon Aurora and RDS database recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
*)}type nonrec export_license_recommendations_response = {s3_destination : s3_destination option;job_id : job_id option;The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
}type nonrec export_license_recommendations_request = {include_member_accounts : include_member_accounts option;Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file .
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
*)file_format : file_format option;The format of the export file.
A CSV file is the only export format currently supported.
*)s3_destination_config : s3_destination_config;fields_to_export : exportable_license_fields option;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.
*)filters : license_recommendation_filters option;An array of objects to specify a filter that exports a more specific set of license recommendations.
*)account_ids : account_ids option;The IDs of the Amazon Web Services accounts for which to export license recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter is omitted, recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
*)}type nonrec export_lambda_function_recommendations_response = {s3_destination : s3_destination option;job_id : job_id option;The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
}type nonrec export_lambda_function_recommendations_request = {include_member_accounts : include_member_accounts option;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.
*)file_format : file_format option;The format of the export file.
The only export file format currently supported is Csv.
s3_destination_config : s3_destination_config;fields_to_export : exportable_lambda_function_fields option;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.
*)filters : lambda_function_recommendation_filters option;An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.
*)account_ids : account_ids option;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.
*)}type nonrec export_idle_recommendations_response = {s3_destination : s3_destination option;job_id : job_id option;The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
}type nonrec export_idle_recommendations_request = {include_member_accounts : include_member_accounts option;If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
*)file_format : file_format option;The format of the export file. The CSV file is the only export file format currently supported.
*)s3_destination_config : s3_destination_config;fields_to_export : exportable_idle_fields option;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.
*)filters : idle_recommendation_filters option;An array of objects to specify a filter that exports a more specific set of idle resource recommendations.
*)account_ids : account_ids option;The Amazon Web Services account IDs for the export idle resource recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
*)}type nonrec export_ecs_service_recommendations_response = {s3_destination : s3_destination option;job_id : job_id option;The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
}type nonrec export_ecs_service_recommendations_request = {include_member_accounts : include_member_accounts option;If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
*)file_format : file_format option;The format of the export file.
The CSV file is the only export file format currently supported.
*)s3_destination_config : s3_destination_config;fields_to_export : exportable_ecs_service_fields option;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.
*)filters : ecs_service_recommendation_filters option;An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
*)account_ids : account_ids option;The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
*)}type nonrec export_ec2_instance_recommendations_response = {s3_destination : s3_destination option;An object that describes the destination Amazon S3 bucket of a recommendations export file.
*)job_id : job_id option;The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
}type nonrec export_ec2_instance_recommendations_request = {recommendation_preferences : recommendation_preferences option;An object to specify the preferences for the Amazon EC2 instance recommendations to export.
*)include_member_accounts : include_member_accounts option;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.
*)file_format : file_format option;The format of the export file.
The only export file format currently supported is Csv.
s3_destination_config : s3_destination_config;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.
*)fields_to_export : exportable_instance_fields option;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.
*)filters : filters option;An array of objects to specify a filter that exports a more specific set of instance recommendations.
*)account_ids : account_ids option;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.
*)}type nonrec export_ebs_volume_recommendations_response = {s3_destination : s3_destination option;job_id : job_id option;The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
}type nonrec export_ebs_volume_recommendations_request = {include_member_accounts : include_member_accounts option;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.
*)file_format : file_format option;The format of the export file.
The only export file format currently supported is Csv.
s3_destination_config : s3_destination_config;fields_to_export : exportable_volume_fields option;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.
*)filters : ebs_filters option;An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
*)account_ids : account_ids option;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.
*)}type nonrec export_auto_scaling_group_recommendations_response = {s3_destination : s3_destination option;An object that describes the destination Amazon S3 bucket of a recommendations export file.
*)job_id : job_id option;The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
}type nonrec export_auto_scaling_group_recommendations_request = {recommendation_preferences : recommendation_preferences option;An object to specify the preferences for the Auto Scaling group recommendations to export.
*)include_member_accounts : include_member_accounts option;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.
*)file_format : file_format option;The format of the export file.
The only export file format currently supported is Csv.
s3_destination_config : s3_destination_config;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.
*)fields_to_export : exportable_auto_scaling_group_fields option;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.
*)filters : filters option;An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.
*)account_ids : account_ids option;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.
*)}type nonrec describe_recommendation_export_jobs_response = {next_token : next_token option;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.
*)recommendation_export_jobs : recommendation_export_jobs option;An array of objects that describe recommendation export jobs.
*)}type nonrec describe_recommendation_export_jobs_request = {max_results : max_results option;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.
next_token : next_token option;The token to advance to the next page of export jobs.
*)filters : job_filters option;An array of objects to specify a filter that returns a more specific list of export jobs.
*)job_ids : job_ids option;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.
*)}type nonrec delete_recommendation_preferences_request = {recommendation_preference_names : recommendation_preference_names;The name of the recommendation preference to delete.
*)scope : scope option;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.
*)resource_type : resource_type;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.
}