Interface ComputeOptimizerAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aComputeOptimizerAsyncClient
.static ComputeOptimizerAsyncClient
create()
Create aComputeOptimizerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteRecommendationPreferences
(Consumer<DeleteRecommendationPreferencesRequest.Builder> deleteRecommendationPreferencesRequest) Deletes a recommendation preference, such as enhanced infrastructure metrics.deleteRecommendationPreferences
(DeleteRecommendationPreferencesRequest deleteRecommendationPreferencesRequest) Deletes a recommendation preference, such as enhanced infrastructure metrics.describeRecommendationExportJobs
(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest) Describes recommendation export jobs created in the last seven days.describeRecommendationExportJobs
(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest) Describes recommendation export jobs created in the last seven days.describeRecommendationExportJobsPaginator
(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest) This is a variant ofdescribeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)
operation.describeRecommendationExportJobsPaginator
(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest) This is a variant ofdescribeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)
operation.exportAutoScalingGroupRecommendations
(Consumer<ExportAutoScalingGroupRecommendationsRequest.Builder> exportAutoScalingGroupRecommendationsRequest) Exports optimization recommendations for Auto Scaling groups.exportAutoScalingGroupRecommendations
(ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest) Exports optimization recommendations for Auto Scaling groups.exportEBSVolumeRecommendations
(Consumer<ExportEbsVolumeRecommendationsRequest.Builder> exportEbsVolumeRecommendationsRequest) Exports optimization recommendations for Amazon EBS volumes.exportEBSVolumeRecommendations
(ExportEbsVolumeRecommendationsRequest exportEbsVolumeRecommendationsRequest) Exports optimization recommendations for Amazon EBS volumes.exportEC2InstanceRecommendations
(Consumer<ExportEc2InstanceRecommendationsRequest.Builder> exportEc2InstanceRecommendationsRequest) Exports optimization recommendations for Amazon EC2 instances.exportEC2InstanceRecommendations
(ExportEc2InstanceRecommendationsRequest exportEc2InstanceRecommendationsRequest) Exports optimization recommendations for Amazon EC2 instances.exportECSServiceRecommendations
(Consumer<ExportEcsServiceRecommendationsRequest.Builder> exportEcsServiceRecommendationsRequest) Exports optimization recommendations for Amazon ECS services on Fargate.exportECSServiceRecommendations
(ExportEcsServiceRecommendationsRequest exportEcsServiceRecommendationsRequest) Exports optimization recommendations for Amazon ECS services on Fargate.exportLambdaFunctionRecommendations
(Consumer<ExportLambdaFunctionRecommendationsRequest.Builder> exportLambdaFunctionRecommendationsRequest) Exports optimization recommendations for Lambda functions.exportLambdaFunctionRecommendations
(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest) Exports optimization recommendations for Lambda functions.exportLicenseRecommendations
(Consumer<ExportLicenseRecommendationsRequest.Builder> exportLicenseRecommendationsRequest) Export optimization recommendations for your licenses.exportLicenseRecommendations
(ExportLicenseRecommendationsRequest exportLicenseRecommendationsRequest) Export optimization recommendations for your licenses.getAutoScalingGroupRecommendations
(Consumer<GetAutoScalingGroupRecommendationsRequest.Builder> getAutoScalingGroupRecommendationsRequest) Returns Auto Scaling group recommendations.getAutoScalingGroupRecommendations
(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest) Returns Auto Scaling group recommendations.getEBSVolumeRecommendations
(Consumer<GetEbsVolumeRecommendationsRequest.Builder> getEbsVolumeRecommendationsRequest) Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.getEBSVolumeRecommendations
(GetEbsVolumeRecommendationsRequest getEbsVolumeRecommendationsRequest) Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.getEC2InstanceRecommendations
(Consumer<GetEc2InstanceRecommendationsRequest.Builder> getEc2InstanceRecommendationsRequest) Returns Amazon EC2 instance recommendations.getEC2InstanceRecommendations
(GetEc2InstanceRecommendationsRequest getEc2InstanceRecommendationsRequest) Returns Amazon EC2 instance recommendations.getEC2RecommendationProjectedMetrics
(Consumer<GetEc2RecommendationProjectedMetricsRequest.Builder> getEc2RecommendationProjectedMetricsRequest) Returns the projected utilization metrics of Amazon EC2 instance recommendations.getEC2RecommendationProjectedMetrics
(GetEc2RecommendationProjectedMetricsRequest getEc2RecommendationProjectedMetricsRequest) Returns the projected utilization metrics of Amazon EC2 instance recommendations.getECSServiceRecommendationProjectedMetrics
(Consumer<GetEcsServiceRecommendationProjectedMetricsRequest.Builder> getEcsServiceRecommendationProjectedMetricsRequest) Returns the projected metrics of Amazon ECS service recommendations.getECSServiceRecommendationProjectedMetrics
(GetEcsServiceRecommendationProjectedMetricsRequest getEcsServiceRecommendationProjectedMetricsRequest) Returns the projected metrics of Amazon ECS service recommendations.getECSServiceRecommendations
(Consumer<GetEcsServiceRecommendationsRequest.Builder> getEcsServiceRecommendationsRequest) Returns Amazon ECS service recommendations.getECSServiceRecommendations
(GetEcsServiceRecommendationsRequest getEcsServiceRecommendationsRequest) Returns Amazon ECS service recommendations.getEffectiveRecommendationPreferences
(Consumer<GetEffectiveRecommendationPreferencesRequest.Builder> getEffectiveRecommendationPreferencesRequest) Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.getEffectiveRecommendationPreferences
(GetEffectiveRecommendationPreferencesRequest getEffectiveRecommendationPreferencesRequest) Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.getEnrollmentStatus
(Consumer<GetEnrollmentStatusRequest.Builder> getEnrollmentStatusRequest) Returns the enrollment (opt in) status of an account to the Compute Optimizer service.getEnrollmentStatus
(GetEnrollmentStatusRequest getEnrollmentStatusRequest) Returns the enrollment (opt in) status of an account to the Compute Optimizer service.getEnrollmentStatusesForOrganization
(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest) Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.getEnrollmentStatusesForOrganization
(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.getEnrollmentStatusesForOrganizationPaginator
(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest) getEnrollmentStatusesForOrganizationPaginator
(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) getLambdaFunctionRecommendations
(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest) Returns Lambda function recommendations.getLambdaFunctionRecommendations
(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) Returns Lambda function recommendations.getLambdaFunctionRecommendationsPaginator
(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest) This is a variant ofgetLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)
operation.getLambdaFunctionRecommendationsPaginator
(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) This is a variant ofgetLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)
operation.getLicenseRecommendations
(Consumer<GetLicenseRecommendationsRequest.Builder> getLicenseRecommendationsRequest) Returns license recommendations for Amazon EC2 instances that run on a specific license.getLicenseRecommendations
(GetLicenseRecommendationsRequest getLicenseRecommendationsRequest) Returns license recommendations for Amazon EC2 instances that run on a specific license.getRecommendationPreferences
(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest) Returns existing recommendation preferences, such as enhanced infrastructure metrics.getRecommendationPreferences
(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) Returns existing recommendation preferences, such as enhanced infrastructure metrics.getRecommendationPreferencesPaginator
(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest) This is a variant ofgetRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)
operation.getRecommendationPreferencesPaginator
(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) This is a variant ofgetRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)
operation.getRecommendationSummaries
(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest) Returns the optimization findings for an account.getRecommendationSummaries
(GetRecommendationSummariesRequest getRecommendationSummariesRequest) Returns the optimization findings for an account.getRecommendationSummariesPaginator
(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest) This is a variant ofgetRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)
operation.getRecommendationSummariesPaginator
(GetRecommendationSummariesRequest getRecommendationSummariesRequest) This is a variant ofgetRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)
operation.putRecommendationPreferences
(Consumer<PutRecommendationPreferencesRequest.Builder> putRecommendationPreferencesRequest) Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.putRecommendationPreferences
(PutRecommendationPreferencesRequest putRecommendationPreferencesRequest) Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdateEnrollmentStatus
(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest) Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.updateEnrollmentStatus
(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest) Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
deleteRecommendationPreferences
default CompletableFuture<DeleteRecommendationPreferencesResponse> deleteRecommendationPreferences(DeleteRecommendationPreferencesRequest deleteRecommendationPreferencesRequest) Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
- Parameters:
deleteRecommendationPreferencesRequest
-- Returns:
- A Java Future containing the result of the DeleteRecommendationPreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRecommendationPreferences
default CompletableFuture<DeleteRecommendationPreferencesResponse> deleteRecommendationPreferences(Consumer<DeleteRecommendationPreferencesRequest.Builder> deleteRecommendationPreferencesRequest) Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
This is a convenience which creates an instance of the
DeleteRecommendationPreferencesRequest.Builder
avoiding the need to create one manually viaDeleteRecommendationPreferencesRequest.builder()
- Parameters:
deleteRecommendationPreferencesRequest
- AConsumer
that will call methods onDeleteRecommendationPreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRecommendationPreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRecommendationExportJobs
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.
- Parameters:
describeRecommendationExportJobsRequest
-- Returns:
- A Java Future containing the result of the DescribeRecommendationExportJobs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRecommendationExportJobs
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 viaDescribeRecommendationExportJobsRequest.builder()
- Parameters:
describeRecommendationExportJobsRequest
- AConsumer
that will call methods onDescribeRecommendationExportJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRecommendationExportJobs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRecommendationExportJobsPaginator
default DescribeRecommendationExportJobsPublisher describeRecommendationExportJobsPaginator(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest) This is a variant of
describeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsPublisher publisher = client.describeRecommendationExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsPublisher publisher = client.describeRecommendationExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)
operation.- Parameters:
describeRecommendationExportJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRecommendationExportJobsPaginator
default DescribeRecommendationExportJobsPublisher describeRecommendationExportJobsPaginator(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest) This is a variant of
describeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsPublisher publisher = client.describeRecommendationExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsPublisher publisher = client.describeRecommendationExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRecommendationExportJobsRequest.Builder
avoiding the need to create one manually viaDescribeRecommendationExportJobsRequest.builder()
- Parameters:
describeRecommendationExportJobsRequest
- AConsumer
that will call methods onDescribeRecommendationExportJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportAutoScalingGroupRecommendations
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) (.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.
- Parameters:
exportAutoScalingGroupRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ExportAutoScalingGroupRecommendations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportAutoScalingGroupRecommendations
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) (.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.
This is a convenience which creates an instance of the
ExportAutoScalingGroupRecommendationsRequest.Builder
avoiding the need to create one manually viaExportAutoScalingGroupRecommendationsRequest.builder()
- Parameters:
exportAutoScalingGroupRecommendationsRequest
- AConsumer
that will call methods onExportAutoScalingGroupRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportAutoScalingGroupRecommendations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportEBSVolumeRecommendations
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) (.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.
- Parameters:
exportEbsVolumeRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ExportEBSVolumeRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportEBSVolumeRecommendations
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) (.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.
This is a convenience which creates an instance of the
ExportEbsVolumeRecommendationsRequest.Builder
avoiding the need to create one manually viaExportEbsVolumeRecommendationsRequest.builder()
- Parameters:
exportEbsVolumeRecommendationsRequest
- AConsumer
that will call methods onExportEbsVolumeRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportEBSVolumeRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportEC2InstanceRecommendations
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) (.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.
- Parameters:
exportEc2InstanceRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ExportEC2InstanceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportEC2InstanceRecommendations
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) (.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.
This is a convenience which creates an instance of the
ExportEc2InstanceRecommendationsRequest.Builder
avoiding the need to create one manually viaExportEc2InstanceRecommendationsRequest.builder()
- Parameters:
exportEc2InstanceRecommendationsRequest
- AConsumer
that will call methods onExportEc2InstanceRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportEC2InstanceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportECSServiceRecommendations
default CompletableFuture<ExportEcsServiceRecommendationsResponse> exportECSServiceRecommendations(ExportEcsServiceRecommendationsRequest exportEcsServiceRecommendationsRequest) 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 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.
- Parameters:
exportEcsServiceRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ExportECSServiceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportECSServiceRecommendations
default CompletableFuture<ExportEcsServiceRecommendationsResponse> exportECSServiceRecommendations(Consumer<ExportEcsServiceRecommendationsRequest.Builder> exportEcsServiceRecommendationsRequest) 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 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.
This is a convenience which creates an instance of the
ExportEcsServiceRecommendationsRequest.Builder
avoiding the need to create one manually viaExportEcsServiceRecommendationsRequest.builder()
- Parameters:
exportEcsServiceRecommendationsRequest
- AConsumer
that will call methods onExportEcsServiceRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportECSServiceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportLambdaFunctionRecommendations
default CompletableFuture<ExportLambdaFunctionRecommendationsResponse> exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest) 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 Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Lambda function export job in progress per Amazon Web Services Region.
- Parameters:
exportLambdaFunctionRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ExportLambdaFunctionRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportLambdaFunctionRecommendations
default CompletableFuture<ExportLambdaFunctionRecommendationsResponse> exportLambdaFunctionRecommendations(Consumer<ExportLambdaFunctionRecommendationsRequest.Builder> exportLambdaFunctionRecommendationsRequest) 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 Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Lambda function export job in progress per Amazon Web Services Region.
This is a convenience which creates an instance of the
ExportLambdaFunctionRecommendationsRequest.Builder
avoiding the need to create one manually viaExportLambdaFunctionRecommendationsRequest.builder()
- Parameters:
exportLambdaFunctionRecommendationsRequest
- AConsumer
that will call methods onExportLambdaFunctionRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportLambdaFunctionRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportLicenseRecommendations
default CompletableFuture<ExportLicenseRecommendationsResponse> exportLicenseRecommendations(ExportLicenseRecommendationsRequest exportLicenseRecommendationsRequest) 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.
- Parameters:
exportLicenseRecommendationsRequest
-- Returns:
- A Java Future containing the result of the ExportLicenseRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportLicenseRecommendations
default CompletableFuture<ExportLicenseRecommendationsResponse> exportLicenseRecommendations(Consumer<ExportLicenseRecommendationsRequest.Builder> exportLicenseRecommendationsRequest) 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.
This is a convenience which creates an instance of the
ExportLicenseRecommendationsRequest.Builder
avoiding the need to create one manually viaExportLicenseRecommendationsRequest.builder()
- Parameters:
exportLicenseRecommendationsRequest
- AConsumer
that will call methods onExportLicenseRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportLicenseRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAutoScalingGroupRecommendations
default CompletableFuture<GetAutoScalingGroupRecommendationsResponse> getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest) 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 Supported resources and requirements in the Compute Optimizer User Guide.
- Parameters:
getAutoScalingGroupRecommendationsRequest
-- Returns:
- A Java Future containing the result of the GetAutoScalingGroupRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAutoScalingGroupRecommendations
default CompletableFuture<GetAutoScalingGroupRecommendationsResponse> getAutoScalingGroupRecommendations(Consumer<GetAutoScalingGroupRecommendationsRequest.Builder> getAutoScalingGroupRecommendationsRequest) 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 Supported resources and requirements in the Compute Optimizer User Guide.
This is a convenience which creates an instance of the
GetAutoScalingGroupRecommendationsRequest.Builder
avoiding the need to create one manually viaGetAutoScalingGroupRecommendationsRequest.builder()
- Parameters:
getAutoScalingGroupRecommendationsRequest
- AConsumer
that will call methods onGetAutoScalingGroupRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAutoScalingGroupRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEBSVolumeRecommendations
default CompletableFuture<GetEbsVolumeRecommendationsResponse> getEBSVolumeRecommendations(GetEbsVolumeRecommendationsRequest getEbsVolumeRecommendationsRequest) 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.
- Parameters:
getEbsVolumeRecommendationsRequest
-- Returns:
- A Java Future containing the result of the GetEBSVolumeRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEBSVolumeRecommendations
default CompletableFuture<GetEbsVolumeRecommendationsResponse> getEBSVolumeRecommendations(Consumer<GetEbsVolumeRecommendationsRequest.Builder> getEbsVolumeRecommendationsRequest) 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.
This is a convenience which creates an instance of the
GetEbsVolumeRecommendationsRequest.Builder
avoiding the need to create one manually viaGetEbsVolumeRecommendationsRequest.builder()
- Parameters:
getEbsVolumeRecommendationsRequest
- AConsumer
that will call methods onGetEbsVolumeRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEBSVolumeRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEC2InstanceRecommendations
default CompletableFuture<GetEc2InstanceRecommendationsResponse> getEC2InstanceRecommendations(GetEc2InstanceRecommendationsRequest getEc2InstanceRecommendationsRequest) 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.
- Parameters:
getEc2InstanceRecommendationsRequest
-- Returns:
- A Java Future containing the result of the GetEC2InstanceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEC2InstanceRecommendations
default CompletableFuture<GetEc2InstanceRecommendationsResponse> getEC2InstanceRecommendations(Consumer<GetEc2InstanceRecommendationsRequest.Builder> getEc2InstanceRecommendationsRequest) 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.
This is a convenience which creates an instance of the
GetEc2InstanceRecommendationsRequest.Builder
avoiding the need to create one manually viaGetEc2InstanceRecommendationsRequest.builder()
- Parameters:
getEc2InstanceRecommendationsRequest
- AConsumer
that will call methods onGetEc2InstanceRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEC2InstanceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEC2RecommendationProjectedMetrics
default CompletableFuture<GetEc2RecommendationProjectedMetricsResponse> getEC2RecommendationProjectedMetrics(GetEc2RecommendationProjectedMetricsRequest getEc2RecommendationProjectedMetricsRequest) Returns the projected utilization metrics of Amazon EC2 instance recommendations.
The
Cpu
andMemory
metrics are the only projected utilization metrics returned when you run this action. Additionally, theMemory
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.- Parameters:
getEc2RecommendationProjectedMetricsRequest
-- Returns:
- A Java Future containing the result of the GetEC2RecommendationProjectedMetrics operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEC2RecommendationProjectedMetrics
default CompletableFuture<GetEc2RecommendationProjectedMetricsResponse> getEC2RecommendationProjectedMetrics(Consumer<GetEc2RecommendationProjectedMetricsRequest.Builder> getEc2RecommendationProjectedMetricsRequest) Returns the projected utilization metrics of Amazon EC2 instance recommendations.
The
Cpu
andMemory
metrics are the only projected utilization metrics returned when you run this action. Additionally, theMemory
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 viaGetEc2RecommendationProjectedMetricsRequest.builder()
- Parameters:
getEc2RecommendationProjectedMetricsRequest
- AConsumer
that will call methods onGetEc2RecommendationProjectedMetricsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEC2RecommendationProjectedMetrics operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getECSServiceRecommendationProjectedMetrics
default CompletableFuture<GetEcsServiceRecommendationProjectedMetricsResponse> getECSServiceRecommendationProjectedMetrics(GetEcsServiceRecommendationProjectedMetricsRequest getEcsServiceRecommendationProjectedMetricsRequest) Returns the projected metrics of Amazon ECS service recommendations.
- Parameters:
getEcsServiceRecommendationProjectedMetricsRequest
-- Returns:
- A Java Future containing the result of the GetECSServiceRecommendationProjectedMetrics operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getECSServiceRecommendationProjectedMetrics
default CompletableFuture<GetEcsServiceRecommendationProjectedMetricsResponse> getECSServiceRecommendationProjectedMetrics(Consumer<GetEcsServiceRecommendationProjectedMetricsRequest.Builder> getEcsServiceRecommendationProjectedMetricsRequest) Returns the projected metrics of Amazon ECS service recommendations.
This is a convenience which creates an instance of the
GetEcsServiceRecommendationProjectedMetricsRequest.Builder
avoiding the need to create one manually viaGetEcsServiceRecommendationProjectedMetricsRequest.builder()
- Parameters:
getEcsServiceRecommendationProjectedMetricsRequest
- AConsumer
that will call methods onGetEcsServiceRecommendationProjectedMetricsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetECSServiceRecommendationProjectedMetrics operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getECSServiceRecommendations
default CompletableFuture<GetEcsServiceRecommendationsResponse> getECSServiceRecommendations(GetEcsServiceRecommendationsRequest getEcsServiceRecommendationsRequest) 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.
- Parameters:
getEcsServiceRecommendationsRequest
-- Returns:
- A Java Future containing the result of the GetECSServiceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getECSServiceRecommendations
default CompletableFuture<GetEcsServiceRecommendationsResponse> getECSServiceRecommendations(Consumer<GetEcsServiceRecommendationsRequest.Builder> getEcsServiceRecommendationsRequest) 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.
This is a convenience which creates an instance of the
GetEcsServiceRecommendationsRequest.Builder
avoiding the need to create one manually viaGetEcsServiceRecommendationsRequest.builder()
- Parameters:
getEcsServiceRecommendationsRequest
- AConsumer
that will call methods onGetEcsServiceRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetECSServiceRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEffectiveRecommendationPreferences
default CompletableFuture<GetEffectiveRecommendationPreferencesResponse> getEffectiveRecommendationPreferences(GetEffectiveRecommendationPreferencesRequest getEffectiveRecommendationPreferencesRequest) 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
orInactive
. Use this action to view the recommendation preferences that are in effect, orActive
.- Parameters:
getEffectiveRecommendationPreferencesRequest
-- Returns:
- A Java Future containing the result of the GetEffectiveRecommendationPreferences operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEffectiveRecommendationPreferences
default CompletableFuture<GetEffectiveRecommendationPreferencesResponse> getEffectiveRecommendationPreferences(Consumer<GetEffectiveRecommendationPreferencesRequest.Builder> getEffectiveRecommendationPreferencesRequest) 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
orInactive
. Use this action to view the recommendation preferences that are in effect, orActive
.
This is a convenience which creates an instance of the
GetEffectiveRecommendationPreferencesRequest.Builder
avoiding the need to create one manually viaGetEffectiveRecommendationPreferencesRequest.builder()
- Parameters:
getEffectiveRecommendationPreferencesRequest
- AConsumer
that will call methods onGetEffectiveRecommendationPreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEffectiveRecommendationPreferences operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnrollmentStatus
default CompletableFuture<GetEnrollmentStatusResponse> getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest) 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.
- Parameters:
getEnrollmentStatusRequest
-- Returns:
- A Java Future containing the result of the GetEnrollmentStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnrollmentStatus
default CompletableFuture<GetEnrollmentStatusResponse> getEnrollmentStatus(Consumer<GetEnrollmentStatusRequest.Builder> getEnrollmentStatusRequest) 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.
This is a convenience which creates an instance of the
GetEnrollmentStatusRequest.Builder
avoiding the need to create one manually viaGetEnrollmentStatusRequest.builder()
- Parameters:
getEnrollmentStatusRequest
- AConsumer
that will call methods onGetEnrollmentStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEnrollmentStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnrollmentStatusesForOrganization
default CompletableFuture<GetEnrollmentStatusesForOrganizationResponse> getEnrollmentStatusesForOrganization(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) 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 action.
- Parameters:
getEnrollmentStatusesForOrganizationRequest
-- Returns:
- A Java Future containing the result of the GetEnrollmentStatusesForOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnrollmentStatusesForOrganization
default CompletableFuture<GetEnrollmentStatusesForOrganizationResponse> getEnrollmentStatusesForOrganization(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest) 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 action.
This is a convenience which creates an instance of the
GetEnrollmentStatusesForOrganizationRequest.Builder
avoiding the need to create one manually viaGetEnrollmentStatusesForOrganizationRequest.builder()
- Parameters:
getEnrollmentStatusesForOrganizationRequest
- AConsumer
that will call methods onGetEnrollmentStatusesForOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEnrollmentStatusesForOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnrollmentStatusesForOrganizationPaginator
default GetEnrollmentStatusesForOrganizationPublisher getEnrollmentStatusesForOrganizationPaginator(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) This is a variant of
getEnrollmentStatusesForOrganization(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationPublisher publisher = client.getEnrollmentStatusesForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationPublisher publisher = client.getEnrollmentStatusesForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEnrollmentStatusesForOrganization(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationRequest)
operation.- Parameters:
getEnrollmentStatusesForOrganizationRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnrollmentStatusesForOrganizationPaginator
default GetEnrollmentStatusesForOrganizationPublisher getEnrollmentStatusesForOrganizationPaginator(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest) This is a variant of
getEnrollmentStatusesForOrganization(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationPublisher publisher = client.getEnrollmentStatusesForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationPublisher publisher = client.getEnrollmentStatusesForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEnrollmentStatusesForOrganization(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationRequest)
operation.
This is a convenience which creates an instance of the
GetEnrollmentStatusesForOrganizationRequest.Builder
avoiding the need to create one manually viaGetEnrollmentStatusesForOrganizationRequest.builder()
- Parameters:
getEnrollmentStatusesForOrganizationRequest
- AConsumer
that will call methods onGetEnrollmentStatusesForOrganizationRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLambdaFunctionRecommendations
default CompletableFuture<GetLambdaFunctionRecommendationsResponse> getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) 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.
- Parameters:
getLambdaFunctionRecommendationsRequest
-- Returns:
- A Java Future containing the result of the GetLambdaFunctionRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLambdaFunctionRecommendations
default CompletableFuture<GetLambdaFunctionRecommendationsResponse> getLambdaFunctionRecommendations(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest) 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.
This is a convenience which creates an instance of the
GetLambdaFunctionRecommendationsRequest.Builder
avoiding the need to create one manually viaGetLambdaFunctionRecommendationsRequest.builder()
- Parameters:
getLambdaFunctionRecommendationsRequest
- AConsumer
that will call methods onGetLambdaFunctionRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLambdaFunctionRecommendations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLambdaFunctionRecommendationsPaginator
default GetLambdaFunctionRecommendationsPublisher getLambdaFunctionRecommendationsPaginator(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) This is a variant of
getLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsPublisher publisher = client.getLambdaFunctionRecommendationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsPublisher publisher = client.getLambdaFunctionRecommendationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)
operation.- Parameters:
getLambdaFunctionRecommendationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLambdaFunctionRecommendationsPaginator
default GetLambdaFunctionRecommendationsPublisher getLambdaFunctionRecommendationsPaginator(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest) This is a variant of
getLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsPublisher publisher = client.getLambdaFunctionRecommendationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsPublisher publisher = client.getLambdaFunctionRecommendationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)
operation.
This is a convenience which creates an instance of the
GetLambdaFunctionRecommendationsRequest.Builder
avoiding the need to create one manually viaGetLambdaFunctionRecommendationsRequest.builder()
- Parameters:
getLambdaFunctionRecommendationsRequest
- AConsumer
that will call methods onGetLambdaFunctionRecommendationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- LimitExceededException The request exceeds a limit of the service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLicenseRecommendations
default CompletableFuture<GetLicenseRecommendationsResponse> getLicenseRecommendations(GetLicenseRecommendationsRequest getLicenseRecommendationsRequest) 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.
- Parameters:
getLicenseRecommendationsRequest
-- Returns:
- A Java Future containing the result of the GetLicenseRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLicenseRecommendations
default CompletableFuture<GetLicenseRecommendationsResponse> getLicenseRecommendations(Consumer<GetLicenseRecommendationsRequest.Builder> getLicenseRecommendationsRequest) 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.
This is a convenience which creates an instance of the
GetLicenseRecommendationsRequest.Builder
avoiding the need to create one manually viaGetLicenseRecommendationsRequest.builder()
- Parameters:
getLicenseRecommendationsRequest
- AConsumer
that will call methods onGetLicenseRecommendationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLicenseRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendationPreferences
default CompletableFuture<GetRecommendationPreferencesResponse> getRecommendationPreferences(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) 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.
- Parameters:
getRecommendationPreferencesRequest
-- Returns:
- A Java Future containing the result of the GetRecommendationPreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendationPreferences
default CompletableFuture<GetRecommendationPreferencesResponse> getRecommendationPreferences(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest) 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.
This is a convenience which creates an instance of the
GetRecommendationPreferencesRequest.Builder
avoiding the need to create one manually viaGetRecommendationPreferencesRequest.builder()
- Parameters:
getRecommendationPreferencesRequest
- AConsumer
that will call methods onGetRecommendationPreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRecommendationPreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendationPreferencesPaginator
default GetRecommendationPreferencesPublisher getRecommendationPreferencesPaginator(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) This is a variant of
getRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesPublisher publisher = client.getRecommendationPreferencesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesPublisher publisher = client.getRecommendationPreferencesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)
operation.- Parameters:
getRecommendationPreferencesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendationPreferencesPaginator
default GetRecommendationPreferencesPublisher getRecommendationPreferencesPaginator(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest) This is a variant of
getRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesPublisher publisher = client.getRecommendationPreferencesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesPublisher publisher = client.getRecommendationPreferencesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)
operation.
This is a convenience which creates an instance of the
GetRecommendationPreferencesRequest.Builder
avoiding the need to create one manually viaGetRecommendationPreferencesRequest.builder()
- Parameters:
getRecommendationPreferencesRequest
- AConsumer
that will call methods onGetRecommendationPreferencesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendationSummaries
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
, orOptimized
. -
Auto Scaling groups in an account that are
NotOptimized
, orOptimized
. -
Amazon EBS volumes in an account that are
NotOptimized
, orOptimized
. -
Lambda functions in an account that are
NotOptimized
, orOptimized
. -
Amazon ECS services in an account that are
Underprovisioned
,Overprovisioned
, orOptimized
.
- Parameters:
getRecommendationSummariesRequest
-- Returns:
- A Java Future containing the result of the GetRecommendationSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getRecommendationSummaries
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
, orOptimized
. -
Auto Scaling groups in an account that are
NotOptimized
, orOptimized
. -
Amazon EBS volumes in an account that are
NotOptimized
, orOptimized
. -
Lambda functions in an account that are
NotOptimized
, orOptimized
. -
Amazon ECS services in an account that are
Underprovisioned
,Overprovisioned
, orOptimized
.
This is a convenience which creates an instance of the
GetRecommendationSummariesRequest.Builder
avoiding the need to create one manually viaGetRecommendationSummariesRequest.builder()
- Parameters:
getRecommendationSummariesRequest
- AConsumer
that will call methods onGetRecommendationSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRecommendationSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getRecommendationSummariesPaginator
default GetRecommendationSummariesPublisher getRecommendationSummariesPaginator(GetRecommendationSummariesRequest getRecommendationSummariesRequest) This is a variant of
getRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesPublisher publisher = client.getRecommendationSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesPublisher publisher = client.getRecommendationSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)
operation.- Parameters:
getRecommendationSummariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendationSummariesPaginator
default GetRecommendationSummariesPublisher getRecommendationSummariesPaginator(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest) This is a variant of
getRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesPublisher publisher = client.getRecommendationSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesPublisher publisher = client.getRecommendationSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)
operation.
This is a convenience which creates an instance of the
GetRecommendationSummariesRequest.Builder
avoiding the need to create one manually viaGetRecommendationSummariesRequest.builder()
- Parameters:
getRecommendationSummariesRequest
- AConsumer
that will call methods onGetRecommendationSummariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRecommendationPreferences
default CompletableFuture<PutRecommendationPreferencesResponse> putRecommendationPreferences(PutRecommendationPreferencesRequest putRecommendationPreferencesRequest) 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.
- Parameters:
putRecommendationPreferencesRequest
-- Returns:
- A Java Future containing the result of the PutRecommendationPreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRecommendationPreferences
default CompletableFuture<PutRecommendationPreferencesResponse> putRecommendationPreferences(Consumer<PutRecommendationPreferencesRequest.Builder> putRecommendationPreferencesRequest) 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.
This is a convenience which creates an instance of the
PutRecommendationPreferencesRequest.Builder
avoiding the need to create one manually viaPutRecommendationPreferencesRequest.builder()
- Parameters:
putRecommendationPreferencesRequest
- AConsumer
that will call methods onPutRecommendationPreferencesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRecommendationPreferences operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- OptInRequiredException The account is not opted in to Compute Optimizer.
- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- ResourceNotFoundException A resource that is required for the action doesn't exist.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnrollmentStatus
default CompletableFuture<UpdateEnrollmentStatusResponse> updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest) 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.
- Parameters:
updateEnrollmentStatusRequest
-- Returns:
- A Java Future containing the result of the UpdateEnrollmentStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnrollmentStatus
default CompletableFuture<UpdateEnrollmentStatusResponse> updateEnrollmentStatus(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest) 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.
This is a convenience which creates an instance of the
UpdateEnrollmentStatusRequest.Builder
avoiding the need to create one manually viaUpdateEnrollmentStatusRequest.builder()
- Parameters:
updateEnrollmentStatusRequest
- AConsumer
that will call methods onUpdateEnrollmentStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEnrollmentStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException An internal error has occurred. Try your call again.
- ServiceUnavailableException The request has failed due to a temporary failure of the server.
- AccessDeniedException You do not have sufficient access to perform this action.
- InvalidParameterValueException The value supplied for the input parameter is out of range or not valid.
- MissingAuthenticationTokenException The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ComputeOptimizerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aComputeOptimizerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aComputeOptimizerAsyncClient
.
-