{ "version": "2.0", "metadata": { "apiVersion": "2019-11-01", "endpointPrefix": "compute-optimizer", "jsonVersion": "1.0", "protocol": "json", "serviceFullName": "AWS Compute Optimizer", "serviceId": "Compute Optimizer", "signatureVersion": "v4", "signingName": "compute-optimizer", "targetPrefix": "ComputeOptimizerService", "uid": "compute-optimizer-2019-11-01" }, "operations": { "DeleteRecommendationPreferences": { "name": "DeleteRecommendationPreferences", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteRecommendationPreferencesRequest" }, "output": { "shape": "DeleteRecommendationPreferencesResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Deletes a recommendation preference, such as enhanced infrastructure metrics.

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "DescribeRecommendationExportJobs": { "name": "DescribeRecommendationExportJobs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeRecommendationExportJobsRequest" }, "output": { "shape": "DescribeRecommendationExportJobsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes recommendation export jobs created in the last seven days.

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.

" }, "ExportAutoScalingGroupRecommendations": { "name": "ExportAutoScalingGroupRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportAutoScalingGroupRecommendationsRequest" }, "output": { "shape": "ExportAutoScalingGroupRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Exports optimization recommendations for Auto Scaling groups.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.

" }, "ExportEBSVolumeRecommendations": { "name": "ExportEBSVolumeRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportEBSVolumeRecommendationsRequest" }, "output": { "shape": "ExportEBSVolumeRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Exports optimization recommendations for Amazon EBS volumes.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.

" }, "ExportEC2InstanceRecommendations": { "name": "ExportEC2InstanceRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportEC2InstanceRecommendationsRequest" }, "output": { "shape": "ExportEC2InstanceRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Exports optimization recommendations for Amazon EC2 instances.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.

" }, "ExportECSServiceRecommendations": { "name": "ExportECSServiceRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportECSServiceRecommendationsRequest" }, "output": { "shape": "ExportECSServiceRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Exports optimization recommendations for Amazon ECS services on Fargate.

Recommendations are exported in a CSV file, and its metadata in a JSON file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can only have one Amazon ECS service export job in progress per Amazon Web Services Region.

" }, "ExportLambdaFunctionRecommendations": { "name": "ExportLambdaFunctionRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportLambdaFunctionRecommendationsRequest" }, "output": { "shape": "ExportLambdaFunctionRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Exports optimization recommendations for Lambda functions.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Lambda function export job in progress per Amazon Web Services Region.

" }, "ExportLicenseRecommendations": { "name": "ExportLicenseRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportLicenseRecommendationsRequest" }, "output": { "shape": "ExportLicenseRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Export optimization recommendations for your licenses.

Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one license export job in progress per Amazon Web Services Region.

" }, "GetAutoScalingGroupRecommendations": { "name": "GetAutoScalingGroupRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetAutoScalingGroupRecommendationsRequest" }, "output": { "shape": "GetAutoScalingGroupRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns Auto Scaling group recommendations.

Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

" }, "GetEBSVolumeRecommendations": { "name": "GetEBSVolumeRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEBSVolumeRecommendationsRequest" }, "output": { "shape": "GetEBSVolumeRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

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

Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

" }, "GetEC2InstanceRecommendations": { "name": "GetEC2InstanceRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEC2InstanceRecommendationsRequest" }, "output": { "shape": "GetEC2InstanceRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns Amazon EC2 instance recommendations.

Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

" }, "GetEC2RecommendationProjectedMetrics": { "name": "GetEC2RecommendationProjectedMetrics", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEC2RecommendationProjectedMetricsRequest" }, "output": { "shape": "GetEC2RecommendationProjectedMetricsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

" }, "GetECSServiceRecommendationProjectedMetrics": { "name": "GetECSServiceRecommendationProjectedMetrics", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetECSServiceRecommendationProjectedMetricsRequest" }, "output": { "shape": "GetECSServiceRecommendationProjectedMetricsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns the projected metrics of Amazon ECS service recommendations.

" }, "GetECSServiceRecommendations": { "name": "GetECSServiceRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetECSServiceRecommendationsRequest" }, "output": { "shape": "GetECSServiceRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns Amazon ECS service recommendations.

Compute Optimizer generates recommendations for Amazon ECS services on Fargate that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

" }, "GetEffectiveRecommendationPreferences": { "name": "GetEffectiveRecommendationPreferences", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEffectiveRecommendationPreferencesRequest" }, "output": { "shape": "GetEffectiveRecommendationPreferencesResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.

When you create a recommendation preference, you can set its status to Active or Inactive. Use this action to view the recommendation preferences that are in effect, or Active.

" }, "GetEnrollmentStatus": { "name": "GetEnrollmentStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEnrollmentStatusRequest" }, "output": { "shape": "GetEnrollmentStatusResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

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

If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.

" }, "GetEnrollmentStatusesForOrganization": { "name": "GetEnrollmentStatusesForOrganization", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEnrollmentStatusesForOrganizationRequest" }, "output": { "shape": "GetEnrollmentStatusesForOrganizationResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

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

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

" }, "GetLambdaFunctionRecommendations": { "name": "GetLambdaFunctionRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetLambdaFunctionRecommendationsRequest" }, "output": { "shape": "GetLambdaFunctionRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" }, { "shape": "LimitExceededException" } ], "documentation": "

Returns Lambda function recommendations.

Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

" }, "GetLicenseRecommendations": { "name": "GetLicenseRecommendations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetLicenseRecommendationsRequest" }, "output": { "shape": "GetLicenseRecommendationsResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

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

Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

" }, "GetRecommendationPreferences": { "name": "GetRecommendationPreferences", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetRecommendationPreferencesRequest" }, "output": { "shape": "GetRecommendationPreferencesResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns existing recommendation preferences, such as enhanced infrastructure metrics.

Use the scope parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN).

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "GetRecommendationSummaries": { "name": "GetRecommendationSummaries", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetRecommendationSummariesRequest" }, "output": { "shape": "GetRecommendationSummariesResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

Returns the optimization findings for an account.

It returns the number of:

" }, "PutRecommendationPreferences": { "name": "PutRecommendationPreferences", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutRecommendationPreferencesRequest" }, "output": { "shape": "PutRecommendationPreferencesResponse" }, "errors": [ { "shape": "OptInRequiredException" }, { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

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

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "UpdateEnrollmentStatus": { "name": "UpdateEnrollmentStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateEnrollmentStatusRequest" }, "output": { "shape": "UpdateEnrollmentStatusResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "ServiceUnavailableException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingAuthenticationToken" }, { "shape": "ThrottlingException" } ], "documentation": "

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

If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.

You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.

When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.

" } }, "shapes": { "AccountEnrollmentStatus": { "type": "structure", "members": { "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID.

" }, "status": { "shape": "Status", "documentation": "

The account enrollment status.

" }, "statusReason": { "shape": "StatusReason", "documentation": "

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.

" }, "lastUpdatedTimestamp": { "shape": "LastUpdatedTimestamp", "documentation": "

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

" } }, "documentation": "

Describes the enrollment status of an organization's member accounts in Compute Optimizer.

" }, "AccountEnrollmentStatuses": { "type": "list", "member": { "shape": "AccountEnrollmentStatus" } }, "AccountId": { "type": "string" }, "AccountIds": { "type": "list", "member": { "shape": "AccountId" } }, "AutoScalingConfiguration": { "type": "string", "enum": [ "TargetTrackingScalingCpu", "TargetTrackingScalingMemory" ] }, "AutoScalingGroupArn": { "type": "string" }, "AutoScalingGroupArns": { "type": "list", "member": { "shape": "AutoScalingGroupArn" } }, "AutoScalingGroupConfiguration": { "type": "structure", "members": { "desiredCapacity": { "shape": "DesiredCapacity", "documentation": "

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

" }, "minSize": { "shape": "MinSize", "documentation": "

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

" }, "maxSize": { "shape": "MaxSize", "documentation": "

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

" }, "instanceType": { "shape": "InstanceType", "documentation": "

The instance type for the Auto Scaling group.

" } }, "documentation": "

Describes the configuration of an Auto Scaling group.

" }, "AutoScalingGroupEstimatedMonthlySavings": { "type": "structure", "members": { "currency": { "shape": "Currency", "documentation": "

The currency of the estimated monthly savings.

" }, "value": { "shape": "Value", "documentation": "

The value of the estimated monthly savings.

" } }, "documentation": "

An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances discounts.

" }, "AutoScalingGroupName": { "type": "string" }, "AutoScalingGroupRecommendation": { "type": "structure", "members": { "accountId": { "shape": "AccountId", "documentation": "

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

" }, "autoScalingGroupArn": { "shape": "AutoScalingGroupArn", "documentation": "

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

" }, "autoScalingGroupName": { "shape": "AutoScalingGroupName", "documentation": "

The name of the Auto Scaling group.

" }, "finding": { "shape": "Finding", "documentation": "

The finding classification of the Auto Scaling group.

Findings for Auto Scaling groups include:

" }, "utilizationMetrics": { "shape": "UtilizationMetrics", "documentation": "

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

" }, "lookBackPeriodInDays": { "shape": "LookBackPeriodInDays", "documentation": "

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

" }, "currentConfiguration": { "shape": "AutoScalingGroupConfiguration", "documentation": "

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

" }, "recommendationOptions": { "shape": "AutoScalingGroupRecommendationOptions", "documentation": "

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

" }, "lastRefreshTimestamp": { "shape": "LastRefreshTimestamp", "documentation": "

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

" }, "currentPerformanceRisk": { "shape": "CurrentPerformanceRisk", "documentation": "

The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.

" }, "effectiveRecommendationPreferences": { "shape": "EffectiveRecommendationPreferences", "documentation": "

An object that describes the effective recommendation preferences for the Auto Scaling group.

" }, "inferredWorkloadTypes": { "shape": "InferredWorkloadTypes", "documentation": "

The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.

Compute Optimizer can infer if one of the following applications might be running on the instances:

" }, "currentInstanceGpuInfo": { "shape": "GpuInfo", "documentation": "

Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.

" } }, "documentation": "

Describes an Auto Scaling group recommendation.

" }, "AutoScalingGroupRecommendationOption": { "type": "structure", "members": { "configuration": { "shape": "AutoScalingGroupConfiguration", "documentation": "

An array of objects that describe an Auto Scaling group configuration.

" }, "projectedUtilizationMetrics": { "shape": "ProjectedUtilizationMetrics", "documentation": "

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.

" }, "performanceRisk": { "shape": "PerformanceRisk", "documentation": "

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.

" }, "rank": { "shape": "Rank", "documentation": "

The rank of the Auto Scaling group recommendation option.

The top recommendation option is ranked as 1.

" }, "savingsOpportunity": { "shape": "SavingsOpportunity", "documentation": "

An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

" }, "migrationEffort": { "shape": "MigrationEffort", "documentation": "

The level of effort required to migrate from the current instance type to the recommended instance type.

For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

" }, "instanceGpuInfo": { "shape": "GpuInfo", "documentation": "

Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.

" }, "savingsOpportunityAfterDiscounts": { "shape": "AutoScalingGroupSavingsOpportunityAfterDiscounts", "documentation": "

An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.

" } }, "documentation": "

Describes a recommendation option for an Auto Scaling group.

" }, "AutoScalingGroupRecommendationOptions": { "type": "list", "member": { "shape": "AutoScalingGroupRecommendationOption" } }, "AutoScalingGroupRecommendations": { "type": "list", "member": { "shape": "AutoScalingGroupRecommendation" } }, "AutoScalingGroupSavingsOpportunityAfterDiscounts": { "type": "structure", "members": { "savingsOpportunityPercentage": { "shape": "SavingsOpportunityPercentage", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s Auto Scaling group recommendations.

" }, "estimatedMonthlySavings": { "shape": "AutoScalingGroupEstimatedMonthlySavings", "documentation": "

An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Auto Scaling group recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.

" } }, "documentation": "

Describes the savings opportunity for Auto Scaling group recommendations after applying the Savings Plans and Reserved Instances discounts.

Savings opportunity represents the estimated monthly savings you can achieve by implementing Compute Optimizer recommendations.

" }, "Code": { "type": "string" }, "ContainerConfiguration": { "type": "structure", "members": { "containerName": { "shape": "ContainerName", "documentation": "

The name of the container.

" }, "memorySizeConfiguration": { "shape": "MemorySizeConfiguration", "documentation": "

The memory size configurations for the container.

" }, "cpu": { "shape": "NullableCpu", "documentation": "

The number of CPU units reserved for the container.

" } }, "documentation": "

Describes the container configurations within the tasks of your Amazon ECS service.

" }, "ContainerConfigurations": { "type": "list", "member": { "shape": "ContainerConfiguration" } }, "ContainerName": { "type": "string" }, "ContainerRecommendation": { "type": "structure", "members": { "containerName": { "shape": "ContainerName", "documentation": "

The name of the container.

" }, "memorySizeConfiguration": { "shape": "MemorySizeConfiguration", "documentation": "

The recommended memory size configurations for the container.

" }, "cpu": { "shape": "NullableCpu", "documentation": "

The recommended number of CPU units reserved for the container.

" } }, "documentation": "

The CPU and memory recommendations for a container within the tasks of your Amazon ECS service.

" }, "ContainerRecommendations": { "type": "list", "member": { "shape": "ContainerRecommendation" } }, "CpuSize": { "type": "integer" }, "CpuVendorArchitecture": { "type": "string", "enum": [ "AWS_ARM64", "CURRENT" ] }, "CpuVendorArchitectures": { "type": "list", "member": { "shape": "CpuVendorArchitecture" } }, "CreationTimestamp": { "type": "timestamp" }, "Currency": { "type": "string", "enum": [ "USD", "CNY" ] }, "CurrentInstanceType": { "type": "string" }, "CurrentPerformanceRisk": { "type": "string", "enum": [ "VeryLow", "Low", "Medium", "High" ] }, "CurrentPerformanceRiskRatings": { "type": "structure", "members": { "high": { "shape": "High", "documentation": "

A count of the applicable resource types with a high performance risk rating.

" }, "medium": { "shape": "Medium", "documentation": "

A count of the applicable resource types with a medium performance risk rating.

" }, "low": { "shape": "Low", "documentation": "

A count of the applicable resource types with a low performance risk rating.

" }, "veryLow": { "shape": "VeryLow", "documentation": "

A count of the applicable resource types with a very low performance risk rating.

" } }, "documentation": "

Describes the performance risk ratings for a given resource type.

Resources with a high or medium rating are at risk of not meeting the performance needs of their workloads, while resources with a low rating are performing well in their workloads.

" }, "CustomizableMetricHeadroom": { "type": "string", "enum": [ "PERCENT_30", "PERCENT_20", "PERCENT_10", "PERCENT_0" ] }, "CustomizableMetricName": { "type": "string", "enum": [ "CpuUtilization", "MemoryUtilization" ] }, "CustomizableMetricParameters": { "type": "structure", "members": { "threshold": { "shape": "CustomizableMetricThreshold", "documentation": "

The threshold value used for the specified metric parameter.

You can only specify the threshold value for CPU utilization.

" }, "headroom": { "shape": "CustomizableMetricHeadroom", "documentation": "

The headroom value in percentage used for the specified metric parameter.

The following lists the valid values for CPU and memory utilization.

" } }, "documentation": "

Defines the various metric parameters that can be customized, such as threshold and headroom.

" }, "CustomizableMetricThreshold": { "type": "string", "enum": [ "P90", "P95", "P99_5" ] }, "DeleteRecommendationPreferencesRequest": { "type": "structure", "required": [ "resourceType", "recommendationPreferenceNames" ], "members": { "resourceType": { "shape": "ResourceType", "documentation": "

The target resource type of the recommendation preference to delete.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

The valid values for this parameter are Ec2Instance and AutoScalingGroup.

" }, "scope": { "shape": "Scope", "documentation": "

An object that describes the scope of the recommendation preference to delete.

You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "recommendationPreferenceNames": { "shape": "RecommendationPreferenceNames", "documentation": "

The name of the recommendation preference to delete.

" } } }, "DeleteRecommendationPreferencesResponse": { "type": "structure", "members": {} }, "DescribeRecommendationExportJobsRequest": { "type": "structure", "members": { "jobIds": { "shape": "JobIds", "documentation": "

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.

" }, "filters": { "shape": "JobFilters", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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.

" } } }, "DescribeRecommendationExportJobsResponse": { "type": "structure", "members": { "recommendationExportJobs": { "shape": "RecommendationExportJobs", "documentation": "

An array of objects that describe recommendation export jobs.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } } }, "DesiredCapacity": { "type": "integer" }, "DestinationBucket": { "type": "string" }, "DestinationKey": { "type": "string" }, "DestinationKeyPrefix": { "type": "string" }, "EBSEffectiveRecommendationPreferences": { "type": "structure", "members": { "savingsEstimationMode": { "shape": "EBSSavingsEstimationMode", "documentation": "

Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes.

" } }, "documentation": "

Describes the effective recommendation preferences for Amazon EBS volumes.

" }, "EBSEstimatedMonthlySavings": { "type": "structure", "members": { "currency": { "shape": "Currency", "documentation": "

The currency of the estimated monthly savings.

" }, "value": { "shape": "Value", "documentation": "

The value of the estimated monthly savings.

" } }, "documentation": "

An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EBS volume recommendations. This includes any applicable discounts.

" }, "EBSFilter": { "type": "structure", "members": { "name": { "shape": "EBSFilterName", "documentation": "

The name of the filter.

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

You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.

" }, "values": { "shape": "FilterValues", "documentation": "

The value of the filter.

The valid values are Optimized, or NotOptimized.

" } }, "documentation": "

Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.

You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

" }, "EBSFilterName": { "type": "string", "enum": [ "Finding" ] }, "EBSFilters": { "type": "list", "member": { "shape": "EBSFilter" } }, "EBSFinding": { "type": "string", "enum": [ "Optimized", "NotOptimized" ] }, "EBSMetricName": { "type": "string", "enum": [ "VolumeReadOpsPerSecond", "VolumeWriteOpsPerSecond", "VolumeReadBytesPerSecond", "VolumeWriteBytesPerSecond" ] }, "EBSSavingsEstimationMode": { "type": "structure", "members": { "source": { "shape": "EBSSavingsEstimationModeSource", "documentation": "

Describes the source for calculating the savings opportunity for Amazon EBS volumes.

" } }, "documentation": "

Describes the savings estimation mode used for calculating savings opportunity for Amazon EBS volumes.

" }, "EBSSavingsEstimationModeSource": { "type": "string", "enum": [ "PublicPricing", "CostExplorerRightsizing", "CostOptimizationHub" ] }, "EBSSavingsOpportunityAfterDiscounts": { "type": "structure", "members": { "savingsOpportunityPercentage": { "shape": "SavingsOpportunityPercentage", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost after applying the specific discounts. This saving can be achieved by adopting Compute Optimizer’s Amazon EBS volume recommendations.

" }, "estimatedMonthlySavings": { "shape": "EBSEstimatedMonthlySavings", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon EBS volume recommendations. This saving includes any applicable discounts.

" } }, "documentation": "

Describes the savings opportunity for Amazon EBS volume recommendations after applying specific discounts.

" }, "EBSUtilizationMetric": { "type": "structure", "members": { "name": { "shape": "EBSMetricName", "documentation": "

The name of the utilization metric.

The following utilization metrics are available:

" }, "statistic": { "shape": "MetricStatistic", "documentation": "

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.

" }, "value": { "shape": "MetricValue", "documentation": "

The value of the utilization metric.

" } }, "documentation": "

Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

" }, "EBSUtilizationMetrics": { "type": "list", "member": { "shape": "EBSUtilizationMetric" } }, "ECSEffectiveRecommendationPreferences": { "type": "structure", "members": { "savingsEstimationMode": { "shape": "ECSSavingsEstimationMode", "documentation": "

Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon ECS services.

" } }, "documentation": "

Describes the effective recommendation preferences for Amazon ECS services.

" }, "ECSEstimatedMonthlySavings": { "type": "structure", "members": { "currency": { "shape": "Currency", "documentation": "

The currency of the estimated monthly savings.

" }, "value": { "shape": "Value", "documentation": "

The value of the estimated monthly savings for Amazon ECS services.

" } }, "documentation": "

Describes the estimated monthly savings possible for Amazon ECS services by adopting Compute Optimizer recommendations. This is based on Amazon ECS service pricing after applying Savings Plans discounts.

" }, "ECSSavingsEstimationMode": { "type": "structure", "members": { "source": { "shape": "ECSSavingsEstimationModeSource", "documentation": "

Describes the source for calculating the savings opportunity for Amazon ECS services.

" } }, "documentation": "

Describes the savings estimation mode used for calculating savings opportunity for Amazon ECS services.

" }, "ECSSavingsEstimationModeSource": { "type": "string", "enum": [ "PublicPricing", "CostExplorerRightsizing", "CostOptimizationHub" ] }, "ECSSavingsOpportunityAfterDiscounts": { "type": "structure", "members": { "savingsOpportunityPercentage": { "shape": "SavingsOpportunityPercentage", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.

" }, "estimatedMonthlySavings": { "shape": "ECSEstimatedMonthlySavings", "documentation": "

The estimated monthly savings possible by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.

" } }, "documentation": "

Describes the savings opportunity for Amazon ECS service recommendations after applying Savings Plans discounts.

Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.

" }, "ECSServiceLaunchType": { "type": "string", "enum": [ "EC2", "Fargate" ] }, "ECSServiceMetricName": { "type": "string", "enum": [ "Cpu", "Memory" ] }, "ECSServiceMetricStatistic": { "type": "string", "enum": [ "Maximum", "Average" ] }, "ECSServiceProjectedMetric": { "type": "structure", "members": { "name": { "shape": "ECSServiceMetricName", "documentation": "

The name of the projected metric.

The following metrics are available:

" }, "timestamps": { "shape": "Timestamps", "documentation": "

The timestamps of the projected metric.

" }, "upperBoundValues": { "shape": "MetricValues", "documentation": "

The upper bound values for the projected metric.

" }, "lowerBoundValues": { "shape": "MetricValues", "documentation": "

The lower bound values for the projected metric.

" } }, "documentation": "

Describes the projected metrics of an Amazon ECS service recommendation option.

To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.

" }, "ECSServiceProjectedMetrics": { "type": "list", "member": { "shape": "ECSServiceProjectedMetric" } }, "ECSServiceProjectedUtilizationMetric": { "type": "structure", "members": { "name": { "shape": "ECSServiceMetricName", "documentation": "

The name of the projected utilization metric.

The following utilization metrics are available:

" }, "statistic": { "shape": "ECSServiceMetricStatistic", "documentation": "

The statistic of the projected 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.

" }, "lowerBoundValue": { "shape": "LowerBoundValue", "documentation": "

The lower bound values for the projected utilization metrics.

" }, "upperBoundValue": { "shape": "UpperBoundValue", "documentation": "

The upper bound values for the projected utilization metrics.

" } }, "documentation": "

Describes the projected utilization metrics of an Amazon ECS service recommendation option.

To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.

" }, "ECSServiceProjectedUtilizationMetrics": { "type": "list", "member": { "shape": "ECSServiceProjectedUtilizationMetric" } }, "ECSServiceRecommendation": { "type": "structure", "members": { "serviceArn": { "shape": "ServiceArn", "documentation": "

The Amazon Resource Name (ARN) of the current Amazon ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

" }, "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID of the Amazon ECS service.

" }, "currentServiceConfiguration": { "shape": "ServiceConfiguration", "documentation": "

The configuration of the current Amazon ECS service.

" }, "utilizationMetrics": { "shape": "ECSServiceUtilizationMetrics", "documentation": "

An array of objects that describe the utilization metrics of the Amazon ECS service.

" }, "lookbackPeriodInDays": { "shape": "LookBackPeriodInDays", "documentation": "

The number of days the Amazon ECS service utilization metrics were analyzed.

" }, "launchType": { "shape": "ECSServiceLaunchType", "documentation": "

The launch type the Amazon ECS service is using.

Compute Optimizer only supports the Fargate launch type.

" }, "lastRefreshTimestamp": { "shape": "LastRefreshTimestamp", "documentation": "

The timestamp of when the Amazon ECS service recommendation was last generated.

" }, "finding": { "shape": "ECSServiceRecommendationFinding", "documentation": "

The finding classification of an Amazon ECS service.

Findings for Amazon ECS services include:

" }, "findingReasonCodes": { "shape": "ECSServiceRecommendationFindingReasonCodes", "documentation": "

The reason for the finding classification of an Amazon ECS service.

Finding reason codes for Amazon ECS services include:

" }, "serviceRecommendationOptions": { "shape": "ECSServiceRecommendationOptions", "documentation": "

An array of objects that describe the recommendation options for the Amazon ECS service.

" }, "currentPerformanceRisk": { "shape": "CurrentPerformanceRisk", "documentation": "

The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.

" }, "tags": { "shape": "Tags", "documentation": "

A list of tags assigned to your Amazon ECS service recommendations.

" }, "effectiveRecommendationPreferences": { "shape": "ECSEffectiveRecommendationPreferences", "documentation": "

Describes the effective recommendation preferences for Amazon ECS services.

" } }, "documentation": "

Describes an Amazon ECS service recommendation.

" }, "ECSServiceRecommendationFilter": { "type": "structure", "members": { "name": { "shape": "ECSServiceRecommendationFilterName", "documentation": "

The name of the filter.

Specify Finding to return recommendations with a specific finding classification.

Specify FindingReasonCode to return recommendations with a specific finding reason code.

You can filter your Amazon ECS service recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service recommendations with a tag key value of Owner or without any tag keys assigned.

" }, "values": { "shape": "FilterValues", "documentation": "

The value of the filter.

The valid values for this parameter are as follows:

" } }, "documentation": "

Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the GetECSServiceRecommendations action.

" }, "ECSServiceRecommendationFilterName": { "type": "string", "enum": [ "Finding", "FindingReasonCode" ] }, "ECSServiceRecommendationFilters": { "type": "list", "member": { "shape": "ECSServiceRecommendationFilter" } }, "ECSServiceRecommendationFinding": { "type": "string", "enum": [ "Optimized", "Underprovisioned", "Overprovisioned" ] }, "ECSServiceRecommendationFindingReasonCode": { "type": "string", "enum": [ "MemoryOverprovisioned", "MemoryUnderprovisioned", "CPUOverprovisioned", "CPUUnderprovisioned" ] }, "ECSServiceRecommendationFindingReasonCodes": { "type": "list", "member": { "shape": "ECSServiceRecommendationFindingReasonCode" } }, "ECSServiceRecommendationOption": { "type": "structure", "members": { "memory": { "shape": "NullableMemory", "documentation": "

The memory size of the Amazon ECS service recommendation option.

" }, "cpu": { "shape": "NullableCpu", "documentation": "

The CPU size of the Amazon ECS service recommendation option.

" }, "savingsOpportunity": { "shape": "SavingsOpportunity" }, "projectedUtilizationMetrics": { "shape": "ECSServiceProjectedUtilizationMetrics", "documentation": "

An array of objects that describe the projected utilization metrics of the Amazon ECS service recommendation option.

" }, "containerRecommendations": { "shape": "ContainerRecommendations", "documentation": "

The CPU and memory size recommendations for the containers within the task of your Amazon ECS service.

" }, "savingsOpportunityAfterDiscounts": { "shape": "ECSSavingsOpportunityAfterDiscounts", "documentation": "

Describes the savings opportunity for Amazon ECS service recommendations or for the recommendation option.

Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.

" } }, "documentation": "

Describes the recommendation options for an Amazon ECS service.

" }, "ECSServiceRecommendationOptions": { "type": "list", "member": { "shape": "ECSServiceRecommendationOption" } }, "ECSServiceRecommendations": { "type": "list", "member": { "shape": "ECSServiceRecommendation" } }, "ECSServiceRecommendedOptionProjectedMetric": { "type": "structure", "members": { "recommendedCpuUnits": { "shape": "CpuSize", "documentation": "

The recommended CPU size for the Amazon ECS service.

" }, "recommendedMemorySize": { "shape": "MemorySize", "documentation": "

The recommended memory size for the Amazon ECS service.

" }, "projectedMetrics": { "shape": "ECSServiceProjectedMetrics", "documentation": "

An array of objects that describe the projected metric.

" } }, "documentation": "

Describes the projected metrics of an Amazon ECS service recommendation option.

To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.

" }, "ECSServiceRecommendedOptionProjectedMetrics": { "type": "list", "member": { "shape": "ECSServiceRecommendedOptionProjectedMetric" } }, "ECSServiceUtilizationMetric": { "type": "structure", "members": { "name": { "shape": "ECSServiceMetricName", "documentation": "

The name of the utilization metric.

The following utilization metrics are available:

" }, "statistic": { "shape": "ECSServiceMetricStatistic", "documentation": "

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.

" }, "value": { "shape": "MetricValue", "documentation": "

The value of the utilization metric.

" } }, "documentation": "

Describes the utilization metric of an Amazon ECS service.

To determine the performance difference between your current Amazon ECS service and the recommended option, compare the utilization metric data of your service against its projected utilization metric data.

" }, "ECSServiceUtilizationMetrics": { "type": "list", "member": { "shape": "ECSServiceUtilizationMetric" } }, "EffectivePreferredResource": { "type": "structure", "members": { "name": { "shape": "PreferredResourceName", "documentation": "

The name of the preferred resource list.

" }, "includeList": { "shape": "PreferredResourceValues", "documentation": "

The list of preferred resource values that you want considered as rightsizing recommendation candidates.

" }, "effectiveIncludeList": { "shape": "PreferredResourceValues", "documentation": "

The expanded version of your preferred resource's include list.

" }, "excludeList": { "shape": "PreferredResourceValues", "documentation": "

The list of preferred resources values that you want excluded from rightsizing recommendation candidates.

" } }, "documentation": "

Describes the effective preferred resources that Compute Optimizer considers as rightsizing recommendation candidates.

Compute Optimizer only supports Amazon EC2 instance types.

" }, "EffectivePreferredResources": { "type": "list", "member": { "shape": "EffectivePreferredResource" } }, "EffectiveRecommendationPreferences": { "type": "structure", "members": { "cpuVendorArchitectures": { "shape": "CpuVendorArchitectures", "documentation": "

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

" }, "enhancedInfrastructureMetrics": { "shape": "EnhancedInfrastructureMetrics", "documentation": "

Describes the activation status of the enhanced infrastructure metrics preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "inferredWorkloadTypes": { "shape": "InferredWorkloadTypesPreference", "documentation": "

Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not yet applied to recommendations.

" }, "externalMetricsPreference": { "shape": "ExternalMetricsPreference", "documentation": "

An object that describes the external metrics recommendation preference.

If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

" }, "lookBackPeriod": { "shape": "LookBackPeriodPreference", "documentation": "

The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

" }, "utilizationPreferences": { "shape": "UtilizationPreferences", "documentation": "

The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

This preference is only available for the Amazon EC2 instance resource type.

" }, "preferredResources": { "shape": "EffectivePreferredResources", "documentation": "

The resource type values that are considered as candidates when generating rightsizing recommendations.

" }, "savingsEstimationMode": { "shape": "InstanceSavingsEstimationMode", "documentation": "

Describes the savings estimation mode applied for calculating savings opportunity for a resource.

" } }, "documentation": "

Describes the effective recommendation preferences for a resource.

" }, "EnhancedInfrastructureMetrics": { "type": "string", "enum": [ "Active", "Inactive" ] }, "EnrollmentFilter": { "type": "structure", "members": { "name": { "shape": "EnrollmentFilterName", "documentation": "

The name of the filter.

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

" }, "values": { "shape": "FilterValues", "documentation": "

The value of the filter.

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

" } }, "documentation": "

Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.

" }, "EnrollmentFilterName": { "type": "string", "enum": [ "Status" ] }, "EnrollmentFilters": { "type": "list", "member": { "shape": "EnrollmentFilter" } }, "EstimatedMonthlySavings": { "type": "structure", "members": { "currency": { "shape": "Currency", "documentation": "

The currency of the estimated monthly savings.

" }, "value": { "shape": "Value", "documentation": "

The value of the estimated monthly savings.

" } }, "documentation": "

Describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.

For more information, see Estimated monthly savings and savings opportunities in the Compute Optimizer User Guide.

" }, "ExportAutoScalingGroupRecommendationsRequest": { "type": "structure", "required": [ "s3DestinationConfig" ], "members": { "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "filters": { "shape": "Filters", "documentation": "

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

" }, "fieldsToExport": { "shape": "ExportableAutoScalingGroupFields", "documentation": "

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.

" }, "s3DestinationConfig": { "shape": "S3DestinationConfig", "documentation": "

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.

" }, "fileFormat": { "shape": "FileFormat", "documentation": "

The format of the export file.

The only export file format currently supported is Csv.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

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.

" }, "recommendationPreferences": { "shape": "RecommendationPreferences", "documentation": "

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

" } } }, "ExportAutoScalingGroupRecommendationsResponse": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

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

" }, "s3Destination": { "shape": "S3Destination", "documentation": "

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

" } } }, "ExportDestination": { "type": "structure", "members": { "s3": { "shape": "S3Destination", "documentation": "

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.

" } }, "documentation": "

Describes the destination of the recommendations export and metadata files.

" }, "ExportEBSVolumeRecommendationsRequest": { "type": "structure", "required": [ "s3DestinationConfig" ], "members": { "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "filters": { "shape": "EBSFilters", "documentation": "

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

" }, "fieldsToExport": { "shape": "ExportableVolumeFields", "documentation": "

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.

" }, "s3DestinationConfig": { "shape": "S3DestinationConfig" }, "fileFormat": { "shape": "FileFormat", "documentation": "

The format of the export file.

The only export file format currently supported is Csv.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

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": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

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

" }, "s3Destination": { "shape": "S3Destination" } } }, "ExportEC2InstanceRecommendationsRequest": { "type": "structure", "required": [ "s3DestinationConfig" ], "members": { "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "filters": { "shape": "Filters", "documentation": "

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

" }, "fieldsToExport": { "shape": "ExportableInstanceFields", "documentation": "

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.

" }, "s3DestinationConfig": { "shape": "S3DestinationConfig", "documentation": "

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.

" }, "fileFormat": { "shape": "FileFormat", "documentation": "

The format of the export file.

The only export file format currently supported is Csv.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

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.

" }, "recommendationPreferences": { "shape": "RecommendationPreferences", "documentation": "

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

" } } }, "ExportEC2InstanceRecommendationsResponse": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

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

" }, "s3Destination": { "shape": "S3Destination", "documentation": "

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

" } } }, "ExportECSServiceRecommendationsRequest": { "type": "structure", "required": [ "s3DestinationConfig" ], "members": { "accountIds": { "shape": "AccountIds", "documentation": "

The Amazon Web Services account IDs for the export Amazon ECS service recommendations.

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

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

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

" }, "filters": { "shape": "ECSServiceRecommendationFilters", "documentation": "

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

" }, "fieldsToExport": { "shape": "ExportableECSServiceFields", "documentation": "

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.

" }, "s3DestinationConfig": { "shape": "S3DestinationConfig" }, "fileFormat": { "shape": "FileFormat", "documentation": "

The format of the export file.

The CSV file is the only export file format currently supported.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the 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.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.

" } } }, "ExportECSServiceRecommendationsResponse": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.

" }, "s3Destination": { "shape": "S3Destination" } } }, "ExportLambdaFunctionRecommendationsRequest": { "type": "structure", "required": [ "s3DestinationConfig" ], "members": { "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "filters": { "shape": "LambdaFunctionRecommendationFilters", "documentation": "

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

" }, "fieldsToExport": { "shape": "ExportableLambdaFunctionFields", "documentation": "

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.

" }, "s3DestinationConfig": { "shape": "S3DestinationConfig" }, "fileFormat": { "shape": "FileFormat", "documentation": "

The format of the export file.

The only export file format currently supported is Csv.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

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": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

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

" }, "s3Destination": { "shape": "S3Destination" } } }, "ExportLicenseRecommendationsRequest": { "type": "structure", "required": [ "s3DestinationConfig" ], "members": { "accountIds": { "shape": "AccountIds", "documentation": "

The IDs of the Amazon Web Services accounts for which to export license 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 can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter is omitted, recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

" }, "filters": { "shape": "LicenseRecommendationFilters", "documentation": "

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

" }, "fieldsToExport": { "shape": "ExportableLicenseFields", "documentation": "

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.

" }, "s3DestinationConfig": { "shape": "S3DestinationConfig" }, "fileFormat": { "shape": "FileFormat", "documentation": "

The format of the export file.

A CSV file is the only export format currently supported.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

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.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file .

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

" } } }, "ExportLicenseRecommendationsResponse": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.

" }, "s3Destination": { "shape": "S3Destination" } } }, "ExportableAutoScalingGroupField": { "type": "string", "enum": [ "AccountId", "AutoScalingGroupArn", "AutoScalingGroupName", "Finding", "UtilizationMetricsCpuMaximum", "UtilizationMetricsMemoryMaximum", "UtilizationMetricsEbsReadOpsPerSecondMaximum", "UtilizationMetricsEbsWriteOpsPerSecondMaximum", "UtilizationMetricsEbsReadBytesPerSecondMaximum", "UtilizationMetricsEbsWriteBytesPerSecondMaximum", "UtilizationMetricsDiskReadOpsPerSecondMaximum", "UtilizationMetricsDiskWriteOpsPerSecondMaximum", "UtilizationMetricsDiskReadBytesPerSecondMaximum", "UtilizationMetricsDiskWriteBytesPerSecondMaximum", "UtilizationMetricsNetworkInBytesPerSecondMaximum", "UtilizationMetricsNetworkOutBytesPerSecondMaximum", "UtilizationMetricsNetworkPacketsInPerSecondMaximum", "UtilizationMetricsNetworkPacketsOutPerSecondMaximum", "LookbackPeriodInDays", "CurrentConfigurationInstanceType", "CurrentConfigurationDesiredCapacity", "CurrentConfigurationMinSize", "CurrentConfigurationMaxSize", "CurrentOnDemandPrice", "CurrentStandardOneYearNoUpfrontReservedPrice", "CurrentStandardThreeYearNoUpfrontReservedPrice", "CurrentVCpus", "CurrentMemory", "CurrentStorage", "CurrentNetwork", "RecommendationOptionsConfigurationInstanceType", "RecommendationOptionsConfigurationDesiredCapacity", "RecommendationOptionsConfigurationMinSize", "RecommendationOptionsConfigurationMaxSize", "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum", "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum", "RecommendationOptionsPerformanceRisk", "RecommendationOptionsOnDemandPrice", "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice", "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice", "RecommendationOptionsVcpus", "RecommendationOptionsMemory", "RecommendationOptionsStorage", "RecommendationOptionsNetwork", "LastRefreshTimestamp", "CurrentPerformanceRisk", "RecommendationOptionsSavingsOpportunityPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrency", "RecommendationOptionsEstimatedMonthlySavingsValue", "EffectiveRecommendationPreferencesCpuVendorArchitectures", "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics", "EffectiveRecommendationPreferencesInferredWorkloadTypes", "InferredWorkloadTypes", "RecommendationOptionsMigrationEffort", "CurrentInstanceGpuInfo", "RecommendationOptionsInstanceGpuInfo", "UtilizationMetricsGpuPercentageMaximum", "UtilizationMetricsGpuMemoryPercentageMaximum", "RecommendationOptionsProjectedUtilizationMetricsGpuPercentageMaximum", "RecommendationOptionsProjectedUtilizationMetricsGpuMemoryPercentageMaximum", "EffectiveRecommendationPreferencesSavingsEstimationMode", "RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts", "RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts", "EffectiveRecommendationPreferencesPreferredResources", "EffectiveRecommendationPreferencesLookBackPeriod" ] }, "ExportableAutoScalingGroupFields": { "type": "list", "member": { "shape": "ExportableAutoScalingGroupField" } }, "ExportableECSServiceField": { "type": "string", "enum": [ "AccountId", "ServiceArn", "LookbackPeriodInDays", "LastRefreshTimestamp", "LaunchType", "CurrentPerformanceRisk", "CurrentServiceConfigurationMemory", "CurrentServiceConfigurationCpu", "CurrentServiceConfigurationTaskDefinitionArn", "CurrentServiceConfigurationAutoScalingConfiguration", "CurrentServiceContainerConfigurations", "UtilizationMetricsCpuMaximum", "UtilizationMetricsMemoryMaximum", "Finding", "FindingReasonCodes", "RecommendationOptionsMemory", "RecommendationOptionsCpu", "RecommendationOptionsSavingsOpportunityPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrency", "RecommendationOptionsEstimatedMonthlySavingsValue", "RecommendationOptionsContainerRecommendations", "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum", "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum", "Tags", "EffectiveRecommendationPreferencesSavingsEstimationMode", "RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts", "RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts" ] }, "ExportableECSServiceFields": { "type": "list", "member": { "shape": "ExportableECSServiceField" } }, "ExportableInstanceField": { "type": "string", "enum": [ "AccountId", "InstanceArn", "InstanceName", "Finding", "FindingReasonCodes", "LookbackPeriodInDays", "CurrentInstanceType", "UtilizationMetricsCpuMaximum", "UtilizationMetricsMemoryMaximum", "UtilizationMetricsEbsReadOpsPerSecondMaximum", "UtilizationMetricsEbsWriteOpsPerSecondMaximum", "UtilizationMetricsEbsReadBytesPerSecondMaximum", "UtilizationMetricsEbsWriteBytesPerSecondMaximum", "UtilizationMetricsDiskReadOpsPerSecondMaximum", "UtilizationMetricsDiskWriteOpsPerSecondMaximum", "UtilizationMetricsDiskReadBytesPerSecondMaximum", "UtilizationMetricsDiskWriteBytesPerSecondMaximum", "UtilizationMetricsNetworkInBytesPerSecondMaximum", "UtilizationMetricsNetworkOutBytesPerSecondMaximum", "UtilizationMetricsNetworkPacketsInPerSecondMaximum", "UtilizationMetricsNetworkPacketsOutPerSecondMaximum", "CurrentOnDemandPrice", "CurrentStandardOneYearNoUpfrontReservedPrice", "CurrentStandardThreeYearNoUpfrontReservedPrice", "CurrentVCpus", "CurrentMemory", "CurrentStorage", "CurrentNetwork", "RecommendationOptionsInstanceType", "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum", "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum", "RecommendationOptionsPlatformDifferences", "RecommendationOptionsPerformanceRisk", "RecommendationOptionsVcpus", "RecommendationOptionsMemory", "RecommendationOptionsStorage", "RecommendationOptionsNetwork", "RecommendationOptionsOnDemandPrice", "RecommendationOptionsStandardOneYearNoUpfrontReservedPrice", "RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice", "RecommendationsSourcesRecommendationSourceArn", "RecommendationsSourcesRecommendationSourceType", "LastRefreshTimestamp", "CurrentPerformanceRisk", "RecommendationOptionsSavingsOpportunityPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrency", "RecommendationOptionsEstimatedMonthlySavingsValue", "EffectiveRecommendationPreferencesCpuVendorArchitectures", "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics", "EffectiveRecommendationPreferencesInferredWorkloadTypes", "InferredWorkloadTypes", "RecommendationOptionsMigrationEffort", "EffectiveRecommendationPreferencesExternalMetricsSource", "InstanceState", "Tags", "ExternalMetricStatusCode", "ExternalMetricStatusReason", "CurrentInstanceGpuInfo", "RecommendationOptionsInstanceGpuInfo", "UtilizationMetricsGpuPercentageMaximum", "UtilizationMetricsGpuMemoryPercentageMaximum", "RecommendationOptionsProjectedUtilizationMetricsGpuPercentageMaximum", "RecommendationOptionsProjectedUtilizationMetricsGpuMemoryPercentageMaximum", "Idle", "EffectiveRecommendationPreferencesPreferredResources", "EffectiveRecommendationPreferencesLookBackPeriod", "EffectiveRecommendationPreferencesUtilizationPreferences", "EffectiveRecommendationPreferencesSavingsEstimationMode", "RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts", "RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts" ] }, "ExportableInstanceFields": { "type": "list", "member": { "shape": "ExportableInstanceField" } }, "ExportableLambdaFunctionField": { "type": "string", "enum": [ "AccountId", "FunctionArn", "FunctionVersion", "Finding", "FindingReasonCodes", "NumberOfInvocations", "UtilizationMetricsDurationMaximum", "UtilizationMetricsDurationAverage", "UtilizationMetricsMemoryMaximum", "UtilizationMetricsMemoryAverage", "LookbackPeriodInDays", "CurrentConfigurationMemorySize", "CurrentConfigurationTimeout", "CurrentCostTotal", "CurrentCostAverage", "RecommendationOptionsConfigurationMemorySize", "RecommendationOptionsCostLow", "RecommendationOptionsCostHigh", "RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound", "RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound", "RecommendationOptionsProjectedUtilizationMetricsDurationExpected", "LastRefreshTimestamp", "CurrentPerformanceRisk", "RecommendationOptionsSavingsOpportunityPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrency", "RecommendationOptionsEstimatedMonthlySavingsValue", "Tags", "EffectiveRecommendationPreferencesSavingsEstimationMode", "RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts", "RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts" ] }, "ExportableLambdaFunctionFields": { "type": "list", "member": { "shape": "ExportableLambdaFunctionField" } }, "ExportableLicenseField": { "type": "string", "enum": [ "AccountId", "ResourceArn", "LookbackPeriodInDays", "LastRefreshTimestamp", "Finding", "FindingReasonCodes", "CurrentLicenseConfigurationNumberOfCores", "CurrentLicenseConfigurationInstanceType", "CurrentLicenseConfigurationOperatingSystem", "CurrentLicenseConfigurationLicenseName", "CurrentLicenseConfigurationLicenseEdition", "CurrentLicenseConfigurationLicenseModel", "CurrentLicenseConfigurationLicenseVersion", "CurrentLicenseConfigurationMetricsSource", "RecommendationOptionsOperatingSystem", "RecommendationOptionsLicenseEdition", "RecommendationOptionsLicenseModel", "RecommendationOptionsSavingsOpportunityPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrency", "RecommendationOptionsEstimatedMonthlySavingsValue", "Tags" ] }, "ExportableLicenseFields": { "type": "list", "member": { "shape": "ExportableLicenseField" } }, "ExportableVolumeField": { "type": "string", "enum": [ "AccountId", "VolumeArn", "Finding", "UtilizationMetricsVolumeReadOpsPerSecondMaximum", "UtilizationMetricsVolumeWriteOpsPerSecondMaximum", "UtilizationMetricsVolumeReadBytesPerSecondMaximum", "UtilizationMetricsVolumeWriteBytesPerSecondMaximum", "LookbackPeriodInDays", "CurrentConfigurationVolumeType", "CurrentConfigurationVolumeBaselineIOPS", "CurrentConfigurationVolumeBaselineThroughput", "CurrentConfigurationVolumeBurstIOPS", "CurrentConfigurationVolumeBurstThroughput", "CurrentConfigurationVolumeSize", "CurrentMonthlyPrice", "RecommendationOptionsConfigurationVolumeType", "RecommendationOptionsConfigurationVolumeBaselineIOPS", "RecommendationOptionsConfigurationVolumeBaselineThroughput", "RecommendationOptionsConfigurationVolumeBurstIOPS", "RecommendationOptionsConfigurationVolumeBurstThroughput", "RecommendationOptionsConfigurationVolumeSize", "RecommendationOptionsMonthlyPrice", "RecommendationOptionsPerformanceRisk", "LastRefreshTimestamp", "CurrentPerformanceRisk", "RecommendationOptionsSavingsOpportunityPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrency", "RecommendationOptionsEstimatedMonthlySavingsValue", "RootVolume", "Tags", "CurrentConfigurationRootVolume", "EffectiveRecommendationPreferencesSavingsEstimationMode", "RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage", "RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts", "RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts" ] }, "ExportableVolumeFields": { "type": "list", "member": { "shape": "ExportableVolumeField" } }, "ExternalMetricStatus": { "type": "structure", "members": { "statusCode": { "shape": "ExternalMetricStatusCode", "documentation": "

The status code for Compute Optimizer's integration with an external metrics provider.

" }, "statusReason": { "shape": "ExternalMetricStatusReason", "documentation": "

The reason for Compute Optimizer's integration status with your external metric provider.

" } }, "documentation": "

Describes Compute Optimizer's integration status with your chosen external metric provider. For example, Datadog.

" }, "ExternalMetricStatusCode": { "type": "string", "enum": [ "NO_EXTERNAL_METRIC_SET", "INTEGRATION_SUCCESS", "DATADOG_INTEGRATION_ERROR", "DYNATRACE_INTEGRATION_ERROR", "NEWRELIC_INTEGRATION_ERROR", "INSTANA_INTEGRATION_ERROR", "INSUFFICIENT_DATADOG_METRICS", "INSUFFICIENT_DYNATRACE_METRICS", "INSUFFICIENT_NEWRELIC_METRICS", "INSUFFICIENT_INSTANA_METRICS" ] }, "ExternalMetricStatusReason": { "type": "string" }, "ExternalMetricsPreference": { "type": "structure", "members": { "source": { "shape": "ExternalMetricsSource", "documentation": "

Contains the source options for external metrics preferences.

" } }, "documentation": "

Describes the external metrics preferences for EC2 rightsizing recommendations.

" }, "ExternalMetricsSource": { "type": "string", "enum": [ "Datadog", "Dynatrace", "NewRelic", "Instana" ] }, "FailureReason": { "type": "string" }, "FileFormat": { "type": "string", "enum": [ "Csv" ] }, "Filter": { "type": "structure", "members": { "name": { "shape": "FilterName", "documentation": "

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.

Specify InferredWorkloadTypes to return recommendations of a specific inferred workload. For example, Redis.

You can filter your EC2 instance recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your recommendations. Use this filter to find all of your recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your recommendations with a tag key value of Owner or without any tag keys assigned.

" }, "values": { "shape": "FilterValues", "documentation": "

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:

" } }, "documentation": "

Describes a filter that returns a more specific list of recommendations. Use this filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with the DescribeRecommendationExportJobs action.

" }, "FilterName": { "type": "string", "enum": [ "Finding", "FindingReasonCodes", "RecommendationSourceType", "InferredWorkloadTypes" ] }, "FilterValue": { "type": "string" }, "FilterValues": { "type": "list", "member": { "shape": "FilterValue" } }, "Filters": { "type": "list", "member": { "shape": "Filter" } }, "Finding": { "type": "string", "enum": [ "Underprovisioned", "Overprovisioned", "Optimized", "NotOptimized" ] }, "FindingReasonCode": { "type": "string", "enum": [ "MemoryOverprovisioned", "MemoryUnderprovisioned" ] }, "FunctionArn": { "type": "string" }, "FunctionArns": { "type": "list", "member": { "shape": "FunctionArn" } }, "FunctionVersion": { "type": "string" }, "GetAutoScalingGroupRecommendationsRequest": { "type": "structure", "members": { "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "autoScalingGroupArns": { "shape": "AutoScalingGroupArns", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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.

" }, "filters": { "shape": "Filters", "documentation": "

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

" }, "recommendationPreferences": { "shape": "RecommendationPreferences", "documentation": "

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

" } } }, "GetAutoScalingGroupRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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.

" }, "autoScalingGroupRecommendations": { "shape": "AutoScalingGroupRecommendations", "documentation": "

An array of objects that describe Auto Scaling group recommendations.

" }, "errors": { "shape": "GetRecommendationErrors", "documentation": "

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.

" } } }, "GetEBSVolumeRecommendationsRequest": { "type": "structure", "members": { "volumeArns": { "shape": "VolumeArns", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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.

" }, "filters": { "shape": "EBSFilters", "documentation": "

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

" }, "accountIds": { "shape": "AccountIds", "documentation": "

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.

" } } }, "GetEBSVolumeRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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.

" }, "volumeRecommendations": { "shape": "VolumeRecommendations", "documentation": "

An array of objects that describe volume recommendations.

" }, "errors": { "shape": "GetRecommendationErrors", "documentation": "

An array of objects that describe errors of the request.

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

" } } }, "GetEC2InstanceRecommendationsRequest": { "type": "structure", "members": { "instanceArns": { "shape": "InstanceArns", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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.

" }, "filters": { "shape": "Filters", "documentation": "

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

" }, "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "recommendationPreferences": { "shape": "RecommendationPreferences", "documentation": "

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

" } } }, "GetEC2InstanceRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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.

" }, "instanceRecommendations": { "shape": "InstanceRecommendations", "documentation": "

An array of objects that describe instance recommendations.

" }, "errors": { "shape": "GetRecommendationErrors", "documentation": "

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.

" } } }, "GetEC2RecommendationProjectedMetricsRequest": { "type": "structure", "required": [ "instanceArn", "stat", "period", "startTime", "endTime" ], "members": { "instanceArn": { "shape": "InstanceArn", "documentation": "

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

" }, "stat": { "shape": "MetricStatistic", "documentation": "

The statistic of the projected metrics.

" }, "period": { "shape": "Period", "documentation": "

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

" }, "startTime": { "shape": "Timestamp", "documentation": "

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

" }, "endTime": { "shape": "Timestamp", "documentation": "

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

" }, "recommendationPreferences": { "shape": "RecommendationPreferences", "documentation": "

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

" } } }, "GetEC2RecommendationProjectedMetricsResponse": { "type": "structure", "members": { "recommendedOptionProjectedMetrics": { "shape": "RecommendedOptionProjectedMetrics", "documentation": "

An array of objects that describes projected metrics.

" } } }, "GetECSServiceRecommendationProjectedMetricsRequest": { "type": "structure", "required": [ "serviceArn", "stat", "period", "startTime", "endTime" ], "members": { "serviceArn": { "shape": "ServiceArn", "documentation": "

The ARN that identifies the Amazon ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

" }, "stat": { "shape": "MetricStatistic", "documentation": "

The statistic of the projected metrics.

" }, "period": { "shape": "Period", "documentation": "

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

" }, "startTime": { "shape": "Timestamp", "documentation": "

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

" }, "endTime": { "shape": "Timestamp", "documentation": "

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

" } } }, "GetECSServiceRecommendationProjectedMetricsResponse": { "type": "structure", "members": { "recommendedOptionProjectedMetrics": { "shape": "ECSServiceRecommendedOptionProjectedMetrics", "documentation": "

An array of objects that describes the projected metrics.

" } } }, "GetECSServiceRecommendationsRequest": { "type": "structure", "members": { "serviceArns": { "shape": "ServiceArns", "documentation": "

The ARN that identifies the Amazon ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

" }, "nextToken": { "shape": "NextToken", "documentation": "

The token to advance to the next page of Amazon ECS service recommendations.

" }, "maxResults": { "shape": "MaxResults", "documentation": "

The maximum number of Amazon ECS service recommendations to return with a single request.

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

" }, "filters": { "shape": "ECSServiceRecommendationFilters", "documentation": "

An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations.

" }, "accountIds": { "shape": "AccountIds", "documentation": "

Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts.

You can only specify one account ID per request.

" } } }, "GetECSServiceRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

The token to advance to the next page of Amazon ECS service recommendations.

" }, "ecsServiceRecommendations": { "shape": "ECSServiceRecommendations", "documentation": "

An array of objects that describe the Amazon ECS service recommendations.

" }, "errors": { "shape": "GetRecommendationErrors", "documentation": "

An array of objects that describe errors of the request.

" } } }, "GetEffectiveRecommendationPreferencesRequest": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "shape": "ResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.

" } } }, "GetEffectiveRecommendationPreferencesResponse": { "type": "structure", "members": { "enhancedInfrastructureMetrics": { "shape": "EnhancedInfrastructureMetrics", "documentation": "

The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.

A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "externalMetricsPreference": { "shape": "ExternalMetricsPreference", "documentation": "

The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.

If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

To validate whether the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetEC2InstanceRecommendations actions.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "lookBackPeriod": { "shape": "LookBackPeriodPreference", "documentation": "

The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

" }, "utilizationPreferences": { "shape": "UtilizationPreferences", "documentation": "

The resource’s CPU and memory utilization preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.

To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

" }, "preferredResources": { "shape": "EffectivePreferredResources", "documentation": "

The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.

To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

" } } }, "GetEnrollmentStatusRequest": { "type": "structure", "members": {} }, "GetEnrollmentStatusResponse": { "type": "structure", "members": { "status": { "shape": "Status", "documentation": "

The enrollment status of the account.

" }, "statusReason": { "shape": "StatusReason", "documentation": "

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.

" }, "memberAccountsEnrolled": { "shape": "MemberAccountsEnrolled", "documentation": "

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

" }, "lastUpdatedTimestamp": { "shape": "LastUpdatedTimestamp", "documentation": "

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

" }, "numberOfMemberAccountsOptedIn": { "shape": "NumberOfMemberAccountsOptedIn", "documentation": "

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

" } } }, "GetEnrollmentStatusesForOrganizationRequest": { "type": "structure", "members": { "filters": { "shape": "EnrollmentFilters", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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": { "type": "structure", "members": { "accountEnrollmentStatuses": { "shape": "AccountEnrollmentStatuses", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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.

" } } }, "GetLambdaFunctionRecommendationsRequest": { "type": "structure", "members": { "functionArns": { "shape": "FunctionArns", "documentation": "

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.

" }, "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "filters": { "shape": "LambdaFunctionRecommendationFilters", "documentation": "

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

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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.

" }, "lambdaFunctionRecommendations": { "shape": "LambdaFunctionRecommendations", "documentation": "

An array of objects that describe function recommendations.

" } } }, "GetLicenseRecommendationsRequest": { "type": "structure", "members": { "resourceArns": { "shape": "ResourceArns", "documentation": "

The ARN that identifies the Amazon EC2 instance.

The following is the format of the ARN:

arn:aws:ec2:region:aws_account_id:instance/instance-id

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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

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

" }, "filters": { "shape": "LicenseRecommendationFilters", "documentation": "

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

" }, "accountIds": { "shape": "AccountIds", "documentation": "

The ID of the Amazon Web Services account for which to return license 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 license recommendations.

Only one account ID can be specified per request.

" } } }, "GetLicenseRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "licenseRecommendations": { "shape": "LicenseRecommendations", "documentation": "

An array of objects that describe license recommendations.

" }, "errors": { "shape": "GetRecommendationErrors", "documentation": "

An array of objects that describe errors of the request.

" } } }, "GetRecommendationError": { "type": "structure", "members": { "identifier": { "shape": "Identifier", "documentation": "

The ID of the error.

" }, "code": { "shape": "Code", "documentation": "

The error code.

" }, "message": { "shape": "Message", "documentation": "

The message, or reason, for the error.

" } }, "documentation": "

Describes an error experienced when getting recommendations.

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

" }, "GetRecommendationErrors": { "type": "list", "member": { "shape": "GetRecommendationError" } }, "GetRecommendationPreferencesRequest": { "type": "structure", "required": [ "resourceType" ], "members": { "resourceType": { "shape": "ResourceType", "documentation": "

The target resource type of the recommendation preference for which to return preferences.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

The valid values for this parameter are Ec2Instance and AutoScalingGroup.

" }, "scope": { "shape": "Scope", "documentation": "

An object that describes the scope of the recommendation preference to return.

You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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

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

" } } }, "GetRecommendationPreferencesResponse": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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

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

" }, "recommendationPreferencesDetails": { "shape": "RecommendationPreferencesDetails", "documentation": "

An array of objects that describe recommendation preferences.

" } } }, "GetRecommendationSummariesRequest": { "type": "structure", "members": { "accountIds": { "shape": "AccountIds", "documentation": "

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.

" }, "nextToken": { "shape": "NextToken", "documentation": "

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

" }, "maxResults": { "shape": "MaxResults", "documentation": "

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": { "type": "structure", "members": { "nextToken": { "shape": "NextToken", "documentation": "

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.

" }, "recommendationSummaries": { "shape": "RecommendationSummaries", "documentation": "

An array of objects that summarize a recommendation.

" } } }, "Gpu": { "type": "structure", "members": { "gpuCount": { "shape": "GpuCount", "documentation": "

The number of GPUs for the instance type.

" }, "gpuMemorySizeInMiB": { "shape": "GpuMemorySizeInMiB", "documentation": "

The total size of the memory for the GPU accelerators for the instance type, in MiB.

" } }, "documentation": "

Describes the GPU accelerators for the instance type.

" }, "GpuCount": { "type": "integer" }, "GpuInfo": { "type": "structure", "members": { "gpus": { "shape": "Gpus", "documentation": "

Describes the GPU accelerators for the instance type.

" } }, "documentation": "

Describes the GPU accelerator settings for the instance type.

" }, "GpuMemorySizeInMiB": { "type": "integer" }, "Gpus": { "type": "list", "member": { "shape": "Gpu" } }, "High": { "type": "long" }, "Identifier": { "type": "string" }, "IncludeMemberAccounts": { "type": "boolean" }, "InferredWorkloadSaving": { "type": "structure", "members": { "inferredWorkloadTypes": { "shape": "InferredWorkloadTypes", "documentation": "

The applications that might be running on the instance as inferred by Compute Optimizer.

Compute Optimizer can infer if one of the following applications might be running on the instance:

" }, "estimatedMonthlySavings": { "shape": "EstimatedMonthlySavings", "documentation": "

An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.

" } }, "documentation": "

The estimated monthly savings after you adjust the configurations of your instances running on the inferred workload types to the recommended configurations. If the inferredWorkloadTypes list contains multiple entries, then the savings are the sum of the monthly savings from instances that run the exact combination of the inferred workload types.

" }, "InferredWorkloadSavings": { "type": "list", "member": { "shape": "InferredWorkloadSaving" } }, "InferredWorkloadType": { "type": "string", "enum": [ "AmazonEmr", "ApacheCassandra", "ApacheHadoop", "Memcached", "Nginx", "PostgreSql", "Redis", "Kafka", "SQLServer" ] }, "InferredWorkloadTypes": { "type": "list", "member": { "shape": "InferredWorkloadType" } }, "InferredWorkloadTypesPreference": { "type": "string", "enum": [ "Active", "Inactive" ] }, "InstanceArn": { "type": "string" }, "InstanceArns": { "type": "list", "member": { "shape": "InstanceArn" } }, "InstanceEstimatedMonthlySavings": { "type": "structure", "members": { "currency": { "shape": "Currency", "documentation": "

The currency of the estimated monthly savings.

" }, "value": { "shape": "Value", "documentation": "

The value of the estimated monthly savings.

" } }, "documentation": "

An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on the Savings Plans and Reserved Instances pricing discounts.

" }, "InstanceIdle": { "type": "string", "enum": [ "True", "False" ] }, "InstanceName": { "type": "string" }, "InstanceRecommendation": { "type": "structure", "members": { "instanceArn": { "shape": "InstanceArn", "documentation": "

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

" }, "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID of the instance.

" }, "instanceName": { "shape": "InstanceName", "documentation": "

The name of the current instance.

" }, "currentInstanceType": { "shape": "CurrentInstanceType", "documentation": "

The instance type of the current instance.

" }, "finding": { "shape": "Finding", "documentation": "

The finding classification of the instance.

Findings for instances include:

" }, "findingReasonCodes": { "shape": "InstanceRecommendationFindingReasonCodes", "documentation": "

The reason for the finding classification of the instance.

Finding reason codes for instances include:

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.

" }, "utilizationMetrics": { "shape": "UtilizationMetrics", "documentation": "

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

" }, "lookBackPeriodInDays": { "shape": "LookBackPeriodInDays", "documentation": "

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

" }, "recommendationOptions": { "shape": "RecommendationOptions", "documentation": "

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

" }, "recommendationSources": { "shape": "RecommendationSources", "documentation": "

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

" }, "lastRefreshTimestamp": { "shape": "LastRefreshTimestamp", "documentation": "

The timestamp of when the instance recommendation was last generated.

" }, "currentPerformanceRisk": { "shape": "CurrentPerformanceRisk", "documentation": "

The risk of the current instance not meeting the performance needs of its workloads. The higher the risk, the more likely the current instance cannot meet the performance requirements of its workload.

" }, "effectiveRecommendationPreferences": { "shape": "EffectiveRecommendationPreferences", "documentation": "

An object that describes the effective recommendation preferences for the instance.

" }, "inferredWorkloadTypes": { "shape": "InferredWorkloadTypes", "documentation": "

The applications that might be running on the instance as inferred by Compute Optimizer.

Compute Optimizer can infer if one of the following applications might be running on the instance:

" }, "instanceState": { "shape": "InstanceState", "documentation": "

The state of the instance when the recommendation was generated.

" }, "tags": { "shape": "Tags", "documentation": "

A list of tags assigned to your Amazon EC2 instance recommendations.

" }, "externalMetricStatus": { "shape": "ExternalMetricStatus", "documentation": "

An object that describes Compute Optimizer's integration status with your external metrics provider.

" }, "currentInstanceGpuInfo": { "shape": "GpuInfo", "documentation": "

Describes the GPU accelerator settings for the current instance type.

" }, "idle": { "shape": "InstanceIdle", "documentation": "

Describes if an Amazon EC2 instance is idle.

" } }, "documentation": "

Describes an Amazon EC2 instance recommendation.

" }, "InstanceRecommendationFindingReasonCode": { "type": "string", "enum": [ "CPUOverprovisioned", "CPUUnderprovisioned", "MemoryOverprovisioned", "MemoryUnderprovisioned", "EBSThroughputOverprovisioned", "EBSThroughputUnderprovisioned", "EBSIOPSOverprovisioned", "EBSIOPSUnderprovisioned", "NetworkBandwidthOverprovisioned", "NetworkBandwidthUnderprovisioned", "NetworkPPSOverprovisioned", "NetworkPPSUnderprovisioned", "DiskIOPSOverprovisioned", "DiskIOPSUnderprovisioned", "DiskThroughputOverprovisioned", "DiskThroughputUnderprovisioned", "GPUUnderprovisioned", "GPUOverprovisioned", "GPUMemoryUnderprovisioned", "GPUMemoryOverprovisioned" ] }, "InstanceRecommendationFindingReasonCodes": { "type": "list", "member": { "shape": "InstanceRecommendationFindingReasonCode" } }, "InstanceRecommendationOption": { "type": "structure", "members": { "instanceType": { "shape": "InstanceType", "documentation": "

The instance type of the instance recommendation.

" }, "projectedUtilizationMetrics": { "shape": "ProjectedUtilizationMetrics", "documentation": "

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.

" }, "platformDifferences": { "shape": "PlatformDifferences", "documentation": "

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:

" }, "performanceRisk": { "shape": "PerformanceRisk", "documentation": "

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.

" }, "rank": { "shape": "Rank", "documentation": "

The rank of the instance recommendation option.

The top recommendation option is ranked as 1.

" }, "savingsOpportunity": { "shape": "SavingsOpportunity", "documentation": "

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

" }, "migrationEffort": { "shape": "MigrationEffort", "documentation": "

The level of effort required to migrate from the current instance type to the recommended instance type.

For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

" }, "instanceGpuInfo": { "shape": "GpuInfo", "documentation": "

Describes the GPU accelerator settings for the recommended instance type.

" }, "savingsOpportunityAfterDiscounts": { "shape": "InstanceSavingsOpportunityAfterDiscounts", "documentation": "

An object that describes the savings opportunity for the instance recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.

" } }, "documentation": "

Describes a recommendation option for an Amazon EC2 instance.

" }, "InstanceRecommendations": { "type": "list", "member": { "shape": "InstanceRecommendation" } }, "InstanceSavingsEstimationMode": { "type": "structure", "members": { "source": { "shape": "InstanceSavingsEstimationModeSource", "documentation": "

Describes the source for calculating the savings opportunity for Amazon EC2 instances.

" } }, "documentation": "

Describes the savings estimation mode used for calculating savings opportunity for Amazon EC2 instances.

" }, "InstanceSavingsEstimationModeSource": { "type": "string", "enum": [ "PublicPricing", "CostExplorerRightsizing", "CostOptimizationHub" ] }, "InstanceSavingsOpportunityAfterDiscounts": { "type": "structure", "members": { "savingsOpportunityPercentage": { "shape": "SavingsOpportunityPercentage", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost after applying the Savings Plans and Reserved Instances discounts. This saving can be achieved by adopting Compute Optimizer’s EC2 instance recommendations.

" }, "estimatedMonthlySavings": { "shape": "InstanceEstimatedMonthlySavings", "documentation": "

An object that describes the estimated monthly savings possible by adopting Compute Optimizer’s Amazon EC2 instance recommendations. This is based on pricing after applying the Savings Plans and Reserved Instances discounts.

" } }, "documentation": "

Describes the savings opportunity for instance recommendations after applying the Savings Plans and Reserved Instances discounts.

Savings opportunity after discounts represents the estimated monthly savings you can achieve by implementing Compute Optimizer recommendations.

" }, "InstanceState": { "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceType": { "type": "string" }, "JobFilter": { "type": "structure", "members": { "name": { "shape": "JobFilterName", "documentation": "

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).

" }, "values": { "shape": "FilterValues", "documentation": "

The value of the filter.

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

" } }, "documentation": "

Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.

You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

" }, "JobFilterName": { "type": "string", "enum": [ "ResourceType", "JobStatus" ] }, "JobFilters": { "type": "list", "member": { "shape": "JobFilter" } }, "JobId": { "type": "string" }, "JobIds": { "type": "list", "member": { "shape": "JobId" } }, "JobStatus": { "type": "string", "enum": [ "Queued", "InProgress", "Complete", "Failed" ] }, "LambdaEffectiveRecommendationPreferences": { "type": "structure", "members": { "savingsEstimationMode": { "shape": "LambdaSavingsEstimationMode", "documentation": "

Describes the savings estimation mode applied for calculating savings opportunity for Lambda functions.

" } }, "documentation": "

Describes the effective recommendation preferences for Lambda functions.

" }, "LambdaEstimatedMonthlySavings": { "type": "structure", "members": { "currency": { "shape": "Currency", "documentation": "

The currency of the estimated monthly savings.

" }, "value": { "shape": "Value", "documentation": "

The value of the estimated monthly savings.

" } }, "documentation": "

Describes the estimated monthly savings possible for Lambda functions by adopting Compute Optimizer recommendations. This is based on Lambda functions pricing after applying Savings Plans discounts.

" }, "LambdaFunctionMemoryMetricName": { "type": "string", "enum": [ "Duration" ] }, "LambdaFunctionMemoryMetricStatistic": { "type": "string", "enum": [ "LowerBound", "UpperBound", "Expected" ] }, "LambdaFunctionMemoryProjectedMetric": { "type": "structure", "members": { "name": { "shape": "LambdaFunctionMemoryMetricName", "documentation": "

The name of the projected utilization metric.

" }, "statistic": { "shape": "LambdaFunctionMemoryMetricStatistic", "documentation": "

The statistic of the projected utilization metric.

" }, "value": { "shape": "MetricValue", "documentation": "

The values of the projected utilization metrics.

" } }, "documentation": "

Describes a projected utilization metric of an Lambda function recommendation option.

" }, "LambdaFunctionMemoryProjectedMetrics": { "type": "list", "member": { "shape": "LambdaFunctionMemoryProjectedMetric" } }, "LambdaFunctionMemoryRecommendationOption": { "type": "structure", "members": { "rank": { "shape": "Rank", "documentation": "

The rank of the function recommendation option.

The top recommendation option is ranked as 1.

" }, "memorySize": { "shape": "MemorySize", "documentation": "

The memory size, in MB, of the function recommendation option.

" }, "projectedUtilizationMetrics": { "shape": "LambdaFunctionMemoryProjectedMetrics", "documentation": "

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

" }, "savingsOpportunity": { "shape": "SavingsOpportunity", "documentation": "

An object that describes the savings opportunity for the Lambda function recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

" }, "savingsOpportunityAfterDiscounts": { "shape": "LambdaSavingsOpportunityAfterDiscounts", "documentation": "

An object that describes the savings opportunity for the Lambda recommendation option which includes Saving Plans discounts. Savings opportunity includes the estimated monthly savings and percentage.

" } }, "documentation": "

Describes a recommendation option for an Lambda function.

" }, "LambdaFunctionMemoryRecommendationOptions": { "type": "list", "member": { "shape": "LambdaFunctionMemoryRecommendationOption" } }, "LambdaFunctionMetricName": { "type": "string", "enum": [ "Duration", "Memory" ] }, "LambdaFunctionMetricStatistic": { "type": "string", "enum": [ "Maximum", "Average" ] }, "LambdaFunctionRecommendation": { "type": "structure", "members": { "functionArn": { "shape": "FunctionArn", "documentation": "

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

" }, "functionVersion": { "shape": "FunctionVersion", "documentation": "

The version number of the current function.

" }, "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID of the function.

" }, "currentMemorySize": { "shape": "MemorySize", "documentation": "

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

" }, "numberOfInvocations": { "shape": "NumberOfInvocations", "documentation": "

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

" }, "utilizationMetrics": { "shape": "LambdaFunctionUtilizationMetrics", "documentation": "

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

" }, "lookbackPeriodInDays": { "shape": "LookBackPeriodInDays", "documentation": "

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

" }, "lastRefreshTimestamp": { "shape": "LastRefreshTimestamp", "documentation": "

The timestamp of when the function recommendation was last generated.

" }, "finding": { "shape": "LambdaFunctionRecommendationFinding", "documentation": "

The finding classification of the function.

Findings for functions include:

" }, "findingReasonCodes": { "shape": "LambdaFunctionRecommendationFindingReasonCodes", "documentation": "

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:

" }, "memorySizeRecommendationOptions": { "shape": "LambdaFunctionMemoryRecommendationOptions", "documentation": "

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

" }, "currentPerformanceRisk": { "shape": "CurrentPerformanceRisk", "documentation": "

The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.

" }, "tags": { "shape": "Tags", "documentation": "

A list of tags assigned to your Lambda function recommendations.

" }, "effectiveRecommendationPreferences": { "shape": "LambdaEffectiveRecommendationPreferences", "documentation": "

Describes the effective recommendation preferences for Lambda functions.

" } }, "documentation": "

Describes an Lambda function recommendation.

" }, "LambdaFunctionRecommendationFilter": { "type": "structure", "members": { "name": { "shape": "LambdaFunctionRecommendationFilterName", "documentation": "

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).

You can filter your Lambda function recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your Lambda function recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Lambda function recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your Lambda function recommendations. Use this filter to find all of your Lambda function recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Lambda function recommendations with a tag key value of Owner or without any tag keys assigned.

" }, "values": { "shape": "FilterValues", "documentation": "

The value of the filter.

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

" } }, "documentation": "

Describes a filter that returns a more specific list of Lambda function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.

You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

" }, "LambdaFunctionRecommendationFilterName": { "type": "string", "enum": [ "Finding", "FindingReasonCode" ] }, "LambdaFunctionRecommendationFilters": { "type": "list", "member": { "shape": "LambdaFunctionRecommendationFilter" } }, "LambdaFunctionRecommendationFinding": { "type": "string", "enum": [ "Optimized", "NotOptimized", "Unavailable" ] }, "LambdaFunctionRecommendationFindingReasonCode": { "type": "string", "enum": [ "MemoryOverprovisioned", "MemoryUnderprovisioned", "InsufficientData", "Inconclusive" ] }, "LambdaFunctionRecommendationFindingReasonCodes": { "type": "list", "member": { "shape": "LambdaFunctionRecommendationFindingReasonCode" } }, "LambdaFunctionRecommendations": { "type": "list", "member": { "shape": "LambdaFunctionRecommendation" } }, "LambdaFunctionUtilizationMetric": { "type": "structure", "members": { "name": { "shape": "LambdaFunctionMetricName", "documentation": "

The name of the utilization metric.

The following utilization metrics are available:

" }, "statistic": { "shape": "LambdaFunctionMetricStatistic", "documentation": "

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.

" }, "value": { "shape": "MetricValue", "documentation": "

The value of the utilization metric.

" } }, "documentation": "

Describes a utilization metric of an Lambda function.

" }, "LambdaFunctionUtilizationMetrics": { "type": "list", "member": { "shape": "LambdaFunctionUtilizationMetric" } }, "LambdaSavingsEstimationMode": { "type": "structure", "members": { "source": { "shape": "LambdaSavingsEstimationModeSource", "documentation": "

Describes the source for calculation of savings opportunity for Lambda functions.

" } }, "documentation": "

Describes the savings estimation used for calculating savings opportunity for Lambda functions.

" }, "LambdaSavingsEstimationModeSource": { "type": "string", "enum": [ "PublicPricing", "CostExplorerRightsizing", "CostOptimizationHub" ] }, "LambdaSavingsOpportunityAfterDiscounts": { "type": "structure", "members": { "savingsOpportunityPercentage": { "shape": "SavingsOpportunityPercentage", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.

" }, "estimatedMonthlySavings": { "shape": "LambdaEstimatedMonthlySavings", "documentation": "

The estimated monthly savings possible by adopting Compute Optimizer’s Lambda function recommendations. This includes any applicable Savings Plans discounts.

" } }, "documentation": "

Describes the savings opportunity for Lambda functions recommendations after applying Savings Plans discounts.

Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation.

" }, "LastRefreshTimestamp": { "type": "timestamp" }, "LastUpdatedTimestamp": { "type": "timestamp" }, "LicenseConfiguration": { "type": "structure", "members": { "numberOfCores": { "shape": "NumberOfCores", "documentation": "

The current number of cores associated with the instance.

" }, "instanceType": { "shape": "InstanceType", "documentation": "

The instance type used in the license.

" }, "operatingSystem": { "shape": "OperatingSystem", "documentation": "

The operating system of the instance.

" }, "licenseEdition": { "shape": "LicenseEdition", "documentation": "

The edition of the license for the application that runs on the instance.

" }, "licenseName": { "shape": "LicenseName", "documentation": "

The name of the license for the application that runs on the instance.

" }, "licenseModel": { "shape": "LicenseModel", "documentation": "

The license type associated with the instance.

" }, "licenseVersion": { "shape": "LicenseVersion", "documentation": "

The version of the license for the application that runs on the instance.

" }, "metricsSource": { "shape": "MetricsSource", "documentation": "

The list of metric sources required to generate recommendations for commercial software licenses.

" } }, "documentation": "

Describes the configuration of a license for an Amazon EC2 instance.

" }, "LicenseEdition": { "type": "string", "enum": [ "Enterprise", "Standard", "Free", "NoLicenseEditionFound" ] }, "LicenseFinding": { "type": "string", "enum": [ "InsufficientMetrics", "Optimized", "NotOptimized" ] }, "LicenseFindingReasonCode": { "type": "string", "enum": [ "InvalidCloudWatchApplicationInsightsSetup", "CloudWatchApplicationInsightsError", "LicenseOverprovisioned", "Optimized" ] }, "LicenseFindingReasonCodes": { "type": "list", "member": { "shape": "LicenseFindingReasonCode" } }, "LicenseModel": { "type": "string", "enum": [ "LicenseIncluded", "BringYourOwnLicense" ] }, "LicenseName": { "type": "string", "enum": [ "SQLServer" ] }, "LicenseRecommendation": { "type": "structure", "members": { "resourceArn": { "shape": "ResourceArn", "documentation": "

The ARN that identifies the Amazon EC2 instance.

" }, "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID of the license.

" }, "currentLicenseConfiguration": { "shape": "LicenseConfiguration", "documentation": "

An object that describes the current configuration of an instance that runs on a license.

" }, "lookbackPeriodInDays": { "shape": "LookBackPeriodInDays", "documentation": "

The number of days for which utilization metrics were analyzed for an instance that runs on a license.

" }, "lastRefreshTimestamp": { "shape": "LastRefreshTimestamp", "documentation": "

The timestamp of when the license recommendation was last generated.

" }, "finding": { "shape": "LicenseFinding", "documentation": "

The finding classification for an instance that runs on a license.

Findings include:

" }, "findingReasonCodes": { "shape": "LicenseFindingReasonCodes", "documentation": "

The reason for the finding classification for an instance that runs on a license.

Finding reason codes include:

" }, "licenseRecommendationOptions": { "shape": "LicenseRecommendationOptions", "documentation": "

An array of objects that describe the license recommendation options.

" }, "tags": { "shape": "Tags", "documentation": "

A list of tags assigned to an EC2 instance.

" } }, "documentation": "

Describes a license recommendation for an EC2 instance.

" }, "LicenseRecommendationFilter": { "type": "structure", "members": { "name": { "shape": "LicenseRecommendationFilterName", "documentation": "

The name of the filter.

Specify Finding to return recommendations with a specific finding classification.

Specify FindingReasonCode to return recommendations with a specific finding reason code.

You can filter your license recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your license recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all license recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your license recommendations. Use this filter to find all of your license recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your license recommendations with a tag key value of Owner or without any tag keys assigned.

" }, "values": { "shape": "FilterValues", "documentation": "

The value of the filter.

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

" } }, "documentation": "

Describes a filter that returns a more specific list of license recommendations. Use this filter with the GetLicenseRecommendation action.

" }, "LicenseRecommendationFilterName": { "type": "string", "enum": [ "Finding", "FindingReasonCode", "LicenseName" ] }, "LicenseRecommendationFilters": { "type": "list", "member": { "shape": "LicenseRecommendationFilter" } }, "LicenseRecommendationOption": { "type": "structure", "members": { "rank": { "shape": "Rank", "documentation": "

The rank of the license recommendation option.

The top recommendation option is ranked as 1.

" }, "operatingSystem": { "shape": "OperatingSystem", "documentation": "

The operating system of a license recommendation option.

" }, "licenseEdition": { "shape": "LicenseEdition", "documentation": "

The recommended edition of the license for the application that runs on the instance.

" }, "licenseModel": { "shape": "LicenseModel", "documentation": "

The recommended license type associated with the instance.

" }, "savingsOpportunity": { "shape": "SavingsOpportunity" } }, "documentation": "

Describes the recommendation options for licenses.

" }, "LicenseRecommendationOptions": { "type": "list", "member": { "shape": "LicenseRecommendationOption" } }, "LicenseRecommendations": { "type": "list", "member": { "shape": "LicenseRecommendation" } }, "LicenseVersion": { "type": "string" }, "LookBackPeriodInDays": { "type": "double" }, "LookBackPeriodPreference": { "type": "string", "enum": [ "DAYS_14", "DAYS_32", "DAYS_93" ] }, "Low": { "type": "long" }, "LowerBoundValue": { "type": "double" }, "MaxResults": { "type": "integer", "box": true, "max": 1000, "min": 0 }, "MaxSize": { "type": "integer" }, "Medium": { "type": "long" }, "MemberAccountsEnrolled": { "type": "boolean" }, "MemorySize": { "type": "integer" }, "MemorySizeConfiguration": { "type": "structure", "members": { "memory": { "shape": "NullableMemory", "documentation": "

The amount of memory in the container.

" }, "memoryReservation": { "shape": "NullableMemoryReservation", "documentation": "

The limit of memory reserve for the container.

" } }, "documentation": "

The memory size configurations of a container.

" }, "Message": { "type": "string" }, "MetadataKey": { "type": "string" }, "MetricName": { "type": "string", "enum": [ "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND", "DISK_READ_OPS_PER_SECOND", "DISK_WRITE_OPS_PER_SECOND", "DISK_READ_BYTES_PER_SECOND", "DISK_WRITE_BYTES_PER_SECOND", "NETWORK_IN_BYTES_PER_SECOND", "NETWORK_OUT_BYTES_PER_SECOND", "NETWORK_PACKETS_IN_PER_SECOND", "NETWORK_PACKETS_OUT_PER_SECOND", "GPU_PERCENTAGE", "GPU_MEMORY_PERCENTAGE" ] }, "MetricProviderArn": { "type": "string" }, "MetricSource": { "type": "structure", "members": { "provider": { "shape": "MetricSourceProvider", "documentation": "

The name of the metric source provider.

" }, "providerArn": { "shape": "MetricProviderArn", "documentation": "

The ARN of the metric source provider.

" } }, "documentation": "

The list of metric sources required to generate recommendations for commercial software licenses.

" }, "MetricSourceProvider": { "type": "string", "enum": [ "CloudWatchApplicationInsights" ] }, "MetricStatistic": { "type": "string", "enum": [ "Maximum", "Average" ] }, "MetricValue": { "type": "double" }, "MetricValues": { "type": "list", "member": { "shape": "MetricValue" } }, "MetricsSource": { "type": "list", "member": { "shape": "MetricSource" } }, "MigrationEffort": { "type": "string", "enum": [ "VeryLow", "Low", "Medium", "High" ] }, "MinSize": { "type": "integer" }, "NextToken": { "type": "string" }, "NullableCpu": { "type": "integer" }, "NullableMemory": { "type": "integer" }, "NullableMemoryReservation": { "type": "integer" }, "NumberOfCores": { "type": "integer" }, "NumberOfInvocations": { "type": "long" }, "NumberOfMemberAccountsOptedIn": { "type": "integer" }, "OperatingSystem": { "type": "string" }, "PerformanceRisk": { "type": "double", "max": 4, "min": 0 }, "Period": { "type": "integer" }, "PlatformDifference": { "type": "string", "enum": [ "Hypervisor", "NetworkInterface", "StorageInterface", "InstanceStoreAvailability", "VirtualizationType", "Architecture" ] }, "PlatformDifferences": { "type": "list", "member": { "shape": "PlatformDifference" } }, "PreferredResource": { "type": "structure", "members": { "name": { "shape": "PreferredResourceName", "documentation": "

The type of preferred resource to customize.

Compute Optimizer only supports the customization of Ec2InstanceTypes.

" }, "includeList": { "shape": "PreferredResourceValues", "documentation": "

The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.

" }, "excludeList": { "shape": "PreferredResourceValues", "documentation": "

The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.

" } }, "documentation": "

The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs. For more information, see Rightsizing recommendation preferences in the Compute Optimizer User Guide.

" }, "PreferredResourceName": { "type": "string", "enum": [ "Ec2InstanceTypes" ] }, "PreferredResourceValue": { "type": "string" }, "PreferredResourceValues": { "type": "list", "member": { "shape": "PreferredResourceValue" } }, "PreferredResources": { "type": "list", "member": { "shape": "PreferredResource" } }, "ProjectedMetric": { "type": "structure", "members": { "name": { "shape": "MetricName", "documentation": "

The name of the projected utilization metric.

The following projected utilization metrics are returned:

" }, "timestamps": { "shape": "Timestamps", "documentation": "

The timestamps of the projected utilization metric.

" }, "values": { "shape": "MetricValues", "documentation": "

The values of the projected utilization metrics.

" } }, "documentation": "

Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

The Cpu, Memory, GPU, and GPU_MEMORY metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, these metrics are only returned for resources with the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent and Enabling NVIDIA GPU utilization with the CloudWatch Agent.

" }, "ProjectedMetrics": { "type": "list", "member": { "shape": "ProjectedMetric" } }, "ProjectedUtilizationMetrics": { "type": "list", "member": { "shape": "UtilizationMetric" } }, "PutRecommendationPreferencesRequest": { "type": "structure", "required": [ "resourceType" ], "members": { "resourceType": { "shape": "ResourceType", "documentation": "

The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

The valid values for this parameter are Ec2Instance and AutoScalingGroup.

" }, "scope": { "shape": "Scope", "documentation": "

An object that describes the scope of the recommendation preference to create.

You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

" }, "enhancedInfrastructureMetrics": { "shape": "EnhancedInfrastructureMetrics", "documentation": "

The status of the enhanced infrastructure metrics recommendation preference to create or update.

Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "inferredWorkloadTypes": { "shape": "InferredWorkloadTypesPreference", "documentation": "

The status of the inferred workload types recommendation preference to create or update.

The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

Specify the Inactive status to deactivate the feature, or specify Active to activate it.

For more information, see Inferred workload types in the Compute Optimizer User Guide.

" }, "externalMetricsPreference": { "shape": "ExternalMetricsPreference", "documentation": "

The provider of the external metrics recommendation preference to create or update.

Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

This preference can only be set for the Ec2Instance resource type.

For more information, see External metrics ingestion in the Compute Optimizer User Guide.

" }, "lookBackPeriod": { "shape": "LookBackPeriodPreference", "documentation": "

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14.

You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

" }, "utilizationPreferences": { "shape": "UtilizationPreferences", "documentation": "

The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values.

CPU utilization:

Memory utilization:

" }, "preferredResources": { "shape": "PreferredResources", "documentation": "

The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs.

You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

" }, "savingsEstimationMode": { "shape": "SavingsEstimationMode", "documentation": "

The status of the savings estimation mode preference to create or update.

Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.

Only the account manager or delegated administrator of your organization can activate this preference.

For more information, see Savings estimation mode in the Compute Optimizer User Guide.

" } } }, "PutRecommendationPreferencesResponse": { "type": "structure", "members": {} }, "Rank": { "type": "integer" }, "ReasonCodeSummaries": { "type": "list", "member": { "shape": "ReasonCodeSummary" } }, "ReasonCodeSummary": { "type": "structure", "members": { "name": { "shape": "FindingReasonCode", "documentation": "

The name of the finding reason code.

" }, "value": { "shape": "SummaryValue", "documentation": "

The value of the finding reason code summary.

" } }, "documentation": "

A summary of a finding reason code.

" }, "RecommendationExportJob": { "type": "structure", "members": { "jobId": { "shape": "JobId", "documentation": "

The identification number of the export job.

" }, "destination": { "shape": "ExportDestination", "documentation": "

An object that describes the destination of the export file.

" }, "resourceType": { "shape": "ResourceType", "documentation": "

The resource type of the exported recommendations.

" }, "status": { "shape": "JobStatus", "documentation": "

The status of the export job.

" }, "creationTimestamp": { "shape": "CreationTimestamp", "documentation": "

The timestamp of when the export job was created.

" }, "lastUpdatedTimestamp": { "shape": "LastUpdatedTimestamp", "documentation": "

The timestamp of when the export job was last updated.

" }, "failureReason": { "shape": "FailureReason", "documentation": "

The reason for an export job failure.

" } }, "documentation": "

Describes a recommendation export job.

Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.

" }, "RecommendationExportJobs": { "type": "list", "member": { "shape": "RecommendationExportJob" } }, "RecommendationOptions": { "type": "list", "member": { "shape": "InstanceRecommendationOption" } }, "RecommendationPreferenceName": { "type": "string", "enum": [ "EnhancedInfrastructureMetrics", "InferredWorkloadTypes", "ExternalMetricsPreference", "LookBackPeriodPreference", "PreferredResources", "UtilizationPreferences" ] }, "RecommendationPreferenceNames": { "type": "list", "member": { "shape": "RecommendationPreferenceName" } }, "RecommendationPreferences": { "type": "structure", "members": { "cpuVendorArchitectures": { "shape": "CpuVendorArchitectures", "documentation": "

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

For example, when you specify AWS_ARM64 with:

" } }, "documentation": "

Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, and GetEC2RecommendationProjectedMetrics request.

" }, "RecommendationPreferencesDetail": { "type": "structure", "members": { "scope": { "shape": "Scope", "documentation": "

An object that describes the scope of the recommendation preference.

Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "resourceType": { "shape": "ResourceType", "documentation": "

The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

" }, "enhancedInfrastructureMetrics": { "shape": "EnhancedInfrastructureMetrics", "documentation": "

The status of the enhanced infrastructure metrics recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

" }, "inferredWorkloadTypes": { "shape": "InferredWorkloadTypesPreference", "documentation": "

The status of the inferred workload types recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

" }, "externalMetricsPreference": { "shape": "ExternalMetricsPreference", "documentation": "

An object that describes the external metrics recommendation preference.

If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

" }, "lookBackPeriod": { "shape": "LookBackPeriodPreference", "documentation": "

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.

" }, "utilizationPreferences": { "shape": "UtilizationPreferences", "documentation": "

The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. If the preference isn’t set, this object is null.

This preference is only available for the Amazon EC2 instance resource type.

" }, "preferredResources": { "shape": "EffectivePreferredResources", "documentation": "

The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.

" }, "savingsEstimationMode": { "shape": "SavingsEstimationMode", "documentation": "

Describes the savings estimation mode used for calculating savings opportunity.

Only the account manager or delegated administrator of your organization can activate this preference.

" } }, "documentation": "

Describes a recommendation preference.

" }, "RecommendationPreferencesDetails": { "type": "list", "member": { "shape": "RecommendationPreferencesDetail" } }, "RecommendationSource": { "type": "structure", "members": { "recommendationSourceArn": { "shape": "RecommendationSourceArn", "documentation": "

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

" }, "recommendationSourceType": { "shape": "RecommendationSourceType", "documentation": "

The resource type of the recommendation source.

" } }, "documentation": "

Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.

" }, "RecommendationSourceArn": { "type": "string" }, "RecommendationSourceType": { "type": "string", "enum": [ "Ec2Instance", "AutoScalingGroup", "EbsVolume", "LambdaFunction", "EcsService", "License" ] }, "RecommendationSources": { "type": "list", "member": { "shape": "RecommendationSource" } }, "RecommendationSummaries": { "type": "list", "member": { "shape": "RecommendationSummary" } }, "RecommendationSummary": { "type": "structure", "members": { "summaries": { "shape": "Summaries", "documentation": "

An array of objects that describe a recommendation summary.

" }, "recommendationResourceType": { "shape": "RecommendationSourceType", "documentation": "

The resource type that the recommendation summary applies to.

" }, "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID of the recommendation summary.

" }, "savingsOpportunity": { "shape": "SavingsOpportunity", "documentation": "

An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

" }, "currentPerformanceRiskRatings": { "shape": "CurrentPerformanceRiskRatings", "documentation": "

An object that describes the performance risk ratings for a given resource type.

" }, "inferredWorkloadSavings": { "shape": "InferredWorkloadSavings", "documentation": "

An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top five savings opportunites for the instances that run inferred workload types.

" } }, "documentation": "

A summary of a recommendation.

" }, "RecommendedInstanceType": { "type": "string" }, "RecommendedOptionProjectedMetric": { "type": "structure", "members": { "recommendedInstanceType": { "shape": "RecommendedInstanceType", "documentation": "

The recommended instance type.

" }, "rank": { "shape": "Rank", "documentation": "

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.

" }, "projectedMetrics": { "shape": "ProjectedMetrics", "documentation": "

An array of objects that describe a projected utilization metric.

" } }, "documentation": "

Describes a projected utilization metric of a recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

" }, "RecommendedOptionProjectedMetrics": { "type": "list", "member": { "shape": "RecommendedOptionProjectedMetric" } }, "ResourceArn": { "type": "string" }, "ResourceArns": { "type": "list", "member": { "shape": "ResourceArn" } }, "ResourceType": { "type": "string", "enum": [ "Ec2Instance", "AutoScalingGroup", "EbsVolume", "LambdaFunction", "NotApplicable", "EcsService", "License" ] }, "RootVolume": { "type": "boolean" }, "S3Destination": { "type": "structure", "members": { "bucket": { "shape": "DestinationBucket", "documentation": "

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

" }, "key": { "shape": "DestinationKey", "documentation": "

The Amazon S3 bucket key of an export file.

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

" }, "metadataKey": { "shape": "MetadataKey", "documentation": "

The Amazon S3 bucket key of a metadata file.

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

" } }, "documentation": "

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

" }, "S3DestinationConfig": { "type": "structure", "members": { "bucket": { "shape": "DestinationBucket", "documentation": "

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

" }, "keyPrefix": { "shape": "DestinationKeyPrefix", "documentation": "

The Amazon S3 bucket prefix for an export job.

" } }, "documentation": "

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations 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 permission 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.

" }, "SavingsEstimationMode": { "type": "string", "enum": [ "AfterDiscounts", "BeforeDiscounts" ] }, "SavingsOpportunity": { "type": "structure", "members": { "savingsOpportunityPercentage": { "shape": "SavingsOpportunityPercentage", "documentation": "

The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.

" }, "estimatedMonthlySavings": { "shape": "EstimatedMonthlySavings", "documentation": "

An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..

" } }, "documentation": "

Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.

Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.

Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.

" }, "SavingsOpportunityPercentage": { "type": "double" }, "Scope": { "type": "structure", "members": { "name": { "shape": "ScopeName", "documentation": "

The name of the scope.

The following scopes are possible:

" }, "value": { "shape": "ScopeValue", "documentation": "

The value of the scope.

If you specified the name of the scope as:

Only EC2 instance and Auto Scaling group ARNs are currently supported.

" } }, "documentation": "

Describes the scope of a recommendation preference.

Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

" }, "ScopeName": { "type": "string", "enum": [ "Organization", "AccountId", "ResourceArn" ] }, "ScopeValue": { "type": "string" }, "ServiceArn": { "type": "string" }, "ServiceArns": { "type": "list", "member": { "shape": "ServiceArn" } }, "ServiceConfiguration": { "type": "structure", "members": { "memory": { "shape": "NullableMemory", "documentation": "

The amount of memory used by the tasks in the Amazon ECS service.

" }, "cpu": { "shape": "NullableCpu", "documentation": "

The number of CPU units used by the tasks in the Amazon ECS service.

" }, "containerConfigurations": { "shape": "ContainerConfigurations", "documentation": "

The container configurations within a task of an Amazon ECS service.

" }, "autoScalingConfiguration": { "shape": "AutoScalingConfiguration", "documentation": "

Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.

The Auto Scaling configuration methods include:

For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide.

" }, "taskDefinitionArn": { "shape": "TaskDefinitionArn", "documentation": "

The task definition ARN used by the tasks in the Amazon ECS service.

" } }, "documentation": "

The Amazon ECS service configurations used for recommendations.

" }, "Status": { "type": "string", "enum": [ "Active", "Inactive", "Pending", "Failed" ] }, "StatusReason": { "type": "string" }, "Summaries": { "type": "list", "member": { "shape": "Summary" } }, "Summary": { "type": "structure", "members": { "name": { "shape": "Finding", "documentation": "

The finding classification of the recommendation.

" }, "value": { "shape": "SummaryValue", "documentation": "

The value of the recommendation summary.

" }, "reasonCodeSummaries": { "shape": "ReasonCodeSummaries", "documentation": "

An array of objects that summarize a finding reason code.

" } }, "documentation": "

The summary of a recommendation.

" }, "SummaryValue": { "type": "double" }, "Tag": { "type": "structure", "members": { "key": { "shape": "TagKey", "documentation": "

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

" }, "value": { "shape": "TagValue", "documentation": "

One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

" } }, "documentation": "

A list of tag key and value pairs that you define.

" }, "TagKey": { "type": "string" }, "TagValue": { "type": "string" }, "Tags": { "type": "list", "member": { "shape": "Tag" } }, "TaskDefinitionArn": { "type": "string" }, "Timestamp": { "type": "timestamp" }, "Timestamps": { "type": "list", "member": { "shape": "Timestamp" } }, "UpdateEnrollmentStatusRequest": { "type": "structure", "required": [ "status" ], "members": { "status": { "shape": "Status", "documentation": "

The new enrollment status of the account.

The following status options are available:

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.

" }, "includeMemberAccounts": { "shape": "IncludeMemberAccounts", "documentation": "

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

" } } }, "UpdateEnrollmentStatusResponse": { "type": "structure", "members": { "status": { "shape": "Status", "documentation": "

The enrollment status of the account.

" }, "statusReason": { "shape": "StatusReason", "documentation": "

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.

" } } }, "UpperBoundValue": { "type": "double" }, "UtilizationMetric": { "type": "structure", "members": { "name": { "shape": "MetricName", "documentation": "

The name of the utilization metric.

The following utilization metrics are available:

" }, "statistic": { "shape": "MetricStatistic", "documentation": "

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.

" }, "value": { "shape": "MetricValue", "documentation": "

The value of the utilization metric.

" } }, "documentation": "

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

" }, "UtilizationMetrics": { "type": "list", "member": { "shape": "UtilizationMetric" } }, "UtilizationPreference": { "type": "structure", "members": { "metricName": { "shape": "CustomizableMetricName", "documentation": "

The name of the resource utilization metric name to customize.

" }, "metricParameters": { "shape": "CustomizableMetricParameters", "documentation": "

The parameters to set when customizing the resource utilization thresholds.

" } }, "documentation": "

The preference to control the resource’s CPU utilization thresholds - threshold and headroom.

This preference is only available for the Amazon EC2 instance resource type.

" }, "UtilizationPreferences": { "type": "list", "member": { "shape": "UtilizationPreference" } }, "Value": { "type": "double" }, "VeryLow": { "type": "long" }, "VolumeArn": { "type": "string" }, "VolumeArns": { "type": "list", "member": { "shape": "VolumeArn" } }, "VolumeBaselineIOPS": { "type": "integer" }, "VolumeBaselineThroughput": { "type": "integer" }, "VolumeBurstIOPS": { "type": "integer" }, "VolumeBurstThroughput": { "type": "integer" }, "VolumeConfiguration": { "type": "structure", "members": { "volumeType": { "shape": "VolumeType", "documentation": "

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.

" }, "volumeSize": { "shape": "VolumeSize", "documentation": "

The size of the volume, in GiB.

" }, "volumeBaselineIOPS": { "shape": "VolumeBaselineIOPS", "documentation": "

The baseline IOPS of the volume.

" }, "volumeBurstIOPS": { "shape": "VolumeBurstIOPS", "documentation": "

The burst IOPS of the volume.

" }, "volumeBaselineThroughput": { "shape": "VolumeBaselineThroughput", "documentation": "

The baseline throughput of the volume.

" }, "volumeBurstThroughput": { "shape": "VolumeBurstThroughput", "documentation": "

The burst throughput of the volume.

" }, "rootVolume": { "shape": "RootVolume", "documentation": "

Contains the image used to boot the instance during launch.

" } }, "documentation": "

Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.

" }, "VolumeRecommendation": { "type": "structure", "members": { "volumeArn": { "shape": "VolumeArn", "documentation": "

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

" }, "accountId": { "shape": "AccountId", "documentation": "

The Amazon Web Services account ID of the volume.

" }, "currentConfiguration": { "shape": "VolumeConfiguration", "documentation": "

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

" }, "finding": { "shape": "EBSFinding", "documentation": "

The finding classification of the volume.

Findings for volumes include:

" }, "utilizationMetrics": { "shape": "EBSUtilizationMetrics", "documentation": "

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

" }, "lookBackPeriodInDays": { "shape": "LookBackPeriodInDays", "documentation": "

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

" }, "volumeRecommendationOptions": { "shape": "VolumeRecommendationOptions", "documentation": "

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

" }, "lastRefreshTimestamp": { "shape": "LastRefreshTimestamp", "documentation": "

The timestamp of when the volume recommendation was last generated.

" }, "currentPerformanceRisk": { "shape": "CurrentPerformanceRisk", "documentation": "

The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.

" }, "tags": { "shape": "Tags", "documentation": "

A list of tags assigned to your Amazon EBS volume recommendations.

" }, "effectiveRecommendationPreferences": { "shape": "EBSEffectiveRecommendationPreferences", "documentation": "

Describes the effective recommendation preferences for Amazon EBS volume.

" } }, "documentation": "

Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.

" }, "VolumeRecommendationOption": { "type": "structure", "members": { "configuration": { "shape": "VolumeConfiguration", "documentation": "

An array of objects that describe a volume configuration.

" }, "performanceRisk": { "shape": "PerformanceRisk", "documentation": "

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.

" }, "rank": { "shape": "Rank", "documentation": "

The rank of the volume recommendation option.

The top recommendation option is ranked as 1.

" }, "savingsOpportunity": { "shape": "SavingsOpportunity", "documentation": "

An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

" }, "savingsOpportunityAfterDiscounts": { "shape": "EBSSavingsOpportunityAfterDiscounts", "documentation": "

An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage.

" } }, "documentation": "

Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.

" }, "VolumeRecommendationOptions": { "type": "list", "member": { "shape": "VolumeRecommendationOption" } }, "VolumeRecommendations": { "type": "list", "member": { "shape": "VolumeRecommendation" } }, "VolumeSize": { "type": "integer" }, "VolumeType": { "type": "string" } }, "documentation": "

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.

" }