ComputeOptimizer class

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.

Constructors

ComputeOptimizer({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

deleteRecommendationPreferences({required List<RecommendationPreferenceName> recommendationPreferenceNames, required ResourceType resourceType, Scope? scope}) → Future<void>

Deletes a recommendation preference, such as enhanced infrastructure metrics.

describeRecommendationExportJobs({List<JobFilter>? filters, List<String>? jobIds, int? maxResults, String? nextToken}) → Future<DescribeRecommendationExportJobsResponse>

Describes recommendation export jobs created in the last seven days.

exportAutoScalingGroupRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableAutoScalingGroupField>? fieldsToExport, FileFormat? fileFormat, List<Filter>? filters, bool? includeMemberAccounts, RecommendationPreferences? recommendationPreferences}) → Future<ExportAutoScalingGroupRecommendationsResponse>

Exports optimization recommendations for Auto Scaling groups.

exportEBSVolumeRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableVolumeField>? fieldsToExport, FileFormat? fileFormat, List<EBSFilter>? filters, bool? includeMemberAccounts}) → Future<ExportEBSVolumeRecommendationsResponse>

Exports optimization recommendations for Amazon EBS volumes.

exportEC2InstanceRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableInstanceField>? fieldsToExport, FileFormat? fileFormat, List<Filter>? filters, bool? includeMemberAccounts, RecommendationPreferences? recommendationPreferences}) → Future<ExportEC2InstanceRecommendationsResponse>

Exports optimization recommendations for Amazon EC2 instances.

exportECSServiceRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableECSServiceField>? fieldsToExport, FileFormat? fileFormat, List<ECSServiceRecommendationFilter>? filters, bool? includeMemberAccounts}) → Future<ExportECSServiceRecommendationsResponse>

Exports optimization recommendations for Amazon ECS services on Fargate.

exportIdleRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableIdleField>? fieldsToExport, FileFormat? fileFormat, List<IdleRecommendationFilter>? filters, bool? includeMemberAccounts}) → Future<ExportIdleRecommendationsResponse>

Export optimization recommendations for your idle resources.

exportLambdaFunctionRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableLambdaFunctionField>? fieldsToExport, FileFormat? fileFormat, List<LambdaFunctionRecommendationFilter>? filters, bool? includeMemberAccounts}) → Future<ExportLambdaFunctionRecommendationsResponse>

Exports optimization recommendations for Lambda functions.

exportLicenseRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableLicenseField>? fieldsToExport, FileFormat? fileFormat, List<LicenseRecommendationFilter>? filters, bool? includeMemberAccounts}) → Future<ExportLicenseRecommendationsResponse>

Export optimization recommendations for your licenses.

exportRDSDatabaseRecommendations({required S3DestinationConfig s3DestinationConfig, List<String>? accountIds, List<ExportableRDSDBField>? fieldsToExport, FileFormat? fileFormat, List<RDSDBRecommendationFilter>? filters, bool? includeMemberAccounts, RecommendationPreferences? recommendationPreferences}) → Future<ExportRDSDatabaseRecommendationsResponse>

Export optimization recommendations for your Amazon Aurora and Amazon Relational Database Service (Amazon RDS) databases.

getAutoScalingGroupRecommendations({List<String>? accountIds, List<String>? autoScalingGroupArns, List<Filter>? filters, int? maxResults, String? nextToken, RecommendationPreferences? recommendationPreferences}) → Future<GetAutoScalingGroupRecommendationsResponse>

Returns Auto Scaling group recommendations.

getEBSVolumeRecommendations({List<String>? accountIds, List<EBSFilter>? filters, int? maxResults, String? nextToken, List<String>? volumeArns}) → Future<GetEBSVolumeRecommendationsResponse>

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

getEC2InstanceRecommendations({List<String>? accountIds, List<Filter>? filters, List<String>? instanceArns, int? maxResults, String? nextToken, RecommendationPreferences? recommendationPreferences}) → Future<GetEC2InstanceRecommendationsResponse>

