AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Lambda UpdateFunctionCode API operation.

Syntax

FromMemoryStream (Default)
Update-LMFunctionCode
-FunctionName <String>
-Publish <SwitchParameter>
-Architecture <String[]>
-DryRun <Boolean>
-PublishVersion <Boolean>
-PublishTo <FunctionVersionLatestPublished>
-RevisionId <String>
-SourceKMSKeyArn <String>
-ZipFile <Byte[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaConfig>
FromZipFile
Update-LMFunctionCode
-FunctionName <String>
-ZipFilename <String>
-Publish <SwitchParameter>
-Architecture <String[]>
-DryRun <Boolean>
-PublishVersion <Boolean>
-PublishTo <FunctionVersionLatestPublished>
-RevisionId <String>
-SourceKMSKeyArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaConfig>
FromImage
Update-LMFunctionCode
-FunctionName <String>
-Publish <SwitchParameter>
-Architecture <String[]>
-DryRun <Boolean>
-ImageUri <String>
-PublishVersion <Boolean>
-PublishTo <FunctionVersionLatestPublished>
-RevisionId <String>
-SourceKMSKeyArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaConfig>
FromS3Object
Update-LMFunctionCode
-FunctionName <String>
-Publish <SwitchParameter>
-Architecture <String[]>
-DryRun <Boolean>
-PublishVersion <Boolean>
-PublishTo <FunctionVersionLatestPublished>
-RevisionId <String>
-S3Bucket <String>
-S3Key <String>
-S3ObjectVersion <String>
-SourceKMSKeyArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaConfig>

Description

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. 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.

Parameters

-Architecture <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesArchitectures
-ClientConfig <AmazonLambdaConfig>
Amazon.PowerShell.Cmdlets.LM.AmazonLambdaClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DryRun <Boolean>
Set to true to validate the request parameters and access permissions without modifying the function code.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FunctionName <String>
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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ImageUri <String>
URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FunctionName parameter. The -PassThru parameter is deprecated, use -Select '^FunctionName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Publish <SwitchParameter>
This parameter is obsolete. Use PublishVersion instead.
Required?False
Position?Named
Accept pipeline input?False
-PublishTo <FunctionVersionLatestPublished>
Specifies where to publish the function version or configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PublishVersion <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBucketName, FunctionCode_S3Bucket
-S3Key <String>
The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFunctionCode_S3Key, Key
-S3ObjectVersion <String>
For versioned objects, the version of the deployment package object to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFunctionCode_S3ObjectVersion, VersionId
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lambda.Model.UpdateFunctionCodeResponse). Specifying the name of a property of type Amazon.Lambda.Model.UpdateFunctionCodeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceKMSKeyArn <String>
The ARN of the Key Management Service (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 Web Services managed key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ZipFile <Byte[]>
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.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesZipContent, ZipFileContent
-ZipFilename <String>
This parameter is obsolete and will be removed in a future version. Use 'ZipFile' instead. The path to a zip file containing your deployment package. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFunctionZip, Filename

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Lambda.Model.UpdateFunctionCodeResponse
This cmdlet returns an Amazon.Lambda.Model.UpdateFunctionCodeResponse object containing multiple properties.

Examples

Example 1

Update-LMFunctionCode -FunctionName MyFunction -ZipFilename .\UpdatedCode.zip
Updates the function named 'MyFunction' with new content contained in the specified zip file. For a C# .NET Core Lambda function the zip file should contain the compiled assembly.

Example 2

Update-LMFunctionCode -FunctionName MyFunction -BucketName amzn-s3-demo-bucket -Key UpdatedCode.zip
This example is similar to the previous one but uses an Amazon S3 object containing the updated code to update the function.
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z