put_runtime_management_config¶
Operation¶
put_runtime_management_config
¶
put_runtime_management_config(request: PutRuntimeManagementConfigInput | PutRuntimeManagementConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutRuntimeManagementConfigInputDict]) -> PutRuntimeManagementConfigOutput
Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutRuntimeManagementConfigInput | PutRuntimeManagementConfigInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutRuntimeManagementConfigInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutRuntimeManagementConfigOutput
|
An instance of |
put_runtime_management_config
async
¶
put_runtime_management_config(request: PutRuntimeManagementConfigInput | PutRuntimeManagementConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutRuntimeManagementConfigInputDict]) -> PutRuntimeManagementConfigOutput
Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutRuntimeManagementConfigInput | PutRuntimeManagementConfigInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutRuntimeManagementConfigInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutRuntimeManagementConfigOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
PutRuntimeManagementConfigInputDict
¶
Bases: TypedDict
Dictionary form of PutRuntimeManagementConfigInput.
Attributes¶
function_name
instance-attribute
¶
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
instance-attribute
¶
qualifier: str | None
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.
runtime_version_arn
instance-attribute
¶
runtime_version_arn: str | None
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.
update_runtime_on
instance-attribute
¶
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.
PutRuntimeManagementConfigInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutRuntimeManagementConfigInput structure.
Attributes¶
function_name
class-attribute
instance-attribute
¶
function_name: str | None = ...
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
class-attribute
instance-attribute
¶
qualifier: str | None = ...
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.
runtime_version_arn
class-attribute
instance-attribute
¶
runtime_version_arn: str | None = ...
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.
update_runtime_on
class-attribute
instance-attribute
¶
update_runtime_on: str | None = ...
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.
Output¶
PutRuntimeManagementConfigOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutRuntimeManagementConfigOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.