libZSservicesZSamazonka-compute-optimizerZSamazonka-compute-optimizer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ComputeOptimizer.Lens

Description

 
Synopsis

Operations

ExportEBSVolumeRecommendations

exportEBSVolumeRecommendations_accountIds :: Lens' ExportEBSVolumeRecommendations (Maybe [Text]) Source #

The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

exportEBSVolumeRecommendations_fileFormat :: Lens' ExportEBSVolumeRecommendations (Maybe FileFormat) Source #

The format of the export file.

The only export file format currently supported is Csv.

exportEBSVolumeRecommendations_filters :: Lens' ExportEBSVolumeRecommendations (Maybe [EBSFilter]) Source #

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

exportEBSVolumeRecommendations_fieldsToExport :: Lens' ExportEBSVolumeRecommendations (Maybe [ExportableVolumeField]) Source #

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

exportEBSVolumeRecommendations_includeMemberAccounts :: Lens' ExportEBSVolumeRecommendations (Maybe Bool) Source #

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

exportEBSVolumeRecommendationsResponse_jobId :: Lens' ExportEBSVolumeRecommendationsResponse (Maybe Text) Source #

The identification number of the export job.

Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

GetRecommendationSummaries

getRecommendationSummaries_accountIds :: Lens' GetRecommendationSummaries (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return recommendation summaries.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.

Only one account ID can be specified per request.

getRecommendationSummaries_nextToken :: Lens' GetRecommendationSummaries (Maybe Text) Source #

The token to advance to the next page of recommendation summaries.

getRecommendationSummaries_maxResults :: Lens' GetRecommendationSummaries (Maybe Int) Source #

The maximum number of recommendation summaries to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

getRecommendationSummariesResponse_nextToken :: Lens' GetRecommendationSummariesResponse (Maybe Text) Source #

The token to use to advance to the next page of recommendation summaries.

This value is null when there are no more pages of recommendation summaries to return.

ExportAutoScalingGroupRecommendations

exportAutoScalingGroupRecommendations_accountIds :: Lens' ExportAutoScalingGroupRecommendations (Maybe [Text]) Source #

The IDs of the Amazon Web Services accounts for which to export Auto Scaling group recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

exportAutoScalingGroupRecommendations_fileFormat :: Lens' ExportAutoScalingGroupRecommendations (Maybe FileFormat) Source #

The format of the export file.

The only export file format currently supported is Csv.

exportAutoScalingGroupRecommendations_filters :: Lens' ExportAutoScalingGroupRecommendations (Maybe [Filter]) Source #

An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.

exportAutoScalingGroupRecommendations_fieldsToExport :: Lens' ExportAutoScalingGroupRecommendations (Maybe [ExportableAutoScalingGroupField]) Source #

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

exportAutoScalingGroupRecommendations_includeMemberAccounts :: Lens' ExportAutoScalingGroupRecommendations (Maybe Bool) Source #

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

exportAutoScalingGroupRecommendations_recommendationPreferences :: Lens' ExportAutoScalingGroupRecommendations (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Auto Scaling group recommendations to export.

exportAutoScalingGroupRecommendations_s3DestinationConfig :: Lens' ExportAutoScalingGroupRecommendations S3DestinationConfig Source #

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

exportAutoScalingGroupRecommendationsResponse_jobId :: Lens' ExportAutoScalingGroupRecommendationsResponse (Maybe Text) Source #

The identification number of the export job.

Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

exportAutoScalingGroupRecommendationsResponse_s3Destination :: Lens' ExportAutoScalingGroupRecommendationsResponse (Maybe S3Destination) Source #

An object that describes the destination Amazon S3 bucket of a recommendations export file.

GetEC2InstanceRecommendations

getEC2InstanceRecommendations_accountIds :: Lens' GetEC2InstanceRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.

Only one account ID can be specified per request.

getEC2InstanceRecommendations_filters :: Lens' GetEC2InstanceRecommendations (Maybe [Filter]) Source #

An array of objects to specify a filter that returns a more specific list of instance recommendations.

getEC2InstanceRecommendations_recommendationPreferences :: Lens' GetEC2InstanceRecommendations (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

getEC2InstanceRecommendations_nextToken :: Lens' GetEC2InstanceRecommendations (Maybe Text) Source #

The token to advance to the next page of instance recommendations.

getEC2InstanceRecommendations_instanceArns :: Lens' GetEC2InstanceRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the instances for which to return recommendations.

getEC2InstanceRecommendations_maxResults :: Lens' GetEC2InstanceRecommendations (Maybe Int) Source #

