2020/10/07 - AWS Compute Optimizer - 5 updated api methods
Changes This release enables AWS Compute Optimizer to analyze EC2 instance-level EBS read and write operations, and throughput when generating recommendations for your EC2 instances and Auto Scaling groups.
{'fieldsToExport': {'UtilizationMetricsEbsReadBytesPerSecondMaximum',
'UtilizationMetricsEbsReadOpsPerSecondMaximum',
'UtilizationMetricsEbsWriteBytesPerSecondMaximum',
'UtilizationMetricsEbsWriteOpsPerSecondMaximum'}}
Exports optimization recommendations for Auto Scaling groups.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide .
You can have only one Auto Scaling group export job in progress per AWS Region.
See also: AWS API Documentation
Request Syntax
client.export_auto_scaling_group_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'RecommendationSourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'AutoScalingGroupArn'|'AutoScalingGroupName'|'Finding'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEbsReadOpsPerSecondMaximum'|'UtilizationMetricsEbsWriteOpsPerSecondMaximum'|'UtilizationMetricsEbsReadBytesPerSecondMaximum'|'UtilizationMetricsEbsWriteBytesPerSecondMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationInstanceType'|'CurrentConfigurationDesiredCapacity'|'CurrentConfigurationMinSize'|'CurrentConfigurationMaxSize'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsConfigurationInstanceType'|'RecommendationOptionsConfigurationDesiredCapacity'|'RecommendationOptionsConfigurationMinSize'|'RecommendationOptionsConfigurationMaxSize'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'LastRefreshTimestamp',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
If your account is the master 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.
(string) --
list
An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
(dict) --
Describes a filter that returns a more specific list of recommendations.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).
values (list) --
The value of the filter.
If you specify the name parameter as Finding , and you request recommendations for an instance , then the valid values are Underprovisioned , Overprovisioned , NotOptimized , or Optimized .
If you specify the name parameter as Finding , and you request recommendations for an Auto Scaling group , then the valid values are Optimized , or NotOptimized .
If you specify the name parameter as RecommendationSourceType , then the valid values are Ec2Instance , or AutoScalingGroup .
(string) --
list
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide .
(string) --
dict
[REQUIRED]
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide .
bucket (string) --
The name of the Amazon S3 bucket to use as the destination for an export job.
keyPrefix (string) --
The Amazon S3 bucket prefix for an export job.
string
The format of the export file.
The only export file format currently supported is Csv .
boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master 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.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
s3Destination (dict) --
An object that describes the destination Amazon S3 bucket of a recommendations export file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
{'fieldsToExport': {'UtilizationMetricsEbsReadBytesPerSecondMaximum',
'UtilizationMetricsEbsReadOpsPerSecondMaximum',
'UtilizationMetricsEbsWriteBytesPerSecondMaximum',
'UtilizationMetricsEbsWriteOpsPerSecondMaximum'}}
Exports optimization recommendations for Amazon EC2 instances.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide .
You can have only one Amazon EC2 instance export job in progress per AWS Region.
See also: AWS API Documentation
Request Syntax
client.export_ec2_instance_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'RecommendationSourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'InstanceArn'|'InstanceName'|'Finding'|'LookbackPeriodInDays'|'CurrentInstanceType'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEbsReadOpsPerSecondMaximum'|'UtilizationMetricsEbsWriteOpsPerSecondMaximum'|'UtilizationMetricsEbsReadBytesPerSecondMaximum'|'UtilizationMetricsEbsWriteBytesPerSecondMaximum'|'CurrentOnDemandPrice'|'CurrentStandardOneYearNoUpfrontReservedPrice'|'CurrentStandardThreeYearNoUpfrontReservedPrice'|'CurrentVCpus'|'CurrentMemory'|'CurrentStorage'|'CurrentNetwork'|'RecommendationOptionsInstanceType'|'RecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum'|'RecommendationOptionsPerformanceRisk'|'RecommendationOptionsVcpus'|'RecommendationOptionsMemory'|'RecommendationOptionsStorage'|'RecommendationOptionsNetwork'|'RecommendationOptionsOnDemandPrice'|'RecommendationOptionsStandardOneYearNoUpfrontReservedPrice'|'RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice'|'RecommendationsSourcesRecommendationSourceArn'|'RecommendationsSourcesRecommendationSourceType'|'LastRefreshTimestamp',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the AWS accounts for which to export instance recommendations.
If your account is the master 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.
(string) --
list
An array of objects that describe a filter to export a more specific set of instance recommendations.
(dict) --
Describes a filter that returns a more specific list of recommendations.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).
values (list) --
The value of the filter.
If you specify the name parameter as Finding , and you request recommendations for an instance , then the valid values are Underprovisioned , Overprovisioned , NotOptimized , or Optimized .
If you specify the name parameter as Finding , and you request recommendations for an Auto Scaling group , then the valid values are Optimized , or NotOptimized .
If you specify the name parameter as RecommendationSourceType , then the valid values are Ec2Instance , or AutoScalingGroup .
(string) --
list
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide .
(string) --
dict
[REQUIRED]
An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide .
bucket (string) --
The name of the Amazon S3 bucket to use as the destination for an export job.
keyPrefix (string) --
The Amazon S3 bucket prefix for an export job.
string
The format of the export file.
The only export file format currently supported is Csv .
boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master 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.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
s3Destination (dict) --
An object that describes the destination Amazon S3 bucket of a recommendations export file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
{'autoScalingGroupRecommendations': {'recommendationOptions': {'projectedUtilizationMetrics': {'name': {'EBS_READ_BYTES_PER_SECOND',
'EBS_READ_OPS_PER_SECOND',
'EBS_WRITE_BYTES_PER_SECOND',
'EBS_WRITE_OPS_PER_SECOND'}}},
'utilizationMetrics': {'name': {'EBS_READ_BYTES_PER_SECOND',
'EBS_READ_OPS_PER_SECOND',
'EBS_WRITE_BYTES_PER_SECOND',
'EBS_WRITE_OPS_PER_SECOND'}}}}
Returns Auto Scaling group recommendations.
AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.get_auto_scaling_group_recommendations(
accountIds=[
'string',
],
autoScalingGroupArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'RecommendationSourceType',
'values': [
'string',
]
},
]
)
list
The IDs of the AWS accounts for which to return Auto Scaling group recommendations.
If your account is the master 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.
(string) --
list
The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
(string) --
string
The token to advance to the next page of Auto Scaling group recommendations.
integer
The maximum number of Auto Scaling group recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
list
An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations.
(dict) --
Describes a filter that returns a more specific list of recommendations.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).
values (list) --
The value of the filter.
If you specify the name parameter as Finding , and you request recommendations for an instance , then the valid values are Underprovisioned , Overprovisioned , NotOptimized , or Optimized .
If you specify the name parameter as Finding , and you request recommendations for an Auto Scaling group , then the valid values are Optimized , or NotOptimized .
If you specify the name parameter as RecommendationSourceType , then the valid values are Ec2Instance , or AutoScalingGroup .
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'autoScalingGroupRecommendations': [
{
'accountId': 'string',
'autoScalingGroupArn': 'string',
'autoScalingGroupName': 'string',
'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'utilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'currentConfiguration': {
'desiredCapacity': 123,
'minSize': 123,
'maxSize': 123,
'instanceType': 'string'
},
'recommendationOptions': [
{
'configuration': {
'desiredCapacity': 123,
'minSize': 123,
'maxSize': 123,
'instanceType': 'string'
},
'projectedUtilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'performanceRisk': 123.0,
'rank': 123
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1)
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of Auto Scaling group recommendations.
This value is null when there are no more pages of Auto Scaling group recommendations to return.
autoScalingGroupRecommendations (list) --
An array of objects that describe Auto Scaling group recommendations.
(dict) --
Describes an Auto Scaling group recommendation.
accountId (string) --
The AWS account ID of the Auto Scaling group.
autoScalingGroupArn (string) --
The Amazon Resource Name (ARN) of the Auto Scaling group.
autoScalingGroupName (string) --
The name of the Auto Scaling group.
finding (string) --
The finding classification 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.
Note
The values that are returned might be NOT_OPTIMIZED or OPTIMIZED .
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the Auto Scaling group.
(dict) --
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
name (string) --
The name of the utilization metric.
Note
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
statistic (string) --
The statistic of the utilization metric.
value (float) --
The value of the utilization metric.
lookBackPeriodInDays (float) --
The number of days for which utilization metrics were analyzed for the Auto Scaling group.
currentConfiguration (dict) --
An array of objects that describe the current configuration of the Auto Scaling group.
desiredCapacity (integer) --
The desired capacity, or number of instances, for the Auto Scaling group.
minSize (integer) --
The minimum size, or minimum number of instances, for the Auto Scaling group.
maxSize (integer) --
The maximum size, or maximum number of instances, for the Auto Scaling group.
instanceType (string) --
The instance type for the Auto Scaling group.
recommendationOptions (list) --
An array of objects that describe the recommendation options for the Auto Scaling group.
(dict) --
Describes a recommendation option for an Auto Scaling group.
configuration (dict) --
An array of objects that describe an Auto Scaling group configuration.
desiredCapacity (integer) --
The desired capacity, or number of instances, for the Auto Scaling group.
minSize (integer) --
The minimum size, or minimum number of instances, for the Auto Scaling group.
maxSize (integer) --
The maximum size, or maximum number of instances, for the Auto Scaling group.
instanceType (string) --
The instance type for the Auto Scaling group.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
(dict) --
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
name (string) --
The name of the utilization metric.
Note
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
statistic (string) --
The statistic of the utilization metric.
value (float) --
The value of the utilization metric.
performanceRisk (float) --
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 .
rank (integer) --
The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as 1 .
lastRefreshTimestamp (datetime) --
The time stamp of when the Auto Scaling group recommendation was last refreshed.
errors (list) --
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.
(dict) --
Describes an error experienced when getting recommendations.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
identifier (string) --
The ID of the error.
code (string) --
The error code.
message (string) --
The message, or reason, for the error.
{'instanceRecommendations': {'recommendationOptions': {'projectedUtilizationMetrics': {'name': {'EBS_READ_BYTES_PER_SECOND',
'EBS_READ_OPS_PER_SECOND',
'EBS_WRITE_BYTES_PER_SECOND',
'EBS_WRITE_OPS_PER_SECOND'}}},
'utilizationMetrics': {'name': {'EBS_READ_BYTES_PER_SECOND',
'EBS_READ_OPS_PER_SECOND',
'EBS_WRITE_BYTES_PER_SECOND',
'EBS_WRITE_OPS_PER_SECOND'}}}}
Returns Amazon EC2 instance recommendations.
AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide .
See also: AWS API Documentation
Request Syntax
client.get_ec2_instance_recommendations(
instanceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'RecommendationSourceType',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
list
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
(string) --
string
The token to advance to the next page of instance recommendations.
integer
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
list
An array of objects that describe a filter that returns a more specific list of instance recommendations.
(dict) --
Describes a filter that returns a more specific list of recommendations.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned ).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).
values (list) --
The value of the filter.
If you specify the name parameter as Finding , and you request recommendations for an instance , then the valid values are Underprovisioned , Overprovisioned , NotOptimized , or Optimized .
If you specify the name parameter as Finding , and you request recommendations for an Auto Scaling group , then the valid values are Optimized , or NotOptimized .
If you specify the name parameter as RecommendationSourceType , then the valid values are Ec2Instance , or AutoScalingGroup .
(string) --
list
The IDs of the AWS accounts for which to return instance recommendations.
If your account is the master 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) --
dict
Response Syntax
{
'nextToken': 'string',
'instanceRecommendations': [
{
'instanceArn': 'string',
'accountId': 'string',
'instanceName': 'string',
'currentInstanceType': 'string',
'finding': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'utilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'recommendationOptions': [
{
'instanceType': 'string',
'projectedUtilizationMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'performanceRisk': 123.0,
'rank': 123
},
],
'recommendationSources': [
{
'recommendationSourceArn': 'string',
'recommendationSourceType': 'Ec2Instance'|'AutoScalingGroup'
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1)
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
instanceRecommendations (list) --
An array of objects that describe instance recommendations.
(dict) --
Describes an Amazon EC2 instance recommendation.
instanceArn (string) --
The Amazon Resource Name (ARN) of the current instance.
accountId (string) --
The AWS account ID of the instance.
instanceName (string) --
The name of the current instance.
currentInstanceType (string) --
The instance type of the current instance.
finding (string) --
The finding classification 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.
Note
The values that are returned might be UNDER_PROVISIONED , OVER_PROVISIONED , or OPTIMIZED .
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the instance.
(dict) --
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
name (string) --
The name of the utilization metric.
Note
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
statistic (string) --
The statistic of the utilization metric.
value (float) --
The value of the utilization metric.
lookBackPeriodInDays (float) --
The number of days for which utilization metrics were analyzed for the instance.
recommendationOptions (list) --
An array of objects that describe the recommendation options for the instance.
(dict) --
Describes a recommendation option for an Amazon EC2 instance.
instanceType (string) --
The instance type of the instance recommendation.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the instance recommendation option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
(dict) --
Describes a utilization metric of a resource, such as an Amazon EC2 instance.
name (string) --
The name of the utilization metric.
Note
The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
statistic (string) --
The statistic of the utilization metric.
value (float) --
The value of the utilization metric.
performanceRisk (float) --
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 .
rank (integer) --
The rank of the instance recommendation option.
The top recommendation option is ranked as 1 .
recommendationSources (list) --
An array of objects that describe the source resource of the recommendation.
(dict) --
Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
recommendationSourceArn (string) --
The Amazon Resource Name (ARN) of the recommendation source.
recommendationSourceType (string) --
The resource type of the recommendation source.
lastRefreshTimestamp (datetime) --
The time stamp of when the instance recommendation was last refreshed.
errors (list) --
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
(dict) --
Describes an error experienced when getting recommendations.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
identifier (string) --
The ID of the error.
code (string) --
The error code.
message (string) --
The message, or reason, for the error.
{'recommendedOptionProjectedMetrics': {'projectedMetrics': {'name': {'EBS_READ_BYTES_PER_SECOND',
'EBS_READ_OPS_PER_SECOND',
'EBS_WRITE_BYTES_PER_SECOND',
'EBS_WRITE_OPS_PER_SECOND'}}}}
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
See also: AWS API Documentation
Request Syntax
client.get_ec2_recommendation_projected_metrics(
instanceArn='string',
stat='Maximum'|'Average',
period=123,
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
string
[REQUIRED]
The statistic of the projected metrics.
integer
[REQUIRED]
The granularity, in seconds, of the projected metrics data points.
datetime
[REQUIRED]
The time stamp of the first projected metrics data point to return.
datetime
[REQUIRED]
The time stamp of the last projected metrics data point to return.
dict
Response Syntax
{
'recommendedOptionProjectedMetrics': [
{
'recommendedInstanceType': 'string',
'rank': 123,
'projectedMetrics': [
{
'name': 'Cpu'|'Memory'|'EBS_READ_OPS_PER_SECOND'|'EBS_WRITE_OPS_PER_SECOND'|'EBS_READ_BYTES_PER_SECOND'|'EBS_WRITE_BYTES_PER_SECOND',
'timestamps': [
datetime(2015, 1, 1),
],
'values': [
123.0,
]
},
]
},
]
}
Response Structure
(dict) --
recommendedOptionProjectedMetrics (list) --
An array of objects that describe a projected metrics.
(dict) --
Describes a projected utilization metric of a recommendation option.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
recommendedInstanceType (string) --
The recommended instance type.
rank (integer) --
The rank of the recommendation option projected metric.
The top recommendation option is ranked as 1 .
The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.
projectedMetrics (list) --
An array of objects that describe a projected utilization metric.
(dict) --
Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance.
Note
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .
name (string) --
The name of the projected utilization metric.
timestamps (list) --
The time stamps of the projected utilization metric.
(datetime) --
values (list) --
The values of the projected utilization metrics.
(float) --