Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetFunctionConfiguration

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

Request Syntax


GET /2015-03-31/functions/FunctionName/configuration?Qualifier=Qualifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

FunctionName

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.

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-_]+))?

Required: Yes

Qualifier

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

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern:(|[a-zA-Z0-9$_-]+)

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200Content-type: application/json{   "Architectures": [ "string" ],   "CodeSha256": "string",   "CodeSize":number,   "DeadLetterConfig":{       "TargetArn": "string"   },   "Description": "string",   "Environment":{       "Error":{          "ErrorCode": "string",         "Message": "string"      },      "Variables":{          "string" : "string"       }   },   "EphemeralStorage":{       "Size":number   },   "FileSystemConfigs": [{          "Arn": "string",         "LocalMountPath": "string"      }   ],   "FunctionArn": "string",   "FunctionName": "string",   "Handler": "string",   "ImageConfigResponse":{       "Error":{          "ErrorCode": "string",         "Message": "string"      },      "ImageConfig":{          "Command": [ "string" ],         "EntryPoint": [ "string" ],         "WorkingDirectory": "string"      }   },   "KMSKeyArn": "string",   "LastModified": "string",   "LastUpdateStatus": "string",   "LastUpdateStatusReason": "string",   "LastUpdateStatusReasonCode": "string",   "Layers": [{          "Arn": "string",         "CodeSize":number,         "SigningJobArn": "string",         "SigningProfileVersionArn": "string"      }   ],   "LoggingConfig":{       "ApplicationLogLevel": "string",      "LogFormat": "string",      "LogGroup": "string",      "SystemLogLevel": "string"   },   "MasterArn": "string",   "MemorySize":number,   "PackageType": "string",   "RevisionId": "string",   "Role": "string",   "Runtime": "string",   "RuntimeVersionConfig":{       "Error":{          "ErrorCode": "string",         "Message": "string"      },      "RuntimeVersionArn": "string"   },   "SigningJobArn": "string",   "SigningProfileVersionArn": "string",   "SnapStart":{       "ApplyOn": "string",      "OptimizationStatus": "string"   },   "State": "string",   "StateReason": "string",   "StateReasonCode": "string",   "Timeout":number,   "TracingConfig":{       "Mode": "string"   },   "Version": "string",   "VpcConfig":{       "Ipv6AllowedForDualStack":boolean,      "SecurityGroupIds": [ "string" ],      "SubnetIds": [ "string" ],      "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.

Architectures

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value isx86_64.

Type: Array of strings

Array Members: Fixed number of 1 item.

Valid Values:x86_64 | arm64

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'senvironment variables. Omitted from AWS CloudTrail logs.

Type:EnvironmentResponse object

EphemeralStorage

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, seeConfiguring ephemeral storage (console).

Type:EphemeralStorage object

FileSystemConfigs

Connection settings for anAmazon EFS file system.

Type: Array ofFileSystemConfig objects

Array Members: Maximum number of 1 item.

FunctionArn

The function's Amazon Resource Name (ARN).

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 that Lambda calls to begin running your function.

Type: String

Length Constraints: Maximum length of 128.

Pattern:[^\s]+

ImageConfigResponse

The function's image configuration values.

Type:ImageConfigResponse object

KMSKeyArn

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

The function'senvironment variables.
The function'sLambda SnapStart snapshots.
When used withSourceKMSKeyArn, 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, seeFunction lifecycle.

If you don't provide a customer managed key, Lambda uses anAWS owned key or anAWS managed key.

Type: String

Pattern:(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()

LastModified

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

Type: String

LastUpdateStatus

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

Type: String

Valid Values:Successful | Failed | InProgress

LastUpdateStatusReason

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

Type: String

LastUpdateStatusReasonCode

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

Type: String

Layers

The function'slayers.

Type: Array ofLayer objects

LoggingConfig

The function's Amazon CloudWatch Logs configuration settings.

Type:LoggingConfig object

MasterArn

For Lambda@Edge functions, the ARN of the main 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 amount of memory available to the function at runtime.

Type: Integer

Valid Range: Minimum value of 128. Maximum value of 10240.

PackageType

The type of deployment package. Set toImage for container image and setZip for .zip file archive.

Type: String

Valid Values:Zip | Image

RevisionId

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 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, seeRuntime use after deprecation.

For a list of all currently supported runtimes, seeSupported runtimes.

Type: String

RuntimeVersionConfig

The ARN of the runtime and any errors that occured.

Type:RuntimeVersionConfig object

SigningJobArn

The ARN of the signing job.

Type: String

Pattern:arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

SigningProfileVersionArn

The ARN of the signing profile version.

Type: String

Pattern:arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

SnapStart

SetApplyOn toPublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, seeImproving startup performance with Lambda SnapStart.