Returns Amazon EC2 instance recommendations.

getEC2RecommendationProjectedMetrics({required DateTime endTime, required String instanceArn, required int period, required DateTime startTime, required MetricStatistic stat, RecommendationPreferences? recommendationPreferences}) → Future<GetEC2RecommendationProjectedMetricsResponse>

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

getECSServiceRecommendationProjectedMetrics({required DateTime endTime, required int period, required String serviceArn, required DateTime startTime, required MetricStatistic stat}) → Future<GetECSServiceRecommendationProjectedMetricsResponse>

Returns the projected metrics of Amazon ECS service recommendations.

getECSServiceRecommendations({List<String>? accountIds, List<ECSServiceRecommendationFilter>? filters, int? maxResults, String? nextToken, List<String>? serviceArns}) → Future<GetECSServiceRecommendationsResponse>

Returns Amazon ECS service recommendations.

getEffectiveRecommendationPreferences({required String resourceArn}) → Future<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() → Future<GetEnrollmentStatusResponse>

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

getEnrollmentStatusesForOrganization({List<EnrollmentFilter>? filters, int? maxResults, String? nextToken}) → Future<GetEnrollmentStatusesForOrganizationResponse>

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

getIdleRecommendations({List<String>? accountIds, List<IdleRecommendationFilter>? filters, int? maxResults, String? nextToken, OrderBy? orderBy, List<String>? resourceArns}) → Future<GetIdleRecommendationsResponse>

Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User Guide

getLambdaFunctionRecommendations({List<String>? accountIds, List<LambdaFunctionRecommendationFilter>? filters, List<String>? functionArns, int? maxResults, String? nextToken}) → Future<GetLambdaFunctionRecommendationsResponse>

Returns Lambda function recommendations.

getLicenseRecommendations({List<String>? accountIds, List<LicenseRecommendationFilter>? filters, int? maxResults, String? nextToken, List<String>? resourceArns}) → Future<GetLicenseRecommendationsResponse>

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

getRDSDatabaseRecommendationProjectedMetrics({required DateTime endTime, required int period, required String resourceArn, required DateTime startTime, required MetricStatistic stat, RecommendationPreferences? recommendationPreferences}) → Future<GetRDSDatabaseRecommendationProjectedMetricsResponse>

Returns the projected metrics of Aurora and RDS database recommendations.

getRDSDatabaseRecommendations({List<String>? accountIds, List<RDSDBRecommendationFilter>? filters, int? maxResults, String? nextToken, RecommendationPreferences? recommendationPreferences, List<String>? resourceArns}) → Future<GetRDSDatabaseRecommendationsResponse>

Returns Amazon Aurora and RDS database recommendations.

getRecommendationPreferences({required ResourceType resourceType, int? maxResults, String? nextToken, Scope? scope}) → Future<GetRecommendationPreferencesResponse>

Returns existing recommendation preferences, such as enhanced infrastructure metrics.

getRecommendationSummaries({List<String>? accountIds, int? maxResults, String? nextToken}) → Future<GetRecommendationSummariesResponse>

Returns the optimization findings for an account.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putRecommendationPreferences({required ResourceType resourceType, EnhancedInfrastructureMetrics? enhancedInfrastructureMetrics, ExternalMetricsPreference? externalMetricsPreference, InferredWorkloadTypesPreference? inferredWorkloadTypes, LookBackPeriodPreference? lookBackPeriod, List<PreferredResource>? preferredResources, SavingsEstimationMode? savingsEstimationMode, Scope? scope, List<UtilizationPreference>? utilizationPreferences}) → Future<void>

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

toString() → String

A string representation of this object.

inherited

updateEnrollmentStatus({required Status status, bool? includeMemberAccounts}) → Future<UpdateEnrollmentStatusResponse>

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited