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 for 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 is the likelihood of the recommended instance type not meeting the performance requirement of your workload.
The lowest performance risk is categorized as 0, and the highest as 5.
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 following statistics are available:
Average - This is the value of Sum / SampleCount during the specified period, or the average value
observed during the specified period.
Maximum - The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
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 accounts 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.
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 instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member accounts 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.
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.
String name
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (e.g.,
Overprovisioned).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g.,
AutoScalingGroup).
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 specified the name parameter as
Finding and you want to filter results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or Optimized if you specified
the name parameter as Finding and you want to filter results for EC2 instances.
Specify Ec2Instance or AutoScalingGroup if you specified the name
parameter as RecommendationSourceType.
List<E> accountIds
The IDs of the AWS accounts 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 accounts 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 IDs of the AWS accounts for which to return volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member accounts 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 IDs of the AWS accounts for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member accounts 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> accountIds
The IDs of the AWS accounts for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member accounts 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 for 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.
An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized
resources, AWS Compute Optimizer might recommend a new generation instance type.
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.
Double performanceRisk
The performance risk of the instance recommendation option.
Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.
The lowest performance risk is categorized as 0, and the highest as 5.
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 specified 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
specified the name parameter as JobStatus.
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.
Accepted options are Active or Inactive. You will get an error if Pending
or Failed are specified.
Boolean includeMemberAccounts
Indicates whether to enroll member accounts of the organization if the your 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
String statistic
The statistic of the utilization metric.
The following statistics are available:
Average - This is the value of Sum / SampleCount during the specified period, or the average value
observed during the specified period.
Maximum - The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
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 for 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 not meeting the performance requirement of your workload.
The lowest performance risk is categorized as 0, and the highest as 5.
Integer rank
The rank of the volume recommendation option.
The top recommendation option is ranked as 1.
Copyright © 2020. All rights reserved.