Lambda / Client / update_function_code

update_function_code#

Lambda.Client.update_function_code(**kwargs)#

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

response = client.update_function_code(
    FunctionName='string',
    ZipFile=b'bytes',
    S3Bucket='string',
    S3Key='string',
    S3ObjectVersion='string',
    ImageUri='string',
    Publish=True|False,
    DryRun=True|False,
    RevisionId='string',
    Architectures=[
        'x86_64'|'arm64',
    ]
)

Parameters:

FunctionName (string) –
[REQUIRED]

The name 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.
ZipFile (bytes) –
The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.
S3Bucket (string) – 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.
S3Key (string) – The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
S3ObjectVersion (string) – For versioned objects, the version of the deployment package object to use.
ImageUri (string) – URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
Publish (boolean) – Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
DryRun (boolean) – Set to true to validate the request parameters and access permissions without modifying the function code.
RevisionId (string) – 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.
Architectures (list) –
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.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'FunctionName': 'string',
    'FunctionArn': 'string',
    'Runtime': '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'|'nodejs4.3-edge'|'go1.x'|'ruby2.5'|'ruby2.7'|'provided'|'provided.al2'|'nodejs18.x'|'python3.10'|'java17',
    'Role': 'string',
    'Handler': 'string',
    'CodeSize': 123,
    'Description': 'string',
    'Timeout': 123,
    'MemorySize': 123,
    'LastModified': 'string',
    'CodeSha256': 'string',
    'Version': 'string',
    'VpcConfig': {
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'VpcId': 'string'
    },
    'DeadLetterConfig': {
        'TargetArn': 'string'
    },
    'Environment': {
        'Variables': {
            'string': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'KMSKeyArn': 'string',
    'TracingConfig': {
        'Mode': 'Active'|'PassThrough'
    },
    'MasterArn': 'string',
    'RevisionId': 'string',
    'Layers': [
        {
            'Arn': 'string',
            'CodeSize': 123,
            'SigningProfileVersionArn': 'string',
            'SigningJobArn': 'string'
        },
    ],
    'State': 'Pending'|'Active'|'Inactive'|'Failed',
    'StateReason': 'string',
    'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage'|'KMSKeyAccessDenied'|'KMSKeyNotFound'|'InvalidStateKMSKey'|'DisabledKMSKey'|'EFSIOError'|'EFSMountConnectivityError'|'EFSMountFailure'|'EFSMountTimeout'|'InvalidRuntime'|'InvalidZipFileException'|'FunctionError',
    'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
    'LastUpdateStatusReason': 'string',
    'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage'|'KMSKeyAccessDenied'|'KMSKeyNotFound'|'InvalidStateKMSKey'|'DisabledKMSKey'|'EFSIOError'|'EFSMountConnectivityError'|'EFSMountFailure'|'EFSMountTimeout'|'InvalidRuntime'|'InvalidZipFileException'|'FunctionError',
    'FileSystemConfigs': [
        {
            'Arn': 'string',
            'LocalMountPath': 'string'
        },
    ],
    'PackageType': 'Zip'|'Image',
    'ImageConfigResponse': {
        'ImageConfig': {
            'EntryPoint': [
                'string',
            ],
            'Command': [
                'string',
            ],
            'WorkingDirectory': 'string'
        },
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    },
    'SigningProfileVersionArn': 'string',
    'SigningJobArn': 'string',
    'Architectures': [
        'x86_64'|'arm64',
    ],
    'EphemeralStorage': {
        'Size': 123
    },
    'SnapStart': {
        'ApplyOn': 'PublishedVersions'|'None',
        'OptimizationStatus': 'On'|'Off'
    },
    'RuntimeVersionConfig': {
        'RuntimeVersionArn': 'string',
        'Error': {
            'ErrorCode': 'string',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) –

Details about a function’s configuration.
- FunctionName (string) –
  
  The name of the function.
- FunctionArn (string) –
  
  The function’s Amazon Resource Name (ARN).
- Runtime (string) –
  
  The identifier of the function’s runtime. Runtime is required if the deployment package is a .zip file archive.
  
  The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
- Role (string) –
  
  The function’s execution role.
- Handler (string) –
  
  The function that Lambda calls to begin running your function.
- CodeSize (integer) –
  
  The size of the function’s deployment package, in bytes.
- Description (string) –
  
  The function’s description.
- Timeout (integer) –
  
  The amount of time in seconds that Lambda allows a function to run before stopping it.
- MemorySize (integer) –
  
  The amount of memory available to the function at runtime.
- LastModified (string) –
  
  The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- CodeSha256 (string) –
  
  The SHA256 hash of the function’s deployment package.
- Version (string) –
  
  The version of the Lambda function.
- VpcConfig (dict) –
  
  The function’s networking configuration.
  - SubnetIds (list) –
    
    A list of VPC subnet IDs.
    - (string) –
  - SecurityGroupIds (list) –
    
    A list of VPC security group IDs.
    - (string) –
  - VpcId (string) –
    
    The ID of the VPC.
- DeadLetterConfig (dict) –
  
  The function’s dead letter queue.
  - TargetArn (string) –
    
    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
- Environment (dict) –
  
  The function’s environment variables. Omitted from CloudTrail logs.
  - Variables (dict) –
    
    Environment variable key-value pairs. Omitted from CloudTrail logs.
    - (string) –
      - (string) –
  - Error (dict) –
    
    Error messages for environment variables that couldn’t be applied.
    - ErrorCode (string) –
      
      The error code.
    - Message (string) –
      
      The error message.
- KMSKeyArn (string) –
  
  The KMS key that’s used to encrypt the function’s environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function’s snapshot. This key is returned only if you’ve configured a customer managed key.
- TracingConfig (dict) –
  
  The function’s X-Ray tracing configuration.
  - Mode (string) –
    
    The tracing mode.
- MasterArn (string) –
  
  For Lambda@Edge functions, the ARN of the main function.
- RevisionId (string) –
  
  The latest updated revision of the function or alias.
- Layers (list) –
  
  The function’s layers.
  - (dict) –
    
    An Lambda layer.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the function layer.
    - CodeSize (integer) –
      
      The size of the layer archive in bytes.
    - SigningProfileVersionArn (string) –
      
      The Amazon Resource Name (ARN) for a signing profile version.
    - SigningJobArn (string) –
      
      The Amazon Resource Name (ARN) of a signing job.
- State (string) –
  
  The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
- StateReason (string) –
  
  The reason for the function’s current state.
- StateReasonCode (string) –
  
  The reason code for the function’s current state. When the code is Creating, you can’t invoke or modify the function.
- LastUpdateStatus (string) –
  
  The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
- LastUpdateStatusReason (string) –
  
  The reason for the last update that was performed on the function.
- LastUpdateStatusReasonCode (string) –
  
  The reason code for the last update that was performed on the function.
- FileSystemConfigs (list) –
  
  Connection settings for an Amazon EFS file system.
  - (dict) –
    
    Details about the connection between a Lambda function and an Amazon EFS file system.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
    - LocalMountPath (string) –
      
      The path where the function can access the file system, starting with /mnt/.
- PackageType (string) –
  
  The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
- ImageConfigResponse (dict) –
  
  The function’s image configuration values.
  - ImageConfig (dict) –
    
    Configuration values that override the container image Dockerfile.
    - EntryPoint (list) –
      
      Specifies the entry point to their application, which is typically the location of the runtime executable.
      - (string) –
    - Command (list) –
      
      Specifies parameters that you want to pass in with ENTRYPOINT.
      - (string) –
    - WorkingDirectory (string) –
      
      Specifies the working directory.
  - Error (dict) –
    
    Error response to GetFunctionConfiguration.
    - ErrorCode (string) –
      
      Error code.
    - Message (string) –
      
      Error message.
- SigningProfileVersionArn (string) –
  
  The ARN of the signing profile version.
- SigningJobArn (string) –
  
  The ARN of the signing job.
- Architectures (list) –
  
  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.
  - (string) –
- EphemeralStorage (dict) –
  
  The size of the function’s /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
  - Size (integer) –
    
    The size of the function’s /tmp directory.
- SnapStart (dict) –
  
  Set ApplyOn to PublishedVersions 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.
  - ApplyOn (string) –
    
    When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
  - OptimizationStatus (string) –
    
    When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
- RuntimeVersionConfig (dict) –
  
  The ARN of the runtime and any errors that occured.
  - RuntimeVersionArn (string) –
    
    The ARN of the runtime version you want the function to use.
  - Error (dict) –
    
    Error response when Lambda is unable to retrieve the runtime version for a function.
    - ErrorCode (string) –
      
      The error code.
    - Message (string) –
      
      The error message.

Exceptions

Lambda.Client.exceptions.ServiceException
Lambda.Client.exceptions.ResourceNotFoundException
Lambda.Client.exceptions.InvalidParameterValueException
Lambda.Client.exceptions.TooManyRequestsException
Lambda.Client.exceptions.CodeStorageExceededException
Lambda.Client.exceptions.PreconditionFailedException
Lambda.Client.exceptions.ResourceConflictException
Lambda.Client.exceptions.CodeVerificationFailedException
Lambda.Client.exceptions.InvalidCodeSignatureException
Lambda.Client.exceptions.CodeSigningConfigNotFoundException

Examples

The following example replaces the code of the unpublished ($LATEST) version of a function named my-function with the contents of the specified zip file in Amazon S3.

response = client.update_function_code(
    FunctionName='my-function',
    S3Bucket='my-bucket-1xpuxmplzrlbh',
    S3Key='function.zip',
)

print(response)

Expected Output:

{
    'CodeSha256': 'PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=',
    'CodeSize': 308,
    'Description': '',
    'FunctionArn': 'arn:aws:lambda:us-east-2:123456789012:function:my-function',
    'FunctionName': 'my-function',
    'Handler': 'index.handler',
    'LastModified': '2019-08-14T22:26:11.234+0000',
    'MemorySize': 128,
    'RevisionId': '873282ed-xmpl-4dc8-a069-d0c647e470c6',
    'Role': 'arn:aws:iam::123456789012:role/lambda-role',
    'Runtime': 'nodejs12.x',
    'Timeout': 3,
    'TracingConfig': {
        'Mode': 'PassThrough',
    },
    'Version': '$LATEST',
    'ResponseMetadata': {
        '...': '...',
    },
}

update_function_code#

Note

Request Syntax

Name formats

This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.

Response Syntax

Response Structure

Exceptions

Examples