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

Invokes the UpdateFunctionCode operation against Amazon Lambda.

Syntax

FromZipFile (Default)

Update-LMFunctionCode
-FunctionName <String>
-ZipFilename <String>
-Publish <SwitchParameter>
-Force <SwitchParameter>

FromS3Object

Update-LMFunctionCode
-FunctionName <String>
-BucketName <String>
-Key <String>
-VersionId <String>
-Publish <SwitchParameter>
-Force <SwitchParameter>

FromMemoryStream

Update-LMFunctionCode
-FunctionName <String>
-ZipFileContent <MemoryStream>
-Publish <SwitchParameter>
-Force <SwitchParameter>

Description

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration. If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:UpdateFunctionCode action. The updated code for the function may be supplied from a zip file in an S3 bucket, from a zip file on the local file system (the default) or from a memory stream onto a resource containing the code.

Parameters

-BucketName <String>
Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region as the existing Lambda function.
Required?True
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?False
-FunctionName <String>
The existing Lambda function name whose code you want to replace. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Key <String>
The key name of the Amazon S3 object (the deployment package) you want to upload to Lambda.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Publish <SwitchParameter>
If set requests that AWS Lambda update the Lambda function and publish a version as an atomic operation.
Required?False
Position?Named
Accept pipeline input?False
-VersionId <String>
Optional version ID of the Amazon S3 object (the deployment package) you want to upload to Lambda.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ZipFileContent <MemoryStream>
A stream onto the zip file containing your deployment package. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide. Note: the supplied stream is not disposed when the cmdlet exits.
Required?True
Position?Named
Accept pipeline input?False
-ZipFilename <String>
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?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the FunctionName parameter.

Outputs

This cmdlet returns a Amazon.Lambda.Model.UpdateFunctionCodeResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\>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

PS C:\>Update-LMFunctionCode -FunctionName MyFunction -BucketName mybucket -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.

Supported Version

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