The maximum number of instance recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

getEC2InstanceRecommendationsResponse_nextToken :: Lens' GetEC2InstanceRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of instance recommendations.

This value is null when there are no more pages of instance recommendations to return.

getEC2InstanceRecommendationsResponse_errors :: Lens' GetEC2InstanceRecommendationsResponse (Maybe [GetRecommendationError]) Source #

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an instance of an unsupported instance family.

GetLambdaFunctionRecommendations

getLambdaFunctionRecommendations_functionArns :: Lens' GetLambdaFunctionRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the functions for which to return recommendations.

You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest ($LATEST) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the Lambda Developer Guide.

getLambdaFunctionRecommendations_accountIds :: Lens' GetLambdaFunctionRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return function recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.

Only one account ID can be specified per request.

getLambdaFunctionRecommendations_filters :: Lens' GetLambdaFunctionRecommendations (Maybe [LambdaFunctionRecommendationFilter]) Source #

An array of objects to specify a filter that returns a more specific list of function recommendations.

getLambdaFunctionRecommendations_nextToken :: Lens' GetLambdaFunctionRecommendations (Maybe Text) Source #

The token to advance to the next page of function recommendations.

getLambdaFunctionRecommendations_maxResults :: Lens' GetLambdaFunctionRecommendations (Maybe Int) Source #

The maximum number of function recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

getLambdaFunctionRecommendationsResponse_nextToken :: Lens' GetLambdaFunctionRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of function recommendations.

This value is null when there are no more pages of function recommendations to return.

UpdateEnrollmentStatus

updateEnrollmentStatus_includeMemberAccounts :: Lens' UpdateEnrollmentStatus (Maybe Bool) Source #

Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.

updateEnrollmentStatus_status :: Lens' UpdateEnrollmentStatus Status Source #

The new enrollment status of the account.

The following status options are available:

  • Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.
  • Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.

The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.

updateEnrollmentStatusResponse_statusReason :: Lens' UpdateEnrollmentStatusResponse (Maybe Text) Source #

The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

DescribeRecommendationExportJobs

describeRecommendationExportJobs_filters :: Lens' DescribeRecommendationExportJobs (Maybe [JobFilter]) Source #

An array of objects to specify a filter that returns a more specific list of export jobs.

describeRecommendationExportJobs_nextToken :: Lens' DescribeRecommendationExportJobs (Maybe Text) Source #

The token to advance to the next page of export jobs.

describeRecommendationExportJobs_maxResults :: Lens' DescribeRecommendationExportJobs (Maybe Int) Source #

The maximum number of export jobs to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

describeRecommendationExportJobs_jobIds :: Lens' DescribeRecommendationExportJobs (Maybe [Text]) Source #

The identification numbers of the export jobs to return.

An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.

All export jobs created in the last seven days are returned if this parameter is omitted.

describeRecommendationExportJobsResponse_nextToken :: Lens' DescribeRecommendationExportJobsResponse (Maybe Text) Source #

The token to use to advance to the next page of export jobs.

This value is null when there are no more pages of export jobs to return.

GetEC2RecommendationProjectedMetrics

getEC2RecommendationProjectedMetrics_recommendationPreferences :: Lens' GetEC2RecommendationProjectedMetrics (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.

getEC2RecommendationProjectedMetrics_instanceArn :: Lens' GetEC2RecommendationProjectedMetrics Text Source #

The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

getEC2RecommendationProjectedMetrics_period :: Lens' GetEC2RecommendationProjectedMetrics Int Source #

The granularity, in seconds, of the projected metrics data points.

getEC2RecommendationProjectedMetrics_startTime :: Lens' GetEC2RecommendationProjectedMetrics UTCTime Source #

The timestamp of the first projected metrics data point to return.

getEC2RecommendationProjectedMetrics_endTime :: Lens' GetEC2RecommendationProjectedMetrics UTCTime Source #

The timestamp of the last projected metrics data point to return.

GetEnrollmentStatusesForOrganization

getEnrollmentStatusesForOrganization_filters :: Lens' GetEnrollmentStatusesForOrganization (Maybe [EnrollmentFilter]) Source #

An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

getEnrollmentStatusesForOrganization_nextToken :: Lens' GetEnrollmentStatusesForOrganization (Maybe Text) Source #

The token to advance to the next page of account enrollment statuses.

getEnrollmentStatusesForOrganization_maxResults :: Lens' GetEnrollmentStatusesForOrganization (Maybe Int) Source #

The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.

To retrieve the remaining results, make another request with the returned nextToken value.

