GetLambdaFunctionRecommendations - AWS Compute Optimizer

GetLambdaFunctionRecommendations

Returns AWS Lambda function recommendations.

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

Request Syntax

{ "accountIds": [ "string" ], "filters": [ { "name": "string", "values": [ "string" ] } ], "functionArns": [ "string" ], "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

accountIds

The ID of the AWS 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.

Type: Array of strings

Required: No

filters

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

Type: Array of LambdaFunctionRecommendationFilter objects

Required: No

functionArns

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 AWS Lambda Developer Guide.

Type: Array of strings

Required: No

maxResults

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.

Type: Integer

Required: No

nextToken

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

Type: String

Required: No

Response Syntax

{ "lambdaFunctionRecommendations": [ { "accountId": "string", "currentMemorySize": number, "currentPerformanceRisk": "string", "finding": "string", "findingReasonCodes": [ "string" ], "functionArn": "string", "functionVersion": "string", "lastRefreshTimestamp": number, "lookbackPeriodInDays": number, "memorySizeRecommendationOptions": [ { "memorySize": number, "projectedUtilizationMetrics": [ { "name": "string", "statistic": "string", "value": number } ], "rank": number, "savingsOpportunity": { "estimatedMonthlySavings": { "currency": "string", "value": number }, "savingsOpportunityPercentage": number } } ], "numberOfInvocations": number, "utilizationMetrics": [ { "name": "string", "statistic": "string", "value": number } ] } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

lambdaFunctionRecommendations

An array of objects that describe function recommendations.

Type: Array of LambdaFunctionRecommendation objects

nextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Try your call again.

HTTP Status Code: 500

InvalidParameterValueException

The value supplied for the input parameter is out of range or not valid.

HTTP Status Code: 400

LimitExceededException

The request exceeds a limit of the service.

HTTP Status Code: 400

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 400

OptInRequiredException

The account is not opted in to AWS Compute Optimizer.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed due to a temporary failure of the server.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: