GetFunctionConfigurationCommand

Suggest an Edit

Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

To get all of a function's details, including function-level settings, use GetFunction.

Example Syntax

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

import { LambdaClient, GetFunctionConfigurationCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, GetFunctionConfigurationCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // GetFunctionConfigurationRequest
  FunctionName: "STRING_VALUE", // required
  Qualifier: "STRING_VALUE",
};
const command = new GetFunctionConfigurationCommand(input);
const response = await client.send(command);
// { // FunctionConfiguration
//   FunctionName: "STRING_VALUE",
//   FunctionArn: "STRING_VALUE",
//   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" || "dotnet8" || "nodejs4.3-edge" || "go1.x" || "ruby2.5" || "ruby2.7" || "provided" || "provided.al2" || "nodejs18.x" || "python3.10" || "java17" || "ruby3.2" || "ruby3.3" || "ruby3.4" || "python3.11" || "nodejs20.x" || "provided.al2023" || "python3.12" || "java21" || "python3.13" || "nodejs22.x",
//   Role: "STRING_VALUE",
//   Handler: "STRING_VALUE",
//   CodeSize: Number("long"),
//   Description: "STRING_VALUE",
//   Timeout: Number("int"),
//   MemorySize: Number("int"),
//   LastModified: "STRING_VALUE",
//   CodeSha256: "STRING_VALUE",
//   Version: "STRING_VALUE",
//   VpcConfig: { // VpcConfigResponse
//     SubnetIds: [ // SubnetIds
//       "STRING_VALUE",
//     ],
//     SecurityGroupIds: [ // SecurityGroupIds
//       "STRING_VALUE",
//     ],
//     VpcId: "STRING_VALUE",
//     Ipv6AllowedForDualStack: true || false,
//   },
//   DeadLetterConfig: { // DeadLetterConfig
//     TargetArn: "STRING_VALUE",
//   },
//   Environment: { // EnvironmentResponse
//     Variables: { // EnvironmentVariables
//       "<keys>": "STRING_VALUE",
//     },
//     Error: { // EnvironmentError
//       ErrorCode: "STRING_VALUE",
//       Message: "STRING_VALUE",
//     },
//   },
//   KMSKeyArn: "STRING_VALUE",
//   TracingConfig: { // TracingConfigResponse
//     Mode: "Active" || "PassThrough",
//   },
//   MasterArn: "STRING_VALUE",
//   RevisionId: "STRING_VALUE",
//   Layers: [ // LayersReferenceList
//     { // Layer
//       Arn: "STRING_VALUE",
//       CodeSize: Number("long"),
//       SigningProfileVersionArn: "STRING_VALUE",
//       SigningJobArn: "STRING_VALUE",
//     },
//   ],
//   State: "Pending" || "Active" || "Inactive" || "Failed",
//   StateReason: "STRING_VALUE",
//   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_VALUE",
//   LastUpdateStatusReasonCode: "EniLimitExceeded" || "InsufficientRolePermissions" || "InvalidConfiguration" || "InternalError" || "SubnetOutOfIPAddresses" || "InvalidSubnet" || "InvalidSecurityGroup" || "ImageDeleted" || "ImageAccessDenied" || "InvalidImage" || "KMSKeyAccessDenied" || "KMSKeyNotFound" || "InvalidStateKMSKey" || "DisabledKMSKey" || "EFSIOError" || "EFSMountConnectivityError" || "EFSMountFailure" || "EFSMountTimeout" || "InvalidRuntime" || "InvalidZipFileException" || "FunctionError",
//   FileSystemConfigs: [ // FileSystemConfigList
//     { // FileSystemConfig
//       Arn: "STRING_VALUE", // required
//       LocalMountPath: "STRING_VALUE", // required
//     },
//   ],
//   PackageType: "Zip" || "Image",
//   ImageConfigResponse: { // ImageConfigResponse
//     ImageConfig: { // ImageConfig
//       EntryPoint: [ // StringList
//         "STRING_VALUE",
//       ],
//       Command: [
//         "STRING_VALUE",
//       ],
//       WorkingDirectory: "STRING_VALUE",
//     },
//     Error: { // ImageConfigError
//       ErrorCode: "STRING_VALUE",
//       Message: "STRING_VALUE",
//     },
//   },
//   SigningProfileVersionArn: "STRING_VALUE",
//   SigningJobArn: "STRING_VALUE",
//   Architectures: [ // ArchitecturesList
//     "x86_64" || "arm64",
//   ],
//   EphemeralStorage: { // EphemeralStorage
//     Size: Number("int"), // required
//   },
//   SnapStart: { // SnapStartResponse
//     ApplyOn: "PublishedVersions" || "None",
//     OptimizationStatus: "On" || "Off",
//   },
//   RuntimeVersionConfig: { // RuntimeVersionConfig
//     RuntimeVersionArn: "STRING_VALUE",
//     Error: { // RuntimeVersionError
//       ErrorCode: "STRING_VALUE",
//       Message: "STRING_VALUE",
//     },
//   },
//   LoggingConfig: { // LoggingConfig
//     LogFormat: "JSON" || "Text",
//     ApplicationLogLevel: "TRACE" || "DEBUG" || "INFO" || "WARN" || "ERROR" || "FATAL",
//     SystemLogLevel: "DEBUG" || "INFO" || "WARN",
//     LogGroup: "STRING_VALUE",
//   },
// };