getEnrollmentStatusesForOrganizationResponse_accountEnrollmentStatuses :: Lens' GetEnrollmentStatusesForOrganizationResponse (Maybe [AccountEnrollmentStatus]) Source #

An array of objects that describe the enrollment statuses of organization member accounts.

getEnrollmentStatusesForOrganizationResponse_nextToken :: Lens' GetEnrollmentStatusesForOrganizationResponse (Maybe Text) Source #

The token to use to advance to the next page of account enrollment statuses.

This value is null when there are no more pages of account enrollment statuses to return.

GetEBSVolumeRecommendations

getEBSVolumeRecommendations_accountIds :: Lens' GetEBSVolumeRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.

Only one account ID can be specified per request.

getEBSVolumeRecommendations_filters :: Lens' GetEBSVolumeRecommendations (Maybe [EBSFilter]) Source #

An array of objects to specify a filter that returns a more specific list of volume recommendations.

getEBSVolumeRecommendations_nextToken :: Lens' GetEBSVolumeRecommendations (Maybe Text) Source #

The token to advance to the next page of volume recommendations.

getEBSVolumeRecommendations_volumeArns :: Lens' GetEBSVolumeRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

getEBSVolumeRecommendations_maxResults :: Lens' GetEBSVolumeRecommendations (Maybe Int) Source #

The maximum number of volume recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

getEBSVolumeRecommendationsResponse_nextToken :: Lens' GetEBSVolumeRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of volume recommendations.

This value is null when there are no more pages of volume recommendations to return.

getEBSVolumeRecommendationsResponse_errors :: Lens' GetEBSVolumeRecommendationsResponse (Maybe [GetRecommendationError]) Source #

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported volume.

ExportLambdaFunctionRecommendations

exportLambdaFunctionRecommendations_accountIds :: Lens' ExportLambdaFunctionRecommendations (Maybe [Text]) Source #

The IDs of the Amazon Web Services accounts for which to export Lambda function recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

exportLambdaFunctionRecommendations_fileFormat :: Lens' ExportLambdaFunctionRecommendations (Maybe FileFormat) Source #

The format of the export file.

The only export file format currently supported is Csv.

exportLambdaFunctionRecommendations_filters :: Lens' ExportLambdaFunctionRecommendations (Maybe [LambdaFunctionRecommendationFilter]) Source #

An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.

exportLambdaFunctionRecommendations_fieldsToExport :: Lens' ExportLambdaFunctionRecommendations (Maybe [ExportableLambdaFunctionField]) Source #

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

exportLambdaFunctionRecommendations_includeMemberAccounts :: Lens' ExportLambdaFunctionRecommendations (Maybe Bool) Source #

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

exportLambdaFunctionRecommendationsResponse_jobId :: Lens' ExportLambdaFunctionRecommendationsResponse (Maybe Text) Source #

The identification number of the export job.

Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

ExportEC2InstanceRecommendations

exportEC2InstanceRecommendations_accountIds :: Lens' ExportEC2InstanceRecommendations (Maybe [Text]) Source #

The IDs of the Amazon Web Services accounts for which to export instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

exportEC2InstanceRecommendations_fileFormat :: Lens' ExportEC2InstanceRecommendations (Maybe FileFormat) Source #

The format of the export file.

The only export file format currently supported is Csv.

exportEC2InstanceRecommendations_filters :: Lens' ExportEC2InstanceRecommendations (Maybe [Filter]) Source #

An array of objects to specify a filter that exports a more specific set of instance recommendations.

exportEC2InstanceRecommendations_fieldsToExport :: Lens' ExportEC2InstanceRecommendations (Maybe [ExportableInstanceField]) Source #

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

exportEC2InstanceRecommendations_includeMemberAccounts :: Lens' ExportEC2InstanceRecommendations (Maybe Bool) Source #

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

exportEC2InstanceRecommendations_recommendationPreferences :: Lens' ExportEC2InstanceRecommendations (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Amazon EC2 instance recommendations to export.

exportEC2InstanceRecommendations_s3DestinationConfig :: Lens' ExportEC2InstanceRecommendations S3DestinationConfig Source #

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

exportEC2InstanceRecommendationsResponse_jobId :: Lens' ExportEC2InstanceRecommendationsResponse (Maybe Text) Source #

The identification number of the export job.

Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

exportEC2InstanceRecommendationsResponse_s3Destination :: Lens' ExportEC2InstanceRecommendationsResponse (Maybe S3Destination) Source #

An object that describes the destination Amazon S3 bucket of a recommendations export file.

