2024/11/20 - AWS Compute Optimizer - 2 new8 updated api methods
Changes This release enables AWS Compute Optimizer to analyze and generate optimization recommendations for Amazon Aurora database instances. It also enables Compute Optimizer to identify idle Amazon EC2 instances, Amazon EBS volumes, Amazon ECS services running on Fargate, and Amazon RDS databases.
Export optimization recommendations for your idle resources.
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 idle resource export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_idle_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding'|'ResourceType',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'ResourceArn'|'ResourceId'|'ResourceType'|'LastRefreshTimestamp'|'LookbackPeriodInDays'|'SavingsOpportunity'|'SavingsOpportunityAfterDiscount'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsNetworkOutBytesPerSecondMaximum'|'UtilizationMetricsNetworkInBytesPerSecondMaximum'|'UtilizationMetricsDatabaseConnectionsMaximum'|'UtilizationMetricsEBSVolumeReadIOPSMaximum'|'UtilizationMetricsEBSVolumeWriteIOPSMaximum'|'UtilizationMetricsVolumeReadOpsPerSecondMaximum'|'UtilizationMetricsVolumeWriteOpsPerSecondMaximum'|'Finding'|'FindingDescription'|'Tags',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The Amazon Web Services account IDs for the export idle resource recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
(string) --
list
An array of objects to specify a filter that exports a more specific set of idle resource recommendations.
(dict) --
Describes a filter that returns a more specific list of idle resource recommendations.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
You can filter your idle resource recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your idle resource recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all idle resource service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your idle resource recommendations. Use this filter to find all of your idle resource recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your idle resource service recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
(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]
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
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 CSV file is the only export file format currently supported.
boolean
If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
s3Destination (dict) --
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User Guide
See also: AWS API Documentation
Request Syntax
client.get_idle_recommendations(
resourceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding'|'ResourceType',
'values': [
'string',
]
},
],
accountIds=[
'string',
],
orderBy={
'dimension': 'SavingsValue'|'SavingsValueAfterDiscount',
'order': 'Asc'|'Desc'
}
)
list
The ARN that identifies the idle resource.
(string) --
string
The token to advance to the next page of idle resource recommendations.
integer
The maximum number of idle resource recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
list
An array of objects to specify a filter that returns a more specific list of idle resource recommendations.
(dict) --
Describes a filter that returns a more specific list of idle resource recommendations.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
You can filter your idle resource recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your idle resource recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all idle resource service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your idle resource recommendations. Use this filter to find all of your idle resource recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your idle resource service recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
(string) --
list
Return the idle resource recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.
You can only specify one account ID per request.
(string) --
dict
The order to sort the idle resource recommendations.
dimension (string) --
The dimension values to sort the recommendations.
order (string) --
The order to sort the recommendations.
dict
Response Syntax
{
'nextToken': 'string',
'idleRecommendations': [
{
'resourceArn': 'string',
'resourceId': 'string',
'resourceType': 'EC2Instance'|'AutoScalingGroup'|'EBSVolume'|'ECSService'|'RDSDBInstance',
'accountId': 'string',
'finding': 'Idle'|'Unattached',
'findingDescription': 'string',
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'utilizationMetrics': [
{
'name': 'CPU'|'Memory'|'NetworkOutBytesPerSecond'|'NetworkInBytesPerSecond'|'DatabaseConnections'|'EBSVolumeReadIOPS'|'EBSVolumeWriteIOPS'|'VolumeReadOpsPerSecond'|'VolumeWriteOpsPerSecond',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'lastRefreshTimestamp': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string',
'resourceType': 'EC2Instance'|'AutoScalingGroup'|'EBSVolume'|'ECSService'|'RDSDBInstance'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to advance to the next page of idle resource recommendations.
idleRecommendations (list) --
An array of objects that describe the idle resource recommendations.
(dict) --
Describes an Idle resource recommendation.
resourceArn (string) --
The ARN of the current idle resource.
resourceId (string) --
The unique identifier for the resource.
resourceType (string) --
The type of resource that is idle.
accountId (string) --
The Amazon Web Services account ID of the idle resource.
finding (string) --
The finding classification of an idle resource.
findingDescription (string) --
A summary of the findings for the resource.
savingsOpportunity (dict) --
The savings opportunity for the idle resource.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer's idle resource recommendations.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible by adopting Compute Optimizer's idle resource recommendations.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings for Idle resources.
savingsOpportunityAfterDiscounts (dict) --
The savings opportunity for the idle resource after any applying discounts.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer's idle resource recommendations. This includes any applicable discounts.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible by adopting Compute Optimizer's idle resource recommendations. This includes any applicable discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings for Idle resources.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the idle resource.
(dict) --
Describes the utilization metric of an idle resource.
name (string) --
The name of the utilization metric.
statistic (string) --
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
value (float) --
The value of the utilization metric.
lookBackPeriodInDays (float) --
The number of days the idle resource utilization metrics were analyzed.
lastRefreshTimestamp (datetime) --
The timestamp of when the idle resource recommendation was last generated.
tags (list) --
A list of tags assigned to your idle resource recommendations.
(dict) --
A list of tag key and value pairs that you define.
key (string) --
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
errors (list) --
An array of objects that describe errors of the request.
(dict) --
Returns of list of resources that doesn't have idle recommendations.
identifier (string) --
The ID of the error.
code (string) --
The error code.
message (string) --
The error message.
resourceType (string) --
The type of resource associated with the error.
{'resourceType': {'Idle'}}
Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License'|'RdsDBInstance'|'Idle',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
recommendationPreferenceNames=[
'EnhancedInfrastructureMetrics'|'InferredWorkloadTypes'|'ExternalMetricsPreference'|'LookBackPeriodPreference'|'PreferredResources'|'UtilizationPreferences',
]
)
string
[REQUIRED]
The target resource type of the recommendation preference to delete.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
dict
An object that describes the scope of the recommendation preference to delete.
You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS.
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
list
[REQUIRED]
The name of the recommendation preference to delete.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'recommendationExportJobs': {'resourceType': {'Idle'}}}
Describes recommendation export jobs created in the last seven days.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
See also: AWS API Documentation
Request Syntax
client.describe_recommendation_export_jobs(
jobIds=[
'string',
],
filters=[
{
'name': 'ResourceType'|'JobStatus',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
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.
(string) --
list
An array of objects to specify a filter that returns a more specific list of export jobs.
(dict) --
Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
name (string) --
The name of the filter.
Specify ResourceType to return export jobs of a specific resource type (for example, Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g, Complete).
values (list) --
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.
(string) --
string
The token to advance to the next page of export jobs.
integer
The maximum number of export jobs to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'recommendationExportJobs': [
{
'jobId': 'string',
'destination': {
's3': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
},
'resourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License'|'RdsDBInstance'|'Idle',
'status': 'Queued'|'InProgress'|'Complete'|'Failed',
'creationTimestamp': datetime(2015, 1, 1),
'lastUpdatedTimestamp': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recommendationExportJobs (list) --
An array of objects that describe recommendation export jobs.
(dict) --
Describes a recommendation export job.
Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
jobId (string) --
The identification number of the export job.
destination (dict) --
An object that describes the destination of the export file.
s3 (dict) --
An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
resourceType (string) --
The resource type of the exported recommendations.
status (string) --
The status of the export job.
creationTimestamp (datetime) --
The timestamp of when the export job was created.
lastUpdatedTimestamp (datetime) --
The timestamp of when the export job was last updated.
failureReason (string) --
The reason for an export job failure.
nextToken (string) --
The token to use to advance to the next page of export jobs.
This value is null when there are no more pages of export jobs to return.
{'fieldsToExport': {'CurrentInstancePerformanceRisk',
'DBClusterIdentifier',
'PromotionTier',
'UtilizationMetricsAuroraMemoryHealthStateMaximum',
'UtilizationMetricsAuroraMemoryNumDeclinedSqlTotalMaximum',
'UtilizationMetricsAuroraMemoryNumKillConnTotalMaximum',
'UtilizationMetricsAuroraMemoryNumKillQueryTotalMaximum',
'UtilizationMetricsReadIOPSEphemeralStorageMaximum',
'UtilizationMetricsStorageNetworkReceiveThroughputMaximum',
'UtilizationMetricsStorageNetworkTransmitThroughputMaximum',
'UtilizationMetricsWriteIOPSEphemeralStorageMaximum'}}
Export optimization recommendations for your Amazon Relational Database Service (Amazon RDS).
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 RDS export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_rds_database_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'InstanceFinding'|'InstanceFindingReasonCode'|'StorageFinding'|'StorageFindingReasonCode'|'Idle',
'values': [
'string',
]
},
],
fieldsToExport=[
'ResourceArn'|'AccountId'|'Engine'|'EngineVersion'|'Idle'|'MultiAZDBInstance'|'CurrentDBInstanceClass'|'CurrentStorageConfigurationStorageType'|'CurrentStorageConfigurationAllocatedStorage'|'CurrentStorageConfigurationMaxAllocatedStorage'|'CurrentStorageConfigurationIOPS'|'CurrentStorageConfigurationStorageThroughput'|'CurrentInstanceOnDemandHourlyPrice'|'CurrentStorageOnDemandMonthlyPrice'|'LookbackPeriodInDays'|'CurrentInstancePerformanceRisk'|'UtilizationMetricsCpuMaximum'|'UtilizationMetricsMemoryMaximum'|'UtilizationMetricsEBSVolumeStorageSpaceUtilizationMaximum'|'UtilizationMetricsNetworkReceiveThroughputMaximum'|'UtilizationMetricsNetworkTransmitThroughputMaximum'|'UtilizationMetricsEBSVolumeReadIOPSMaximum'|'UtilizationMetricsEBSVolumeWriteIOPSMaximum'|'UtilizationMetricsEBSVolumeReadThroughputMaximum'|'UtilizationMetricsEBSVolumeWriteThroughputMaximum'|'UtilizationMetricsDatabaseConnectionsMaximum'|'UtilizationMetricsStorageNetworkReceiveThroughputMaximum'|'UtilizationMetricsStorageNetworkTransmitThroughputMaximum'|'UtilizationMetricsAuroraMemoryHealthStateMaximum'|'UtilizationMetricsAuroraMemoryNumDeclinedSqlTotalMaximum'|'UtilizationMetricsAuroraMemoryNumKillConnTotalMaximum'|'UtilizationMetricsAuroraMemoryNumKillQueryTotalMaximum'|'UtilizationMetricsReadIOPSEphemeralStorageMaximum'|'UtilizationMetricsWriteIOPSEphemeralStorageMaximum'|'InstanceFinding'|'InstanceFindingReasonCodes'|'StorageFinding'|'StorageFindingReasonCodes'|'InstanceRecommendationOptionsDBInstanceClass'|'InstanceRecommendationOptionsRank'|'InstanceRecommendationOptionsPerformanceRisk'|'InstanceRecommendationOptionsProjectedUtilizationMetricsCpuMaximum'|'StorageRecommendationOptionsStorageType'|'StorageRecommendationOptionsAllocatedStorage'|'StorageRecommendationOptionsMaxAllocatedStorage'|'StorageRecommendationOptionsIOPS'|'StorageRecommendationOptionsStorageThroughput'|'StorageRecommendationOptionsRank'|'InstanceRecommendationOptionsInstanceOnDemandHourlyPrice'|'InstanceRecommendationOptionsSavingsOpportunityPercentage'|'InstanceRecommendationOptionsEstimatedMonthlySavingsCurrency'|'InstanceRecommendationOptionsEstimatedMonthlySavingsValue'|'InstanceRecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'InstanceRecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'InstanceRecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts'|'StorageRecommendationOptionsOnDemandMonthlyPrice'|'StorageRecommendationOptionsSavingsOpportunityPercentage'|'StorageRecommendationOptionsEstimatedMonthlySavingsCurrency'|'StorageRecommendationOptionsEstimatedMonthlySavingsValue'|'StorageRecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'StorageRecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'StorageRecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts'|'EffectiveRecommendationPreferencesCpuVendorArchitectures'|'EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics'|'EffectiveRecommendationPreferencesLookBackPeriod'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'LastRefreshTimestamp'|'Tags'|'DBClusterIdentifier'|'PromotionTier',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False,
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
list
The Amazon Web Services account IDs for the export Amazon RDS recommendations.
If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.
This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.
If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.
You can specify multiple account IDs per request.
(string) --
list
An array of objects to specify a filter that exports a more specific set of Amazon RDS recommendations.
(dict) --
Describes a filter that returns a more specific list of Amazon RDS recommendations. Use this filter with the GetECSServiceRecommendations action.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
You can filter your Amazon RDS recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon RDS recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon RDS service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your Amazon RDS recommendations. Use this filter to find all of your Amazon RDS recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon RDS service recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
(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]
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
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 CSV file is the only export file format currently supported.
boolean
If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.
If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.
dict
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
cpuVendorArchitectures (list) --
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton instance types only.
(string) --
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.
s3Destination (dict) --
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
{'recommendedOptionProjectedMetrics': {'projectedMetrics': {'name': {'AuroraMemoryHealthState',
'AuroraMemoryNumDeclinedSql',
'AuroraMemoryNumKillConnTotal',
'AuroraMemoryNumKillQueryTotal',
'ReadIOPSEphemeralStorage',
'StorageNetworkReceiveThroughput',
'StorageNetworkTransmitThroughput',
'WriteIOPSEphemeralStorage'}}}}
Returns the projected metrics of Amazon RDS recommendations.
See also: AWS API Documentation
Request Syntax
client.get_rds_database_recommendation_projected_metrics(
resourceArn='string',
stat='Maximum'|'Average',
period=123,
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
string
[REQUIRED]
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
string
[REQUIRED]
The statistic of the projected metrics.
integer
[REQUIRED]
The granularity, in seconds, of the projected metrics data points.
datetime
[REQUIRED]
The timestamp of the first projected metrics data point to return.
datetime
[REQUIRED]
The timestamp of the last projected metrics data point to return.
dict
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
cpuVendorArchitectures (list) --
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton instance types only.
(string) --
dict
Response Syntax
{
'recommendedOptionProjectedMetrics': [
{
'recommendedDBInstanceClass': 'string',
'rank': 123,
'projectedMetrics': [
{
'name': 'CPU'|'Memory'|'EBSVolumeStorageSpaceUtilization'|'NetworkReceiveThroughput'|'NetworkTransmitThroughput'|'EBSVolumeReadIOPS'|'EBSVolumeWriteIOPS'|'EBSVolumeReadThroughput'|'EBSVolumeWriteThroughput'|'DatabaseConnections'|'StorageNetworkReceiveThroughput'|'StorageNetworkTransmitThroughput'|'AuroraMemoryHealthState'|'AuroraMemoryNumDeclinedSql'|'AuroraMemoryNumKillConnTotal'|'AuroraMemoryNumKillQueryTotal'|'ReadIOPSEphemeralStorage'|'WriteIOPSEphemeralStorage',
'timestamps': [
datetime(2015, 1, 1),
],
'values': [
123.0,
]
},
]
},
]
}
Response Structure
(dict) --
recommendedOptionProjectedMetrics (list) --
An array of objects that describes the projected metrics.
(dict) --
Describes the projected metrics of an Amazon RDS recommendation option.
To determine the performance difference between your current Amazon RDS and the recommended option, compare the metric data of your service against its projected metric data.
recommendedDBInstanceClass (string) --
The recommended DB instance class for the Amazon RDS.
rank (integer) --
The rank identifier of the RDS instance recommendation option.
projectedMetrics (list) --
An array of objects that describe the projected metric.
(dict) --
Describes the projected metrics of an Amazon RDS recommendation option.
To determine the performance difference between your current Amazon RDS and the recommended option, compare the metric data of your service against its projected metric data.
name (string) --
The name of the projected metric.
timestamps (list) --
The timestamps of the projected metric.
(datetime) --
values (list) --
The values for the projected metric.
(float) --
{'rdsDBRecommendations': {'currentInstancePerformanceRisk': 'VeryLow | Low | '
'Medium | High',
'dbClusterIdentifier': 'string',
'instanceFindingReasonCodes': {'DBClusterWriterUnderprovisioned',
'EBSIOPSUnderprovisioned',
'InstanceStorageReadIOPSUnderprovisioned',
'InstanceStorageWriteIOPSUnderprovisioned',
'MemoryUnderprovisioned'},
'instanceRecommendationOptions': {'projectedUtilizationMetrics': {'name': {'AuroraMemoryHealthState',
'AuroraMemoryNumDeclinedSql',
'AuroraMemoryNumKillConnTotal',
'AuroraMemoryNumKillQueryTotal',
'ReadIOPSEphemeralStorage',
'StorageNetworkReceiveThroughput',
'StorageNetworkTransmitThroughput',
'WriteIOPSEphemeralStorage'}}},
'promotionTier': 'integer',
'utilizationMetrics': {'name': {'AuroraMemoryHealthState',
'AuroraMemoryNumDeclinedSql',
'AuroraMemoryNumKillConnTotal',
'AuroraMemoryNumKillQueryTotal',
'ReadIOPSEphemeralStorage',
'StorageNetworkReceiveThroughput',
'StorageNetworkTransmitThroughput',
'WriteIOPSEphemeralStorage'}}}}
Returns Amazon RDS recommendations.
Compute Optimizer generates recommendations for Amazon RDS that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
See also: AWS API Documentation
Request Syntax
client.get_rds_database_recommendations(
resourceArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'InstanceFinding'|'InstanceFindingReasonCode'|'StorageFinding'|'StorageFindingReasonCode'|'Idle',
'values': [
'string',
]
},
],
accountIds=[
'string',
],
recommendationPreferences={
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
]
}
)
list
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
The following is the format of a DB Cluster ARN:
arn:aws:rds:{region}:{accountId}:cluster:{resourceName}
(string) --
string
The token to advance to the next page of Amazon RDS recommendations.
integer
The maximum number of Amazon RDS 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 to specify a filter that returns a more specific list of Amazon RDS recommendations.
(dict) --
Describes a filter that returns a more specific list of Amazon RDS recommendations. Use this filter with the GetECSServiceRecommendations action.
name (string) --
The name of the filter.
Specify Finding to return recommendations with a specific finding classification.
You can filter your Amazon RDS recommendations by tag:key and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your Amazon RDS recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon RDS service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your Amazon RDS recommendations. Use this filter to find all of your Amazon RDS recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon RDS service recommendations with a tag key value of Owner or without any tag keys assigned.
values (list) --
The value of the filter.
(string) --
list
Return the Amazon RDS recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon RDS recommendations to specific member accounts.
You can only specify one account ID per request.
(string) --
dict
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
cpuVendorArchitectures (list) --
Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton instance types only.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'rdsDBRecommendations': [
{
'resourceArn': 'string',
'accountId': 'string',
'engine': 'string',
'engineVersion': 'string',
'promotionTier': 123,
'currentDBInstanceClass': 'string',
'currentStorageConfiguration': {
'storageType': 'string',
'allocatedStorage': 123,
'iops': 123,
'maxAllocatedStorage': 123,
'storageThroughput': 123
},
'dbClusterIdentifier': 'string',
'idle': 'True'|'False',
'instanceFinding': 'Optimized'|'Underprovisioned'|'Overprovisioned',
'storageFinding': 'Optimized'|'Underprovisioned'|'Overprovisioned',
'instanceFindingReasonCodes': [
'CPUOverprovisioned'|'NetworkBandwidthOverprovisioned'|'EBSIOPSOverprovisioned'|'EBSIOPSUnderprovisioned'|'EBSThroughputOverprovisioned'|'CPUUnderprovisioned'|'NetworkBandwidthUnderprovisioned'|'EBSThroughputUnderprovisioned'|'NewGenerationDBInstanceClassAvailable'|'NewEngineVersionAvailable'|'DBClusterWriterUnderprovisioned'|'MemoryUnderprovisioned'|'InstanceStorageReadIOPSUnderprovisioned'|'InstanceStorageWriteIOPSUnderprovisioned',
],
'currentInstancePerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'storageFindingReasonCodes': [
'EBSVolumeAllocatedStorageUnderprovisioned'|'EBSVolumeThroughputUnderprovisioned'|'EBSVolumeIOPSOverprovisioned'|'EBSVolumeThroughputOverprovisioned'|'NewGenerationStorageTypeAvailable',
],
'instanceRecommendationOptions': [
{
'dbInstanceClass': 'string',
'projectedUtilizationMetrics': [
{
'name': 'CPU'|'Memory'|'EBSVolumeStorageSpaceUtilization'|'NetworkReceiveThroughput'|'NetworkTransmitThroughput'|'EBSVolumeReadIOPS'|'EBSVolumeWriteIOPS'|'EBSVolumeReadThroughput'|'EBSVolumeWriteThroughput'|'DatabaseConnections'|'StorageNetworkReceiveThroughput'|'StorageNetworkTransmitThroughput'|'AuroraMemoryHealthState'|'AuroraMemoryNumDeclinedSql'|'AuroraMemoryNumKillConnTotal'|'AuroraMemoryNumKillQueryTotal'|'ReadIOPSEphemeralStorage'|'WriteIOPSEphemeralStorage',
'statistic': 'Maximum'|'Minimum'|'Average',
'value': 123.0
},
],
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'storageRecommendationOptions': [
{
'storageConfiguration': {
'storageType': 'string',
'allocatedStorage': 123,
'iops': 123,
'maxAllocatedStorage': 123,
'storageThroughput': 123
},
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'utilizationMetrics': [
{
'name': 'CPU'|'Memory'|'EBSVolumeStorageSpaceUtilization'|'NetworkReceiveThroughput'|'NetworkTransmitThroughput'|'EBSVolumeReadIOPS'|'EBSVolumeWriteIOPS'|'EBSVolumeReadThroughput'|'EBSVolumeWriteThroughput'|'DatabaseConnections'|'StorageNetworkReceiveThroughput'|'StorageNetworkTransmitThroughput'|'AuroraMemoryHealthState'|'AuroraMemoryNumDeclinedSql'|'AuroraMemoryNumKillConnTotal'|'AuroraMemoryNumKillQueryTotal'|'ReadIOPSEphemeralStorage'|'WriteIOPSEphemeralStorage',
'statistic': 'Maximum'|'Minimum'|'Average',
'value': 123.0
},
],
'effectiveRecommendationPreferences': {
'cpuVendorArchitectures': [
'AWS_ARM64'|'CURRENT',
],
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93',
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
}
},
'lookbackPeriodInDays': 123.0,
'lastRefreshTimestamp': datetime(2015, 1, 1),
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to advance to the next page of Amazon RDS recommendations.
rdsDBRecommendations (list) --
An array of objects that describe the Amazon RDS recommendations.
(dict) --
Describes an Amazon RDS recommendation.
resourceArn (string) --
The ARN of the current Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
accountId (string) --
The Amazon Web Services account ID of the Amazon RDS.
engine (string) --
The engine of the RDS instance.
engineVersion (string) --
The database engine version.
promotionTier (integer) --
The promotion tier for the Aurora instance.
currentDBInstanceClass (string) --
The DB instance class of the current RDS instance.
currentStorageConfiguration (dict) --
The configuration of the current RDS storage.
storageType (string) --
The type of RDS storage.
allocatedStorage (integer) --
The size of the RDS storage in gigabytes (GB).
iops (integer) --
The provisioned IOPs of the RDS storage.
maxAllocatedStorage (integer) --
The maximum limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the RDS instance.
storageThroughput (integer) --
The storage throughput of the RDS storage.
dbClusterIdentifier (string) --
The identifier for DB cluster.
idle (string) --
This indicates if the RDS instance is idle or not.
instanceFinding (string) --
The finding classification of an Amazon RDS instance.
Findings for Amazon RDS instance include:
Underprovisioned — When Compute Optimizer detects that there’s not enough resource specifications, an Amazon RDS is considered under-provisioned.
Overprovisioned — When Compute Optimizer detects that there’s excessive resource specifications, an Amazon RDS is considered over-provisioned.
Optimized — When the specifications of your Amazon RDS instance meet the performance requirements of your workload, the service is considered optimized.
storageFinding (string) --
The finding classification of Amazon RDS storage.
Findings for Amazon RDS instance include:
Underprovisioned — When Compute Optimizer detects that there’s not enough storage, an Amazon RDS is considered under-provisioned.
Overprovisioned — When Compute Optimizer detects that there’s excessive storage, an Amazon RDS is considered over-provisioned.
Optimized — When the storage of your Amazon RDS meet the performance requirements of your workload, the service is considered optimized.
instanceFindingReasonCodes (list) --
The reason for the finding classification of an Amazon RDS instance.
(string) --
currentInstancePerformanceRisk (string) --
The performance risk for the current DB instance.
storageFindingReasonCodes (list) --
The reason for the finding classification of Amazon RDS storage.
(string) --
instanceRecommendationOptions (list) --
An array of objects that describe the recommendation options for the Amazon RDS instance.
(dict) --
Describes the recommendation options for an Amazon RDS instance.
dbInstanceClass (string) --
Describes the DB instance class recommendation option for your Amazon RDS instance.
projectedUtilizationMetrics (list) --
An array of objects that describe the projected utilization metrics of the RDS instance recommendation option.
(dict) --
Describes the utilization metric of an Amazon RDS.
To determine the performance difference between your current Amazon RDS and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
name (string) --
The name of the utilization metric.
statistic (string) --
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
value (float) --
The value of the utilization metric.
performanceRisk (float) --
The performance risk of the RDS instance recommendation option.
rank (integer) --
The rank identifier of the RDS instance recommendation option.
savingsOpportunity (dict) --
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
savingsOpportunityAfterDiscounts (dict) --
Describes the savings opportunity for Amazon RDS recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon RDS instance recommendations. This includes any applicable Savings Plans discounts.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon RDS instance recommendations. This includes any applicable Savings Plans discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings for Amazon RDS instances.
storageRecommendationOptions (list) --
An array of objects that describe the recommendation options for Amazon RDS storage.
(dict) --
Describes the recommendation options for Amazon RDS storage.
storageConfiguration (dict) --
The recommended storage configuration.
storageType (string) --
The type of RDS storage.
allocatedStorage (integer) --
The size of the RDS storage in gigabytes (GB).
iops (integer) --
The provisioned IOPs of the RDS storage.
maxAllocatedStorage (integer) --
The maximum limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the RDS instance.
storageThroughput (integer) --
The storage throughput of the RDS storage.
rank (integer) --
The rank identifier of the RDS storage recommendation option.
savingsOpportunity (dict) --
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
savingsOpportunityAfterDiscounts (dict) --
Describes the savings opportunity for Amazon RDS storage recommendations or for the recommendation option.
Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon RDS storage recommendations. This includes any applicable Savings Plans discounts.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon RDS storage recommendations. This includes any applicable Savings Plans discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings for Amazon RDS storage.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the Amazon RDS.
(dict) --
Describes the utilization metric of an Amazon RDS.
To determine the performance difference between your current Amazon RDS and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.
name (string) --
The name of the utilization metric.
statistic (string) --
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
value (float) --
The value of the utilization metric.
effectiveRecommendationPreferences (dict) --
Describes the effective recommendation preferences for Amazon RDS.
cpuVendorArchitectures (list) --
Describes the CPU vendor and architecture for Amazon RDS recommendations.
(string) --
enhancedInfrastructureMetrics (string) --
Describes the activation status of the enhanced infrastructure metrics preference.
A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
lookBackPeriod (string) --
The number of days the utilization metrics of the Amazon RDS are analyzed.
savingsEstimationMode (dict) --
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon RDS.
source (string) --
Describes the source for calculating the savings opportunity for Amazon RDS.
lookbackPeriodInDays (float) --
The number of days the Amazon RDS utilization metrics were analyzed.
lastRefreshTimestamp (datetime) --
The timestamp of when the Amazon RDS recommendation was last generated.
tags (list) --
A list of tags assigned to your Amazon RDS recommendations.
(dict) --
A list of tag key and value pairs that you define.
key (string) --
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
errors (list) --
An array of objects that describe errors of the request.
(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.
{'resourceType': {'Idle'}}
Response {'recommendationPreferencesDetails': {'resourceType': {'Idle'}}}
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the scope parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
See also: AWS API Documentation
Request Syntax
client.get_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License'|'RdsDBInstance'|'Idle',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The target resource type of the recommendation preference for which to return preferences.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
dict
An object that describes the scope of the recommendation preference to return.
You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS.
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
string
The token to advance to the next page of recommendation preferences.
integer
The maximum number of recommendation preferences to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationPreferencesDetails': [
{
'scope': {
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
'resourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License'|'RdsDBInstance'|'Idle',
'enhancedInfrastructureMetrics': 'Active'|'Inactive',
'inferredWorkloadTypes': 'Active'|'Inactive',
'externalMetricsPreference': {
'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
},
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93',
'utilizationPreferences': [
{
'metricName': 'CpuUtilization'|'MemoryUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_10'|'PERCENT_0'
}
},
],
'preferredResources': [
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'effectiveIncludeList': [
'string',
],
'excludeList': [
'string',
]
},
],
'savingsEstimationMode': 'AfterDiscounts'|'BeforeDiscounts'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of recommendation preferences.
This value is null when there are no more pages of recommendation preferences to return.
recommendationPreferencesDetails (list) --
An array of objects that describe recommendation preferences.
(dict) --
Describes a recommendation preference.
scope (dict) --
An object that describes the scope of the recommendation preference.
Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS.
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
resourceType (string) --
The target resource type of the recommendation preference to create.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
enhancedInfrastructureMetrics (string) --
The status of the enhanced infrastructure metrics recommendation preference.
When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
inferredWorkloadTypes (string) --
The status of the inferred workload types recommendation preference.
When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.
externalMetricsPreference (dict) --
An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.
source (string) --
Contains the source options for external metrics preferences.
lookBackPeriod (string) --
The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.
utilizationPreferences (list) --
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. If the preference isn’t set, this object is null.
(dict) --
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom.
metricName (string) --
The name of the resource utilization metric name to customize.
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom value in percentage used for the specified metric parameter.
The following lists the valid values for CPU and memory utilization.
CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0
Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10
preferredResources (list) --
The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
(dict) --
Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.
name (string) --
The name of the preferred resource list.
includeList (list) --
The list of preferred resource values that you want considered as rightsizing recommendation candidates.
(string) --
effectiveIncludeList (list) --
The expanded version of your preferred resource's include list.
(string) --
excludeList (list) --
The list of preferred resources values that you want excluded from rightsizing recommendation candidates.
(string) --
savingsEstimationMode (string) --
Describes the savings estimation mode used for calculating savings opportunity.
Only the account manager or delegated administrator of your organization can activate this preference.
{'recommendationSummaries': {'aggregatedSavingsOpportunity': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'},
'idleSavingsOpportunity': {'estimatedMonthlySavings': {'currency': 'USD '
'| '
'CNY',
'value': 'double'},
'savingsOpportunityPercentage': 'double'},
'idleSummaries': [{'name': 'Idle | Unattached',
'value': 'double'}]}}
Returns the optimization findings for an account.
It returns the number of:
Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.
Auto Scaling groups in an account that are NotOptimized, or Optimized.
Amazon EBS volumes in an account that are NotOptimized, or Optimized.
Lambda functions in an account that are NotOptimized, or Optimized.
Amazon ECS services in an account that are Underprovisioned, Overprovisioned, or Optimized.
See also: AWS API Documentation
Request Syntax
client.get_recommendation_summaries(
accountIds=[
'string',
],
nextToken='string',
maxResults=123
)
list
The ID of the Amazon Web Services account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
(string) --
string
The token to advance to the next page of recommendation summaries.
integer
The maximum number of recommendation summaries to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationSummaries': [
{
'summaries': [
{
'name': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
'value': 123.0,
'reasonCodeSummaries': [
{
'name': 'MemoryOverprovisioned'|'MemoryUnderprovisioned',
'value': 123.0
},
]
},
],
'idleSummaries': [
{
'name': 'Idle'|'Unattached',
'value': 123.0
},
],
'recommendationResourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'EcsService'|'License'|'RdsDBInstance'|'RdsDBInstanceStorage',
'accountId': 'string',
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'idleSavingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'aggregatedSavingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'currentPerformanceRiskRatings': {
'high': 123,
'medium': 123,
'low': 123,
'veryLow': 123
},
'inferredWorkloadSavings': [
{
'inferredWorkloadTypes': [
'AmazonEmr'|'ApacheCassandra'|'ApacheHadoop'|'Memcached'|'Nginx'|'PostgreSql'|'Redis'|'Kafka'|'SQLServer',
],
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to use to advance to the next page of recommendation summaries.
This value is null when there are no more pages of recommendation summaries to return.
recommendationSummaries (list) --
An array of objects that summarize a recommendation.
(dict) --
A summary of a recommendation.
summaries (list) --
An array of objects that describe a recommendation summary.
(dict) --
The summary of a recommendation.
name (string) --
The finding classification of the recommendation.
value (float) --
The value of the recommendation summary.
reasonCodeSummaries (list) --
An array of objects that summarize a finding reason code.
(dict) --
A summary of a finding reason code.
name (string) --
The name of the finding reason code.
value (float) --
The value of the finding reason code summary.
idleSummaries (list) --
Describes the findings summary of the idle resources.
(dict) --
Describes the findings summary of the idle resources.
name (string) --
The name of the finding group for the idle resources.
value (float) --
The count of idle resources in the finding group.
recommendationResourceType (string) --
The resource type that the recommendation summary applies to.
accountId (string) --
The Amazon Web Services account ID of the recommendation summary.
savingsOpportunity (dict) --
An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
idleSavingsOpportunity (dict) --
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
aggregatedSavingsOpportunity (dict) --
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.
Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
currentPerformanceRiskRatings (dict) --
An object that describes the performance risk ratings for a given resource type.
high (integer) --
A count of the applicable resource types with a high performance risk rating.
medium (integer) --
A count of the applicable resource types with a medium performance risk rating.
low (integer) --
A count of the applicable resource types with a low performance risk rating.
veryLow (integer) --
A count of the applicable resource types with a very low performance risk rating.
inferredWorkloadSavings (list) --
An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top five savings opportunites for the instances that run inferred workload types.
(dict) --
The estimated monthly savings after you adjust the configurations of your instances running on the inferred workload types to the recommended configurations. If the inferredWorkloadTypes list contains multiple entries, then the savings are the sum of the monthly savings from instances that run the exact combination of the inferred workload types.
inferredWorkloadTypes (list) --
The applications that might be running on the instance as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instance:
AmazonEmr - Infers that Amazon EMR might be running on the instance.
ApacheCassandra - Infers that Apache Cassandra might be running on the instance.
ApacheHadoop - Infers that Apache Hadoop might be running on the instance.
Memcached - Infers that Memcached might be running on the instance.
NGINX - Infers that NGINX might be running on the instance.
PostgreSql - Infers that PostgreSQL might be running on the instance.
Redis - Infers that Redis might be running on the instance.
Kafka - Infers that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
(string) --
estimatedMonthlySavings (dict) --
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
{'resourceType': {'Idle'}}
Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
See also: AWS API Documentation
Request Syntax
client.put_recommendation_preferences(
resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService'|'License'|'RdsDBInstance'|'Idle',
scope={
'name': 'Organization'|'AccountId'|'ResourceArn',
'value': 'string'
},
enhancedInfrastructureMetrics='Active'|'Inactive',
inferredWorkloadTypes='Active'|'Inactive',
externalMetricsPreference={
'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
},
lookBackPeriod='DAYS_14'|'DAYS_32'|'DAYS_93',
utilizationPreferences=[
{
'metricName': 'CpuUtilization'|'MemoryUtilization',
'metricParameters': {
'threshold': 'P90'|'P95'|'P99_5',
'headroom': 'PERCENT_30'|'PERCENT_20'|'PERCENT_10'|'PERCENT_0'
}
},
],
preferredResources=[
{
'name': 'Ec2InstanceTypes',
'includeList': [
'string',
],
'excludeList': [
'string',
]
},
],
savingsEstimationMode='AfterDiscounts'|'BeforeDiscounts'
)
string
[REQUIRED]
The target resource type of the recommendation preference to create.
The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.
dict
An object that describes the scope of the recommendation preference to create.
You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
name (string) --
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
value (string) --
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS.
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
string
The status of the enhanced infrastructure metrics recommendation preference to create or update.
Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
string
The status of the inferred workload types recommendation preference to create or update.
Specify the Inactive status to deactivate the feature, or specify Active to activate it.
For more information, see Inferred workload types in the Compute Optimizer User Guide.
dict
The provider of the external metrics recommendation preference to create or update.
Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.
This preference can only be set for the Ec2Instance resource type.
For more information, see External metrics ingestion in the Compute Optimizer User Guide.
source (string) --
Contains the source options for external metrics preferences.
string
The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14.
You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.
list
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values.
CPU utilization:
P99_5 for threshold
PERCENT_20 for headroom
Memory utilization:
PERCENT_20 for headroom
(dict) --
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom.
metricName (string) --
The name of the resource utilization metric name to customize.
metricParameters (dict) --
The parameters to set when customizing the resource utilization thresholds.
threshold (string) --
The threshold value used for the specified metric parameter.
headroom (string) --
The headroom value in percentage used for the specified metric parameter.
The following lists the valid values for CPU and memory utilization.
CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0
Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10
list
The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs.
(dict) --
The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs. For more information, see Rightsizing recommendation preferences in the Compute Optimizer User Guide.
name (string) --
The type of preferred resource to customize.
includeList (list) --
The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
(string) --
excludeList (list) --
The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.
(string) --
string
The status of the savings estimation mode preference to create or update.
Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.
Only the account manager or delegated administrator of your organization can activate this preference.
For more information, see Savings estimation mode in the Compute Optimizer User Guide.
dict
Response Syntax
{}
Response Structure
(dict) --