@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ComputeOptimizerAsyncClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static ComputeOptimizerAsyncClient create()
ComputeOptimizerAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ComputeOptimizerAsyncClientBuilder builder()
ComputeOptimizerAsyncClient.default CompletableFuture<DescribeRecommendationExportJobsResponse> describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest)
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.
describeRecommendationExportJobsRequest - default CompletableFuture<DescribeRecommendationExportJobsResponse> describeRecommendationExportJobs(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest)
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.
This is a convenience which creates an instance of the DescribeRecommendationExportJobsRequest.Builder
avoiding the need to create one manually via DescribeRecommendationExportJobsRequest.builder()
describeRecommendationExportJobsRequest - A Consumer that will call methods on DescribeRecommendationExportJobsRequest.Builder to
create a request.default CompletableFuture<ExportAutoScalingGroupRecommendationsResponse> exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest)
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.
exportAutoScalingGroupRecommendationsRequest - default CompletableFuture<ExportAutoScalingGroupRecommendationsResponse> exportAutoScalingGroupRecommendations(Consumer<ExportAutoScalingGroupRecommendationsRequest.Builder> exportAutoScalingGroupRecommendationsRequest)
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.
This is a convenience which creates an instance of the
ExportAutoScalingGroupRecommendationsRequest.Builder avoiding the need to create one manually via
ExportAutoScalingGroupRecommendationsRequest.builder()
exportAutoScalingGroupRecommendationsRequest - A Consumer that will call methods on ExportAutoScalingGroupRecommendationsRequest.Builder
to create a request.default CompletableFuture<ExportEbsVolumeRecommendationsResponse> exportEBSVolumeRecommendations(ExportEbsVolumeRecommendationsRequest exportEbsVolumeRecommendationsRequest)
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.
exportEbsVolumeRecommendationsRequest - default CompletableFuture<ExportEbsVolumeRecommendationsResponse> exportEBSVolumeRecommendations(Consumer<ExportEbsVolumeRecommendationsRequest.Builder> exportEbsVolumeRecommendationsRequest)
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.
This is a convenience which creates an instance of the ExportEbsVolumeRecommendationsRequest.Builder
avoiding the need to create one manually via ExportEbsVolumeRecommendationsRequest.builder()
exportEbsVolumeRecommendationsRequest - A Consumer that will call methods on ExportEBSVolumeRecommendationsRequest.Builder to
create a request.default CompletableFuture<ExportEc2InstanceRecommendationsResponse> exportEC2InstanceRecommendations(ExportEc2InstanceRecommendationsRequest exportEc2InstanceRecommendationsRequest)
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.
exportEc2InstanceRecommendationsRequest - default CompletableFuture<ExportEc2InstanceRecommendationsResponse> exportEC2InstanceRecommendations(Consumer<ExportEc2InstanceRecommendationsRequest.Builder> exportEc2InstanceRecommendationsRequest)
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.
This is a convenience which creates an instance of the ExportEc2InstanceRecommendationsRequest.Builder
avoiding the need to create one manually via ExportEc2InstanceRecommendationsRequest.builder()
exportEc2InstanceRecommendationsRequest - A Consumer that will call methods on ExportEC2InstanceRecommendationsRequest.Builder to
create a request.default CompletableFuture<ExportLambdaFunctionRecommendationsResponse> exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest)
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.
exportLambdaFunctionRecommendationsRequest - default CompletableFuture<ExportLambdaFunctionRecommendationsResponse> exportLambdaFunctionRecommendations(Consumer<ExportLambdaFunctionRecommendationsRequest.Builder> exportLambdaFunctionRecommendationsRequest)
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.
This is a convenience which creates an instance of the ExportLambdaFunctionRecommendationsRequest.Builder
avoiding the need to create one manually via ExportLambdaFunctionRecommendationsRequest.builder()
exportLambdaFunctionRecommendationsRequest - A Consumer that will call methods on ExportLambdaFunctionRecommendationsRequest.Builder to
create a request.default CompletableFuture<GetAutoScalingGroupRecommendationsResponse> getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest)
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.
getAutoScalingGroupRecommendationsRequest - default CompletableFuture<GetAutoScalingGroupRecommendationsResponse> getAutoScalingGroupRecommendations(Consumer<GetAutoScalingGroupRecommendationsRequest.Builder> getAutoScalingGroupRecommendationsRequest)
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.
This is a convenience which creates an instance of the GetAutoScalingGroupRecommendationsRequest.Builder
avoiding the need to create one manually via GetAutoScalingGroupRecommendationsRequest.builder()
getAutoScalingGroupRecommendationsRequest - A Consumer that will call methods on GetAutoScalingGroupRecommendationsRequest.Builder to
create a request.default CompletableFuture<GetEbsVolumeRecommendationsResponse> getEBSVolumeRecommendations(GetEbsVolumeRecommendationsRequest getEbsVolumeRecommendationsRequest)
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.
getEbsVolumeRecommendationsRequest - default CompletableFuture<GetEbsVolumeRecommendationsResponse> getEBSVolumeRecommendations(Consumer<GetEbsVolumeRecommendationsRequest.Builder> getEbsVolumeRecommendationsRequest)
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.
This is a convenience which creates an instance of the GetEbsVolumeRecommendationsRequest.Builder
avoiding the need to create one manually via GetEbsVolumeRecommendationsRequest.builder()
getEbsVolumeRecommendationsRequest - A Consumer that will call methods on GetEBSVolumeRecommendationsRequest.Builder to create
a request.default CompletableFuture<GetEc2InstanceRecommendationsResponse> getEC2InstanceRecommendations(GetEc2InstanceRecommendationsRequest getEc2InstanceRecommendationsRequest)
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.
getEc2InstanceRecommendationsRequest - default CompletableFuture<GetEc2InstanceRecommendationsResponse> getEC2InstanceRecommendations(Consumer<GetEc2InstanceRecommendationsRequest.Builder> getEc2InstanceRecommendationsRequest)
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.
This is a convenience which creates an instance of the GetEc2InstanceRecommendationsRequest.Builder
avoiding the need to create one manually via GetEc2InstanceRecommendationsRequest.builder()
getEc2InstanceRecommendationsRequest - A Consumer that will call methods on GetEC2InstanceRecommendationsRequest.Builder to
create a request.default CompletableFuture<GetEc2RecommendationProjectedMetricsResponse> getEC2RecommendationProjectedMetrics(GetEc2RecommendationProjectedMetricsRequest getEc2RecommendationProjectedMetricsRequest)
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.
getEc2RecommendationProjectedMetricsRequest - default CompletableFuture<GetEc2RecommendationProjectedMetricsResponse> getEC2RecommendationProjectedMetrics(Consumer<GetEc2RecommendationProjectedMetricsRequest.Builder> getEc2RecommendationProjectedMetricsRequest)
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.
This is a convenience which creates an instance of the
GetEc2RecommendationProjectedMetricsRequest.Builder avoiding the need to create one manually via
GetEc2RecommendationProjectedMetricsRequest.builder()
getEc2RecommendationProjectedMetricsRequest - A Consumer that will call methods on GetEC2RecommendationProjectedMetricsRequest.Builder
to create a request.default CompletableFuture<GetEnrollmentStatusResponse> getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest)
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.
getEnrollmentStatusRequest - default CompletableFuture<GetEnrollmentStatusResponse> getEnrollmentStatus(Consumer<GetEnrollmentStatusRequest.Builder> getEnrollmentStatusRequest)
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.
This is a convenience which creates an instance of the GetEnrollmentStatusRequest.Builder avoiding the
need to create one manually via GetEnrollmentStatusRequest.builder()
getEnrollmentStatusRequest - A Consumer that will call methods on GetEnrollmentStatusRequest.Builder to create a
request.default CompletableFuture<GetLambdaFunctionRecommendationsResponse> getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest)
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.
getLambdaFunctionRecommendationsRequest - default CompletableFuture<GetLambdaFunctionRecommendationsResponse> getLambdaFunctionRecommendations(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest)
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.
This is a convenience which creates an instance of the GetLambdaFunctionRecommendationsRequest.Builder
avoiding the need to create one manually via GetLambdaFunctionRecommendationsRequest.builder()
getLambdaFunctionRecommendationsRequest - A Consumer that will call methods on GetLambdaFunctionRecommendationsRequest.Builder to
create a request.default CompletableFuture<GetRecommendationSummariesResponse> getRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest)
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.
getRecommendationSummariesRequest - default CompletableFuture<GetRecommendationSummariesResponse> getRecommendationSummaries(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest)
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.
This is a convenience which creates an instance of the GetRecommendationSummariesRequest.Builder avoiding
the need to create one manually via GetRecommendationSummariesRequest.builder()
getRecommendationSummariesRequest - A Consumer that will call methods on GetRecommendationSummariesRequest.Builder to create a
request.default CompletableFuture<UpdateEnrollmentStatusResponse> updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)
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.
updateEnrollmentStatusRequest - default CompletableFuture<UpdateEnrollmentStatusResponse> updateEnrollmentStatus(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest)
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.
This is a convenience which creates an instance of the UpdateEnrollmentStatusRequest.Builder avoiding the
need to create one manually via UpdateEnrollmentStatusRequest.builder()
updateEnrollmentStatusRequest - A Consumer that will call methods on UpdateEnrollmentStatusRequest.Builder to create a
request.