View Source AWS.ComputeOptimizer (aws-elixir v1.0.4)
Compute Optimizer is a service that analyzes the configuration and utilization metrics of your Amazon Web Services compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate.
It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, in addition to projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the Compute Optimizer User Guide.
Link to this section Summary
Functions
Deletes a recommendation preference, such as enhanced infrastructure metrics.
Describes recommendation export jobs created in the last seven days.
Exports optimization recommendations for Auto Scaling groups.
Exports optimization recommendations for Amazon ECS services on Fargate.
Exports optimization recommendations for Amazon EBS volumes.
Exports optimization recommendations for Amazon EC2 instances.
Export optimization recommendations for your idle resources.
Exports optimization recommendations for Lambda functions.
Export optimization recommendations for your licenses.
Export optimization recommendations for your Amazon Relational Database Service (Amazon RDS).
Returns Auto Scaling group recommendations.
Returns the projected metrics of Amazon ECS service recommendations.
Returns Amazon ECS service recommendations.
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
Returns Amazon EC2 instance recommendations.
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.
Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
Returns idle resource recommendations.
Returns Lambda function recommendations.
Returns license recommendations for Amazon EC2 instances that run on a specific license.
Returns the projected metrics of Amazon RDS recommendations.
Returns Amazon RDS recommendations.
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Returns the optimization findings for an account.
Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
Link to this section Functions
Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
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.
export_auto_scaling_group_recommendations(client, input, options \\ [])
View SourceExports 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) (.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 Amazon Web Services Region.
export_e_c_s_service_recommendations(client, input, options \\ [])
View SourceExports optimization recommendations for Amazon ECS services on Fargate.
Recommendations are exported in a CSV file, and its metadata in a 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 only have one Amazon ECS service export job in progress per Amazon Web Services Region.
Exports optimization recommendations for Amazon EBS volumes.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.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 EBS volume export job in progress per Amazon Web Services Region.
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) (.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 Amazon Web Services Region.
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.
export_lambda_function_recommendations(client, input, options \\ [])
View SourceExports optimization recommendations for Lambda functions.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.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 Lambda function export job in progress per Amazon Web Services Region.
Export optimization recommendations for your licenses.
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 license export job in progress per Amazon Web Services Region.
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.
get_auto_scaling_group_recommendations(client, input, options \\ [])
View SourceReturns Auto Scaling group recommendations.
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 Compute Optimizer User Guide.
get_e_c_s_service_recommendation_projected_metrics(client, input, options \\ [])
View SourceReturns the projected metrics of Amazon ECS service recommendations.
Returns Amazon ECS service recommendations.
Compute Optimizer generates recommendations for Amazon ECS services on Fargate that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
Returns Amazon EC2 instance recommendations.
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 Compute Optimizer User Guide.
get_ec2_recommendation_projected_metrics(client, input, options \\ [])
View SourceReturns the projected utilization metrics of Amazon EC2 instance recommendations.
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.
get_effective_recommendation_preferences(client, input, options \\ [])
View SourceReturns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.
Considers all applicable preferences that you might have set at the resource, account, and organization level.
When you create a recommendation preference, you can set its status to
Active or Inactive. Use this action to view the
recommendation preferences that are in effect, or Active.
Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
If the account is the management account of an organization, this action also
confirms
the enrollment status of member accounts of the organization. Use the
GetEnrollmentStatusesForOrganization action to get detailed information
about the enrollment status of member accounts of an organization.
get_enrollment_statuses_for_organization(client, input, options \\ [])
View SourceReturns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
To get the enrollment status of standalone accounts, use the
GetEnrollmentStatus action.
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
Returns Lambda function recommendations.
Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
Returns license recommendations for Amazon EC2 instances that run on a specific license.
Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
get_rds_database_recommendation_projected_metrics(client, input, options \\ [])
View SourceReturns the projected metrics of Amazon RDS recommendations.
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.
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.
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.
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.
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.