GetEnrollmentStatus

getEnrollmentStatusResponse_numberOfMemberAccountsOptedIn :: Lens' GetEnrollmentStatusResponse (Maybe Int) Source #

The count of organization member accounts that are opted in to the service, if your account is an organization management account.

getEnrollmentStatusResponse_memberAccountsEnrolled :: Lens' GetEnrollmentStatusResponse (Maybe Bool) Source #

Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.

getEnrollmentStatusResponse_statusReason :: Lens' GetEnrollmentStatusResponse (Maybe Text) Source #

The reason for the enrollment status of the account.

For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

getEnrollmentStatusResponse_lastUpdatedTimestamp :: Lens' GetEnrollmentStatusResponse (Maybe UTCTime) Source #

The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

GetAutoScalingGroupRecommendations

getAutoScalingGroupRecommendations_accountIds :: Lens' GetAutoScalingGroupRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return Auto Scaling group recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.

Only one account ID can be specified per request.

getAutoScalingGroupRecommendations_filters :: Lens' GetAutoScalingGroupRecommendations (Maybe [Filter]) Source #

An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

getAutoScalingGroupRecommendations_autoScalingGroupArns :: Lens' GetAutoScalingGroupRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

getAutoScalingGroupRecommendations_recommendationPreferences :: Lens' GetAutoScalingGroupRecommendations (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

getAutoScalingGroupRecommendations_nextToken :: Lens' GetAutoScalingGroupRecommendations (Maybe Text) Source #

The token to advance to the next page of Auto Scaling group recommendations.

getAutoScalingGroupRecommendations_maxResults :: Lens' GetAutoScalingGroupRecommendations (Maybe Int) Source #

The maximum number of Auto Scaling group recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

getAutoScalingGroupRecommendationsResponse_nextToken :: Lens' GetAutoScalingGroupRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of Auto Scaling group recommendations.

This value is null when there are no more pages of Auto Scaling group recommendations to return.

getAutoScalingGroupRecommendationsResponse_errors :: Lens' GetAutoScalingGroupRecommendationsResponse (Maybe [GetRecommendationError]) Source #

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.

Types

AccountEnrollmentStatus

accountEnrollmentStatus_statusReason :: Lens' AccountEnrollmentStatus (Maybe Text) Source #

The reason for the account enrollment status.

For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

accountEnrollmentStatus_lastUpdatedTimestamp :: Lens' AccountEnrollmentStatus (Maybe UTCTime) Source #

The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

AutoScalingGroupConfiguration

autoScalingGroupConfiguration_maxSize :: Lens' AutoScalingGroupConfiguration (Maybe Int) Source #

The maximum size, or maximum number of instances, for the Auto Scaling group.

autoScalingGroupConfiguration_desiredCapacity :: Lens' AutoScalingGroupConfiguration (Maybe Int) Source #

The desired capacity, or number of instances, for the Auto Scaling group.

autoScalingGroupConfiguration_minSize :: Lens' AutoScalingGroupConfiguration (Maybe Int) Source #

The minimum size, or minimum number of instances, for the Auto Scaling group.

AutoScalingGroupRecommendation

autoScalingGroupRecommendation_finding :: Lens' AutoScalingGroupRecommendation (Maybe Finding) Source #

The finding classification of the Auto Scaling group.

Findings for Auto Scaling groups include:

  • NotOptimized —An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
  • Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.

autoScalingGroupRecommendation_lastRefreshTimestamp :: Lens' AutoScalingGroupRecommendation (Maybe UTCTime) Source #

The timestamp of when the Auto Scaling group recommendation was last refreshed.

autoScalingGroupRecommendation_currentConfiguration :: Lens' AutoScalingGroupRecommendation (Maybe AutoScalingGroupConfiguration) Source #

An array of objects that describe the current configuration of the Auto Scaling group.

autoScalingGroupRecommendation_accountId :: Lens' AutoScalingGroupRecommendation (Maybe Text) Source #

The Amazon Web Services account ID of the Auto Scaling group.

autoScalingGroupRecommendation_utilizationMetrics :: Lens' AutoScalingGroupRecommendation (Maybe [UtilizationMetric]) Source #

An array of objects that describe the utilization metrics of the Auto Scaling group.

autoScalingGroupRecommendation_autoScalingGroupArn :: Lens' AutoScalingGroupRecommendation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Auto Scaling group.

autoScalingGroupRecommendation_recommendationOptions :: Lens' AutoScalingGroupRecommendation (Maybe [AutoScalingGroupRecommendationOption]) Source #

