UpdateFunctionCode
Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.
If the function's package type is Image
, then you must specify the code package in
ImageUri
as the URI of a container image in the Amazon ECR registry.
If the function's package type is Zip
, then you must specify the deployment package as a .zip file
archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide
the function code inline using the ZipFile
field.
The code in the deployment package must be compatible with the target instruction set architecture of the
function (x86-64
or arm64
).
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
Note
For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.
Request Syntax
PUT /2015-03-31/functions/FunctionName
/code HTTP/1.1
Content-type: application/json
{
"Architectures": [ "string
" ],
"DryRun": boolean
,
"ImageUri": "string
",
"Publish": boolean
,
"RevisionId": "string
",
"S3Bucket": "string
",
"S3Key": "string
",
"S3ObjectVersion": "string
",
"SourceKMSKeyArn": "string
",
"ZipFile": blob
}
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
-
Request Body
The request accepts the following data in JSON format.
- Architectures
-
The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is
x86_64
.Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
x86_64 | arm64
Required: No
- DryRun
-
Set to true to validate the request parameters and access permissions without modifying the function code.
Type: Boolean
Required: No
- ImageUri
-
URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
Type: String
Required: No
- Publish
-
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
Type: Boolean
Required: No
- RevisionId
-
Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
Type: String
Required: No
- S3Bucket
-
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[0-9A-Za-z\.\-_]*(?<!\.)$
Required: No
- S3Key
-
The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- S3ObjectVersion
-
For versioned objects, the version of the deployment package object to use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- SourceKMSKeyArn
-
The ARN of the Amazon Key Management Service (Amazon KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon managed key.
Type: String
Pattern:
(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()
Required: No
- ZipFile
-
The base64-encoded contents of the deployment package. Amazon SDK and Amazon CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.
Type: Base64-encoded binary data object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Architectures": [ "string" ],
"CodeSha256": "string",
"CodeSize": number,
"DeadLetterConfig": {
"TargetArn": "string"
},
"Description": "string",
"Environment": {
"Error": {
"ErrorCode": "string",
"Message": "string"
},
"Variables": {
"string" : "string"
}
},
"EphemeralStorage": {
"Size": number
},
"FileSystemConfigs": [
{
"Arn": "string",
"LocalMountPath": "string"
}
],
"FunctionArn": "string",
"FunctionName": "string",
"Handler": "string",
"ImageConfigResponse": {
"Error": {
"ErrorCode": "string",
"Message": "string"
},
"ImageConfig": {
"Command": [ "string" ],
"EntryPoint": [ "string" ],
"WorkingDirectory": "string"
}
},
"KMSKeyArn": "string",
"LastModified": "string",
"LastUpdateStatus": "string",
"LastUpdateStatusReason": "string",
"LastUpdateStatusReasonCode": "string",
"Layers": [
{
"Arn": "string",
"CodeSize": number,
"SigningJobArn": "string",
"SigningProfileVersionArn": "string"
}
],
"LoggingConfig": {
"ApplicationLogLevel": "string",
"LogFormat": "string",
"LogGroup": "string",
"SystemLogLevel": "string"
},
"MasterArn": "string",
"MemorySize": number,
"PackageType": "string",
"RevisionId": "string",
"Role": "string",
"Runtime": "string",
"RuntimeVersionConfig": {
"Error": {
"ErrorCode": "string",
"Message": "string"
},
"RuntimeVersionArn": "string"
},
"SigningJobArn": "string",
"SigningProfileVersionArn": "string",
"SnapStart": {
"ApplyOn": "string",
"OptimizationStatus": "string"
},
"State": "string",
"StateReason": "string",
"StateReasonCode": "string",
"Timeout": number,
"TracingConfig": {
"Mode": "string"
},
"Version": "string",
"VpcConfig": {
"Ipv6AllowedForDualStack": boolean,
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VpcId": "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.
- Architectures
-
The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is
x86_64
.Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values:
x86_64 | arm64
- CodeSha256
-
The SHA256 hash of the function's deployment package.
Type: String
- CodeSize
-
The size of the function's deployment package, in bytes.
Type: Long
- DeadLetterConfig
-
The function's dead letter queue.
Type: DeadLetterConfig object
- Description
-
The function's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- Environment
-
The function's environment variables. Omitted from Amazon CloudTrail logs.
Type: EnvironmentResponse object
- EphemeralStorage
-
The size of the function's
/tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).Type: EphemeralStorage object
- FileSystemConfigs
-
Connection settings for an Amazon EFS file system.
Type: Array of FileSystemConfig objects
Array Members: Maximum number of 1 item.
- FunctionArn
-
The function's Amazon Resource Name (ARN).
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-_]+))?
- FunctionName
-
The name of the function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 170.
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-_]+))?
- Handler
-
The function that Lambda calls to begin running your function.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[^\s]+
- ImageConfigResponse
-
The function's image configuration values.
Type: ImageConfigResponse object
- KMSKeyArn
-
The ARN of the Amazon Key Management Service (Amazon KMS) customer managed key that's used to encrypt the following resources:
-
The function's environment variables.
-
The function's Lambda SnapStart snapshots.
-
When used with
SourceKMSKeyArn
, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda. -
The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.
If you don't provide a customer managed key, Lambda uses an Amazon owned key or an Amazon managed key.
Type: String
Pattern:
(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()
-
- LastModified
-
The date and time that the function was last updated, in ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD). Type: String
- LastUpdateStatus
-
The status of the last update that was performed on the function. This is first set to
Successful
after function creation completes.Type: String
Valid Values:
Successful | Failed | InProgress
- LastUpdateStatusReason
-
The reason for the last update that was performed on the function.
Type: String
- LastUpdateStatusReasonCode
-
The reason code for the last update that was performed on the function.
Type: String
Valid Values:
EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage | KMSKeyAccessDenied | KMSKeyNotFound | InvalidStateKMSKey | DisabledKMSKey | EFSIOError | EFSMountConnectivityError | EFSMountFailure | EFSMountTimeout | InvalidRuntime | InvalidZipFileException | FunctionError
- Layers
-
The function's layers.
Type: Array of Layer objects
- LoggingConfig
-
The function's Amazon CloudWatch Logs configuration settings.
Type: LoggingConfig object
- MasterArn
-
For Lambda@Edge functions, the ARN of the main 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-_]+))?
- MemorySize
-
The amount of memory available to the function at runtime.
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 10240.
- PackageType
-
The type of deployment package. Set to
Image
for container image and setZip
for .zip file archive.Type: String
Valid Values:
Zip | Image
- RevisionId
-
The latest updated revision of the function or alias.
Type: String
- Role
-
The function's execution role.
Type: String
Pattern:
arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
- Runtime
-
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.
For a list of all currently supported runtimes, see Supported runtimes.
Type: String
Valid Values:
nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | nodejs16.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | dotnet6 | dotnet8 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2 | nodejs18.x | python3.10 | java17 | ruby3.2 | ruby3.3 | python3.11 | nodejs20.x | provided.al2023 | python3.12 | java21 | python3.13 | nodejs22.x
- RuntimeVersionConfig
-
The ARN of the runtime and any errors that occured.
Type: RuntimeVersionConfig object
- SigningJobArn
-
The ARN of the signing job.
Type: String
Pattern:
arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
- SigningProfileVersionArn
-
The ARN of the signing profile version.
Type: String
Pattern:
arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
- SnapStart
-
Set
ApplyOn
toPublishedVersions
to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.Type: SnapStartResponse object
- State
-
The current state of the function. When the state is
Inactive
, you can reactivate the function by invoking it.Type: String
Valid Values:
Pending | Active | Inactive | Failed
- StateReason
-
The reason for the function's current state.
Type: String
- StateReasonCode
-
The reason code for the function's current state. When the code is
Creating
, you can't invoke or modify the function.Type: String
Valid Values:
Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage | KMSKeyAccessDenied | KMSKeyNotFound | InvalidStateKMSKey | DisabledKMSKey | EFSIOError | EFSMountConnectivityError | EFSMountFailure | EFSMountTimeout | InvalidRuntime | InvalidZipFileException | FunctionError
- Timeout
-
The amount of time in seconds that Lambda allows a function to run before stopping it.
Type: Integer
Valid Range: Minimum value of 1.
- TracingConfig
-
The function's Amazon X-Ray tracing configuration.
Type: TracingConfigResponse object
- Version
-
The version of the Lambda function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
(\$LATEST|[0-9]+)
- VpcConfig
-
The function's networking configuration.
Type: VpcConfigResponse object
Errors
For information about the errors that are common to all actions, see Common Errors.
- CodeSigningConfigNotFoundException
-
The specified code signing configuration does not exist.
HTTP Status Code: 404
- CodeStorageExceededException
-
Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.
HTTP Status Code: 400
- CodeVerificationFailedException
-
The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code signing policy is set to ENFORCE. Lambda blocks the deployment.
HTTP Status Code: 400
- InvalidCodeSignatureException
-
The code signature failed the integrity check. If the integrity check fails, then Lambda blocks deployment, even if the code signing policy is set to WARN.
HTTP Status Code: 400
- InvalidParameterValueException
-
One of the parameters in the request is not valid.
HTTP Status Code: 400
- PreconditionFailedException
-
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.
-
For AddPermission and RemovePermission API operations: Call
GetPolicy
to retrieve the latest RevisionId for your resource. -
For all other API operations: Call
GetFunction
orGetAlias
to retrieve the latest RevisionId for your resource.
HTTP Status Code: 412
-
- 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 Amazon 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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: