Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetFunctionConfigurationCommandProtected

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

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" || "nodejs4.3-edge" || "go1.x" || "ruby2.5" || "ruby2.7" || "provided" || "provided.al2" || "nodejs18.x" || "python3.10" || "java17" || "ruby3.2" || "python3.11",
// 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",
// },
// 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",
// },
// },
// };

Param

GetFunctionConfigurationCommandInput

Returns

GetFunctionConfigurationCommandOutput

See

Throws

InvalidParameterValueException (client fault)

One of the parameters in the request is not valid.

Throws

ResourceNotFoundException (client fault)

The resource specified in the request does not exist.

Throws

ServiceException (server fault)

The Lambda service encountered an internal error.

Throws

TooManyRequestsException (client fault)

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

Throws

LambdaServiceException

Base exception class for all service exceptions from Lambda service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods