CreateRuntimeVersion
Creates a new runtime version. A runtime version defines the function execution environment by referencing a container image. Runtime versions are immutable. To update the runtime, create a new runtime version and migrate functions by updating the runtime aliases to point to the new runtime version.
Request Syntax
POST /2026-10-01/runtimes/RuntimeName/versions HTTP/1.1
Content-type: application/json
{
"DryRun": boolean,
"ImageUri": "string",
"Name": "string",
"ReleaseNotes": "string"
}
URI Request Parameters
The request uses the following URI parameters.
- RuntimeName
-
The name or ARN of the runtime to create a version for.
Length Constraints: Minimum length of 2. Maximum length of 2048.
Pattern:
(arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:runtime/)?[a-z0-9]([a-z0-9_.-]{0,126})?[a-z0-9]Required: Yes
Request Body
The request accepts the following data in JSON format.
- DryRun
-
When set to true, the request is validated without creating a new runtime version. Use this to check that the request would succeed. No runtime version is created and no changes are made.
Type: Boolean
Required: No
- ImageUri
-
The URI of the container image used to define the function execution environment for this runtime version.
Type: String
Required: Yes
- Name
-
The name to assign to the new runtime version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[A-Za-z0-9_]([A-Za-z0-9_.-]{0,126}[A-Za-z0-9_])?Required: Yes
- ReleaseNotes
-
The release notes to associate with the runtime version.
Type: String
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"Arn": "string",
"Compatibility": {
"Architectures": [ "string" ],
"IntegrationModels": [ "string" ],
"ManagedInstances": "string"
},
"Created": "string",
"LastModified": "string",
"Name": "string",
"Platforms": [
{
"Architecture": "string",
"Digest": "string",
"Os": "string"
}
],
"ReleaseNotes": "string",
"ResolvedUri": "string",
"State": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the runtime version.
Type: String
Length Constraints: Minimum length of 48. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:runtime/[a-z0-9]([a-z0-9_.-]{0,126})?[a-z0-9](/(version|alias)/[^/]{1,128})? - Compatibility
-
The compatibility matrix of the runtime version.
Type: Compatibility object
- Created
-
The date and time when the runtime version was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- LastModified
-
The date and time when the runtime version was last modified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- Name
-
The name of the runtime version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[A-Za-z0-9_]([A-Za-z0-9_.-]{0,126}[A-Za-z0-9_])? - Platforms
-
The platforms (architecture and OS combinations) available for the runtime version.
Type: Array of Platform objects
- ReleaseNotes
-
The release notes associated with the runtime version.
Type: String
- ResolvedUri
-
The resolved image URI of the runtime version.
Type: String
- State
-
The current state of the runtime version.
Type: String
Valid Values:
CREATING | ACTIVE | FAILED | DELETING | PENDING_DELETION
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidParameterValueException
-
One of the parameters in the request is not valid. Check the error message for details about which parameter failed validation.
- message
-
The error message that describes the exception.
- Type
-
The exception type.
HTTP Status Code: 400
- ResourceConflictException
-
The request could not be completed due to a conflict with the current state of the resource. For example, attempting to modify a resource that is not in a state that permits the operation.
- message
-
The error message that describes the exception.
- Type
-
The exception type.
HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource does not exist. Verify the identifier and Region.
- Message
-
The error message that describes the exception.
- Type
-
The exception type.
HTTP Status Code: 404
- ServiceException
-
An internal service error occurred. Retry the request with exponential backoff.
- Message
-
The error message that describes the exception.
- Type
-
The exception type.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The request would exceed a service quota for your account. Request a quota increase or reduce the number of resources in use, then retry the request.
- Message
-
The error message that describes the exception.
- Type
-
The exception type.
HTTP Status Code: 402
- TooManyRequestsException
-
The request was throttled due to exceeding the allowed request rate. Retry the request after a brief wait using exponential backoff.
- message
-
The error message that describes the exception.
- Reason
-
The reason for the throttling.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
- Type
-
The exception type.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: