Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration operation.
GET /2015-03-31/functions/FunctionName/configuration?Qualifier=Qualifier HTTP/1.1
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 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-_]+))?
** 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$_-]+)
The request does not have a request body.
HTTP/1.1 200
Content-type: application/json
{
"[CodeSha256](#SSS-GetFunctionConfiguration-response-CodeSha256)": "string",
"[CodeSize](#SSS-GetFunctionConfiguration-response-CodeSize)": number,
"[DeadLetterConfig](#SSS-GetFunctionConfiguration-response-DeadLetterConfig)": {
"[TargetArn](API_DeadLetterConfig.md#SSS-Type-DeadLetterConfig-TargetArn)": "string"
},
"[Description](#SSS-GetFunctionConfiguration-response-Description)": "string",
"[Environment](#SSS-GetFunctionConfiguration-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-GetFunctionConfiguration-response-FunctionArn)": "string",
"[FunctionName](#SSS-GetFunctionConfiguration-response-FunctionName)": "string",
"[Handler](#SSS-GetFunctionConfiguration-response-Handler)": "string",
"[KMSKeyArn](#SSS-GetFunctionConfiguration-response-KMSKeyArn)": "string",
"[LastModified](#SSS-GetFunctionConfiguration-response-LastModified)": "string",
"[Layers](#SSS-GetFunctionConfiguration-response-Layers)": [
{
"[Arn](API_Layer.md#SSS-Type-Layer-Arn)": "string",
"[CodeSize](API_Layer.md#SSS-Type-Layer-CodeSize)": number
}
],
"[MasterArn](#SSS-GetFunctionConfiguration-response-MasterArn)": "string",
"[MemorySize](#SSS-GetFunctionConfiguration-response-MemorySize)": number,
"[RevisionId](#SSS-GetFunctionConfiguration-response-RevisionId)": "string",
"[Role](#SSS-GetFunctionConfiguration-response-Role)": "string",
"[Runtime](#SSS-GetFunctionConfiguration-response-Runtime)": "string",
"[Timeout](#SSS-GetFunctionConfiguration-response-Timeout)": number,
"[TracingConfig](#SSS-GetFunctionConfiguration-response-TracingConfig)": {
"[Mode](API_TracingConfigResponse.md#SSS-Type-TracingConfigResponse-Mode)": "string"
},
"[Version](#SSS-GetFunctionConfiguration-response-Version)": "string",
"[VpcConfig](#SSS-GetFunctionConfiguration-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"
}
}
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
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
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
For more information about using this API in one of the language-specific AWS SDKs, see the following: