lambda_function_recommendations
Creates, updates, deletes, gets or lists a lambda_function_recommendations resource.
Overview
| Name | lambda_function_recommendations |
| Type | Resource |
| Id | aws.compute_optimizer.lambda_function_recommendations |
Fields
The following fields are returned by SELECT queries:
- get_lambda_function_recommendations
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Amazon Web Services account ID of the function. |
current_memory_size | integer | The amount of memory, in MB, that's allocated to the current function. |
current_performance_risk | string | The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory. (VeryLow, Low, Medium, High) |
effective_recommendation_preferences | object | Describes the effective recommendation preferences for Lambda functions. |
finding | string | 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. (Optimized, NotOptimized, Unavailable) |
finding_reason_codes | array | 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. |
function_arn | string | The Amazon Resource Name (ARN) of the current function. |
function_version | string | The version number of the current function. |
last_refresh_timestamp | string (date-time) | The timestamp of when the function recommendation was last generated. |
lookback_period_in_days | number (double) | The number of days for which utilization metrics were analyzed for the function. |
memory_size_recommendation_options | array | An array of objects that describe the memory configuration recommendation options for the function. |
number_of_invocations | integer (int64) | The number of times your function code was applied during the look-back period. |
tags | array | A list of tags assigned to your Lambda function recommendations. |
utilization_metrics | array | An array of objects that describe the utilization metrics of the function. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_lambda_function_recommendations | select | region | 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. | |
export_lambda_function_recommendations | exec | region, s3DestinationConfig | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_lambda_function_recommendations
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.
SELECT
account_id,
current_memory_size,
current_performance_risk,
effective_recommendation_preferences,
finding,
finding_reason_codes,
function_arn,
function_version,
last_refresh_timestamp,
lookback_period_in_days,
memory_size_recommendation_options,
number_of_invocations,
tags,
utilization_metrics
FROM aws.compute_optimizer.lambda_function_recommendations
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- export_lambda_function_recommendations
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.
EXEC aws.compute_optimizer.lambda_function_recommendations.export_lambda_function_recommendations
@region='{{ region }}' --required
@@json=
'{
"accountIds": "{{ accountIds }}",
"filters": "{{ filters }}",
"fieldsToExport": "{{ fieldsToExport }}",
"s3DestinationConfig": "{{ s3DestinationConfig }}",
"fileFormat": "{{ fileFormat }}",
"includeMemberAccounts": {{ includeMemberAccounts }}
}'
;