Lambda / Client / put_runtime_management_config

put_runtime_management_config#

Lambda.Client.put_runtime_management_config(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_runtime_management_config(
    FunctionName='string',
    Qualifier='string',
    UpdateRuntimeOn='Auto'|'Manual'|'FunctionUpdate',
    RuntimeVersionArn='string'
)
Parameters:

  • FunctionName (string) –

    [REQUIRED]

    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.

  • Qualifier (string) – 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.

  • UpdateRuntimeOn (string) –

    [REQUIRED]

    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.

  • RuntimeVersionArn (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'UpdateRuntimeOn': 'Auto'|'Manual'|'FunctionUpdate',
    'FunctionArn': 'string',
    'RuntimeVersionArn': 'string'
}

Response Structure

  • (dict) –

    • UpdateRuntimeOn (string) –

      The runtime update mode.

    • FunctionArn (string) –

      The ARN of the function

    • RuntimeVersionArn (string) –

      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.

Exceptions