computeoptimizer/aws.sdk.kotlin.services.computeoptimizer

Package-level declarations

Types

interface ComputeOptimizerClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

deleteRecommendationPreferences

inline suspend fun ComputeOptimizerClient.deleteRecommendationPreferences(crossinline block: DeleteRecommendationPreferencesRequest.Builder.() -> Unit): DeleteRecommendationPreferencesResponse

Deletes a recommendation preference, such as enhanced infrastructure metrics.

describeRecommendationExportJobs

inline suspend fun ComputeOptimizerClient.describeRecommendationExportJobs(crossinline block: DescribeRecommendationExportJobsRequest.Builder.() -> Unit): DescribeRecommendationExportJobsResponse

Describes recommendation export jobs created in the last seven days.

exportAutoScalingGroupRecommendations

inline suspend fun ComputeOptimizerClient.exportAutoScalingGroupRecommendations(crossinline block: ExportAutoScalingGroupRecommendationsRequest.Builder.() -> Unit): ExportAutoScalingGroupRecommendationsResponse

Exports optimization recommendations for Auto Scaling groups.

exportEbsVolumeRecommendations

inline suspend fun ComputeOptimizerClient.exportEbsVolumeRecommendations(crossinline block: ExportEbsVolumeRecommendationsRequest.Builder.() -> Unit): ExportEbsVolumeRecommendationsResponse

Exports optimization recommendations for Amazon EBS volumes.

exportEc2InstanceRecommendations

inline suspend fun ComputeOptimizerClient.exportEc2InstanceRecommendations(crossinline block: ExportEc2InstanceRecommendationsRequest.Builder.() -> Unit): ExportEc2InstanceRecommendationsResponse

Exports optimization recommendations for Amazon EC2 instances.

exportEcsServiceRecommendations

inline suspend fun ComputeOptimizerClient.exportEcsServiceRecommendations(crossinline block: ExportEcsServiceRecommendationsRequest.Builder.() -> Unit): ExportEcsServiceRecommendationsResponse

Exports optimization recommendations for Amazon ECS services on Fargate.

exportLambdaFunctionRecommendations

inline suspend fun ComputeOptimizerClient.exportLambdaFunctionRecommendations(crossinline block: ExportLambdaFunctionRecommendationsRequest.Builder.() -> Unit): ExportLambdaFunctionRecommendationsResponse

Exports optimization recommendations for Lambda functions.

exportLicenseRecommendations

inline suspend fun ComputeOptimizerClient.exportLicenseRecommendations(crossinline block: ExportLicenseRecommendationsRequest.Builder.() -> Unit): ExportLicenseRecommendationsResponse

Export optimization recommendations for your licenses.

getAutoScalingGroupRecommendations

inline suspend fun ComputeOptimizerClient.getAutoScalingGroupRecommendations(crossinline block: GetAutoScalingGroupRecommendationsRequest.Builder.() -> Unit): GetAutoScalingGroupRecommendationsResponse

Returns Auto Scaling group recommendations.

getEbsVolumeRecommendations

inline suspend fun ComputeOptimizerClient.getEbsVolumeRecommendations(crossinline block: GetEbsVolumeRecommendationsRequest.Builder.() -> Unit): GetEbsVolumeRecommendationsResponse

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

getEc2InstanceRecommendations

inline suspend fun ComputeOptimizerClient.getEc2InstanceRecommendations(crossinline block: GetEc2InstanceRecommendationsRequest.Builder.() -> Unit): GetEc2InstanceRecommendationsResponse

Returns Amazon EC2 instance recommendations.

getEc2RecommendationProjectedMetrics

inline suspend fun ComputeOptimizerClient.getEc2RecommendationProjectedMetrics(crossinline block: GetEc2RecommendationProjectedMetricsRequest.Builder.() -> Unit): GetEc2RecommendationProjectedMetricsResponse

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

getEcsServiceRecommendationProjectedMetrics

inline suspend fun ComputeOptimizerClient.getEcsServiceRecommendationProjectedMetrics(crossinline block: GetEcsServiceRecommendationProjectedMetricsRequest.Builder.() -> Unit): GetEcsServiceRecommendationProjectedMetricsResponse

Returns the projected metrics of Amazon ECS service recommendations.

getEcsServiceRecommendations

inline suspend fun ComputeOptimizerClient.getEcsServiceRecommendations(crossinline block: GetEcsServiceRecommendationsRequest.Builder.() -> Unit): GetEcsServiceRecommendationsResponse

Returns Amazon ECS service recommendations.

getEffectiveRecommendationPreferences

inline suspend fun ComputeOptimizerClient.getEffectiveRecommendationPreferences(crossinline block: GetEffectiveRecommendationPreferencesRequest.Builder.() -> Unit): GetEffectiveRecommendationPreferencesResponse

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.

getEnrollmentStatus

inline suspend fun ComputeOptimizerClient.getEnrollmentStatus(crossinline block: GetEnrollmentStatusRequest.Builder.() -> Unit): GetEnrollmentStatusResponse

Returns the enrollment (opt in) status of an account to the Compute Optimizer service.

getEnrollmentStatusesForOrganization

inline suspend fun ComputeOptimizerClient.getEnrollmentStatusesForOrganization(crossinline block: GetEnrollmentStatusesForOrganizationRequest.Builder.() -> Unit): GetEnrollmentStatusesForOrganizationResponse

Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.

getLambdaFunctionRecommendations

inline suspend fun ComputeOptimizerClient.getLambdaFunctionRecommendations(crossinline block: GetLambdaFunctionRecommendationsRequest.Builder.() -> Unit): GetLambdaFunctionRecommendationsResponse

Returns Lambda function recommendations.

getLicenseRecommendations

inline suspend fun ComputeOptimizerClient.getLicenseRecommendations(crossinline block: GetLicenseRecommendationsRequest.Builder.() -> Unit): GetLicenseRecommendationsResponse

Returns license recommendations for Amazon EC2 instances that run on a specific license.

getRecommendationPreferences

inline suspend fun ComputeOptimizerClient.getRecommendationPreferences(crossinline block: GetRecommendationPreferencesRequest.Builder.() -> Unit): GetRecommendationPreferencesResponse

Returns existing recommendation preferences, such as enhanced infrastructure metrics.

getRecommendationSummaries

inline suspend fun ComputeOptimizerClient.getRecommendationSummaries(crossinline block: GetRecommendationSummariesRequest.Builder.() -> Unit): GetRecommendationSummariesResponse

Returns the optimization findings for an account.

putRecommendationPreferences

inline suspend fun ComputeOptimizerClient.putRecommendationPreferences(crossinline block: PutRecommendationPreferencesRequest.Builder.() -> Unit): PutRecommendationPreferencesResponse

Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.

updateEnrollmentStatus

inline suspend fun ComputeOptimizerClient.updateEnrollmentStatus(crossinline block: UpdateEnrollmentStatusRequest.Builder.() -> Unit): UpdateEnrollmentStatusResponse

Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.

withConfig

fun ComputeOptimizerClient.withConfig(block: ComputeOptimizerClient.Config.Builder.() -> Unit): ComputeOptimizerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.