UpdateFunctionConfigurationCommand

Use a bare-bones client and the command you need to make an API call.

To update a Lambda function's configuration

UpdateFunctionConfigurationCommandInput

[UpdateFunctionConfigurationCommandInput](@aws-sdk/client-lambda!UpdateFunctionConfigurationCommandInput:Interface)

Modify the version-specific settings of a Lambda function. When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The <code>LastUpdateStatus</code>, <code>LastUpdateStatusReason</code>, and <code>LastUpdateStatusReasonCode</code> fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html">Lambda function states</a>. These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version. To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

FunctionName

The name or ARN of the Lambda function. Name formats <ul> <li> Function name – <code>my-function</code>. </li> <li> Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>. </li> <li> Partial ARN – <code>123456789012:function:my-function</code>. </li> </ul> The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

CapacityProviderConfig

Configuration for the capacity provider that manages compute resources for Lambda functions.

DeadLetterConfig

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq">Dead-letter queues</a>.

Description

DurableConfig

Configuration settings for durable functions. Allows updating execution timeout and retention period for functions with durability enabled.

Environment

Environment variables that are accessible from function code during execution.

EphemeralStorage

The size of the function's <code>/tmp</code> directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage">Configuring ephemeral storage (console)</a>.

FileSystemConfigs

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

Handler

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html">Lambda programming model</a>.

ImageConfig

<a href="https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms">Container image configuration values</a> that override the values in the container image Docker file.

KMSKeyArn

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources: <ul> <li> The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption">environment variables</a>. </li> <li> The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html">Lambda SnapStart</a> snapshots. </li> <li> When used with <code>SourceKMSKeyArn</code>, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/encrypt-zip-package.html#enable-zip-custom-encryption"> Specifying a customer managed key for Lambda</a>. </li> <li> 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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-lifecycle">Function lifecycle</a>. </li> </ul> If you don't provide a customer managed key, Lambda uses an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.

Layers

A list of <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">function layers</a> to add to the function's execution environment. Specify each layer by its ARN, including the version.

LoggingConfig

The function's Amazon CloudWatch Logs configuration settings.

MemorySize

The amount of <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console">memory available to the function</a> at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

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.

Role

The Amazon Resource Name (ARN) of the function's execution role.

Runtime

The identifier of the function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html"> runtime</a>. 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 <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels">Runtime use after deprecation</a>. For a list of all currently supported runtimes, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported">Supported runtimes</a>.

SnapStart

The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html">SnapStart</a> setting.

Timeout

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html">Lambda execution environment</a>.

TracingConfig

Set <code>Mode</code> to <code>Active</code> to sample and trace a subset of incoming requests with <a href="https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html">X-Ray</a>.

VpcConfig

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html">Configuring a Lambda function to access resources in a VPC</a>.

The input for [UpdateFunctionConfigurationCommand](@aws-sdk/client-lambda!UpdateFunctionConfigurationCommand:Class).

$metadata

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 <code>x86_64</code>.

CodeSha256

The SHA256 hash of the function's deployment package.

CodeSize

The size of the function's deployment package, in bytes.

ConfigSha256

The SHA256 hash of the function configuration.

The function's durable execution configuration settings, if the function is configured for durability.

The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html">environment variables</a>. Omitted from CloudTrail logs.

Connection settings for an <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html">Amazon EFS file system</a> or an <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html">Amazon S3 Files file system</a>.

FunctionArn

The function's Amazon Resource Name (ARN).

The function that Lambda calls to begin running your function.

ImageConfigResponse

The function's image configuration values.

LastModified

The date and time that the function was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).

LastUpdateStatus

The status of the last update that was performed on the function. This is first set to <code>Successful</code> after function creation completes.

LastUpdateStatusReason

The reason for the last update that was performed on the function.

LastUpdateStatusReasonCode

The reason code for the last update that was performed on the function.

The function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">layers</a>.

MasterArn

For Lambda@Edge functions, the ARN of the main function.

The amount of memory available to the function at runtime.

PackageType

The type of deployment package. Set to <code>Image</code> for container image and set <code>Zip</code> for .zip file archive.

The latest updated revision of the function or alias.

RuntimeVersionConfig

The ARN of the runtime and any errors that occured.

SigningJobArn

SigningProfileVersionArn

The ARN of the signing profile version.

Set <code>ApplyOn</code> to <code>PublishedVersions</code> to create a snapshot of the initialized execution environment when you publish a function version. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html">Improving startup performance with Lambda SnapStart</a>.

State

The current state of the function. When the state is <code>Inactive</code>, you can reactivate the function by invoking it.

StateReason

The reason for the function's current state.

StateReasonCode

The reason code for the function's current state. When the code is <code>Creating</code>, you can't invoke or modify the function.

TenancyConfig

The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.

The amount of time in seconds that Lambda allows a function to run before stopping it.

The function's X-Ray tracing configuration.

Version

The version of the Lambda function.

The function's networking configuration.

UpdateFunctionConfigurationCommandOutput

The output of [UpdateFunctionConfigurationCommand](@aws-sdk/client-lambda!UpdateFunctionConfigurationCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

Message

Type

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

name

CodeSigningConfigNotFoundException

The specified code signing configuration does not exist.

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.

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.

InvalidParameterValueException

One of the parameters in the request is not valid.

PreconditionFailedException

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. <ul> <li> For AddPermission and RemovePermission API operations: Call <code>GetPolicy</code> to retrieve the latest RevisionId for your resource. </li> <li> For all other API operations: Call <code>GetFunction</code> or <code>GetAlias</code> to retrieve the latest RevisionId for your resource. </li> </ul>

ResourceConflictException

The resource already exists, or another operation is in progress.

ResourceNotFoundException

The resource specified in the request does not exist.

ServiceException

The Lambda service encountered an internal error.

Reason

retryAfterSeconds

The number of seconds the caller should wait before retrying.

TooManyRequestsException

The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.

LambdaServiceException

Base exception class for all service exceptions from Lambda service.