An array of objects that describe the recommendation options for the Auto Scaling group.

autoScalingGroupRecommendation_lookBackPeriodInDays :: Lens' AutoScalingGroupRecommendation (Maybe Double) Source #

The number of days for which utilization metrics were analyzed for the Auto Scaling group.

AutoScalingGroupRecommendationOption

autoScalingGroupRecommendationOption_performanceRisk :: Lens' AutoScalingGroupRecommendationOption (Maybe Double) Source #

The performance risk of the Auto Scaling group configuration recommendation.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

autoScalingGroupRecommendationOption_projectedUtilizationMetrics :: Lens' AutoScalingGroupRecommendationOption (Maybe [UtilizationMetric]) Source #

An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. 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.

autoScalingGroupRecommendationOption_rank :: Lens' AutoScalingGroupRecommendationOption (Maybe Int) Source #

The rank of the Auto Scaling group recommendation option.

The top recommendation option is ranked as 1.

EBSFilter

eBSFilter_values :: Lens' EBSFilter (Maybe [Text]) Source #

The value of the filter.

The valid values are Optimized, or NotOptimized.

eBSFilter_name :: Lens' EBSFilter (Maybe EBSFilterName) Source #

The name of the filter.

Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).

EBSUtilizationMetric

eBSUtilizationMetric_value :: Lens' EBSUtilizationMetric (Maybe Double) Source #

The value of the utilization metric.

eBSUtilizationMetric_name :: Lens' EBSUtilizationMetric (Maybe EBSMetricName) Source #

The name of the utilization metric.

The following utilization metrics are available:

  • VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.

    Unit: Count

  • VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.

    Unit: Count

  • VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.

    Unit: Bytes

  • VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.

    Unit: Bytes

eBSUtilizationMetric_statistic :: Lens' EBSUtilizationMetric (Maybe MetricStatistic) Source #

The statistic of the utilization metric.

The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

EnrollmentFilter

enrollmentFilter_values :: Lens' EnrollmentFilter (Maybe [Text]) Source #

The value of the filter.

The valid values are Active, Inactive, Pending, and Failed.

enrollmentFilter_name :: Lens' EnrollmentFilter (Maybe EnrollmentFilterName) Source #

The name of the filter.

Specify Status to return accounts with a specific enrollment status (for example, Active).

ExportDestination

exportDestination_s3 :: Lens' ExportDestination (Maybe S3Destination) Source #

An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.

Filter

filter_values :: Lens' Filter (Maybe [Text]) Source #

The value of the filter.

The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that you wish to filter results for:

  • Specify Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.
  • Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.
  • Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType.
  • Specify one of the following options if you specify the name parameter as FindingReasonCodes:

    • CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload.
    • CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance.
    • MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload.
    • MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance.
    • EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload.
    • EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance.
    • EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload.
    • EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance.
    • NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload.
    • NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
    • NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload.
    • NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance.
    • DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload.
    • DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance.
    • DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload.
    • DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance.

filter_name :: Lens' Filter (Maybe FilterName) Source #

The name of the filter.

Specify Finding to return recommendations with a specific finding classification (for example, Underprovisioned).

Specify RecommendationSourceType to return recommendations of a specific resource type (for example, Ec2Instance).

Specify FindingReasonCodes to return recommendations with a specific finding reason code (for example, CPUUnderprovisioned).

GetRecommendationError

getRecommendationError_message :: Lens' GetRecommendationError (Maybe Text) Source #

The message, or reason, for the error.

InstanceRecommendation

instanceRecommendation_instanceArn :: Lens' InstanceRecommendation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the current instance.

instanceRecommendation_finding :: Lens' InstanceRecommendation (Maybe Finding) Source #

The finding classification of the instance.

Findings for instances include:

  • Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
  • Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
  • Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. For optimized resources, Compute Optimizer might recommend a new generation instance type.

instanceRecommendation_lastRefreshTimestamp :: Lens' InstanceRecommendation (Maybe UTCTime) Source #

The timestamp of when the instance recommendation was last refreshed.

instanceRecommendation_accountId :: Lens' InstanceRecommendation (Maybe Text) Source #

The Amazon Web Services account ID of the instance.

instanceRecommendation_findingReasonCodes :: Lens' InstanceRecommendation (Maybe [InstanceRecommendationFindingReasonCode]) Source #

The reason for the finding classification of the instance.

Finding reason codes for instances include:

  • CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
  • CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
  • MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
  • MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.

    Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace.

  • EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
  • EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
  • EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.
  • EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.
  • NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period.
  • NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
  • NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
  • NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
  • DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
  • DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
  • DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
  • DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.

