amazonaws.com – compute-optimizer

OpenAPI apis-guru cloud

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 .

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:compute-optimizer/2019-11-01.json
Provider: amazonaws.com:compute-optimizer / compute-optimizer
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/compute-optimizer/2019-11-01/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/compute-optimizer/2019-11-01/openapi.yaml

Tools (23)

Extracted live via the executor SDK.

xAmzTargetComputeOptimizerServiceDeleteRecommendationPreferences.deleteRecommendationPreferences

Deletes a recommendation preference, such as enhanced infrastructure metrics.

For more information, see in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceDescribeRecommendationExportJobs.describeRecommendationExportJobs

Describes recommendation export jobs created in the last seven days.

Use the ExportAutoScalingGroupRecommendations [blocked] or ExportEC2InstanceRecommendations [blocked] actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs [blocked] action to view your export jobs.
xAmzTargetComputeOptimizerServiceExportAutoScalingGroupRecommendations.exportAutoScalingGroupRecommendations

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) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
xAmzTargetComputeOptimizerServiceExportEbsVolumeRecommendations.exportEbsVolumeRecommendations

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

You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
xAmzTargetComputeOptimizerServiceExportEC2InstanceRecommendations.exportEC2InstanceRecommendations

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

You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
xAmzTargetComputeOptimizerServiceExportEcsServiceRecommendations.exportEcsServiceRecommendations

Exports 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 in the Compute Optimizer User Guide.

You can only have one Amazon ECS service export job in progress per Amazon Web Services Region.
xAmzTargetComputeOptimizerServiceExportLambdaFunctionRecommendations.exportLambdaFunctionRecommendations

Exports 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 in the Compute Optimizer User Guide.

You can have only one Lambda function export job in progress per Amazon Web Services Region.
xAmzTargetComputeOptimizerServiceGetAutoScalingGroupRecommendations.getAutoScalingGroupRecommendations

Returns 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 in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceGetEbsVolumeRecommendations.getEbsVolumeRecommendations

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 in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceGetEC2InstanceRecommendations.getEC2InstanceRecommendations

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 in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceGetEC2RecommendationProjectedMetrics.getEC2RecommendationProjectedMetrics

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 .
xAmzTargetComputeOptimizerServiceGetEcsServiceRecommendationProjectedMetrics.getEcsServiceRecommendationProjectedMetrics

Returns the projected metrics of Amazon ECS service recommendations.
xAmzTargetComputeOptimizerServiceGetEcsServiceRecommendations.getEcsServiceRecommendations

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 in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceGetEffectiveRecommendationPreferences.getEffectiveRecommendationPreferences

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

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 [blocked] action to get detailed information about the enrollment status of member accounts of an organization.
xAmzTargetComputeOptimizerServiceGetEnrollmentStatusesForOrganization.getEnrollmentStatusesForOrganization

Returns 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 [blocked] action.
xAmzTargetComputeOptimizerServiceGetLambdaFunctionRecommendations.getLambdaFunctionRecommendations

Returns Lambda function recommendations.

Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceGetRecommendationPreferences.getRecommendationPreferences

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 in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceGetRecommendationSummaries.getRecommendationSummaries
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.
xAmzTargetComputeOptimizerServicePutRecommendationPreferences.putRecommendationPreferences

Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.

For more information, see in the Compute Optimizer User Guide.
xAmzTargetComputeOptimizerServiceUpdateEnrollmentStatus.updateEnrollmentStatus

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 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 in the Compute Optimizer User Guide.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools