Integer desiredCapacity
The desired capacity, or number of instances, for the Auto Scaling group.
Integer minSize
The minimum size, or minimum number of instances, for the Auto Scaling group.
Integer maxSize
The maximum size, or maximum number of instances, for the Auto Scaling group.
String instanceType
The instance type for the Auto Scaling group.
String accountId
The AWS account ID of the Auto Scaling group.
String autoScalingGroupArn
The Amazon Resource Name (ARN) of the Auto Scaling group.
String autoScalingGroupName
The name of the Auto Scaling group.
String finding
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
NotOptimized —An Auto Scaling group is considered not optimized when AWS Compute Optimizer
identifies a recommendation that can provide better performance for your workload.
Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines
that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized
resources, Compute Optimizer might recommend a new generation instance type.
List<E> utilizationMetrics
An array of objects that describe the utilization metrics of the Auto Scaling group.
Double lookBackPeriodInDays
The number of days for which utilization metrics were analyzed for the Auto Scaling group.
AutoScalingGroupConfiguration currentConfiguration
An array of objects that describe the current configuration of the Auto Scaling group.
List<E> recommendationOptions
An array of objects that describe the recommendation options for the Auto Scaling group.
Date lastRefreshTimestamp
The time stamp of when the Auto Scaling group recommendation was last refreshed.
AutoScalingGroupConfiguration configuration
An array of objects that describe an Auto Scaling group configuration.
List<E> projectedUtilizationMetrics
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.
Double performanceRisk
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.
Integer rank
The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as 1.
List<E> jobIds
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.
List<E> filters
An array of objects that describe a filter to return a more specific list of export jobs.
String nextToken
The token to advance to the next page of export jobs.
Integer maxResults
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.
String name
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
String statistic
The statistic of the utilization metric.
The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only
the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average
statistic, which is the value of Sum / SampleCount during the specified period. For
more information, see Viewing resource
recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric
data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
User Guide.
Double value
The value of the utilization metric.
List<E> accountIds
The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
List<E> filters
An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
List<E> fieldsToExport
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.
S3DestinationConfig s3DestinationConfig
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
String fileFormat
The format of the export file.
The only export file format currently supported is Csv.
Boolean includeMemberAccounts
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
String jobId
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an
export job.
S3Destination s3Destination
An object that describes the destination Amazon S3 bucket of a recommendations export file.
S3Destination s3
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.
List<E> accountIds
The IDs of the AWS 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.
List<E> filters
An array of objects that describe a filter to export a more specific set of Amazon EBS volume recommendations.
List<E> fieldsToExport
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.
S3DestinationConfig s3DestinationConfig
String fileFormat
The format of the export file.
The only export file format currently supported is Csv.
Boolean includeMemberAccounts
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
String jobId
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an
export job.
S3Destination s3Destination
List<E> accountIds
The IDs of the AWS accounts for which to export instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
List<E> filters
An array of objects that describe a filter to export a more specific set of instance recommendations.
List<E> fieldsToExport
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.
S3DestinationConfig s3DestinationConfig
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
String fileFormat
The format of the export file.
The only export file format currently supported is Csv.
Boolean includeMemberAccounts
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
String jobId
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an
export job.
S3Destination s3Destination
An object that describes the destination Amazon S3 bucket of a recommendations export file.
List<E> accountIds
The IDs of the AWS 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.
List<E> filters
An array of objects that describe a filter to export a more specific set of Lambda function recommendations.
List<E> fieldsToExport
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.
S3DestinationConfig s3DestinationConfig
String fileFormat
The format of the export file.
The only export file format currently supported is Csv.
Boolean includeMemberAccounts
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
String jobId
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an
export job.
S3Destination s3Destination
String name
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (e.g.,
Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g.,
Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (e.g.,
CPUUnderprovisioned).
List<E> values
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name
parameter and the resource type that you wish to filter results for:
Specify Optimized or NotOptimized if you specify the name parameter as
Finding and you want to filter results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or Optimized if you specify the
name parameter as Finding and you want to filter results for EC2 instances.
Specify Ec2Instance or AutoScalingGroup if you specify the name parameter
as RecommendationSourceType.
Specify one of the following options if you specify the name parameter as
FindingReasonCodes:
CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting
the performance requirements of your workload.
CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance
requirements of your workload and there is an alternative instance type that provides better CPU performance.
MemoryOverprovisioned — The instance’s memory configuration can be sized down while still
meeting the performance requirements of your workload.
MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance
requirements of your workload and there is an alternative instance type that provides better memory performance.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized
down while still meeting the performance requirements of your workload.
EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet
the performance requirements of your workload and there is an alternative instance type that provides better EBS
throughput performance.
EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while
still meeting the performance requirements of your workload.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the
performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS
performance.
NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be
sized down while still meeting the performance requirements of your workload.
NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't
meet the performance requirements of your workload and there is an alternative instance type that provides better
network bandwidth performance. This finding reason happens when the NetworkIn or
NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration
can be sized down while still meeting the performance requirements of your workload.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration
doesn't meet the performance requirements of your workload and there is an alternative instance type that
provides better network PPS performance.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while
still meeting the performance requirements of your workload.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the
performance requirements of your workload and there is an alternative instance type that provides better disk
IOPS performance.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized
down while still meeting the performance requirements of your workload.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet
the performance requirements of your workload and there is an alternative instance type that provides better disk
throughput performance.
List<E> accountIds
The ID of the AWS account for which to return Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.
Only one account ID can be specified per request.
List<E> autoScalingGroupArns
The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
String nextToken
The token to advance to the next page of Auto Scaling group recommendations.
Integer maxResults
The maximum number of Auto Scaling group recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
List<E> filters
An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations.
String nextToken
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.
List<E> autoScalingGroupRecommendations
An array of objects that describe Auto Scaling group recommendations.
List<E> errors
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.
List<E> volumeArns
The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
String nextToken
The token to advance to the next page of volume recommendations.
Integer maxResults
The maximum number of volume recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
List<E> filters
An array of objects that describe a filter that returns a more specific list of volume recommendations.
List<E> accountIds
The ID of the AWS account for which to return volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.
Only one account ID can be specified per request.
String nextToken
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.
List<E> volumeRecommendations
An array of objects that describe volume recommendations.
List<E> errors
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported volume.
List<E> instanceArns
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
String nextToken
The token to advance to the next page of instance recommendations.
Integer maxResults
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
List<E> filters
An array of objects that describe a filter that returns a more specific list of instance recommendations.
List<E> accountIds
The ID of the AWS account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
String nextToken
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.
List<E> instanceRecommendations
An array of objects that describe instance recommendations.
List<E> errors
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.
String instanceArn
The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
String stat
The statistic of the projected metrics.
Integer period
The granularity, in seconds, of the projected metrics data points.
Date startTime
The time stamp of the first projected metrics data point to return.
Date endTime
The time stamp of the last projected metrics data point to return.
String status
The enrollment status of the account.
String statusReason
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.
Boolean memberAccountsEnrolled
Confirms the enrollment status of member accounts within the organization, if the account is a management account of an organization.
List<E> functionArns
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 AWS Lambda Developer Guide.
List<E> accountIds
The ID of the AWS 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.
List<E> filters
An array of objects that describe a filter that returns a more specific list of function recommendations.
String nextToken
The token to advance to the next page of function recommendations.
Integer maxResults
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.
String nextToken
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.
List<E> lambdaFunctionRecommendations
An array of objects that describe function recommendations.
List<E> accountIds
The ID of the AWS account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
String nextToken
The token to advance to the next page of recommendation summaries.
Integer maxResults
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.
String instanceArn
The Amazon Resource Name (ARN) of the current instance.
String accountId
The AWS account ID of the instance.
String instanceName
The name of the current instance.
String currentInstanceType
The instance type of the current instance.
String finding
The finding classification of the instance.
Findings for instances include:
Underprovisioned —An instance is considered under-provisioned when at least one
specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of
your workload. Under-provisioned instances may lead to poor application performance.
Overprovisioned —An instance is considered over-provisioned when at least one specification
of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance
requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to
unnecessary infrastructure cost.
Optimized —An instance is considered optimized when all specifications of your instance,
such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned.
For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
List<E> findingReasonCodes
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 AWS Compute Optimizer User Guide. On Linux instances, Compute
Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy
MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute
Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized
down while still meeting the performance requirements of your workload. This is identified by analyzing the
VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current
instance during the look-back period.
EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet
the performance requirements of your workload and there is an alternative instance type that provides better EBS
throughput performance. This is identified by analyzing the VolumeReadOps and
VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while
still meeting the performance requirements of your workload. This is identified by analyzing the
VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current
instance during the look-back period.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the
performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS
performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes
metric of EBS volumes attached to the current instance during the look-back period.
NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be
sized down while still meeting the performance requirements of your workload. This is identified by analyzing the
NetworkIn and NetworkOut metrics of the current instance during the look-back period.
NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't
meet the performance requirements of your workload and there is an alternative instance type that provides better
network bandwidth performance. This is identified by analyzing the NetworkIn and
NetworkOut metrics of the current instance during the look-back period. This finding reason happens
when the NetworkIn or NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration
can be sized down while still meeting the performance requirements of your workload. This is identified by
analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance
during the look-back period.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration
doesn't meet the performance requirements of your workload and there is an alternative instance type that
provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and
NetworkPacketsIn metrics of the current instance during the look-back period.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while
still meeting the performance requirements of your workload. This is identified by analyzing the
DiskReadOps and DiskWriteOps metrics of the current instance during the look-back
period.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the
performance requirements of your workload and there is an alternative instance type that provides better disk
IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps
metrics of the current instance during the look-back period.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized
down while still meeting the performance requirements of your workload. This is identified by analyzing the
DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back
period.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet
the performance requirements of your workload and there is an alternative instance type that provides better disk
throughput performance. This is identified by analyzing the DiskReadBytes and
DiskWriteBytes metrics of the current instance during the look-back period.
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.
List<E> utilizationMetrics
An array of objects that describe the utilization metrics of the instance.
Double lookBackPeriodInDays
The number of days for which utilization metrics were analyzed for the instance.
List<E> recommendationOptions
An array of objects that describe the recommendation options for the instance.
List<E> recommendationSources
An array of objects that describe the source resource of the recommendation.
Date lastRefreshTimestamp
The time stamp of when the instance recommendation was last refreshed.
String instanceType
The instance type of the instance recommendation.
List<E> projectedUtilizationMetrics
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.
List<E> platformDifferences
Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.
Platform differences include:
Hypervisor — The hypervisor of the recommended instance type is different than that of the
current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance
uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently
asked questions. For more information, see Instances
built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances
built on the Nitro System in the Amazon EC2 User Guide for Windows.
NetworkInterface — The network interface of the recommended instance type is different than
that of the current instance. For example, the recommended instance type supports enhanced networking and the
current instance might not. To enable enhanced networking for the recommended instance type, you will need to
install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more
information, see Networking and storage features and Enhanced networking on
Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on
Windows in the Amazon EC2 User Guide for Windows.
StorageInterface — The storage interface of the recommended instance type is different than
that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the
current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or
upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux
instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on
Windows instances in the Amazon EC2 User Guide for Windows.
InstanceStoreAvailability — The recommended instance type does not support instance store
volumes and the current instance does. Before migrating, you might need to back up the data on your instance
store volumes if you want to preserve them. For more information, see How do I back up an
instance store volume on my Amazon EC2 instance to Amazon EBS? in the AWS Premium Support Knowledge
Base. For more information, see Networking and storage features and Amazon EC2 instance store in
the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store
in the Amazon EC2 User Guide for Windows.
VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM)
virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information
about the differences between these virtualization types, see Linux AMI virtualization
types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.
Double performanceRisk
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.
Integer rank
The rank of the instance recommendation option.
The top recommendation option is ranked as 1.
String name
The name of the filter.
Specify ResourceType to return export jobs of a specific resource type (e.g.,
Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g, Complete).
List<E> values
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name
parameter:
Specify Ec2Instance or AutoScalingGroup if you specify the name parameter
as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be
exported at this time.
Specify Queued, InProgress, Complete, or Failed if you
specify the name parameter as JobStatus.
Integer rank
The rank of the function recommendation option.
The top recommendation option is ranked as 1.
Integer memorySize
The memory size, in MB, of the function recommendation option.
List<E> projectedUtilizationMetrics
An array of objects that describe the projected utilization metrics of the function recommendation option.
String functionArn
The Amazon Resource Name (ARN) of the current function.
String functionVersion
The version number of the current function.
String accountId
The AWS account ID of the function.
Integer currentMemorySize
The amount of memory, in MB, that's allocated to the current function.
Long numberOfInvocations
The number of times your function code was executed during the look-back period.
List<E> utilizationMetrics
An array of objects that describe the utilization metrics of the function.
Double lookbackPeriodInDays
The number of days for which utilization metrics were analyzed for the function.
Date lastRefreshTimestamp
The time stamp of when the function recommendation was last refreshed.
String finding
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.
List<E> findingReasonCodes
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 AWS 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.
List<E> memorySizeRecommendationOptions
An array of objects that describe the memory configuration recommendation options for the function.
String name
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (e.g.,
NotOptimized).
Specify FindingReasonCode to return recommendations with a specific finding reason code (e.g.,
MemoryUnderprovisioned).
List<E> values
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name
parameter:
Specify Optimized, NotOptimized, or Unavailable if you specify the
name parameter as Finding.
Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData,
or Inconclusive if you specify the name parameter as FindingReasonCode.
String name
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.
String statistic
The statistic of the utilization metric.
The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only
the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average
statistic, which is the value of Sum / SampleCount during the specified period. For
more information, see Viewing resource
recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric
data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
User Guide.
Double value
The value of the utilization metric.
String name
The name of the projected utilization metric.
The following projected utilization metrics are returned:
Cpu - The projected percentage of allocated EC2 compute units that would be in use on the
recommendation option had you used that resource during the analyzed period. This metric identifies the
processing power required to run an application on the recommendation option.
Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.
Units: Percent
Memory - The percentage of memory that would be in use on the recommendation option had you used
that resource during the analyzed period. This metric identifies the amount of memory required to run an
application on the recommendation option.
Units: Percent
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.
List<E> timestamps
The time stamps of the projected utilization metric.
List<E> values
The values of the projected utilization metrics.
String jobId
The identification number of the export job.
ExportDestination destination
An object that describes the destination of the export file.
String resourceType
The resource type of the exported recommendations.
String status
The status of the export job.
Date creationTimestamp
The timestamp of when the export job was created.
Date lastUpdatedTimestamp
The timestamp of when the export job was last updated.
String failureReason
The reason for an export job failure.
String recommendedInstanceType
The recommended instance type.
Integer rank
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.
List<E> projectedMetrics
An array of objects that describe a projected utilization metric.
String bucket
The name of the Amazon S3 bucket used as the destination of an export file.
String key
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
String metadataKey
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
String 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 AWS resources after you opt in. For more information, see Metrics analyzed by AWS Compute
Optimizer in the AWS 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.
Boolean includeMemberAccounts
Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
String name
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.
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.
String statistic
The statistic of the utilization metric.
The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only
the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average
statistic, which is the value of Sum / SampleCount during the specified period. For
more information, see Viewing resource
recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric
data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch
User Guide.
Double value
The value of the utilization metric.
String volumeType
The volume type.
This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS
SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for
Magnetic volumes.
Integer volumeSize
The size of the volume, in GiB.
Integer volumeBaselineIOPS
The baseline IOPS of the volume.
Integer volumeBurstIOPS
The burst IOPS of the volume.
Integer volumeBaselineThroughput
The baseline throughput of the volume.
Integer volumeBurstThroughput
The burst throughput of the volume.
String volumeArn
The Amazon Resource Name (ARN) of the current volume.
String accountId
The AWS account ID of the volume.
VolumeConfiguration currentConfiguration
An array of objects that describe the current configuration of the volume.
String finding
The finding classification of the volume.
Findings for volumes include:
NotOptimized —A volume is considered not optimized when AWS 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.
List<E> utilizationMetrics
An array of objects that describe the utilization metrics of the volume.
Double lookBackPeriodInDays
The number of days for which utilization metrics were analyzed for the volume.
List<E> volumeRecommendationOptions
An array of objects that describe the recommendation options for the volume.
Date lastRefreshTimestamp
The time stamp of when the volume recommendation was last refreshed.
VolumeConfiguration configuration
An array of objects that describe a volume configuration.
Double performanceRisk
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.
Integer rank
The rank of the volume recommendation option.
The top recommendation option is ranked as 1.
Copyright © 2021. All rights reserved.