For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide.

instanceRecommendation_recommendationSources :: Lens' InstanceRecommendation (Maybe [RecommendationSource]) Source #

An array of objects that describe the source resource of the recommendation.

instanceRecommendation_utilizationMetrics :: Lens' InstanceRecommendation (Maybe [UtilizationMetric]) Source #

An array of objects that describe the utilization metrics of the instance.

instanceRecommendation_recommendationOptions :: Lens' InstanceRecommendation (Maybe [InstanceRecommendationOption]) Source #

An array of objects that describe the recommendation options for the instance.

instanceRecommendation_lookBackPeriodInDays :: Lens' InstanceRecommendation (Maybe Double) Source #

The number of days for which utilization metrics were analyzed for the instance.

InstanceRecommendationOption

instanceRecommendationOption_platformDifferences :: Lens' InstanceRecommendationOption (Maybe [PlatformDifference]) Source #

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.
  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.
  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.
  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.
  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.
  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

instanceRecommendationOption_performanceRisk :: Lens' InstanceRecommendationOption (Maybe Double) Source #

The performance risk of the instance recommendation option.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

instanceRecommendationOption_projectedUtilizationMetrics :: Lens' InstanceRecommendationOption (Maybe [UtilizationMetric]) Source #

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. 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.

instanceRecommendationOption_instanceType :: Lens' InstanceRecommendationOption (Maybe Text) Source #

The instance type of the instance recommendation.

instanceRecommendationOption_rank :: Lens' InstanceRecommendationOption (Maybe Int) Source #

The rank of the instance recommendation option.

The top recommendation option is ranked as 1.

JobFilter

jobFilter_values :: Lens' JobFilter (Maybe [Text]) Source #

The value of the filter.

The valid values for this parameter are as follows, depending on what you specify for the name parameter:

  • Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be exported at this time.
  • Specify Queued, InProgress, Complete, or Failed if you specify the name parameter as JobStatus.

jobFilter_name :: Lens' JobFilter (Maybe JobFilterName) Source #

The name of the filter.

Specify ResourceType to return export jobs of a specific resource type (for example, Ec2Instance).

Specify JobStatus to return export jobs with a specific status (e.g, Complete).

LambdaFunctionMemoryProjectedMetric

LambdaFunctionMemoryRecommendationOption

lambdaFunctionMemoryRecommendationOption_projectedUtilizationMetrics :: Lens' LambdaFunctionMemoryRecommendationOption (Maybe [LambdaFunctionMemoryProjectedMetric]) Source #

An array of objects that describe the projected utilization metrics of the function recommendation option.

lambdaFunctionMemoryRecommendationOption_rank :: Lens' LambdaFunctionMemoryRecommendationOption (Maybe Int) Source #

The rank of the function recommendation option.

The top recommendation option is ranked as 1.

LambdaFunctionRecommendation

lambdaFunctionRecommendation_functionArn :: Lens' LambdaFunctionRecommendation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the current function.

lambdaFunctionRecommendation_finding :: Lens' LambdaFunctionRecommendation (Maybe LambdaFunctionRecommendationFinding) Source #

The finding classification of the function.

Findings for functions include:

  • Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
  • NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
  • Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the InsufficientData and Inconclusive finding reason codes.

    Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.

lambdaFunctionRecommendation_currentMemorySize :: Lens' LambdaFunctionRecommendation (Maybe Int) Source #

The amount of memory, in MB, that's allocated to the current function.

lambdaFunctionRecommendation_lastRefreshTimestamp :: Lens' LambdaFunctionRecommendation (Maybe UTCTime) Source #

The timestamp of when the function recommendation was last refreshed.

lambdaFunctionRecommendation_accountId :: Lens' LambdaFunctionRecommendation (Maybe Text) Source #

The Amazon Web Services account ID of the function.

lambdaFunctionRecommendation_findingReasonCodes :: Lens' LambdaFunctionRecommendation (Maybe [LambdaFunctionRecommendationFindingReasonCode]) Source #

The reason for the finding classification of the function.

Functions that have a finding classification of Optimized don't have a finding reason code.

Finding reason codes for functions include:

  • MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
  • MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
  • InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
  • Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.

lambdaFunctionRecommendation_utilizationMetrics :: Lens' LambdaFunctionRecommendation (Maybe [LambdaFunctionUtilizationMetric]) Source #

An array of objects that describe the utilization metrics of the function.

lambdaFunctionRecommendation_memorySizeRecommendationOptions :: Lens' LambdaFunctionRecommendation (Maybe [LambdaFunctionMemoryRecommendationOption]) Source #

