/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.computeoptimizer; import org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.computeoptimizer.AWSComputeOptimizerClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.computeoptimizer.model.*; import com.amazonaws.services.computeoptimizer.model.transform.*; /** * Client for accessing AWS Compute Optimizer. All service calls made using this client are blocking, and will not * return until the service call completes. *
*
* 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSComputeOptimizerClient extends AmazonWebServiceClient implements AWSComputeOptimizer { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSComputeOptimizer.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "compute-optimizer"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.0") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidParameterValueException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.InvalidParameterValueExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("OptInRequiredException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.OptInRequiredExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.LimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.AccessDeniedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MissingAuthenticationToken").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.MissingAuthenticationTokenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceUnavailableException").withExceptionUnmarshaller( com.amazonaws.services.computeoptimizer.model.transform.ServiceUnavailableExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.computeoptimizer.model.AWSComputeOptimizerException.class)); public static AWSComputeOptimizerClientBuilder builder() { return AWSComputeOptimizerClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS Compute Optimizer using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSComputeOptimizerClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS Compute Optimizer using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSComputeOptimizerClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("compute-optimizer.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/computeoptimizer/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/computeoptimizer/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Deletes a recommendation preference, such as enhanced infrastructure metrics. *
** For more information, see Activating * enhanced infrastructure metrics in the Compute Optimizer User Guide. *
* * @param deleteRecommendationPreferencesRequest * @return Result of the DeleteRecommendationPreferences operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.DeleteRecommendationPreferences * @see AWS API Documentation */ @Override public DeleteRecommendationPreferencesResult deleteRecommendationPreferences(DeleteRecommendationPreferencesRequest request) { request = beforeClientExecution(request); return executeDeleteRecommendationPreferences(request); } @SdkInternalApi final DeleteRecommendationPreferencesResult executeDeleteRecommendationPreferences( DeleteRecommendationPreferencesRequest deleteRecommendationPreferencesRequest) { ExecutionContext executionContext = createExecutionContext(deleteRecommendationPreferencesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param describeRecommendationExportJobsRequest * @return Result of the DescribeRecommendationExportJobs operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.DescribeRecommendationExportJobs * @see AWS API Documentation */ @Override public DescribeRecommendationExportJobsResult describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest request) { request = beforeClientExecution(request); return executeDescribeRecommendationExportJobs(request); } @SdkInternalApi final DescribeRecommendationExportJobsResult executeDescribeRecommendationExportJobs( DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest) { ExecutionContext executionContext = createExecutionContext(describeRecommendationExportJobsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param exportAutoScalingGroupRecommendationsRequest * @return Result of the ExportAutoScalingGroupRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @throws LimitExceededException * The request exceeds a limit of the service. * @sample AWSComputeOptimizer.ExportAutoScalingGroupRecommendations * @see AWS API Documentation */ @Override public ExportAutoScalingGroupRecommendationsResult exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest request) { request = beforeClientExecution(request); return executeExportAutoScalingGroupRecommendations(request); } @SdkInternalApi final ExportAutoScalingGroupRecommendationsResult executeExportAutoScalingGroupRecommendations( ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(exportAutoScalingGroupRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param exportEBSVolumeRecommendationsRequest * @return Result of the ExportEBSVolumeRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @throws LimitExceededException * The request exceeds a limit of the service. * @sample AWSComputeOptimizer.ExportEBSVolumeRecommendations * @see AWS API Documentation */ @Override public ExportEBSVolumeRecommendationsResult exportEBSVolumeRecommendations(ExportEBSVolumeRecommendationsRequest request) { request = beforeClientExecution(request); return executeExportEBSVolumeRecommendations(request); } @SdkInternalApi final ExportEBSVolumeRecommendationsResult executeExportEBSVolumeRecommendations(ExportEBSVolumeRecommendationsRequest exportEBSVolumeRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(exportEBSVolumeRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param exportEC2InstanceRecommendationsRequest * @return Result of the ExportEC2InstanceRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @throws LimitExceededException * The request exceeds a limit of the service. * @sample AWSComputeOptimizer.ExportEC2InstanceRecommendations * @see AWS API Documentation */ @Override public ExportEC2InstanceRecommendationsResult exportEC2InstanceRecommendations(ExportEC2InstanceRecommendationsRequest request) { request = beforeClientExecution(request); return executeExportEC2InstanceRecommendations(request); } @SdkInternalApi final ExportEC2InstanceRecommendationsResult executeExportEC2InstanceRecommendations( ExportEC2InstanceRecommendationsRequest exportEC2InstanceRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(exportEC2InstanceRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param exportECSServiceRecommendationsRequest * @return Result of the ExportECSServiceRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @throws LimitExceededException * The request exceeds a limit of the service. * @sample AWSComputeOptimizer.ExportECSServiceRecommendations * @see AWS API Documentation */ @Override public ExportECSServiceRecommendationsResult exportECSServiceRecommendations(ExportECSServiceRecommendationsRequest request) { request = beforeClientExecution(request); return executeExportECSServiceRecommendations(request); } @SdkInternalApi final ExportECSServiceRecommendationsResult executeExportECSServiceRecommendations( ExportECSServiceRecommendationsRequest exportECSServiceRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(exportECSServiceRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param exportLambdaFunctionRecommendationsRequest * @return Result of the ExportLambdaFunctionRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @throws LimitExceededException * The request exceeds a limit of the service. * @sample AWSComputeOptimizer.ExportLambdaFunctionRecommendations * @see AWS API Documentation */ @Override public ExportLambdaFunctionRecommendationsResult exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest request) { request = beforeClientExecution(request); return executeExportLambdaFunctionRecommendations(request); } @SdkInternalApi final ExportLambdaFunctionRecommendationsResult executeExportLambdaFunctionRecommendations( ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(exportLambdaFunctionRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getAutoScalingGroupRecommendationsRequest * @return Result of the GetAutoScalingGroupRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetAutoScalingGroupRecommendations * @see AWS API Documentation */ @Override public GetAutoScalingGroupRecommendationsResult getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest request) { request = beforeClientExecution(request); return executeGetAutoScalingGroupRecommendations(request); } @SdkInternalApi final GetAutoScalingGroupRecommendationsResult executeGetAutoScalingGroupRecommendations( GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(getAutoScalingGroupRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getEBSVolumeRecommendationsRequest * @return Result of the GetEBSVolumeRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetEBSVolumeRecommendations * @see AWS API Documentation */ @Override public GetEBSVolumeRecommendationsResult getEBSVolumeRecommendations(GetEBSVolumeRecommendationsRequest request) { request = beforeClientExecution(request); return executeGetEBSVolumeRecommendations(request); } @SdkInternalApi final GetEBSVolumeRecommendationsResult executeGetEBSVolumeRecommendations(GetEBSVolumeRecommendationsRequest getEBSVolumeRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(getEBSVolumeRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getEC2InstanceRecommendationsRequest * @return Result of the GetEC2InstanceRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetEC2InstanceRecommendations * @see AWS API Documentation */ @Override public GetEC2InstanceRecommendationsResult getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest request) { request = beforeClientExecution(request); return executeGetEC2InstanceRecommendations(request); } @SdkInternalApi final GetEC2InstanceRecommendationsResult executeGetEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest getEC2InstanceRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(getEC2InstanceRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns the projected utilization metrics of Amazon EC2 instance recommendations. *
*
* The Cpu
and Memory
metrics are the only projected utilization metrics returned when you
* run this action. Additionally, the Memory
metric is returned only for resources that have the
* unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization
* with the CloudWatch Agent.
*
* Returns the projected metrics of Amazon ECS service recommendations. *
* * @param getECSServiceRecommendationProjectedMetricsRequest * @return Result of the GetECSServiceRecommendationProjectedMetrics operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetECSServiceRecommendationProjectedMetrics * @see AWS API Documentation */ @Override public GetECSServiceRecommendationProjectedMetricsResult getECSServiceRecommendationProjectedMetrics( GetECSServiceRecommendationProjectedMetricsRequest request) { request = beforeClientExecution(request); return executeGetECSServiceRecommendationProjectedMetrics(request); } @SdkInternalApi final GetECSServiceRecommendationProjectedMetricsResult executeGetECSServiceRecommendationProjectedMetrics( GetECSServiceRecommendationProjectedMetricsRequest getECSServiceRecommendationProjectedMetricsRequest) { ExecutionContext executionContext = createExecutionContext(getECSServiceRecommendationProjectedMetricsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getECSServiceRecommendationsRequest * @return Result of the GetECSServiceRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetECSServiceRecommendations * @see AWS API Documentation */ @Override public GetECSServiceRecommendationsResult getECSServiceRecommendations(GetECSServiceRecommendationsRequest request) { request = beforeClientExecution(request); return executeGetECSServiceRecommendations(request); } @SdkInternalApi final GetECSServiceRecommendationsResult executeGetECSServiceRecommendations(GetECSServiceRecommendationsRequest getECSServiceRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(getECSServiceRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure * metrics. Considers all applicable preferences that you might have set at the resource, account, and organization * level. *
*
* When you create a recommendation preference, you can set its status to Active
or
* Inactive
. Use this action to view the recommendation preferences that are in effect, or
* Active
.
*
* 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. *
* * @param getEnrollmentStatusRequest * @return Result of the GetEnrollmentStatus operation returned by the service. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetEnrollmentStatus * @see AWS API Documentation */ @Override public GetEnrollmentStatusResult getEnrollmentStatus(GetEnrollmentStatusRequest request) { request = beforeClientExecution(request); return executeGetEnrollmentStatus(request); } @SdkInternalApi final GetEnrollmentStatusResult executeGetEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest) { ExecutionContext executionContext = createExecutionContext(getEnrollmentStatusRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getEnrollmentStatusesForOrganizationRequest * @return Result of the GetEnrollmentStatusesForOrganization operation returned by the service. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetEnrollmentStatusesForOrganization * @see AWS API Documentation */ @Override public GetEnrollmentStatusesForOrganizationResult getEnrollmentStatusesForOrganization(GetEnrollmentStatusesForOrganizationRequest request) { request = beforeClientExecution(request); return executeGetEnrollmentStatusesForOrganization(request); } @SdkInternalApi final GetEnrollmentStatusesForOrganizationResult executeGetEnrollmentStatusesForOrganization( GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest) { ExecutionContext executionContext = createExecutionContext(getEnrollmentStatusesForOrganizationRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getLambdaFunctionRecommendationsRequest * @return Result of the GetLambdaFunctionRecommendations operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @throws LimitExceededException * The request exceeds a limit of the service. * @sample AWSComputeOptimizer.GetLambdaFunctionRecommendations * @see AWS API Documentation */ @Override public GetLambdaFunctionRecommendationsResult getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest request) { request = beforeClientExecution(request); return executeGetLambdaFunctionRecommendations(request); } @SdkInternalApi final GetLambdaFunctionRecommendationsResult executeGetLambdaFunctionRecommendations( GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest) { ExecutionContext executionContext = createExecutionContext(getLambdaFunctionRecommendationsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns existing recommendation preferences, such as enhanced infrastructure metrics. *
*
* Use the scope
parameter to specify which preferences to return. You can specify to return
* preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon
* Resource Name (ARN).
*
* For more information, see Activating * enhanced infrastructure metrics in the Compute Optimizer User Guide. *
* * @param getRecommendationPreferencesRequest * @return Result of the GetRecommendationPreferences operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.GetRecommendationPreferences * @see AWS API Documentation */ @Override public GetRecommendationPreferencesResult getRecommendationPreferences(GetRecommendationPreferencesRequest request) { request = beforeClientExecution(request); return executeGetRecommendationPreferences(request); } @SdkInternalApi final GetRecommendationPreferencesResult executeGetRecommendationPreferences(GetRecommendationPreferencesRequest getRecommendationPreferencesRequest) { ExecutionContext executionContext = createExecutionContext(getRecommendationPreferencesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns the optimization findings for an account. *
** It returns the number of: *
*
* Amazon EC2 instances in an account that are Underprovisioned
, Overprovisioned
, or
* Optimized
.
*
* Auto Scaling groups in an account that are NotOptimized
, or Optimized
.
*
* Amazon EBS volumes in an account that are NotOptimized
, or Optimized
.
*
* Lambda functions in an account that are NotOptimized
, or Optimized
.
*
* Amazon ECS services in an account that are Underprovisioned
, Overprovisioned
, or
* Optimized
.
*
* 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. *
* * @param putRecommendationPreferencesRequest * @return Result of the PutRecommendationPreferences operation returned by the service. * @throws OptInRequiredException * The account is not opted in to Compute Optimizer. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.PutRecommendationPreferences * @see AWS API Documentation */ @Override public PutRecommendationPreferencesResult putRecommendationPreferences(PutRecommendationPreferencesRequest request) { request = beforeClientExecution(request); return executePutRecommendationPreferences(request); } @SdkInternalApi final PutRecommendationPreferencesResult executePutRecommendationPreferences(PutRecommendationPreferencesRequest putRecommendationPreferencesRequest) { ExecutionContext executionContext = createExecutionContext(putRecommendationPreferencesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param updateEnrollmentStatusRequest * @return Result of the UpdateEnrollmentStatus operation returned by the service. * @throws InternalServerException * An internal error has occurred. Try your call again. * @throws ServiceUnavailableException * The request has failed due to a temporary failure of the server. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InvalidParameterValueException * The value supplied for the input parameter is out of range or not valid. * @throws MissingAuthenticationTokenException * The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 * certificate. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSComputeOptimizer.UpdateEnrollmentStatus * @see AWS API Documentation */ @Override public UpdateEnrollmentStatusResult updateEnrollmentStatus(UpdateEnrollmentStatusRequest request) { request = beforeClientExecution(request); return executeUpdateEnrollmentStatus(request); } @SdkInternalApi final UpdateEnrollmentStatusResult executeUpdateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest) { ExecutionContext executionContext = createExecutionContext(updateEnrollmentStatusRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private