openapi: 3.0.0 info: version: '2019-11-01' x-release: v4 title: AWS Compute Optimizer description: '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.' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: compute-optimizer x-aws-signingName: compute-optimizer x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/compute-optimizer-2019-11-01.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/compute-optimizer/' servers: - url: 'http://compute-optimizer.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Compute Optimizer multi-region endpoint - url: 'https://compute-optimizer.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Compute Optimizer multi-region endpoint - url: 'http://compute-optimizer.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Compute Optimizer endpoint for China (Beijing) and China (Ningxia) - url: 'https://compute-optimizer.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Compute Optimizer endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=ComputeOptimizerService.DeleteRecommendationPreferences: post: operationId: DeleteRecommendationPreferences description: '
Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteRecommendationPreferencesResponse' examples: DeleteRecommendationPreferences200Example: summary: Default DeleteRecommendationPreferences 200 x-microcks-default: true value: {} '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: DeleteRecommendationPreferences480Example: summary: Default DeleteRecommendationPreferences 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteRecommendationPreferences481Example: summary: Default DeleteRecommendationPreferences 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteRecommendationPreferences482Example: summary: Default DeleteRecommendationPreferences 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeleteRecommendationPreferences483Example: summary: Default DeleteRecommendationPreferences 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: DeleteRecommendationPreferences484Example: summary: Default DeleteRecommendationPreferences 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteRecommendationPreferences485Example: summary: Default DeleteRecommendationPreferences 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: DeleteRecommendationPreferences486Example: summary: Default DeleteRecommendationPreferences 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DeleteRecommendationPreferences487Example: summary: Default DeleteRecommendationPreferences 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteRecommendationPreferencesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.DeleteRecommendationPreferences summary: Amazon Compute Optimizer Delete Recommendation Preferences x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.DescribeRecommendationExportJobs: post: operationId: DescribeRecommendationExportJobs description: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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRecommendationExportJobsResponse' examples: DescribeRecommendationExportJobs200Example: summary: Default DescribeRecommendationExportJobs 200 x-microcks-default: true value: recommendationExportJobs: example nextToken: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: DescribeRecommendationExportJobs480Example: summary: Default DescribeRecommendationExportJobs 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DescribeRecommendationExportJobs481Example: summary: Default DescribeRecommendationExportJobs 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeRecommendationExportJobs482Example: summary: Default DescribeRecommendationExportJobs 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DescribeRecommendationExportJobs483Example: summary: Default DescribeRecommendationExportJobs 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: DescribeRecommendationExportJobs484Example: summary: Default DescribeRecommendationExportJobs 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeRecommendationExportJobs485Example: summary: Default DescribeRecommendationExportJobs 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: DescribeRecommendationExportJobs486Example: summary: Default DescribeRecommendationExportJobs 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DescribeRecommendationExportJobs487Example: summary: Default DescribeRecommendationExportJobs 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeRecommendationExportJobsRequest' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.DescribeRecommendationExportJobs summary: Amazon Compute Optimizer Describe Recommendation Export Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.ExportAutoScalingGroupRecommendations: post: operationId: ExportAutoScalingGroupRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportAutoScalingGroupRecommendationsResponse' examples: ExportAutoScalingGroupRecommendations200Example: summary: Default ExportAutoScalingGroupRecommendations 200 x-microcks-default: true value: jobId: example s3Destination: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: ExportAutoScalingGroupRecommendations480Example: summary: Default ExportAutoScalingGroupRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ExportAutoScalingGroupRecommendations481Example: summary: Default ExportAutoScalingGroupRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ExportAutoScalingGroupRecommendations482Example: summary: Default ExportAutoScalingGroupRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ExportAutoScalingGroupRecommendations483Example: summary: Default ExportAutoScalingGroupRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: ExportAutoScalingGroupRecommendations484Example: summary: Default ExportAutoScalingGroupRecommendations 484 x-microcks-default: true value: example '485': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: ExportAutoScalingGroupRecommendations485Example: summary: Default ExportAutoScalingGroupRecommendations 485 x-microcks-default: true value: example '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ExportAutoScalingGroupRecommendations486Example: summary: Default ExportAutoScalingGroupRecommendations 486 x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: ExportAutoScalingGroupRecommendations487Example: summary: Default ExportAutoScalingGroupRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportAutoScalingGroupRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.ExportAutoScalingGroupRecommendations summary: Amazon Compute Optimizer Export Auto Scaling Group Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.ExportEBSVolumeRecommendations: post: operationId: ExportEBSVolumeRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportEBSVolumeRecommendationsResponse' examples: ExportEBSVolumeRecommendations200Example: summary: Default ExportEBSVolumeRecommendations 200 x-microcks-default: true value: jobId: example s3Destination: bucket: {} key: {} metadataKey: {} '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: ExportEBSVolumeRecommendations480Example: summary: Default ExportEBSVolumeRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ExportEBSVolumeRecommendations481Example: summary: Default ExportEBSVolumeRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ExportEBSVolumeRecommendations482Example: summary: Default ExportEBSVolumeRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ExportEBSVolumeRecommendations483Example: summary: Default ExportEBSVolumeRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: ExportEBSVolumeRecommendations484Example: summary: Default ExportEBSVolumeRecommendations 484 x-microcks-default: true value: example '485': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: ExportEBSVolumeRecommendations485Example: summary: Default ExportEBSVolumeRecommendations 485 x-microcks-default: true value: example '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ExportEBSVolumeRecommendations486Example: summary: Default ExportEBSVolumeRecommendations 486 x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: ExportEBSVolumeRecommendations487Example: summary: Default ExportEBSVolumeRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportEBSVolumeRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.ExportEBSVolumeRecommendations summary: Amazon Compute Optimizer Export E B S Volume Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.ExportEC2InstanceRecommendations: post: operationId: ExportEC2InstanceRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportEC2InstanceRecommendationsResponse' examples: ExportEC2InstanceRecommendations200Example: summary: Default ExportEC2InstanceRecommendations 200 x-microcks-default: true value: jobId: example s3Destination: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: ExportEC2InstanceRecommendations480Example: summary: Default ExportEC2InstanceRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ExportEC2InstanceRecommendations481Example: summary: Default ExportEC2InstanceRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ExportEC2InstanceRecommendations482Example: summary: Default ExportEC2InstanceRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ExportEC2InstanceRecommendations483Example: summary: Default ExportEC2InstanceRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: ExportEC2InstanceRecommendations484Example: summary: Default ExportEC2InstanceRecommendations 484 x-microcks-default: true value: example '485': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: ExportEC2InstanceRecommendations485Example: summary: Default ExportEC2InstanceRecommendations 485 x-microcks-default: true value: example '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ExportEC2InstanceRecommendations486Example: summary: Default ExportEC2InstanceRecommendations 486 x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: ExportEC2InstanceRecommendations487Example: summary: Default ExportEC2InstanceRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportEC2InstanceRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.ExportEC2InstanceRecommendations summary: Amazon Compute Optimizer Export E C2 Instance Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.ExportECSServiceRecommendations: post: operationId: ExportECSServiceRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportECSServiceRecommendationsResponse' examples: ExportECSServiceRecommendations200Example: summary: Default ExportECSServiceRecommendations 200 x-microcks-default: true value: jobId: example s3Destination: bucket: {} key: {} metadataKey: {} '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: ExportECSServiceRecommendations480Example: summary: Default ExportECSServiceRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ExportECSServiceRecommendations481Example: summary: Default ExportECSServiceRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ExportECSServiceRecommendations482Example: summary: Default ExportECSServiceRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ExportECSServiceRecommendations483Example: summary: Default ExportECSServiceRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: ExportECSServiceRecommendations484Example: summary: Default ExportECSServiceRecommendations 484 x-microcks-default: true value: example '485': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: ExportECSServiceRecommendations485Example: summary: Default ExportECSServiceRecommendations 485 x-microcks-default: true value: example '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ExportECSServiceRecommendations486Example: summary: Default ExportECSServiceRecommendations 486 x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: ExportECSServiceRecommendations487Example: summary: Default ExportECSServiceRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportECSServiceRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.ExportECSServiceRecommendations summary: Amazon Compute Optimizer Export E C S Service Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.ExportLambdaFunctionRecommendations: post: operationId: ExportLambdaFunctionRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ExportLambdaFunctionRecommendationsResponse' examples: ExportLambdaFunctionRecommendations200Example: summary: Default ExportLambdaFunctionRecommendations 200 x-microcks-default: true value: jobId: example s3Destination: bucket: {} key: {} metadataKey: {} '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: ExportLambdaFunctionRecommendations480Example: summary: Default ExportLambdaFunctionRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ExportLambdaFunctionRecommendations481Example: summary: Default ExportLambdaFunctionRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ExportLambdaFunctionRecommendations482Example: summary: Default ExportLambdaFunctionRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ExportLambdaFunctionRecommendations483Example: summary: Default ExportLambdaFunctionRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: ExportLambdaFunctionRecommendations484Example: summary: Default ExportLambdaFunctionRecommendations 484 x-microcks-default: true value: example '485': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: ExportLambdaFunctionRecommendations485Example: summary: Default ExportLambdaFunctionRecommendations 485 x-microcks-default: true value: example '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ExportLambdaFunctionRecommendations486Example: summary: Default ExportLambdaFunctionRecommendations 486 x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: ExportLambdaFunctionRecommendations487Example: summary: Default ExportLambdaFunctionRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportLambdaFunctionRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.ExportLambdaFunctionRecommendations summary: Amazon Compute Optimizer Export Lambda Function Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetAutoScalingGroupRecommendations: post: operationId: GetAutoScalingGroupRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAutoScalingGroupRecommendationsResponse' examples: GetAutoScalingGroupRecommendations200Example: summary: Default GetAutoScalingGroupRecommendations 200 x-microcks-default: true value: nextToken: example autoScalingGroupRecommendations: example errors: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetAutoScalingGroupRecommendations480Example: summary: Default GetAutoScalingGroupRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetAutoScalingGroupRecommendations481Example: summary: Default GetAutoScalingGroupRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetAutoScalingGroupRecommendations482Example: summary: Default GetAutoScalingGroupRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetAutoScalingGroupRecommendations483Example: summary: Default GetAutoScalingGroupRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetAutoScalingGroupRecommendations484Example: summary: Default GetAutoScalingGroupRecommendations 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetAutoScalingGroupRecommendations485Example: summary: Default GetAutoScalingGroupRecommendations 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetAutoScalingGroupRecommendations486Example: summary: Default GetAutoScalingGroupRecommendations 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetAutoScalingGroupRecommendations487Example: summary: Default GetAutoScalingGroupRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetAutoScalingGroupRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetAutoScalingGroupRecommendations summary: Amazon Compute Optimizer Get Auto Scaling Group Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetEBSVolumeRecommendations: post: operationId: GetEBSVolumeRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEBSVolumeRecommendationsResponse' examples: GetEBSVolumeRecommendations200Example: summary: Default GetEBSVolumeRecommendations 200 x-microcks-default: true value: nextToken: example volumeRecommendations: example errors: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetEBSVolumeRecommendations480Example: summary: Default GetEBSVolumeRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetEBSVolumeRecommendations481Example: summary: Default GetEBSVolumeRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetEBSVolumeRecommendations482Example: summary: Default GetEBSVolumeRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetEBSVolumeRecommendations483Example: summary: Default GetEBSVolumeRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetEBSVolumeRecommendations484Example: summary: Default GetEBSVolumeRecommendations 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetEBSVolumeRecommendations485Example: summary: Default GetEBSVolumeRecommendations 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetEBSVolumeRecommendations486Example: summary: Default GetEBSVolumeRecommendations 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetEBSVolumeRecommendations487Example: summary: Default GetEBSVolumeRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetEBSVolumeRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetEBSVolumeRecommendations summary: Amazon Compute Optimizer Get E B S Volume Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetEC2InstanceRecommendations: post: operationId: GetEC2InstanceRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEC2InstanceRecommendationsResponse' examples: GetEC2InstanceRecommendations200Example: summary: Default GetEC2InstanceRecommendations 200 x-microcks-default: true value: nextToken: example instanceRecommendations: example errors: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetEC2InstanceRecommendations480Example: summary: Default GetEC2InstanceRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetEC2InstanceRecommendations481Example: summary: Default GetEC2InstanceRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetEC2InstanceRecommendations482Example: summary: Default GetEC2InstanceRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetEC2InstanceRecommendations483Example: summary: Default GetEC2InstanceRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetEC2InstanceRecommendations484Example: summary: Default GetEC2InstanceRecommendations 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetEC2InstanceRecommendations485Example: summary: Default GetEC2InstanceRecommendations 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetEC2InstanceRecommendations486Example: summary: Default GetEC2InstanceRecommendations 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetEC2InstanceRecommendations487Example: summary: Default GetEC2InstanceRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetEC2InstanceRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetEC2InstanceRecommendations summary: Amazon Compute Optimizer Get E C2 Instance Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetEC2RecommendationProjectedMetrics: post: operationId: GetEC2RecommendationProjectedMetrics description: '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.
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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetECSServiceRecommendationsResponse' examples: GetECSServiceRecommendations200Example: summary: Default GetECSServiceRecommendations 200 x-microcks-default: true value: nextToken: example ecsServiceRecommendations: example errors: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetECSServiceRecommendations480Example: summary: Default GetECSServiceRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetECSServiceRecommendations481Example: summary: Default GetECSServiceRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetECSServiceRecommendations482Example: summary: Default GetECSServiceRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetECSServiceRecommendations483Example: summary: Default GetECSServiceRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetECSServiceRecommendations484Example: summary: Default GetECSServiceRecommendations 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetECSServiceRecommendations485Example: summary: Default GetECSServiceRecommendations 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetECSServiceRecommendations486Example: summary: Default GetECSServiceRecommendations 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetECSServiceRecommendations487Example: summary: Default GetECSServiceRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetECSServiceRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetECSServiceRecommendations summary: Amazon Compute Optimizer Get E C S Service Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetEffectiveRecommendationPreferences: post: operationId: GetEffectiveRecommendationPreferences description: '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.
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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEnrollmentStatusResponse' examples: GetEnrollmentStatus200Example: summary: Default GetEnrollmentStatus 200 x-microcks-default: true value: status: example statusReason: example memberAccountsEnrolled: example lastUpdatedTimestamp: example numberOfMemberAccountsOptedIn: example '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetEnrollmentStatus480Example: summary: Default GetEnrollmentStatus 480 x-microcks-default: true value: example '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetEnrollmentStatus481Example: summary: Default GetEnrollmentStatus 481 x-microcks-default: true value: example '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetEnrollmentStatus482Example: summary: Default GetEnrollmentStatus 482 x-microcks-default: true value: example '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetEnrollmentStatus483Example: summary: Default GetEnrollmentStatus 483 x-microcks-default: true value: example '484': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetEnrollmentStatus484Example: summary: Default GetEnrollmentStatus 484 x-microcks-default: true value: example '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetEnrollmentStatus485Example: summary: Default GetEnrollmentStatus 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetEnrollmentStatusRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetEnrollmentStatus summary: Amazon Compute Optimizer Get Enrollment Status x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetEnrollmentStatusesForOrganization: post: operationId: GetEnrollmentStatusesForOrganization description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEnrollmentStatusesForOrganizationResponse' examples: GetEnrollmentStatusesForOrganization200Example: summary: Default GetEnrollmentStatusesForOrganization 200 x-microcks-default: true value: accountEnrollmentStatuses: example nextToken: example '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetEnrollmentStatusesForOrganization480Example: summary: Default GetEnrollmentStatusesForOrganization 480 x-microcks-default: true value: example '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetEnrollmentStatusesForOrganization481Example: summary: Default GetEnrollmentStatusesForOrganization 481 x-microcks-default: true value: example '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetEnrollmentStatusesForOrganization482Example: summary: Default GetEnrollmentStatusesForOrganization 482 x-microcks-default: true value: example '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetEnrollmentStatusesForOrganization483Example: summary: Default GetEnrollmentStatusesForOrganization 483 x-microcks-default: true value: example '484': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetEnrollmentStatusesForOrganization484Example: summary: Default GetEnrollmentStatusesForOrganization 484 x-microcks-default: true value: example '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetEnrollmentStatusesForOrganization485Example: summary: Default GetEnrollmentStatusesForOrganization 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetEnrollmentStatusesForOrganizationRequest' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetEnrollmentStatusesForOrganization summary: Amazon Compute Optimizer Get Enrollment Statuses for Organization x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetLambdaFunctionRecommendations: post: operationId: GetLambdaFunctionRecommendations description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetLambdaFunctionRecommendationsResponse' examples: GetLambdaFunctionRecommendations200Example: summary: Default GetLambdaFunctionRecommendations 200 x-microcks-default: true value: nextToken: example lambdaFunctionRecommendations: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetLambdaFunctionRecommendations480Example: summary: Default GetLambdaFunctionRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetLambdaFunctionRecommendations481Example: summary: Default GetLambdaFunctionRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetLambdaFunctionRecommendations482Example: summary: Default GetLambdaFunctionRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetLambdaFunctionRecommendations483Example: summary: Default GetLambdaFunctionRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetLambdaFunctionRecommendations484Example: summary: Default GetLambdaFunctionRecommendations 484 x-microcks-default: true value: example '485': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetLambdaFunctionRecommendations485Example: summary: Default GetLambdaFunctionRecommendations 485 x-microcks-default: true value: example '486': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetLambdaFunctionRecommendations486Example: summary: Default GetLambdaFunctionRecommendations 486 x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: GetLambdaFunctionRecommendations487Example: summary: Default GetLambdaFunctionRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetLambdaFunctionRecommendationsRequest' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetLambdaFunctionRecommendations summary: Amazon Compute Optimizer Get Lambda Function Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetRecommendationPreferences: post: operationId: GetRecommendationPreferences description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetRecommendationPreferencesResponse' examples: GetRecommendationPreferences200Example: summary: Default GetRecommendationPreferences 200 x-microcks-default: true value: nextToken: example recommendationPreferencesDetails: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetRecommendationPreferences480Example: summary: Default GetRecommendationPreferences 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetRecommendationPreferences481Example: summary: Default GetRecommendationPreferences 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetRecommendationPreferences482Example: summary: Default GetRecommendationPreferences 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetRecommendationPreferences483Example: summary: Default GetRecommendationPreferences 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetRecommendationPreferences484Example: summary: Default GetRecommendationPreferences 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetRecommendationPreferences485Example: summary: Default GetRecommendationPreferences 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetRecommendationPreferences486Example: summary: Default GetRecommendationPreferences 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetRecommendationPreferences487Example: summary: Default GetRecommendationPreferences 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetRecommendationPreferencesRequest' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetRecommendationPreferences summary: Amazon Compute Optimizer Get Recommendation Preferences x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.GetRecommendationSummaries: post: operationId: GetRecommendationSummaries description: 'Returns the optimization findings for an account.
It returns the number of:
Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned,
or Optimized.
Auto Scaling groups in an account that are NotOptimized, or Optimized.
Amazon EBS volumes in an account that
are NotOptimized, or Optimized.
Lambda functions in an account that are NotOptimized, or Optimized.
Amazon
ECS services in an account that are Underprovisioned, Overprovisioned, or Optimized.
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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutRecommendationPreferencesResponse' examples: PutRecommendationPreferences200Example: summary: Default PutRecommendationPreferences 200 x-microcks-default: true value: {} '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: PutRecommendationPreferences480Example: summary: Default PutRecommendationPreferences 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: PutRecommendationPreferences481Example: summary: Default PutRecommendationPreferences 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: PutRecommendationPreferences482Example: summary: Default PutRecommendationPreferences 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: PutRecommendationPreferences483Example: summary: Default PutRecommendationPreferences 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: PutRecommendationPreferences484Example: summary: Default PutRecommendationPreferences 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: PutRecommendationPreferences485Example: summary: Default PutRecommendationPreferences 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: PutRecommendationPreferences486Example: summary: Default PutRecommendationPreferences 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: PutRecommendationPreferences487Example: summary: Default PutRecommendationPreferences 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PutRecommendationPreferencesRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.PutRecommendationPreferences summary: Amazon Compute Optimizer Put Recommendation Preferences x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=ComputeOptimizerService.UpdateEnrollmentStatus: post: operationId: UpdateEnrollmentStatus description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEnrollmentStatusResponse' examples: UpdateEnrollmentStatus200Example: summary: Default UpdateEnrollmentStatus 200 x-microcks-default: true value: status: example statusReason: example '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UpdateEnrollmentStatus480Example: summary: Default UpdateEnrollmentStatus 480 x-microcks-default: true value: example '481': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateEnrollmentStatus481Example: summary: Default UpdateEnrollmentStatus 481 x-microcks-default: true value: example '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdateEnrollmentStatus482Example: summary: Default UpdateEnrollmentStatus 482 x-microcks-default: true value: example '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: UpdateEnrollmentStatus483Example: summary: Default UpdateEnrollmentStatus 483 x-microcks-default: true value: example '484': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: UpdateEnrollmentStatus484Example: summary: Default UpdateEnrollmentStatus 484 x-microcks-default: true value: example '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: UpdateEnrollmentStatus485Example: summary: Default UpdateEnrollmentStatus 485 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEnrollmentStatusRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.UpdateEnrollmentStatus summary: Amazon Compute Optimizer Update Enrollment Status x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: DeleteRecommendationPreferencesResponse: type: object properties: {} DeleteRecommendationPreferencesRequest: type: object required: - resourceType - recommendationPreferenceNames title: DeleteRecommendationPreferencesRequest properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: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.
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: allOf: - $ref: '#/components/schemas/RecommendationPreferenceNames' - description: The name of the recommendation preference to delete. OptInRequiredException: {} InternalServerException: {} ServiceUnavailableException: {} AccessDeniedException: {} InvalidParameterValueException: {} ResourceNotFoundException: {} MissingAuthenticationToken: {} ThrottlingException: {} DescribeRecommendationExportJobsResponse: type: object properties: recommendationExportJobs: allOf: - $ref: '#/components/schemas/RecommendationExportJobs' - description: An array of objects that describe recommendation export jobs. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: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.
DescribeRecommendationExportJobsRequest: type: object title: DescribeRecommendationExportJobsRequest properties: jobIds: allOf: - $ref: '#/components/schemas/JobIds' - description: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: allOf: - $ref: '#/components/schemas/JobFilters' - description: An array of objects to specify a filter that returns a more specific list of export jobs. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of export jobs. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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: allOf: - $ref: '#/components/schemas/S3Destination' - description: An object that describes the destination Amazon S3 bucket of a recommendations export file. ExportAutoScalingGroupRecommendationsRequest: type: object required: - s3DestinationConfig title: ExportAutoScalingGroupRecommendationsRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/Filters' - description: An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations. fieldsToExport: allOf: - $ref: '#/components/schemas/ExportableAutoScalingGroupFields' - description: '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: allOf: - $ref: '#/components/schemas/S3DestinationConfig' - description: '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: allOf: - $ref: '#/components/schemas/FileFormat' - description:The format of the export file.
The only export file format currently supported is Csv.
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: allOf: - $ref: '#/components/schemas/RecommendationPreferences' - description: An object to specify the preferences for the Auto Scaling group recommendations to export. LimitExceededException: {} ExportEBSVolumeRecommendationsResponse: type: object properties: jobId: allOf: - $ref: '#/components/schemas/JobId' - description: '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: $ref: '#/components/schemas/S3Destination' ExportEBSVolumeRecommendationsRequest: type: object required: - s3DestinationConfig title: ExportEBSVolumeRecommendationsRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/EBSFilters' - description: An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations. fieldsToExport: allOf: - $ref: '#/components/schemas/ExportableVolumeFields' - description: '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: $ref: '#/components/schemas/S3DestinationConfig' fileFormat: allOf: - $ref: '#/components/schemas/FileFormat' - description:The format of the export file.
The only export file format currently supported is Csv.
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.
' ExportEC2InstanceRecommendationsResponse: type: object properties: jobId: allOf: - $ref: '#/components/schemas/JobId' - description: '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: allOf: - $ref: '#/components/schemas/S3Destination' - description: An object that describes the destination Amazon S3 bucket of a recommendations export file. ExportEC2InstanceRecommendationsRequest: type: object required: - s3DestinationConfig title: ExportEC2InstanceRecommendationsRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/Filters' - description: An array of objects to specify a filter that exports a more specific set of instance recommendations. fieldsToExport: allOf: - $ref: '#/components/schemas/ExportableInstanceFields' - description: '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: allOf: - $ref: '#/components/schemas/S3DestinationConfig' - description: '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: allOf: - $ref: '#/components/schemas/FileFormat' - description:The format of the export file.
The only export file format currently supported is Csv.
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: allOf: - $ref: '#/components/schemas/RecommendationPreferences' - description: An object to specify the preferences for the Amazon EC2 instance recommendations to export. ExportECSServiceRecommendationsResponse: type: object properties: jobId: allOf: - $ref: '#/components/schemas/JobId' - description: '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: $ref: '#/components/schemas/S3Destination' ExportECSServiceRecommendationsRequest: type: object required: - s3DestinationConfig title: ExportECSServiceRecommendationsRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/ECSServiceRecommendationFilters' - description: ' An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations. ' fieldsToExport: allOf: - $ref: '#/components/schemas/ExportableECSServiceFields' - description: '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: $ref: '#/components/schemas/S3DestinationConfig' fileFormat: allOf: - $ref: '#/components/schemas/FileFormat' - description:The format of the export file.
The CSV file is the only export file format currently supported.
includeMemberAccounts: allOf: - $ref: '#/components/schemas/IncludeMemberAccounts' - description: '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.
' ExportLambdaFunctionRecommendationsResponse: type: object properties: jobId: allOf: - $ref: '#/components/schemas/JobId' - description: '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: $ref: '#/components/schemas/S3Destination' ExportLambdaFunctionRecommendationsRequest: type: object required: - s3DestinationConfig title: ExportLambdaFunctionRecommendationsRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/LambdaFunctionRecommendationFilters' - description: An array of objects to specify a filter that exports a more specific set of Lambda function recommendations. fieldsToExport: allOf: - $ref: '#/components/schemas/ExportableLambdaFunctionFields' - description: '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: $ref: '#/components/schemas/S3DestinationConfig' fileFormat: allOf: - $ref: '#/components/schemas/FileFormat' - description:The format of the export file.
The only export file format currently supported is Csv.
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.
' GetAutoScalingGroupRecommendationsResponse: type: object properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: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: allOf: - $ref: '#/components/schemas/AutoScalingGroupRecommendations' - description: An array of objects that describe Auto Scaling group recommendations. errors: allOf: - $ref: '#/components/schemas/GetRecommendationErrors' - description: '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.
' GetAutoScalingGroupRecommendationsRequest: type: object title: GetAutoScalingGroupRecommendationsRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/AutoScalingGroupArns' - description: The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of Auto Scaling group recommendations. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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: allOf: - $ref: '#/components/schemas/VolumeRecommendations' - description: An array of objects that describe volume recommendations. errors: allOf: - $ref: '#/components/schemas/GetRecommendationErrors' - description: 'An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported volume.
' GetEBSVolumeRecommendationsRequest: type: object title: GetEBSVolumeRecommendationsRequest properties: volumeArns: allOf: - $ref: '#/components/schemas/VolumeArns' - description: The Amazon Resource Name (ARN) of the volumes for which to return recommendations. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of volume recommendations. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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.
' GetEC2InstanceRecommendationsResponse: type: object properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: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: allOf: - $ref: '#/components/schemas/InstanceRecommendations' - description: An array of objects that describe instance recommendations. errors: allOf: - $ref: '#/components/schemas/GetRecommendationErrors' - description: '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.
' GetEC2InstanceRecommendationsRequest: type: object title: GetEC2InstanceRecommendationsRequest properties: instanceArns: allOf: - $ref: '#/components/schemas/InstanceArns' - description: The Amazon Resource Name (ARN) of the instances for which to return recommendations. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of instance recommendations. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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: allOf: - $ref: '#/components/schemas/RecommendationPreferences' - description: An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response. GetEC2RecommendationProjectedMetricsResponse: type: object properties: recommendedOptionProjectedMetrics: allOf: - $ref: '#/components/schemas/RecommendedOptionProjectedMetrics' - description: An array of objects that describes projected metrics. GetEC2RecommendationProjectedMetricsRequest: type: object required: - instanceArn - stat - period - startTime - endTime title: GetEC2RecommendationProjectedMetricsRequest properties: instanceArn: allOf: - $ref: '#/components/schemas/InstanceArn' - description: The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics. stat: allOf: - $ref: '#/components/schemas/MetricStatistic' - description: The statistic of the projected metrics. period: allOf: - $ref: '#/components/schemas/Period' - description: 'The granularity, in seconds, of the projected metrics data points.' startTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of the first projected metrics data point to return. endTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of the last projected metrics data point to return. recommendationPreferences: allOf: - $ref: '#/components/schemas/RecommendationPreferences' - description: An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response. GetECSServiceRecommendationProjectedMetricsResponse: type: object properties: recommendedOptionProjectedMetrics: allOf: - $ref: '#/components/schemas/ECSServiceRecommendedOptionProjectedMetrics' - description: ' An array of objects that describes the projected metrics. ' GetECSServiceRecommendationProjectedMetricsRequest: type: object required: - serviceArn - stat - period - startTime - endTime title: GetECSServiceRecommendationProjectedMetricsRequest properties: serviceArn: allOf: - $ref: '#/components/schemas/ServiceArn' - description: '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
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
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.
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.
' GetEffectiveRecommendationPreferencesResponse: type: object properties: enhancedInfrastructureMetrics: allOf: - $ref: '#/components/schemas/EnhancedInfrastructureMetrics' - description: '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: allOf: - $ref: '#/components/schemas/ExternalMetricsPreference' - description: '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.
' GetEffectiveRecommendationPreferencesRequest: type: object required: - resourceArn title: GetEffectiveRecommendationPreferencesRequest properties: resourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: 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. GetEnrollmentStatusResponse: type: object properties: status: allOf: - $ref: '#/components/schemas/Status' - description: The enrollment status of the account. statusReason: allOf: - $ref: '#/components/schemas/StatusReason' - description: '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.
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.
GetEnrollmentStatusesForOrganizationRequest: type: object title: GetEnrollmentStatusesForOrganizationRequest properties: filters: allOf: - $ref: '#/components/schemas/EnrollmentFilters' - description: An array of objects to specify a filter that returns a more specific list of account enrollment statuses. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of account enrollment statuses. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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: allOf: - $ref: '#/components/schemas/LambdaFunctionRecommendations' - description: An array of objects that describe function recommendations. GetLambdaFunctionRecommendationsRequest: type: object title: GetLambdaFunctionRecommendationsRequest properties: functionArns: allOf: - $ref: '#/components/schemas/FunctionArns' - description: '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.
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: allOf: - $ref: '#/components/schemas/LambdaFunctionRecommendationFilters' - description: An array of objects to specify a filter that returns a more specific list of function recommendations. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of function recommendations. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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: allOf: - $ref: '#/components/schemas/RecommendationPreferencesDetails' - description: An array of objects that describe recommendation preferences. GetRecommendationPreferencesRequest: type: object required: - resourceType title: GetRecommendationPreferencesRequest properties: resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: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.
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: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of recommendation preferences. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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: allOf: - $ref: '#/components/schemas/RecommendationSummaries' - description: An array of objects that summarize a recommendation. GetRecommendationSummariesRequest: type: object title: GetRecommendationSummariesRequest properties: accountIds: allOf: - $ref: '#/components/schemas/AccountIds' - description: '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: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to advance to the next page of recommendation summaries. maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: '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.
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.
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.
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: allOf: - $ref: '#/components/schemas/InferredWorkloadTypesPreference' - description: '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: allOf: - $ref: '#/components/schemas/ExternalMetricsPreference' - description: '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.
' UpdateEnrollmentStatusResponse: type: object properties: status: allOf: - $ref: '#/components/schemas/Status' - description: The enrollment status of the account. statusReason: allOf: - $ref: '#/components/schemas/StatusReason' - description: 'The reason for the enrollment status of the account. For example, an account might show a status ofPending because member accounts of an organization require more
time to be enrolled in the service.'
UpdateEnrollmentStatusRequest:
type: object
required:
- status
title: UpdateEnrollmentStatusRequest
properties:
status:
allOf:
- $ref: '#/components/schemas/Status'
- description: 'The new enrollment status of the account.
The following status options are available:
Active - Opts in your account to the Compute Optimizer
service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics
analyzed by Compute Optimizer in the Compute Optimizer User Guide.
Inactive - Opts out your account from the Compute Optimizer service. Your account''s
recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.
The Pending and Failed options cannot
be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.
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.
Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.
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: allOf: - $ref: '#/components/schemas/InferredWorkloadTypesPreference' - description: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.
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.
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
NotOptimized —An Auto Scaling group
is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An
Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources,
Compute Optimizer might recommend a new generation instance type.
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:
AmazonEmr - Infers that Amazon EMR might be running on the instances.
ApacheCassandra
- Infers that Apache Cassandra might be running on the instances.
ApacheHadoop - Infers that Apache Hadoop might be running on the instances.
Memcached - Infers that Memcached might be running on the instances.
NGINX - Infers that NGINX might be running on the instances.
PostgreSql - Infers that PostgreSQL might be running on the instances.
Redis - Infers that Redis might be running on the instances.
Kafka - Infers that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
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.
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.
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.
The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as 1.
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.
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.
The name of the scope.
The following scopes are possible:
Organization - Specifies that the recommendation preference applies at the organization
level, for all member accounts of an organization.
AccountId - Specifies that the recommendation preference applies at the account level, for all resources
of a given resource type in an account.
ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
The value of the scope.
If you specified the name of the scope as:
Organization - The value must be ALL_ACCOUNTS.
AccountId - The value must be a 12-digit Amazon Web Services account ID.
ResourceArn - The value must
be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.
Only EC2 instance and Auto Scaling group ARNs are currently supported.
' description: '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.
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.
The value of the filter.
The valid values are Optimized, or NotOptimized.
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.
The name of the utilization metric.
The following utilization metrics are available:
VolumeReadOpsPerSecond - The completed read operations
per second from the volume in a specified period of time.
Unit: Count
VolumeWriteOpsPerSecond - The completed write operations per second to the volume
in a specified period of time.
Unit: Count
VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
Unit: Bytes
VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
Unit: Bytes
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.
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: array items: $ref: '#/components/schemas/EBSUtilizationMetric' ECSServiceLaunchType: type: string enum: - EC2 - Fargate ECSServiceMetricName: type: string enum: - Cpu - Memory ECSServiceMetricStatistic: type: string enum: - Maximum - Average Timestamps: type: array items: $ref: '#/components/schemas/Timestamp' MetricValues: type: array items: $ref: '#/components/schemas/MetricValue' ECSServiceProjectedMetric: type: object properties: name: allOf: - $ref: '#/components/schemas/ECSServiceMetricName' - description: 'The name of the projected metric.
The following metrics are available:
Cpu — The percentage of allocated compute units that are currently
in use on the service tasks.
Memory — The percentage of memory that''s currently in use on the service tasks.
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: array items: $ref: '#/components/schemas/ECSServiceProjectedMetric' LowerBoundValue: type: number format: double UpperBoundValue: type: number format: double ECSServiceProjectedUtilizationMetric: type: object properties: name: allOf: - $ref: '#/components/schemas/ECSServiceMetricName' - description: 'The name of the projected utilization metric.
The following utilization metrics are available:
Cpu — The percentage of allocated compute
units that are currently in use on the service tasks.
Memory — The percentage of memory that''s currently in use on the service tasks.
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.
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: array items: $ref: '#/components/schemas/ECSServiceProjectedUtilizationMetric' ServiceArn: type: string ServiceConfiguration: type: object properties: memory: allOf: - $ref: '#/components/schemas/NullableMemory' - description: ' The amount of memory used by the tasks in the Amazon ECS service. ' cpu: allOf: - $ref: '#/components/schemas/NullableCpu' - description: ' The number of CPU units used by the tasks in the Amazon ECS service. ' containerConfigurations: allOf: - $ref: '#/components/schemas/ContainerConfigurations' - description: ' The container configurations within a task of an Amazon ECS service. ' autoScalingConfiguration: allOf: - $ref: '#/components/schemas/AutoScalingConfiguration' - description: '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:
TARGET_TRACKING_SCALING_CPU —
If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn''t generate CPU recommendations.
TARGET_TRACKING_SCALING_MEMORY
— If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn''t generate memory recommendations.
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: allOf: - $ref: '#/components/schemas/TaskDefinitionArn' - description: ' The task definition ARN used by the tasks in the Amazon ECS service. ' description: ' The Amazon ECS service configurations used for recommendations. ' ECSServiceUtilizationMetrics: type: array items: $ref: '#/components/schemas/ECSServiceUtilizationMetric' ECSServiceRecommendationFinding: type: string enum: - Optimized - Underprovisioned - Overprovisioned ECSServiceRecommendationFindingReasonCodes: type: array items: $ref: '#/components/schemas/ECSServiceRecommendationFindingReasonCode' ECSServiceRecommendationOptions: type: array items: $ref: '#/components/schemas/ECSServiceRecommendationOption' Tags: type: array items: $ref: '#/components/schemas/Tag' ECSServiceRecommendation: type: object properties: serviceArn: allOf: - $ref: '#/components/schemas/ServiceArn' - description: '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
The launch type the Amazon ECS service is using.
Compute Optimizer only supports the Fargate launch type.
The finding classification of an Amazon ECS service.
Findings for Amazon ECS services include:
Underprovisioned — When Compute
Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.
Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned
service might result in additional infrastructure costs.
Optimized — When both the CPU and memory of your Amazon ECS service meet the performance
requirements of your workload, the service is considered optimized.
The reason for the finding classification of an Amazon ECS service.
Finding reason codes for Amazon ECS services include:
CPUUnderprovisioned
— The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service
during the look-back period.
CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements
of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.
MemoryUnderprovisioned
— The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current
service during the look-back period.
MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance
requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.
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.
The value of the filter.
The valid values for this parameter are as follows:
If you specify the name parameter as Finding,
specify Optimized, NotOptimized, or Unavailable.
If you specify the name parameter as FindingReasonCode,
specify CPUUnderprovisioned, CPUOverprovisioned, MemoryUnderprovisioned, or MemoryOverprovisioned.
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: array items: $ref: '#/components/schemas/ECSServiceRecommendedOptionProjectedMetric' ECSServiceUtilizationMetric: type: object properties: name: allOf: - $ref: '#/components/schemas/ECSServiceMetricName' - description: 'The name of the utilization metric.
The following utilization metrics are available:
Cpu — The amount of CPU capacity that''s used in
the service.
Memory — The amount of memory that''s used in the service.
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.
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.
' EnhancedInfrastructureMetrics: type: string enum: - Active - Inactive InferredWorkloadTypesPreference: type: string enum: - Active - Inactive ExternalMetricsPreference: type: object properties: source: allOf: - $ref: '#/components/schemas/ExternalMetricsSource' - description: ' Contains the source options for external metrics preferences. ' description: ' Describes the external metrics preferences for EC2 rightsizing recommendations. ' EnrollmentFilterName: type: string enum: - Status EnrollmentFilter: type: object properties: name: allOf: - $ref: '#/components/schemas/EnrollmentFilterName' - description: 'The name of the filter.
Specify Status to return accounts with a specific enrollment status (for example, Active).
The value of the filter.
The valid values are Active, Inactive, Pending, and Failed.
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.
' Filters: type: array items: $ref: '#/components/schemas/Filter' ExportableAutoScalingGroupFields: type: array items: $ref: '#/components/schemas/ExportableAutoScalingGroupField' S3DestinationConfig: type: object properties: bucket: allOf: - $ref: '#/components/schemas/DestinationBucket' - description: The name of the Amazon S3 bucket to use as the destination for an export job. keyPrefix: allOf: - $ref: '#/components/schemas/DestinationKeyPrefix' - description: The Amazon S3 bucket prefix for an export job. description: '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.
' FileFormat: type: string enum: - Csv IncludeMemberAccounts: type: boolean RecommendationPreferences: type: object properties: cpuVendorArchitectures: allOf: - $ref: '#/components/schemas/CpuVendorArchitectures' - description: 'Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
' metadataKey: allOf: - $ref: '#/components/schemas/MetadataKey' - description: 'The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
' description: 'Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.' ExportDestination: type: object properties: s3: allOf: - $ref: '#/components/schemas/S3Destination' - description: '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.' description: Describes the destination of the recommendations export and metadata files. ExportableVolumeFields: type: array items: $ref: '#/components/schemas/ExportableVolumeField' ExportableInstanceFields: type: array items: $ref: '#/components/schemas/ExportableInstanceField' ExportableECSServiceFields: type: array items: $ref: '#/components/schemas/ExportableECSServiceField' LambdaFunctionRecommendationFilters: type: array items: $ref: '#/components/schemas/LambdaFunctionRecommendationFilter' ExportableLambdaFunctionFields: type: array items: $ref: '#/components/schemas/ExportableLambdaFunctionField' 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 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 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 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 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 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 ExternalMetricStatus: type: object properties: statusCode: allOf: - $ref: '#/components/schemas/ExternalMetricStatusCode' - description: ' The status code for Compute Optimizer''s integration with an external metrics provider. ' statusReason: allOf: - $ref: '#/components/schemas/ExternalMetricStatusReason' - description: ' The reason for Compute Optimizer''s integration status with your external metric provider. ' description: ' Describes Compute Optimizer''s integration status with your chosen external metric provider. For example, Datadog. ' ExternalMetricsSource: type: string enum: - Datadog - Dynatrace - NewRelic - Instana FailureReason: type: string FilterName: type: string enum: - Finding - FindingReasonCodes - RecommendationSourceType - InferredWorkloadTypes Filter: type: object properties: name: allOf: - $ref: '#/components/schemas/FilterName' - description: '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.
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that
you wish to filter results for:
Specify Optimized or NotOptimized if you specify the name parameter as Finding and you
want to filter results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name
parameter as Finding and you want to filter results for EC2 instances.
Specify Ec2Instance or AutoScalingGroup if you specify the name
parameter as RecommendationSourceType.
Specify one of the following options if you specify the name parameter as FindingReasonCodes:
CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload.
CPUUnderprovisioned — The instance’s CPU configuration doesn''t meet the performance requirements of your workload and there is an alternative instance type that
provides better CPU performance.
MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance
requirements of your workload.
MemoryUnderprovisioned — The instance’s memory configuration doesn''t meet the performance requirements of your workload
and there is an alternative instance type that provides better memory performance.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration
can be sized down while still meeting the performance requirements of your workload.
EBSThroughputUnderprovisioned — The instance’s EBS throughput
configuration doesn''t meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance.
EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn''t meet the performance requirements of your workload and there is an alternative instance type that
provides better EBS IOPS performance.
NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still
meeting the performance requirements of your workload.
NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn''t meet
the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This finding reason happens when the NetworkIn
or NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration
can be sized down while still meeting the performance requirements of your workload.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets
per second) configuration doesn''t meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn''t meet the performance requirements of your workload and there is an alternative instance
type that provides better disk IOPS performance.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while
still meeting the performance requirements of your workload.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn''t
meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance.
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.
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.
' RecommendationPreferencesDetails: type: array items: $ref: '#/components/schemas/RecommendationPreferencesDetail' RecommendationSummaries: type: array items: $ref: '#/components/schemas/RecommendationSummary' InferredWorkloadSaving: type: object properties: inferredWorkloadTypes: allOf: - $ref: '#/components/schemas/InferredWorkloadTypes' - description: '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:
AmazonEmr - Infers that Amazon EMR might be running on the instance.
ApacheCassandra - Infers that Apache Cassandra
might be running on the instance.
ApacheHadoop - Infers that Apache Hadoop might be running on the instance.
Memcached - Infers
that Memcached might be running on the instance.
NGINX - Infers that NGINX might be running on the instance.
PostgreSql - Infers
that PostgreSQL might be running on the instance.
Redis - Infers that Redis might be running on the instance.
Kafka - Infers
that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
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: array
items:
$ref: '#/components/schemas/InferredWorkloadSaving'
InferredWorkloadType:
type: string
enum:
- AmazonEmr
- ApacheCassandra
- ApacheHadoop
- Memcached
- Nginx
- PostgreSql
- Redis
- Kafka
- SQLServer
InstanceName:
type: string
InstanceRecommendationFindingReasonCodes:
type: array
items:
$ref: '#/components/schemas/InstanceRecommendationFindingReasonCode'
RecommendationOptions:
type: array
items:
$ref: '#/components/schemas/InstanceRecommendationOption'
RecommendationSources:
type: array
items:
$ref: '#/components/schemas/RecommendationSource'
InstanceState:
type: string
enum:
- pending
- running
- shutting-down
- terminated
- stopping
- stopped
InstanceRecommendation:
type: object
properties:
instanceArn:
allOf:
- $ref: '#/components/schemas/InstanceArn'
- description: The Amazon Resource Name (ARN) of the current instance.
accountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The Amazon Web Services account ID of the instance.
instanceName:
allOf:
- $ref: '#/components/schemas/InstanceName'
- description: The name of the current instance.
currentInstanceType:
allOf:
- $ref: '#/components/schemas/CurrentInstanceType'
- description: The instance type of the current instance.
finding:
allOf:
- $ref: '#/components/schemas/Finding'
- description: 'The finding classification of the instance.
Findings for instances include:
Underprovisioned —An instance is considered under-provisioned
when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor
application performance.
Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU,
memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary
infrastructure cost.
Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet
the performance requirements of your workload and is not over provisioned. For optimized resources, Compute Optimizer might recommend a new generation instance type.
The reason for the finding classification of the instance.
Finding reason codes for instances include:
CPUOverprovisioned — The
instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of
the current instance during the look-back period.
CPUUnderprovisioned — The instance’s CPU configuration doesn''t meet the performance requirements
of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance
during the look-back period.
MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements
of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
MemoryUnderprovisioned
— The instance’s memory configuration doesn''t meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This
is identified by analyzing the memory utilization metric of the current instance during the look-back period.
Memory utilization is analyzed only for resources that have the
unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with
the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent
namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes
In Use metric in the CWAgent namespace.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can
be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics
of EBS volumes attached to the current instance during the look-back period.
EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration
doesn''t meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadBytes
and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period.
EBSIOPSOverprovisioned — The
instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps
metric of EBS volumes attached to the current instance during the look-back period.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration
doesn''t meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadOps
and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period.
NetworkBandwidthOverprovisioned
— The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn
and NetworkOut metrics of the current instance during the look-back period.
NetworkBandwidthUnderprovisioned — The instance’s network
bandwidth configuration doesn''t meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified
by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn
or NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration
can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics
of the current instance during the look-back period.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn''t
meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn
and NetworkPacketsIn metrics of the current instance during the look-back period.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration
can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the
current instance during the look-back period.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn''t meet the performance requirements
of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps
metrics of the current instance during the look-back period.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized
down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current
instance during the look-back period.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn''t meet the performance requirements
of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes
metrics of the current instance during the look-back period.
For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide.
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:
AmazonEmr - Infers that Amazon EMR might be running on the instance.
ApacheCassandra - Infers that Apache Cassandra
might be running on the instance.
ApacheHadoop - Infers that Apache Hadoop might be running on the instance.
Memcached - Infers
that Memcached might be running on the instance.
NGINX - Infers that NGINX might be running on the instance.
PostgreSql - Infers
that PostgreSQL might be running on the instance.
Redis - Infers that Redis might be running on the instance.
Kafka - Infers
that Kafka might be running on the instance.
SQLServer - Infers that SQLServer might be running on the instance.
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.
Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.
Platform differences include:
Hypervisor — The hypervisor of the recommended instance type is different than
that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between
these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information,
see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux,
or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.
NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended
instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter
(ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking
and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux,
or Networking and storage features and Enhanced
networking on Windows in the Amazon EC2 User Guide for Windows.
StorageInterface — The storage interface of the recommended instance type
is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the
recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking
and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide
for Linux, or Networking and storage features and Amazon
EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.
InstanceStoreAvailability — The recommended instance type does
not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more
information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon
EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking
and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux,
or see Networking and storage features and Amazon
EC2 instance store in the Amazon EC2 User Guide for Windows.
VirtualizationType — The recommended instance type uses the hardware virtual
machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see
Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows
AMI virtualization types in the Amazon EC2 User Guide for Windows.
Architecture — The CPU architecture between the recommended instance
type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86.
Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the
new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.
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.
The rank of the instance recommendation option.
The top recommendation option is ranked as 1.
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.
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).
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Specify
Ec2Instance or AutoScalingGroup if you specify the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations
cannot be exported at this time.
Specify Queued, InProgress, Complete, or Failed if you specify the name
parameter as JobStatus.
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.
The rank of the function recommendation option.
The top recommendation option is ranked as 1.
The finding classification of the function.
Findings for functions include:
Optimized — The function is correctly provisioned
to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
NotOptimized
— The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal.
Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include
the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
Unavailable — Compute Optimizer was unable to
generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding
classification can include the InsufficientData and Inconclusive finding reason codes.
Functions with a finding of unavailable are not returned unless
you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
The reason for the finding classification of the function.
Functions that have a finding classification of Optimized don''t have a finding reason
code.
Finding reason codes for functions include:
MemoryOverprovisioned — The function is over-provisioned when its memory configuration
can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is
part of the NotOptimized finding classification.
MemoryUnderprovisioned — The function is under-provisioned when its memory configuration
doesn''t meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized
finding classification.
InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For
more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
This finding reason code is part of the Unavailable finding classification.
Inconclusive — The function does not qualify for a recommendation
because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
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.
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Specify
Optimized, NotOptimized, or Unavailable if you specify the name parameter as Finding.
Specify MemoryOverprovisioned,
MemoryUnderprovisioned, InsufficientData, or Inconclusive if you specify the name parameter as FindingReasonCode.
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.
The name of the utilization metric.
The following utilization metrics are available:
Duration - The amount of time that your function code
spends processing an event.
Memory - The amount of memory used per invocation.
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.
The name of the projected utilization metric.
The following projected utilization metrics are returned:
Cpu - The projected percentage
of allocated EC2 compute units that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the processing power required
to run an application on the recommendation option.
Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.
Units: Percent
Memory - The percentage of memory that would be in use on the recommendation option had you used that
resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option.
Units: Percent
The Memory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling
Memory Utilization with the CloudWatch Agent.
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 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.
The name of the utilization metric.
The following utilization metrics are available:
Cpu - The percentage of allocated EC2 compute units
that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance.
Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core.
Units: Percent
Memory - The percentage
of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance.
Units: Percent
The Memory
metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling
Memory Utilization with the CloudWatch Agent.
EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance
in a specified period of time.
Unit: Count
EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a
specified period of time.
Unit: Count
EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period
of time.
Unit: Bytes
EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time.
Unit: Bytes
DISK_READ_OPS_PER_SECOND - The completed read operations from all instance store volumes available to the instance in a specified period of time.
If there are no instance store volumes, either the value is 0 or the metric is not reported.
DISK_WRITE_OPS_PER_SECOND - The completed write
operations from all instance store volumes available to the instance in a specified period of time.
If there are no instance store volumes, either the value is 0 or the
metric is not reported.
DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store volumes available to the instance. This metric is used to determine
the volume of the data the application reads from the disk of the instance. This can be used to determine the speed of the application.
If there are no instance store volumes, either
the value is 0 or the metric is not reported.
DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store volumes available to the instance.
This metric is used to determine the volume of the data the application writes onto the disk of the instance. This can be used to determine the speed of the application.
If there are
no instance store volumes, either the value is 0 or the metric is not reported.
NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the
instance on all network interfaces. This metric identifies the volume of incoming network traffic to a single instance.
NETWORK_OUT_BYTES_PER_SECOND - The number
of bytes sent out by the instance on all network interfaces. This metric identifies the volume of outgoing network traffic from a single instance.
NETWORK_PACKETS_IN_PER_SECOND
- The number of packets received by the instance on all network interfaces. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance.
NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the instance on all network interfaces. This metric identifies the volume of outgoing traffic
in terms of the number of packets on a single instance.
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.
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.
' ReasonCodeSummary: type: object properties: name: allOf: - $ref: '#/components/schemas/FindingReasonCode' - description: The name of the finding reason code. value: allOf: - $ref: '#/components/schemas/SummaryValue' - description: The value of the finding reason code summary. description: A summary of a finding reason code. ReasonCodeSummaries: type: array items: $ref: '#/components/schemas/ReasonCodeSummary' SummaryValue: type: number format: double RecommendationExportJob: type: object properties: jobId: allOf: - $ref: '#/components/schemas/JobId' - description: The identification number of the export job. destination: allOf: - $ref: '#/components/schemas/ExportDestination' - description: An object that describes the destination of the export file. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: The resource type of the exported recommendations. status: allOf: - $ref: '#/components/schemas/JobStatus' - description: The status of the export job. creationTimestamp: allOf: - $ref: '#/components/schemas/CreationTimestamp' - description: The timestamp of when the export job was created. lastUpdatedTimestamp: allOf: - $ref: '#/components/schemas/LastUpdatedTimestamp' - description: The timestamp of when the export job was last updated. failureReason: allOf: - $ref: '#/components/schemas/FailureReason' - description: The reason for an export job failure. description: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.
RecommendationPreferenceName: type: string enum: - EnhancedInfrastructureMetrics - InferredWorkloadTypes - ExternalMetricsPreference RecommendationPreferencesDetail: type: object properties: scope: allOf: - $ref: '#/components/schemas/Scope' - description: '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: allOf: - $ref: '#/components/schemas/ResourceType' - description: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 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: allOf: - $ref: '#/components/schemas/InferredWorkloadTypesPreference' - description: '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.
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.
inferredWorkloadTypes. The array contains the top
three savings opportunites for the instances running inferred workload types. '
description: A summary of a recommendation.
Summaries:
type: array
items:
$ref: '#/components/schemas/Summary'
RecommendedInstanceType:
type: string
RecommendedOptionProjectedMetric:
type: object
properties:
recommendedInstanceType:
allOf:
- $ref: '#/components/schemas/RecommendedInstanceType'
- description: The recommended instance type.
rank:
allOf:
- $ref: '#/components/schemas/Rank'
- description: '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.
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.
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.
The finding classification of the volume.
Findings for volumes include:
NotOptimized —A volume is considered not optimized when
Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An volume is considered optimized when
Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new
generation volume type.
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.
The rank of the volume recommendation option.
The top recommendation option is ranked as 1.