Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutRuntimeManagementConfig

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

Request Syntax


PUT /2021-07-20/functions/FunctionName/runtime-management-config?Qualifier=Qualifier HTTP/1.1
Content-type: application/json

{
   "RuntimeVersionArn": "string",
   "UpdateRuntimeOn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

FunctionName

The name or ARN of the Lambda function.

Name formats

Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Length Constraints: Minimum length of 1. Maximum length of 140.

Pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Required: Yes

Qualifier

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (|[a-zA-Z0-9$_-]+)

Request Body

The request accepts the following data in JSON format.

RuntimeVersionArn

The ARN of the runtime version you want the function to use.

Note

This is only required if you're using the Manual runtime update mode.

Type: String

Length Constraints: Minimum length of 26. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$

Required: No

UpdateRuntimeOn

Specify the runtime update mode.

Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

Type: String

Valid Values: Auto | Manual | FunctionUpdate

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "FunctionArn": "string",
   "RuntimeVersionArn": "string",
   "UpdateRuntimeOn": "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.

FunctionArn

The ARN of the function

Type: String

Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?

RuntimeVersionArn

The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.

Type: String

Length Constraints: Minimum length of 26. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$

UpdateRuntimeOn

The runtime update mode.

Type: String

Valid Values: Auto | Manual | FunctionUpdate

Errors

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

InvalidParameterValueException

One of the parameters in the request is not valid.

HTTP Status Code: 400

ResourceConflictException

The resource already exists, or another operation is in progress.

HTTP Status Code: 409

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ServiceException

The AWS Lambda service encountered an internal error.

HTTP Status Code: 500

TooManyRequestsException

The request throughput limit was exceeded. For more information, see Lambda quotas.

HTTP Status Code: 429