Example Usage

 There was an error loading the code editor. Retry

GetFunctionConfigurationCommand Input

See GetFunctionConfigurationCommandInput for more details

Parameter
Type
Description
FunctionName
Required
string | undefined

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Qualifier
string | undefined

Specify a version or alias to get details about a published version of the function.

GetFunctionConfigurationCommand Output

See GetFunctionConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Architectures
Architecture[] | undefined

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.

CodeSha256
string | undefined

The SHA256 hash of the function's deployment package.

CodeSize
number | undefined

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

DeadLetterConfig
DeadLetterConfig | undefined

The function's dead letter queue.

Description
string | undefined

The function's description.

Environment
EnvironmentResponse | undefined

The function's environment variables . Omitted from CloudTrail logs.

EphemeralStorage
EphemeralStorage | undefined

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console) .

FileSystemConfigs
FileSystemConfig[] | undefined

Connection settings for an Amazon EFS file system .

FunctionArn
string | undefined

The function's Amazon Resource Name (ARN).

FunctionName
string | undefined

The name of the function.

Handler
string | undefined

The function that Lambda calls to begin running your function.

ImageConfigResponse
ImageConfigResponse | undefined

The function's image configuration values.

KMSKeyArn
string | undefined

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables .

  • The function's Lambda SnapStart  snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda .

  • 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 Function lifecycle .

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key  or an Amazon Web Services managed key .

LastModified
string | undefined

The date and time that the function was last updated, in ISO-8601 format  (YYYY-MM-DDThh:mm:ss.sTZD).

LastUpdateStatus
LastUpdateStatus | undefined

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

LastUpdateStatusReason
string | undefined

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

LastUpdateStatusReasonCode
LastUpdateStatusReasonCode | undefined

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

Layers
Layer[] | undefined

The function's layers .

LoggingConfig
LoggingConfig | undefined

The function's Amazon CloudWatch Logs configuration settings.

MasterArn
string | undefined

For LambdaEdge functions, the ARN of the main function.

MemorySize
number | undefined

The amount of memory available to the function at runtime.

PackageType
PackageType | undefined

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

RevisionId
string | undefined

The latest updated revision of the function or alias.

Role
string | undefined

The function's execution role.

Runtime
Runtime | undefined

The identifier of the function's runtime . 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 Runtime use after deprecation .

For a list of all currently supported runtimes, see Supported runtimes .

RuntimeVersionConfig
RuntimeVersionConfig | undefined

The ARN of the runtime and any errors that occured.

SigningJobArn
string | undefined

The ARN of the signing job.

SigningProfileVersionArn
string | undefined

The ARN of the signing profile version.

SnapStart
SnapStartResponse | undefined

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 .

State
State | undefined

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

StateReason
string | undefined

The reason for the function's current state.

StateReasonCode
StateReasonCode | undefined

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

Timeout
number | undefined

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

TracingConfig
TracingConfigResponse | undefined

The function's X-Ray tracing configuration.

Version
string | undefined

The version of the Lambda function.

VpcConfig
VpcConfigResponse | undefined

The function's networking configuration.

Throws

Name
Fault
Details
InvalidParameterValueException
client

One of the parameters in the request is not valid.

ResourceNotFoundException
client

The resource specified in the request does not exist.

ServiceException
server

The Lambda service encountered an internal error.

TooManyRequestsException
client

The request throughput limit was exceeded. For more information, see Lambda quotas .

LambdaServiceException
Base exception class for all service exceptions from Lambda service.