@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSComputeOptimizer
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSComputeOptimizer
instead.
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, and Amazon EBS volumes. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
DescribeRecommendationExportJobsResult |
describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest)
Describes recommendation export jobs created in the last seven days.
|
ExportAutoScalingGroupRecommendationsResult |
exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest)
Exports optimization recommendations for Auto Scaling groups.
|
ExportEBSVolumeRecommendationsResult |
exportEBSVolumeRecommendations(ExportEBSVolumeRecommendationsRequest exportEBSVolumeRecommendationsRequest)
Exports optimization recommendations for Amazon EBS volumes.
|
ExportEC2InstanceRecommendationsResult |
exportEC2InstanceRecommendations(ExportEC2InstanceRecommendationsRequest exportEC2InstanceRecommendationsRequest)
Exports optimization recommendations for Amazon EC2 instances.
|
ExportLambdaFunctionRecommendationsResult |
exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest)
Exports optimization recommendations for Lambda functions.
|
GetAutoScalingGroupRecommendationsResult |
getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest)
Returns Auto Scaling group recommendations.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEBSVolumeRecommendationsResult |
getEBSVolumeRecommendations(GetEBSVolumeRecommendationsRequest getEBSVolumeRecommendationsRequest)
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
|
GetEC2InstanceRecommendationsResult |
getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest getEC2InstanceRecommendationsRequest)
Returns Amazon EC2 instance recommendations.
|
GetEC2RecommendationProjectedMetricsResult |
getEC2RecommendationProjectedMetrics(GetEC2RecommendationProjectedMetricsRequest getEC2RecommendationProjectedMetricsRequest)
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
|
GetEnrollmentStatusResult |
getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest)
Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
|
GetEnrollmentStatusesForOrganizationResult |
getEnrollmentStatusesForOrganization(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest)
Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an
organization management account.
|
GetLambdaFunctionRecommendationsResult |
getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest)
Returns Lambda function recommendations.
|
GetRecommendationSummariesResult |
getRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest)
Returns the optimization findings for an account.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateEnrollmentStatusResult |
updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
|
static final String ENDPOINT_PREFIX
DescribeRecommendationExportJobsResult describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest describeRecommendationExportJobsRequest)
Describes recommendation export jobs created in the last seven days.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
describeRecommendationExportJobsRequest
- 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.ExportAutoScalingGroupRecommendationsResult exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest exportAutoScalingGroupRecommendationsRequest)
Exports optimization recommendations for Auto Scaling groups.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
exportAutoScalingGroupRecommendationsRequest
- 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.ExportEBSVolumeRecommendationsResult exportEBSVolumeRecommendations(ExportEBSVolumeRecommendationsRequest exportEBSVolumeRecommendationsRequest)
Exports optimization recommendations for Amazon EBS volumes.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
exportEBSVolumeRecommendationsRequest
- 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.ExportEC2InstanceRecommendationsResult exportEC2InstanceRecommendations(ExportEC2InstanceRecommendationsRequest exportEC2InstanceRecommendationsRequest)
Exports optimization recommendations for Amazon EC2 instances.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
exportEC2InstanceRecommendationsRequest
- 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.ExportLambdaFunctionRecommendationsResult exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest exportLambdaFunctionRecommendationsRequest)
Exports optimization recommendations for Lambda functions.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Lambda function export job in progress per Amazon Web Services Region.
exportLambdaFunctionRecommendationsRequest
- 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.GetAutoScalingGroupRecommendationsResult getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest)
Returns Auto Scaling group recommendations.
Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
getAutoScalingGroupRecommendationsRequest
- 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.GetEBSVolumeRecommendationsResult getEBSVolumeRecommendations(GetEBSVolumeRecommendationsRequest getEBSVolumeRecommendationsRequest)
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
getEBSVolumeRecommendationsRequest
- 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.GetEC2InstanceRecommendationsResult getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest getEC2InstanceRecommendationsRequest)
Returns Amazon EC2 instance recommendations.
Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
getEC2InstanceRecommendationsRequest
- 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.GetEC2RecommendationProjectedMetricsResult getEC2RecommendationProjectedMetrics(GetEC2RecommendationProjectedMetricsRequest getEC2RecommendationProjectedMetricsRequest)
Returns the projected utilization metrics of Amazon EC2 instance recommendations.
The Cpu
and Memory
metrics are the only projected utilization metrics returned when you
run this action. Additionally, the Memory
metric is returned only for resources that have the
unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization
with the CloudWatch Agent.
getEC2RecommendationProjectedMetricsRequest
- 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.GetEnrollmentStatusResult getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest)
Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.
getEnrollmentStatusRequest
- 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.GetEnrollmentStatusesForOrganizationResult getEnrollmentStatusesForOrganization(GetEnrollmentStatusesForOrganizationRequest getEnrollmentStatusesForOrganizationRequest)
Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
getEnrollmentStatusesForOrganizationRequest
- 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.GetLambdaFunctionRecommendationsResult getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest getLambdaFunctionRecommendationsRequest)
Returns Lambda function recommendations.
Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
getLambdaFunctionRecommendationsRequest
- 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.GetRecommendationSummariesResult getRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest)
Returns the optimization findings for an account.
It returns the number of:
Amazon EC2 instances in an account that are Underprovisioned
, Overprovisioned
, or
Optimized
.
Auto Scaling groups in an account that are NotOptimized
, or Optimized
.
Amazon EBS volumes in an account that are NotOptimized
, or Optimized
.
Lambda functions in an account that are NotOptimized
, or Optimized
.
getRecommendationSummariesRequest
- 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.UpdateEnrollmentStatusResult updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
updateEnrollmentStatusRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest 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 a request.
request
- The originally executed request.