Skip to content

Files

272 lines (218 loc) · 15.2 KB

API_UpdateFunctionCode.md

File metadata and controls

272 lines (218 loc) · 15.2 KB

UpdateFunctionCode

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.

Request Syntax

PUT /2015-03-31/functions/FunctionName/code HTTP/1.1
Content-type: application/json

{
   "[DryRun](#SSS-UpdateFunctionCode-request-DryRun)": boolean,
   "[Publish](#SSS-UpdateFunctionCode-request-Publish)": boolean,
   "[RevisionId](#SSS-UpdateFunctionCode-request-RevisionId)": "string",
   "[S3Bucket](#SSS-UpdateFunctionCode-request-S3Bucket)": "string",
   "[S3Key](#SSS-UpdateFunctionCode-request-S3Key)": "string",
   "[S3ObjectVersion](#SSS-UpdateFunctionCode-request-S3ObjectVersion)": "string",
   "[ZipFile](#SSS-UpdateFunctionCode-request-ZipFile)": blob
}

URI Request Parameters

The request requires the following URI parameters.

** FunctionName ** The name of the lambda function.

Name formats

  • Function name - MyFunction.
  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
  • Partial ARN - 123456789012:function:MyFunction. 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-_]+))?

Request Body

The request accepts the following data in JSON format.

** DryRun ** This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256 hash value of the provided code will also be computed and returned in the response.
Type: Boolean
Required: No

** Publish ** This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
Type: Boolean
Required: No

** RevisionId ** An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either using using either GetFunction or GetAlias.
Type: String
Required: No

** S3Bucket ** Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: ^[0-9A-Za-z\.\-_]*(?<!\.)$
Required: No

** S3Key ** The Amazon S3 object (the deployment package) key name you want to upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No

** S3ObjectVersion ** The Amazon S3 object (the deployment package) version you want to upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No

** ZipFile ** The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions.
Type: Base64-encoded binary data object
Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "[CodeSha256](#SSS-UpdateFunctionCode-response-CodeSha256)": "string",
   "[CodeSize](#SSS-UpdateFunctionCode-response-CodeSize)": number,
   "[DeadLetterConfig](#SSS-UpdateFunctionCode-response-DeadLetterConfig)": { 
      "[TargetArn](API_DeadLetterConfig.md#SSS-Type-DeadLetterConfig-TargetArn)": "string"
   },
   "[Description](#SSS-UpdateFunctionCode-response-Description)": "string",
   "[Environment](#SSS-UpdateFunctionCode-response-Environment)": { 
      "[Error](API_EnvironmentResponse.md#SSS-Type-EnvironmentResponse-Error)": { 
         "[ErrorCode](API_EnvironmentError.md#SSS-Type-EnvironmentError-ErrorCode)": "string",
         "[Message](API_EnvironmentError.md#SSS-Type-EnvironmentError-Message)": "string"
      },
      "[Variables](API_EnvironmentResponse.md#SSS-Type-EnvironmentResponse-Variables)": { 
         "string" : "string" 
      }
   },
   "[FunctionArn](#SSS-UpdateFunctionCode-response-FunctionArn)": "string",
   "[FunctionName](#SSS-UpdateFunctionCode-response-FunctionName)": "string",
   "[Handler](#SSS-UpdateFunctionCode-response-Handler)": "string",
   "[KMSKeyArn](#SSS-UpdateFunctionCode-response-KMSKeyArn)": "string",
   "[LastModified](#SSS-UpdateFunctionCode-response-LastModified)": "string",
   "[Layers](#SSS-UpdateFunctionCode-response-Layers)": [ 
      { 
         "[Arn](API_Layer.md#SSS-Type-Layer-Arn)": "string",
         "[CodeSize](API_Layer.md#SSS-Type-Layer-CodeSize)": number
      }
   ],
   "[MasterArn](#SSS-UpdateFunctionCode-response-MasterArn)": "string",
   "[MemorySize](#SSS-UpdateFunctionCode-response-MemorySize)": number,
   "[RevisionId](#SSS-UpdateFunctionCode-response-RevisionId)": "string",
   "[Role](#SSS-UpdateFunctionCode-response-Role)": "string",
   "[Runtime](#SSS-UpdateFunctionCode-response-Runtime)": "string",
   "[Timeout](#SSS-UpdateFunctionCode-response-Timeout)": number,
   "[TracingConfig](#SSS-UpdateFunctionCode-response-TracingConfig)": { 
      "[Mode](API_TracingConfigResponse.md#SSS-Type-TracingConfigResponse-Mode)": "string"
   },
   "[Version](#SSS-UpdateFunctionCode-response-Version)": "string",
   "[VpcConfig](#SSS-UpdateFunctionCode-response-VpcConfig)": { 
      "[SecurityGroupIds](API_VpcConfigResponse.md#SSS-Type-VpcConfigResponse-SecurityGroupIds)": [ "string" ],
      "[SubnetIds](API_VpcConfigResponse.md#SSS-Type-VpcConfigResponse-SubnetIds)": [ "string" ],
      "[VpcId](API_VpcConfigResponse.md#SSS-Type-VpcConfigResponse-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.

** 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.
Type: EnvironmentResponse object

** FunctionArn ** The function's Amazon Resource Name.
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 Lambda calls to begin executing your function.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [^\s]+

** KMSKeyArn ** The KMS key used to encrypt the function's environment variables. Only returned if you've configured a customer managed CMK.
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

** Layers ** A list of function layers.
Type: Array of Layer objects

** MasterArn ** The ARN of the master 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 memory allocated to the function
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 3008.

** RevisionId ** Represents 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 runtime environment for the Lambda function.
Type: String
Valid Values: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | java8 | python2.7 | python3.6 | python3.7 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | nodejs4.3-edge | go1.x | ruby2.5 | provided

** Timeout ** The amount of time that Lambda allows a function to run before terminating it.
Type: Integer
Valid Range: Minimum value of 1.

** TracingConfig ** The function's AWS 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

CodeStorageExceededException
You have exceeded your maximum total code size per account. Limits
HTTP Status Code: 400

InvalidParameterValueException
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
HTTP Status Code: 400

PreconditionFailedException
The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.
HTTP Status Code: 412

ResourceNotFoundException
The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
HTTP Status Code: 404

ServiceException
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500

TooManyRequestsException
Request throughput limit exceeded
HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: