Interface ComputeOptimizerClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ComputeOptimizerClient extends AwsClient
Service client for accessing AWS Compute Optimizer. This can be created using the staticbuilder()method.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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ComputeOptimizerClientBuilderbuilder()Create a builder that can be used to configure and create aComputeOptimizerClient.static ComputeOptimizerClientcreate()Create aComputeOptimizerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DeleteRecommendationPreferencesResponsedeleteRecommendationPreferences(Consumer<DeleteRecommendationPreferencesRequest.Builder> deleteRecommendationPreferencesRequest)Deletes a recommendation preference, such as enhanced infrastructure metrics.default DeleteRecommendationPreferencesResponsedeleteRecommendationPreferences(DeleteRecommendationPreferencesRequest deleteRecommendationPreferencesRequest)Deletes a recommendation preference, such as enhanced infrastructure metrics.default DescribeRecommendationExportJobsResponsedescribeRecommendationExportJobs(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest)Describes recommendation export jobs created in the last seven days.default DescribeRecommendationExportJobsResponsedescribeRecommendationExportJobs(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest)Describes recommendation export jobs created in the last seven days.default DescribeRecommendationExportJobsIterabledescribeRecommendationExportJobsPaginator(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest)Describes recommendation export jobs created in the last seven days.default DescribeRecommendationExportJobsIterabledescribeRecommendationExportJobsPaginator(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest)Describes recommendation export jobs created in the last seven days.default ExportAutoScalingGroupRecommendationsResponseexportAutoScalingGroupRecommendations(Consumer<ExportAutoScalingGroupRecommendationsRequest.Builder> exportAutoScalingGroupRecommendationsRequest)Exports optimization recommendations for Auto Scaling groups.default ExportAutoScalingGroupRecommendationsResponseexportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest)Exports optimization recommendations for Auto Scaling groups.default ExportEbsVolumeRecommendationsResponseexportEBSVolumeRecommendations(Consumer<ExportEbsVolumeRecommendationsRequest.Builder> exportEbsVolumeRecommendationsRequest)Exports optimization recommendations for Amazon EBS volumes.default ExportEbsVolumeRecommendationsResponseexportEBSVolumeRecommendations(ExportEbsVolumeRecommendationsRequest exportEbsVolumeRecommendationsRequest)Exports optimization recommendations for Amazon EBS volumes.default ExportEc2InstanceRecommendationsResponseexportEC2InstanceRecommendations(Consumer<ExportEc2InstanceRecommendationsRequest.Builder> exportEc2InstanceRecommendationsRequest)Exports optimization recommendations for Amazon EC2 instances.default ExportEc2InstanceRecommendationsResponseexportEC2InstanceRecommendations(ExportEc2InstanceRecommendationsRequest exportEc2InstanceRecommendationsRequest)Exports optimization recommendations for Amazon EC2 instances.default ExportEcsServiceRecommendationsResponseexportECSServiceRecommendations(Consumer<ExportEcsServiceRecommendationsRequest.Builder> exportEcsServiceRecommendationsRequest)Exports optimization recommendations for Amazon ECS services on Fargate.default ExportEcsServiceRecommendationsResponseexportECSServiceRecommendations(ExportEcsServiceRecommendationsRequest exportEcsServiceRecommendationsRequest)Exports optimization recommendations for Amazon ECS services on Fargate.default ExportLambdaFunctionRecommendationsResponseexportLambdaFunctionRecommendations(Consumer<ExportLambdaFunctionRecommendationsRequest.Builder> exportLambdaFunctionRecommendationsRequest)Exports optimization recommendations for Lambda functions.default ExportLambdaFunctionRecommendationsResponseexportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest)Exports optimization recommendations for Lambda functions.default ExportLicenseRecommendationsResponseexportLicenseRecommendations(Consumer<ExportLicenseRecommendationsRequest.Builder> exportLicenseRecommendationsRequest)Export optimization recommendations for your licenses.default ExportLicenseRecommendationsResponseexportLicenseRecommendations(ExportLicenseRecommendationsRequest exportLicenseRecommendationsRequest)Export optimization recommendations for your licenses.default GetAutoScalingGroupRecommendationsResponsegetAutoScalingGroupRecommendations(Consumer<GetAutoScalingGroupRecommendationsRequest.Builder> getAutoScalingGroupRecommendationsRequest)Returns Auto Scaling group recommendations.default GetAutoScalingGroupRecommendationsResponsegetAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest)Returns Auto Scaling group recommendations.default GetEbsVolumeRecommendationsResponsegetEBSVolumeRecommendations(Consumer<GetEbsVolumeRecommendationsRequest.Builder> getEbsVolumeRecommendationsRequest)Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.default GetEbsVolumeRecommendationsResponsegetEBSVolumeRecommendations(GetEbsVolumeRecommendationsRequest getEbsVolumeRecommendationsRequest)Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.default GetEc2InstanceRecommendationsResponsegetEC2InstanceRecommendations(Consumer<GetEc2InstanceRecommendationsRequest.Builder> getEc2InstanceRecommendationsRequest)Returns Amazon EC2 instance recommendations.default GetEc2InstanceRecommendationsResponsegetEC2InstanceRecommendations(GetEc2InstanceRecommendationsRequest getEc2InstanceRecommendationsRequest)Returns Amazon EC2 instance recommendations.default GetEc2RecommendationProjectedMetricsResponsegetEC2RecommendationProjectedMetrics(Consumer<GetEc2RecommendationProjectedMetricsRequest.Builder> getEc2RecommendationProjectedMetricsRequest)Returns the projected utilization metrics of Amazon EC2 instance recommendations.default GetEc2RecommendationProjectedMetricsResponsegetEC2RecommendationProjectedMetrics(GetEc2RecommendationProjectedMetricsRequest getEc2RecommendationProjectedMetricsRequest)Returns the projected utilization metrics of Amazon EC2 instance recommendations.default GetEcsServiceRecommendationProjectedMetricsResponsegetECSServiceRecommendationProjectedMetrics(Consumer<GetEcsServiceRecommendationProjectedMetricsRequest.Builder> getEcsServiceRecommendationProjectedMetricsRequest)Returns the projected metrics of Amazon ECS service recommendations.default GetEcsServiceRecommendationProjectedMetricsResponsegetECSServiceRecommendationProjectedMetrics(GetEcsServiceRecommendationProjectedMetricsRequest getEcsServiceRecommendationProjectedMetricsRequest)Returns the projected metrics of Amazon ECS service recommendations.default GetEcsServiceRecommendationsResponsegetECSServiceRecommendations(Consumer<GetEcsServiceRecommendationsRequest.Builder> getEcsServiceRecommendationsRequest)Returns Amazon ECS service recommendations.default GetEcsServiceRecommendationsResponsegetECSServiceRecommendations(GetEcsServiceRecommendationsRequest getEcsServiceRecommendationsRequest)Returns Amazon ECS service recommendations.default GetEffectiveRecommendationPreferencesResponsegetEffectiveRecommendationPreferences(Consumer<GetEffectiveRecommendationPreferencesRequest.Builder> getEffectiveRecommendationPreferencesRequest)Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.default GetEffectiveRecommendationPreferencesResponsegetEffectiveRecommendationPreferences(GetEffectiveRecommendationPreferencesRequest getEffectiveRecommendationPreferencesRequest)Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics.default GetEnrollmentStatusResponsegetEnrollmentStatus(Consumer<GetEnrollmentStatusRequest.Builder> getEnrollmentStatusRequest)Returns the enrollment (opt in) status of an account to the Compute Optimizer service.default GetEnrollmentStatusResponsegetEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest)Returns the enrollment (opt in) status of an account to the Compute Optimizer service.default GetEnrollmentStatusesForOrganizationResponsegetEnrollmentStatusesForOrganization(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest)Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.default GetEnrollmentStatusesForOrganizationResponsegetEnrollmentStatusesForOrganization(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest)Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.default GetEnrollmentStatusesForOrganizationIterablegetEnrollmentStatusesForOrganizationPaginator(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest)Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.default GetEnrollmentStatusesForOrganizationIterablegetEnrollmentStatusesForOrganizationPaginator(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest)Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.default GetLambdaFunctionRecommendationsResponsegetLambdaFunctionRecommendations(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest)Returns Lambda function recommendations.default GetLambdaFunctionRecommendationsResponsegetLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest)Returns Lambda function recommendations.default GetLambdaFunctionRecommendationsIterablegetLambdaFunctionRecommendationsPaginator(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest)Returns Lambda function recommendations.default GetLambdaFunctionRecommendationsIterablegetLambdaFunctionRecommendationsPaginator(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest)Returns Lambda function recommendations.default GetLicenseRecommendationsResponsegetLicenseRecommendations(Consumer<GetLicenseRecommendationsRequest.Builder> getLicenseRecommendationsRequest)Returns license recommendations for Amazon EC2 instances that run on a specific license.default GetLicenseRecommendationsResponsegetLicenseRecommendations(GetLicenseRecommendationsRequest getLicenseRecommendationsRequest)Returns license recommendations for Amazon EC2 instances that run on a specific license.default GetRecommendationPreferencesResponsegetRecommendationPreferences(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest)Returns existing recommendation preferences, such as enhanced infrastructure metrics.default GetRecommendationPreferencesResponsegetRecommendationPreferences(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest)Returns existing recommendation preferences, such as enhanced infrastructure metrics.default GetRecommendationPreferencesIterablegetRecommendationPreferencesPaginator(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest)Returns existing recommendation preferences, such as enhanced infrastructure metrics.default GetRecommendationPreferencesIterablegetRecommendationPreferencesPaginator(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest)Returns existing recommendation preferences, such as enhanced infrastructure metrics.default GetRecommendationSummariesResponsegetRecommendationSummaries(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest)Returns the optimization findings for an account.default GetRecommendationSummariesResponsegetRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest)Returns the optimization findings for an account.default GetRecommendationSummariesIterablegetRecommendationSummariesPaginator(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest)Returns the optimization findings for an account.default GetRecommendationSummariesIterablegetRecommendationSummariesPaginator(GetRecommendationSummariesRequest getRecommendationSummariesRequest)Returns the optimization findings for an account.default PutRecommendationPreferencesResponseputRecommendationPreferences(Consumer<PutRecommendationPreferencesRequest.Builder> putRecommendationPreferencesRequest)Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.default PutRecommendationPreferencesResponseputRecommendationPreferences(PutRecommendationPreferencesRequest putRecommendationPreferencesRequest)Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.default ComputeOptimizerServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default UpdateEnrollmentStatusResponseupdateEnrollmentStatus(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest)Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.default UpdateEnrollmentStatusResponseupdateEnrollmentStatus(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
deleteRecommendationPreferences
default DeleteRecommendationPreferencesResponse deleteRecommendationPreferences(DeleteRecommendationPreferencesRequest deleteRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the DeleteRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRecommendationPreferences
default DeleteRecommendationPreferencesResponse deleteRecommendationPreferences(Consumer<DeleteRecommendationPreferencesRequest.Builder> deleteRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaDeleteRecommendationPreferencesRequest.builder()- Parameters:
deleteRecommendationPreferencesRequest- AConsumerthat will call methods onDeleteRecommendationPreferencesRequest.Builderto create a request.- Returns:
- Result of the DeleteRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRecommendationExportJobs
default DescribeRecommendationExportJobsResponse describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the DescribeRecommendationExportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRecommendationExportJobs
default DescribeRecommendationExportJobsResponse describeRecommendationExportJobs(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaDescribeRecommendationExportJobsRequest.builder()- Parameters:
describeRecommendationExportJobsRequest- AConsumerthat will call methods onDescribeRecommendationExportJobsRequest.Builderto create a request.- Returns:
- Result of the DescribeRecommendationExportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRecommendationExportJobsPaginator
default DescribeRecommendationExportJobsIterable describeRecommendationExportJobsPaginator(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
describeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsIterable responses = client.describeRecommendationExportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsIterable responses = client .describeRecommendationExportJobsPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsIterable responses = client.describeRecommendationExportJobsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRecommendationExportJobsPaginator
default DescribeRecommendationExportJobsIterable describeRecommendationExportJobsPaginator(Consumer<DescribeRecommendationExportJobsRequest.Builder> describeRecommendationExportJobsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
describeRecommendationExportJobs(software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsIterable responses = client.describeRecommendationExportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsIterable responses = client .describeRecommendationExportJobsPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.DescribeRecommendationExportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.DescribeRecommendationExportJobsIterable responses = client.describeRecommendationExportJobsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeRecommendationExportJobsRequest.builder()- Parameters:
describeRecommendationExportJobsRequest- AConsumerthat will call methods onDescribeRecommendationExportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportAutoScalingGroupRecommendations
default ExportAutoScalingGroupRecommendationsResponse exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the ExportAutoScalingGroupRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportAutoScalingGroupRecommendations
default ExportAutoScalingGroupRecommendationsResponse exportAutoScalingGroupRecommendations(Consumer<ExportAutoScalingGroupRecommendationsRequest.Builder> exportAutoScalingGroupRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaExportAutoScalingGroupRecommendationsRequest.builder()- Parameters:
exportAutoScalingGroupRecommendationsRequest- AConsumerthat will call methods onExportAutoScalingGroupRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ExportAutoScalingGroupRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportEBSVolumeRecommendations
default ExportEbsVolumeRecommendationsResponse exportEBSVolumeRecommendations(ExportEbsVolumeRecommendationsRequest exportEbsVolumeRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the ExportEBSVolumeRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportEBSVolumeRecommendations
default ExportEbsVolumeRecommendationsResponse exportEBSVolumeRecommendations(Consumer<ExportEbsVolumeRecommendationsRequest.Builder> exportEbsVolumeRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaExportEbsVolumeRecommendationsRequest.builder()- Parameters:
exportEbsVolumeRecommendationsRequest- AConsumerthat will call methods onExportEbsVolumeRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ExportEBSVolumeRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportEC2InstanceRecommendations
default ExportEc2InstanceRecommendationsResponse exportEC2InstanceRecommendations(ExportEc2InstanceRecommendationsRequest exportEc2InstanceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the ExportEC2InstanceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportEC2InstanceRecommendations
default ExportEc2InstanceRecommendationsResponse exportEC2InstanceRecommendations(Consumer<ExportEc2InstanceRecommendationsRequest.Builder> exportEc2InstanceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaExportEc2InstanceRecommendationsRequest.builder()- Parameters:
exportEc2InstanceRecommendationsRequest- AConsumerthat will call methods onExportEc2InstanceRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ExportEC2InstanceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportECSServiceRecommendations
default ExportEcsServiceRecommendationsResponse exportECSServiceRecommendations(ExportEcsServiceRecommendationsRequest exportEcsServiceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the ExportECSServiceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportECSServiceRecommendations
default ExportEcsServiceRecommendationsResponse exportECSServiceRecommendations(Consumer<ExportEcsServiceRecommendationsRequest.Builder> exportEcsServiceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaExportEcsServiceRecommendationsRequest.builder()- Parameters:
exportEcsServiceRecommendationsRequest- AConsumerthat will call methods onExportEcsServiceRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ExportECSServiceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportLambdaFunctionRecommendations
default ExportLambdaFunctionRecommendationsResponse exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the ExportLambdaFunctionRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportLambdaFunctionRecommendations
default ExportLambdaFunctionRecommendationsResponse exportLambdaFunctionRecommendations(Consumer<ExportLambdaFunctionRecommendationsRequest.Builder> exportLambdaFunctionRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaExportLambdaFunctionRecommendationsRequest.builder()- Parameters:
exportLambdaFunctionRecommendationsRequest- AConsumerthat will call methods onExportLambdaFunctionRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ExportLambdaFunctionRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportLicenseRecommendations
default ExportLicenseRecommendationsResponse exportLicenseRecommendations(ExportLicenseRecommendationsRequest exportLicenseRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the ExportLicenseRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportLicenseRecommendations
default ExportLicenseRecommendationsResponse exportLicenseRecommendations(Consumer<ExportLicenseRecommendationsRequest.Builder> exportLicenseRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaExportLicenseRecommendationsRequest.builder()- Parameters:
exportLicenseRecommendationsRequest- AConsumerthat will call methods onExportLicenseRecommendationsRequest.Builderto create a request.- Returns:
- Result of the ExportLicenseRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAutoScalingGroupRecommendations
default GetAutoScalingGroupRecommendationsResponse getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetAutoScalingGroupRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAutoScalingGroupRecommendations
default GetAutoScalingGroupRecommendationsResponse getAutoScalingGroupRecommendations(Consumer<GetAutoScalingGroupRecommendationsRequest.Builder> getAutoScalingGroupRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetAutoScalingGroupRecommendationsRequest.builder()- Parameters:
getAutoScalingGroupRecommendationsRequest- AConsumerthat will call methods onGetAutoScalingGroupRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetAutoScalingGroupRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEBSVolumeRecommendations
default GetEbsVolumeRecommendationsResponse getEBSVolumeRecommendations(GetEbsVolumeRecommendationsRequest getEbsVolumeRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetEBSVolumeRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEBSVolumeRecommendations
default GetEbsVolumeRecommendationsResponse getEBSVolumeRecommendations(Consumer<GetEbsVolumeRecommendationsRequest.Builder> getEbsVolumeRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetEbsVolumeRecommendationsRequest.builder()- Parameters:
getEbsVolumeRecommendationsRequest- AConsumerthat will call methods onGetEbsVolumeRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetEBSVolumeRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEC2InstanceRecommendations
default GetEc2InstanceRecommendationsResponse getEC2InstanceRecommendations(GetEc2InstanceRecommendationsRequest getEc2InstanceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetEC2InstanceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEC2InstanceRecommendations
default GetEc2InstanceRecommendationsResponse getEC2InstanceRecommendations(Consumer<GetEc2InstanceRecommendationsRequest.Builder> getEc2InstanceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetEc2InstanceRecommendationsRequest.builder()- Parameters:
getEc2InstanceRecommendationsRequest- AConsumerthat will call methods onGetEc2InstanceRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetEC2InstanceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEC2RecommendationProjectedMetrics
default GetEc2RecommendationProjectedMetricsResponse getEC2RecommendationProjectedMetrics(GetEc2RecommendationProjectedMetricsRequest getEc2RecommendationProjectedMetricsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
The
CpuandMemorymetrics are the only projected utilization metrics returned when you run this action. Additionally, theMemorymetric 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:
- Result of the GetEC2RecommendationProjectedMetrics operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEC2RecommendationProjectedMetrics
default GetEc2RecommendationProjectedMetricsResponse getEC2RecommendationProjectedMetrics(Consumer<GetEc2RecommendationProjectedMetricsRequest.Builder> getEc2RecommendationProjectedMetricsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
The
CpuandMemorymetrics are the only projected utilization metrics returned when you run this action. Additionally, theMemorymetric 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.Builderavoiding the need to create one manually viaGetEc2RecommendationProjectedMetricsRequest.builder()- Parameters:
getEc2RecommendationProjectedMetricsRequest- AConsumerthat will call methods onGetEc2RecommendationProjectedMetricsRequest.Builderto create a request.- Returns:
- Result of the GetEC2RecommendationProjectedMetrics operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getECSServiceRecommendationProjectedMetrics
default GetEcsServiceRecommendationProjectedMetricsResponse getECSServiceRecommendationProjectedMetrics(GetEcsServiceRecommendationProjectedMetricsRequest getEcsServiceRecommendationProjectedMetricsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns the projected metrics of Amazon ECS service recommendations.
- Parameters:
getEcsServiceRecommendationProjectedMetricsRequest-- Returns:
- Result of the GetECSServiceRecommendationProjectedMetrics operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getECSServiceRecommendationProjectedMetrics
default GetEcsServiceRecommendationProjectedMetricsResponse getECSServiceRecommendationProjectedMetrics(Consumer<GetEcsServiceRecommendationProjectedMetricsRequest.Builder> getEcsServiceRecommendationProjectedMetricsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns the projected metrics of Amazon ECS service recommendations.
This is a convenience which creates an instance of the
GetEcsServiceRecommendationProjectedMetricsRequest.Builderavoiding the need to create one manually viaGetEcsServiceRecommendationProjectedMetricsRequest.builder()- Parameters:
getEcsServiceRecommendationProjectedMetricsRequest- AConsumerthat will call methods onGetEcsServiceRecommendationProjectedMetricsRequest.Builderto create a request.- Returns:
- Result of the GetECSServiceRecommendationProjectedMetrics operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getECSServiceRecommendations
default GetEcsServiceRecommendationsResponse getECSServiceRecommendations(GetEcsServiceRecommendationsRequest getEcsServiceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetECSServiceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getECSServiceRecommendations
default GetEcsServiceRecommendationsResponse getECSServiceRecommendations(Consumer<GetEcsServiceRecommendationsRequest.Builder> getEcsServiceRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetEcsServiceRecommendationsRequest.builder()- Parameters:
getEcsServiceRecommendationsRequest- AConsumerthat will call methods onGetEcsServiceRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetECSServiceRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEffectiveRecommendationPreferences
default GetEffectiveRecommendationPreferencesResponse getEffectiveRecommendationPreferences(GetEffectiveRecommendationPreferencesRequest getEffectiveRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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
ActiveorInactive. Use this action to view the recommendation preferences that are in effect, orActive.- Parameters:
getEffectiveRecommendationPreferencesRequest-- Returns:
- Result of the GetEffectiveRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEffectiveRecommendationPreferences
default GetEffectiveRecommendationPreferencesResponse getEffectiveRecommendationPreferences(Consumer<GetEffectiveRecommendationPreferencesRequest.Builder> getEffectiveRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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
ActiveorInactive. Use this action to view the recommendation preferences that are in effect, orActive.
This is a convenience which creates an instance of the
GetEffectiveRecommendationPreferencesRequest.Builderavoiding the need to create one manually viaGetEffectiveRecommendationPreferencesRequest.builder()- Parameters:
getEffectiveRecommendationPreferencesRequest- AConsumerthat will call methods onGetEffectiveRecommendationPreferencesRequest.Builderto create a request.- Returns:
- Result of the GetEffectiveRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnrollmentStatus
default GetEnrollmentStatusResponse getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetEnrollmentStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnrollmentStatus
default GetEnrollmentStatusResponse getEnrollmentStatus(Consumer<GetEnrollmentStatusRequest.Builder> getEnrollmentStatusRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetEnrollmentStatusRequest.builder()- Parameters:
getEnrollmentStatusRequest- AConsumerthat will call methods onGetEnrollmentStatusRequest.Builderto create a request.- Returns:
- Result of the GetEnrollmentStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnrollmentStatusesForOrganization
default GetEnrollmentStatusesForOrganizationResponse getEnrollmentStatusesForOrganization(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetEnrollmentStatusesForOrganization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnrollmentStatusesForOrganization
default GetEnrollmentStatusesForOrganizationResponse getEnrollmentStatusesForOrganization(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetEnrollmentStatusesForOrganizationRequest.builder()- Parameters:
getEnrollmentStatusesForOrganizationRequest- AConsumerthat will call methods onGetEnrollmentStatusesForOrganizationRequest.Builderto create a request.- Returns:
- Result of the GetEnrollmentStatusesForOrganization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnrollmentStatusesForOrganizationPaginator
default GetEnrollmentStatusesForOrganizationIterable getEnrollmentStatusesForOrganizationPaginator(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
getEnrollmentStatusesForOrganization(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationIterable responses = client.getEnrollmentStatusesForOrganizationPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationIterable responses = client .getEnrollmentStatusesForOrganizationPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationIterable responses = client.getEnrollmentStatusesForOrganizationPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnrollmentStatusesForOrganizationPaginator
default GetEnrollmentStatusesForOrganizationIterable getEnrollmentStatusesForOrganizationPaginator(Consumer<GetEnrollmentStatusesForOrganizationRequest.Builder> getEnrollmentStatusesForOrganizationRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
getEnrollmentStatusesForOrganization(software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationIterable responses = client.getEnrollmentStatusesForOrganizationPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationIterable responses = client .getEnrollmentStatusesForOrganizationPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetEnrollmentStatusesForOrganizationResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetEnrollmentStatusesForOrganizationIterable responses = client.getEnrollmentStatusesForOrganizationPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetEnrollmentStatusesForOrganizationRequest.builder()- Parameters:
getEnrollmentStatusesForOrganizationRequest- AConsumerthat will call methods onGetEnrollmentStatusesForOrganizationRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLambdaFunctionRecommendations
default GetLambdaFunctionRecommendationsResponse getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetLambdaFunctionRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLambdaFunctionRecommendations
default GetLambdaFunctionRecommendationsResponse getLambdaFunctionRecommendations(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetLambdaFunctionRecommendationsRequest.builder()- Parameters:
getLambdaFunctionRecommendationsRequest- AConsumerthat will call methods onGetLambdaFunctionRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetLambdaFunctionRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLambdaFunctionRecommendationsPaginator
default GetLambdaFunctionRecommendationsIterable getLambdaFunctionRecommendationsPaginator(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
getLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsIterable responses = client.getLambdaFunctionRecommendationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsIterable responses = client .getLambdaFunctionRecommendationsPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsIterable responses = client.getLambdaFunctionRecommendationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLambdaFunctionRecommendationsPaginator
default GetLambdaFunctionRecommendationsIterable getLambdaFunctionRecommendationsPaginator(Consumer<GetLambdaFunctionRecommendationsRequest.Builder> getLambdaFunctionRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
getLambdaFunctionRecommendations(software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsIterable responses = client.getLambdaFunctionRecommendationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsIterable responses = client .getLambdaFunctionRecommendationsPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetLambdaFunctionRecommendationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetLambdaFunctionRecommendationsIterable responses = client.getLambdaFunctionRecommendationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetLambdaFunctionRecommendationsRequest.builder()- Parameters:
getLambdaFunctionRecommendationsRequest- AConsumerthat will call methods onGetLambdaFunctionRecommendationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLicenseRecommendations
default GetLicenseRecommendationsResponse getLicenseRecommendations(GetLicenseRecommendationsRequest getLicenseRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetLicenseRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLicenseRecommendations
default GetLicenseRecommendationsResponse getLicenseRecommendations(Consumer<GetLicenseRecommendationsRequest.Builder> getLicenseRecommendationsRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetLicenseRecommendationsRequest.builder()- Parameters:
getLicenseRecommendationsRequest- AConsumerthat will call methods onGetLicenseRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetLicenseRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendationPreferences
default GetRecommendationPreferencesResponse getRecommendationPreferences(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the
scopeparameter 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:
- Result of the GetRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendationPreferences
default GetRecommendationPreferencesResponse getRecommendationPreferences(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the
scopeparameter 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.Builderavoiding the need to create one manually viaGetRecommendationPreferencesRequest.builder()- Parameters:
getRecommendationPreferencesRequest- AConsumerthat will call methods onGetRecommendationPreferencesRequest.Builderto create a request.- Returns:
- Result of the GetRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendationPreferencesPaginator
default GetRecommendationPreferencesIterable getRecommendationPreferencesPaginator(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the
scopeparameter 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 variant of
getRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesIterable responses = client.getRecommendationPreferencesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesIterable responses = client .getRecommendationPreferencesPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesIterable responses = client.getRecommendationPreferencesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendationPreferencesPaginator
default GetRecommendationPreferencesIterable getRecommendationPreferencesPaginator(Consumer<GetRecommendationPreferencesRequest.Builder> getRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the
scopeparameter 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 variant of
getRecommendationPreferences(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesIterable responses = client.getRecommendationPreferencesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesIterable responses = client .getRecommendationPreferencesPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationPreferencesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationPreferencesIterable responses = client.getRecommendationPreferencesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetRecommendationPreferencesRequest.builder()- Parameters:
getRecommendationPreferencesRequest- AConsumerthat will call methods onGetRecommendationPreferencesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendationSummaries
default GetRecommendationSummariesResponse getRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the GetRecommendationSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getRecommendationSummaries
default GetRecommendationSummariesResponse getRecommendationSummaries(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaGetRecommendationSummariesRequest.builder()- Parameters:
getRecommendationSummariesRequest- AConsumerthat will call methods onGetRecommendationSummariesRequest.Builderto create a request.- Returns:
- Result of the GetRecommendationSummaries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getRecommendationSummariesPaginator
default GetRecommendationSummariesIterable getRecommendationSummariesPaginator(GetRecommendationSummariesRequest getRecommendationSummariesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
getRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesIterable responses = client.getRecommendationSummariesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesIterable responses = client .getRecommendationSummariesPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesIterable responses = client.getRecommendationSummariesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
getRecommendationSummariesPaginator
default GetRecommendationSummariesIterable getRecommendationSummariesPaginator(Consumer<GetRecommendationSummariesRequest.Builder> getRecommendationSummariesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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 variant of
getRecommendationSummaries(software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesIterable responses = client.getRecommendationSummariesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesIterable responses = client .getRecommendationSummariesPaginator(request); for (software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationSummariesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.computeoptimizer.paginators.GetRecommendationSummariesIterable responses = client.getRecommendationSummariesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetRecommendationSummariesRequest.builder()- Parameters:
getRecommendationSummariesRequest- AConsumerthat will call methods onGetRecommendationSummariesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
putRecommendationPreferences
default PutRecommendationPreferencesResponse putRecommendationPreferences(PutRecommendationPreferencesRequest putRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the PutRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putRecommendationPreferences
default PutRecommendationPreferencesResponse putRecommendationPreferences(Consumer<PutRecommendationPreferencesRequest.Builder> putRecommendationPreferencesRequest) throws OptInRequiredException, InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaPutRecommendationPreferencesRequest.builder()- Parameters:
putRecommendationPreferencesRequest- AConsumerthat will call methods onPutRecommendationPreferencesRequest.Builderto create a request.- Returns:
- Result of the PutRecommendationPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEnrollmentStatus
default UpdateEnrollmentStatusResponse updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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:
- Result of the UpdateEnrollmentStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEnrollmentStatus
default UpdateEnrollmentStatusResponse updateEnrollmentStatus(Consumer<UpdateEnrollmentStatusRequest.Builder> updateEnrollmentStatusRequest) throws InternalServerException, ServiceUnavailableException, AccessDeniedException, InvalidParameterValueException, MissingAuthenticationTokenException, ThrottlingException, AwsServiceException, SdkClientException, ComputeOptimizerException
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.Builderavoiding the need to create one manually viaUpdateEnrollmentStatusRequest.builder()- Parameters:
updateEnrollmentStatusRequest- AConsumerthat will call methods onUpdateEnrollmentStatusRequest.Builderto create a request.- Returns:
- Result of the UpdateEnrollmentStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ComputeOptimizerClient create()
Create aComputeOptimizerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ComputeOptimizerClientBuilder builder()
Create a builder that can be used to configure and create aComputeOptimizerClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ComputeOptimizerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-