An array of objects that describe the memory configuration recommendation options for the function.

lambdaFunctionRecommendation_numberOfInvocations :: Lens' LambdaFunctionRecommendation (Maybe Integer) Source #

The number of times your function code was applied during the look-back period.

lambdaFunctionRecommendation_lookbackPeriodInDays :: Lens' LambdaFunctionRecommendation (Maybe Double) Source #

The number of days for which utilization metrics were analyzed for the function.

LambdaFunctionRecommendationFilter

lambdaFunctionRecommendationFilter_values :: Lens' LambdaFunctionRecommendationFilter (Maybe [Text]) Source #

The value of the filter.

The valid values for this parameter are as follows, depending on what you specify for the name parameter:

  • Specify Optimized, NotOptimized, or Unavailable if you specify the name parameter as Finding.
  • Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData, or Inconclusive if you specify the name parameter as FindingReasonCode.

lambdaFunctionRecommendationFilter_name :: Lens' LambdaFunctionRecommendationFilter (Maybe LambdaFunctionRecommendationFilterName) Source #

The name of the filter.

Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).

Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned).

LambdaFunctionUtilizationMetric

lambdaFunctionUtilizationMetric_name :: Lens' LambdaFunctionUtilizationMetric (Maybe LambdaFunctionMetricName) Source #

The name of the utilization metric.

The following utilization metrics are available:

  • Duration - The amount of time that your function code spends processing an event.
  • Memory - The amount of memory used per invocation.

lambdaFunctionUtilizationMetric_statistic :: Lens' LambdaFunctionUtilizationMetric (Maybe LambdaFunctionMetricStatistic) Source #

The statistic of the utilization metric.

The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

ProjectedMetric

projectedMetric_values :: Lens' ProjectedMetric (Maybe [Double]) Source #

The values of the projected utilization metrics.

projectedMetric_name :: Lens' ProjectedMetric (Maybe MetricName) Source #

The name of the projected utilization metric.

The following projected utilization metrics are returned:

  • Cpu - The projected percentage of allocated EC2 compute units that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the processing power required to run an application on the recommendation option.

    Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.

    Units: Percent

  • Memory - The percentage of memory that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option.

    Units: Percent

    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.

projectedMetric_timestamps :: Lens' ProjectedMetric (Maybe [UTCTime]) Source #

The timestamps of the projected utilization metric.

ReasonCodeSummary

reasonCodeSummary_value :: Lens' ReasonCodeSummary (Maybe Double) Source #

The value of the finding reason code summary.

RecommendationExportJob

recommendationExportJob_destination :: Lens' RecommendationExportJob (Maybe ExportDestination) Source #

An object that describes the destination of the export file.

recommendationExportJob_jobId :: Lens' RecommendationExportJob (Maybe Text) Source #

The identification number of the export job.

recommendationExportJob_resourceType :: Lens' RecommendationExportJob (Maybe ResourceType) Source #

The resource type of the exported recommendations.

recommendationExportJob_creationTimestamp :: Lens' RecommendationExportJob (Maybe UTCTime) Source #

The timestamp of when the export job was created.

recommendationExportJob_lastUpdatedTimestamp :: Lens' RecommendationExportJob (Maybe UTCTime) Source #

The timestamp of when the export job was last updated.

RecommendationPreferences

recommendationPreferences_cpuVendorArchitectures :: Lens' RecommendationPreferences (Maybe [CpuVendorArchitecture]) Source #

Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

  • A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.
  • A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.
  • A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

RecommendationSource

recommendationSource_recommendationSourceArn :: Lens' RecommendationSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recommendation source.

RecommendationSummary

recommendationSummary_accountId :: Lens' RecommendationSummary (Maybe Text) Source #

The Amazon Web Services account ID of the recommendation summary.

recommendationSummary_summaries :: Lens' RecommendationSummary (Maybe [Summary]) Source #

An array of objects that describe a recommendation summary.

RecommendedOptionProjectedMetric

recommendedOptionProjectedMetric_projectedMetrics :: Lens' RecommendedOptionProjectedMetric (Maybe [ProjectedMetric]) Source #

An array of objects that describe a projected utilization metric.

recommendedOptionProjectedMetric_rank :: Lens' RecommendedOptionProjectedMetric (Maybe Int) Source #

The rank of the recommendation option projected metric.

The top recommendation option is ranked as 1.

The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.

S3Destination

s3Destination_bucket :: Lens' S3Destination (Maybe Text) Source #

