Skip to content

Latest commit

 

History

History
202 lines (165 loc) · 9.37 KB

API_FunctionConfiguration.md

File metadata and controls

202 lines (165 loc) · 9.37 KB

FunctionConfiguration

Details about a function's configuration.

Contents

** 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 x86_64.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values: x86_64 | arm64
Required: No

** CodeSha256 ** The SHA256 hash of the function's deployment package.
Type: String
Required: No

** CodeSize ** The size of the function's deployment package, in bytes.
Type: Long
Required: No

** DeadLetterConfig ** The function's dead letter queue.
Type: DeadLetterConfig object
Required: No

** Description ** The function's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No

** Environment ** The function's environment variables.
Type: EnvironmentResponse object
Required: No

** 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 10240 MB.
Type: EphemeralStorage object
Required: No

** FileSystemConfigs ** Connection settings for an Amazon EFS file system.
Type: Array of FileSystemConfig objects
Array Members: Maximum number of 1 item.
Required: No

** 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-_]+))?
Required: No

** 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-_]+))?
Required: No

** Handler ** The function that Lambda calls to begin executing your function.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [^\s]+
Required: No

** ImageConfigResponse ** The function's image configuration values.
Type: ImageConfigResponse object
Required: No

** KMSKeyArn ** The AWS KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.
Type: String
Pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()
Required: No

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

** LastUpdateStatus ** The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
Type: String
Valid Values: Successful | Failed | InProgress
Required: No

** LastUpdateStatusReason ** The reason for the last update that was performed on the function.
Type: String
Required: No

** LastUpdateStatusReasonCode ** The reason code for the last update that was performed on the function.
Type: String
Valid Values: EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage
Required: No

** Layers ** The function's layers.
Type: Array of Layer objects
Required: No

** 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-_]+))?
Required: No

** MemorySize ** The amount of memory available to the function at runtime.
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 10240.
Required: No

** PackageType ** The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
Type: String
Valid Values: Zip | Image
Required: No

** RevisionId ** The latest updated revision of the function or alias.
Type: String
Required: No

** Role ** The function's execution role.
Type: String
Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
Required: No

** Runtime ** The runtime environment for the Lambda function.
Type: String
Valid Values: 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
Required: No

** 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})?:(.*)
Required: No

** 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})?:(.*)
Required: No

** State ** The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
Type: String
Valid Values: Pending | Active | Inactive | Failed
Required: No

** StateReason ** The reason for the function's current state.
Type: String
Required: No

** StateReasonCode ** The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
Type: String
Valid Values: Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage
Required: No

** Timeout ** The amount of time in seconds that Lambda allows a function to run before stopping it.
Type: Integer
Valid Range: Minimum value of 1.
Required: No

** TracingConfig ** The function's AWS X-Ray tracing configuration.
Type: TracingConfigResponse object
Required: No

** Version ** The version of the Lambda function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: (\$LATEST|[0-9]+)
Required: No

** VpcConfig ** The function's networking configuration.
Type: VpcConfigResponse object
Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: