AWS.ComputeOptimizer (aws-elixir v0.8.0) View Source

AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, AWS Lambda functions, and Amazon EBS volumes.

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, as well as 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 AWS Compute Optimizer User Guide.

Link to this section Summary

Functions

Describes recommendation export jobs created in the last seven days.

Exports optimization recommendations for Auto Scaling groups.

Exports optimization recommendations for Amazon EBS volumes.

Exports optimization recommendations for Amazon EC2 instances.

Exports optimization recommendations for AWS Lambda functions.

Returns Auto Scaling group 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 enrollment (opt in) status of an account to the AWS Compute Optimizer service.

Returns AWS Lambda function recommendations.

Returns the optimization findings for an account.

Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service.

Link to this section Functions

Link to this function

describe_recommendation_export_jobs(client, input, options \\ [])

View Source

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.

Link to this function

export_auto_scaling_group_recommendations(client, input, options \\ [])

View Source

Exports optimization recommendations for Auto Scaling groups.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per AWS Region.

Link to this function

export_ebs_volume_recommendations(client, input, options \\ [])

View Source

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) 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 AWS Region.

Link to this function

export_ec2_instance_recommendations(client, input, options \\ [])

View Source

Exports optimization recommendations for Amazon EC2 instances.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EC2 instance export job in progress per AWS Region.

Link to this function

export_lambda_function_recommendations(client, input, options \\ [])

View Source

Exports optimization recommendations for AWS Lambda functions.

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 Lambda function export job in progress per AWS Region.

Link to this function

get_auto_scaling_group_recommendations(client, input, options \\ [])

View Source

Returns Auto Scaling group recommendations.

AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Link to this function

get_ebs_volume_recommendations(client, input, options \\ [])

View Source

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

AWS 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 AWS Compute Optimizer User Guide.

Link to this function

get_ec2_instance_recommendations(client, input, options \\ [])

View Source

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Link to this function

get_ec2_recommendation_projected_metrics(client, input, options \\ [])

View Source

Returns 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.

Link to this function

get_enrollment_status(client, input, options \\ [])

View Source

Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is the management account of an organization, this action also confirms the enrollment status of member accounts within the organization.

Link to this function

get_lambda_function_recommendations(client, input, options \\ [])

View Source

Returns AWS Lambda function recommendations.

AWS Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Link to this function

get_recommendation_summaries(client, input, options \\ [])

View Source

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.

Link to this function

update_enrollment_status(client, input, options \\ [])

View Source

Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service.

If the account is a management account of an organization, this action can also be used to enroll member accounts within 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 AWS Identity and Access Management in the AWS 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 AWS Compute Optimizer in the AWS Compute Optimizer User Guide.