The name of the Amazon S3 bucket used as the destination of an export file.

s3Destination_key :: Lens' S3Destination (Maybe Text) Source #

The Amazon S3 bucket key of an export file.

The key uniquely identifies the object, or export file, in the S3 bucket.

s3Destination_metadataKey :: Lens' S3Destination (Maybe Text) Source #

The Amazon S3 bucket key of a metadata file.

The key uniquely identifies the object, or metadata file, in the S3 bucket.

S3DestinationConfig

s3DestinationConfig_bucket :: Lens' S3DestinationConfig (Maybe Text) Source #

The name of the Amazon S3 bucket to use as the destination for an export job.

s3DestinationConfig_keyPrefix :: Lens' S3DestinationConfig (Maybe Text) Source #

The Amazon S3 bucket prefix for an export job.

Summary

summary_reasonCodeSummaries :: Lens' Summary (Maybe [ReasonCodeSummary]) Source #

An array of objects that summarize a finding reason code.

summary_value :: Lens' Summary (Maybe Double) Source #

The value of the recommendation summary.

summary_name :: Lens' Summary (Maybe Finding) Source #

The finding classification of the recommendation.

UtilizationMetric

utilizationMetric_value :: Lens' UtilizationMetric (Maybe Double) Source #

The value of the utilization metric.

utilizationMetric_name :: Lens' UtilizationMetric (Maybe MetricName) Source #

The name of the utilization metric.

The following utilization metrics are available:

  • Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance.

    Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.

    Units: Percent

  • Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance.

    Units: Percent

    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.

  • EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time.

    Unit: Count

  • EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time.

    Unit: Count

  • EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time.

    Unit: Bytes

  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time.

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The completed read operations from all instance store volumes available to the instance in a specified period of time.

    If there are no instance store volumes, either the value is 0 or the metric is not reported.

  • DISK_WRITE_OPS_PER_SECOND - The completed write operations from all instance store volumes available to the instance in a specified period of time.

    If there are no instance store volumes, either the value is 0 or the metric is not reported.

  • DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application.

    If there are no instance store volumes, either the value is 0 or the metric is not reported.

  • DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application.

    If there are no instance store volumes, either the value is 0 or the metric is not reported.

  • NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance.
  • NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance.
  • NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance.
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance.

utilizationMetric_statistic :: Lens' UtilizationMetric (Maybe MetricStatistic) Source #

The statistic of the utilization metric.

The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

VolumeConfiguration

volumeConfiguration_volumeType :: Lens' VolumeConfiguration (Maybe Text) Source #

The volume type.

This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

VolumeRecommendation

volumeRecommendation_finding :: Lens' VolumeRecommendation (Maybe EBSFinding) Source #

The finding classification of the volume.

Findings for volumes include:

  • NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
  • Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.

volumeRecommendation_volumeArn :: Lens' VolumeRecommendation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the current volume.

volumeRecommendation_lastRefreshTimestamp :: Lens' VolumeRecommendation (Maybe UTCTime) Source #

The timestamp of when the volume recommendation was last refreshed.

volumeRecommendation_currentConfiguration :: Lens' VolumeRecommendation (Maybe VolumeConfiguration) Source #

An array of objects that describe the current configuration of the volume.

volumeRecommendation_accountId :: Lens' VolumeRecommendation (Maybe Text) Source #

The Amazon Web Services account ID of the volume.

volumeRecommendation_utilizationMetrics :: Lens' VolumeRecommendation (Maybe [EBSUtilizationMetric]) Source #

An array of objects that describe the utilization metrics of the volume.

volumeRecommendation_volumeRecommendationOptions :: Lens' VolumeRecommendation (Maybe [VolumeRecommendationOption]) Source #

An array of objects that describe the recommendation options for the volume.

volumeRecommendation_lookBackPeriodInDays :: Lens' VolumeRecommendation (Maybe Double) Source #

The number of days for which utilization metrics were analyzed for the volume.

VolumeRecommendationOption

volumeRecommendationOption_performanceRisk :: Lens' VolumeRecommendationOption (Maybe Double) Source #

The performance risk of the volume recommendation option.

Performance risk is the likelihood of the recommended volume type meeting the performance requirement of your workload.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

volumeRecommendationOption_configuration :: Lens' VolumeRecommendationOption (Maybe VolumeConfiguration) Source #

An array of objects that describe a volume configuration.

volumeRecommendationOption_rank :: Lens' VolumeRecommendationOption (Maybe Int) Source #

The rank of the volume recommendation option.

The top recommendation option is ranked as 1.