openapi: 3.0.0 info: version: '2019-11-01' x-release: v4 title: 'AWS Compute Optimizer #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences #X Amz Target=ComputeOptimizerService.GetLambdaFunctionRecommendations API' 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 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) security: - hmac: [] tags: - name: '#X Amz Target=ComputeOptimizerService.GetLambdaFunctionRecommendations' paths: /#X-Amz-Target=ComputeOptimizerService.GetLambdaFunctionRecommendations: 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' 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 tags: - '#X Amz Target=ComputeOptimizerService.GetLambdaFunctionRecommendations' components: schemas: LambdaFunctionMemoryRecommendationOptions: type: array items: $ref: '#/components/schemas/LambdaFunctionMemoryRecommendationOption' FunctionVersion: type: string InternalServerException: {} LambdaFunctionRecommendation: type: object properties: functionArn: allOf: - $ref: '#/components/schemas/FunctionArn' - description: The Amazon Resource Name (ARN) of the current function. functionVersion: allOf: - $ref: '#/components/schemas/FunctionVersion' - description: The version number of the current function. accountId: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services account ID of the function. currentMemorySize: allOf: - $ref: '#/components/schemas/MemorySize' - description: The amount of memory, in MB, that's allocated to the current function. numberOfInvocations: allOf: - $ref: '#/components/schemas/NumberOfInvocations' - description: The number of times your function code was applied during the look-back period. utilizationMetrics: allOf: - $ref: '#/components/schemas/LambdaFunctionUtilizationMetrics' - description: An array of objects that describe the utilization metrics of the function. lookbackPeriodInDays: allOf: - $ref: '#/components/schemas/LookBackPeriodInDays' - description: The number of days for which utilization metrics were analyzed for the function. lastRefreshTimestamp: allOf: - $ref: '#/components/schemas/LastRefreshTimestamp' - description: The timestamp of when the function recommendation was last generated. finding: allOf: - $ref: '#/components/schemas/LambdaFunctionRecommendationFinding' - description: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 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 rank of the function recommendation option.
The top recommendation option is ranked as 1.
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.
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.
FunctionArns: type: array items: $ref: '#/components/schemas/FunctionArn' LastRefreshTimestamp: type: string format: date-time SavingsOpportunityPercentage: type: number format: double AccessDeniedException: {} LambdaFunctionMemoryProjectedMetric: type: object properties: name: allOf: - $ref: '#/components/schemas/LambdaFunctionMemoryMetricName' - description: The name of the projected utilization metric. statistic: allOf: - $ref: '#/components/schemas/LambdaFunctionMemoryMetricStatistic' - description: The statistic of the projected utilization metric. value: allOf: - $ref: '#/components/schemas/MetricValue' - description: The values of the projected utilization metrics. description: Describes a projected utilization metric of an Lambda function recommendation option. NextToken: type: string Tags: type: array items: $ref: '#/components/schemas/Tag' LambdaFunctionRecommendations: type: array items: $ref: '#/components/schemas/LambdaFunctionRecommendation' LambdaFunctionMemoryMetricStatistic: type: string enum: - LowerBound - UpperBound - Expected FilterValue: type: string LambdaFunctionMetricStatistic: type: string enum: - Maximum - Average LambdaFunctionUtilizationMetric: type: object properties: name: allOf: - $ref: '#/components/schemas/LambdaFunctionMetricName' - description: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 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. LambdaFunctionRecommendationFindingReasonCode: type: string enum: - MemoryOverprovisioned - MemoryUnderprovisioned - InsufficientData - Inconclusive LambdaFunctionRecommendationFilter: type: object properties: name: allOf: - $ref: '#/components/schemas/LambdaFunctionRecommendationFilterName' - description: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.