2022/05/12 - AWS Lambda - 13 updated api methods
Changes Lambda releases NodeJs 16 managed runtime to be available in all commercial regions.
{'Runtime': {'nodejs16.x'}}
Creates a Lambda function. To create a function, you need a deployment package and an execution role . The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
You set the package type to Image if the deployment package is a container image . For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a .zip file archive . For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64 ). If you do not specify the architecture, the default value is x86-64 .
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State , StateReason , and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States .
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration . Function-level settings apply to both the unpublished and published versions of the function, and include tags ( TagResource ) and per-function concurrency limits ( PutFunctionConcurrency ).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode , Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function.
If another account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke . To invoke your function in response to events in other Amazon Web Services services, create an event source mapping ( CreateEventSourceMapping ), or configure a function trigger in the other service. For more information, see Invoking Functions .
See also: AWS API Documentation
Request Syntax
client.create_function(
FunctionName='string',
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',
Role='string',
Handler='string',
Code={
'ZipFile': b'bytes',
'S3Bucket': 'string',
'S3Key': 'string',
'S3ObjectVersion': 'string',
'ImageUri': 'string'
},
Description='string',
Timeout=123,
MemorySize=123,
Publish=True|False,
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
PackageType='Zip'|'Image',
DeadLetterConfig={
'TargetArn': 'string'
},
Environment={
'Variables': {
'string': 'string'
}
},
KMSKeyArn='string',
TracingConfig={
'Mode': 'Active'|'PassThrough'
},
Tags={
'string': 'string'
},
Layers=[
'string',
],
FileSystemConfigs=[
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
ImageConfig={
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
CodeSigningConfigArn='string',
Architectures=[
'x86_64'|'arm64',
],
EphemeralStorage={
'Size': 123
}
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - my-function .
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN - 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the function's execution role.
string
The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model .
dict
[REQUIRED]
The code for the function.
ZipFile (bytes) --
The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
S3Bucket (string) --
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
S3Key (string) --
The Amazon S3 key of the deployment package.
S3ObjectVersion (string) --
For versioned objects, the version of the deployment package object to use.
ImageUri (string) --
URI of a container image in the Amazon ECR registry.
string
A description of the function.
integer
The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment .
integer
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
boolean
Set to true to publish the first version of the function during creation.
dict
For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings .
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
string
The type of deployment package. Set to Image for container image and set Zip for ZIP archive.
dict
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues .
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
dict
Environment variables that are accessible from function code during execution.
Variables (dict) --
Environment variable key-value pairs. For more information, see Using Lambda environment variables .
(string) --
(string) --
string
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
dict
Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .
Mode (string) --
The tracing mode.
dict
A list of tags to apply to the function.
(string) --
(string) --
list
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
(string) --
list
Connection settings for an Amazon EFS file system.
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) -- [REQUIRED]
The path where the function can access the file system, starting with /mnt/ .
dict
Container image configuration values that override the values in the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
string
To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
list
The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64 .
(string) --
dict
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.
Size (integer) -- [REQUIRED]
The size of the function’s /tmp directory.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
}
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
{'Configuration': {'Runtime': {'nodejs16.x'}}}
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.
See also: AWS API Documentation
Request Syntax
client.get_function(
FunctionName='string',
Qualifier='string'
)
string
[REQUIRED]
The name 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.
string
Specify a version or alias to get details about a published version of the function.
dict
Response Syntax
{
'Configuration': {
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
},
'Code': {
'RepositoryType': 'string',
'Location': 'string',
'ImageUri': 'string',
'ResolvedImageUri': 'string'
},
'Tags': {
'string': 'string'
},
'Concurrency': {
'ReservedConcurrentExecutions': 123
}
}
Response Structure
(dict) --
Configuration (dict) --
The configuration of the function or version.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
Code (dict) --
The deployment package of the function or version.
RepositoryType (string) --
The service that's hosting the file.
Location (string) --
A presigned URL that you can use to download the deployment package.
ImageUri (string) --
URI of a container image in the Amazon ECR registry.
ResolvedImageUri (string) --
The resolved URI for the image.
Tags (dict) --
The function's tags .
(string) --
(string) --
Concurrency (dict) --
The function's reserved concurrency .
ReservedConcurrentExecutions (integer) --
The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency .
{'Runtime': {'nodejs16.x'}}
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 .
See also: AWS API Documentation
Request Syntax
client.get_function_configuration(
FunctionName='string',
Qualifier='string'
)
string
[REQUIRED]
The name 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.
string
Specify a version or alias to get details about a published version of the function.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
}
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
{'CompatibleRuntimes': {'nodejs16.x'}}
Returns information about a version of an Lambda layer , with a link to download the layer archive that's valid for 10 minutes.
See also: AWS API Documentation
Request Syntax
client.get_layer_version(
LayerName='string',
VersionNumber=123
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
integer
[REQUIRED]
The version number.
dict
Response Syntax
{
'Content': {
'Location': 'string',
'CodeSha256': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
'LayerArn': 'string',
'LayerVersionArn': 'string',
'Description': 'string',
'CreatedDate': 'string',
'Version': 123,
'CompatibleRuntimes': [
'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',
],
'LicenseInfo': 'string',
'CompatibleArchitectures': [
'x86_64'|'arm64',
]
}
Response Structure
(dict) --
Content (dict) --
Details about the layer version.
Location (string) --
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
CodeSha256 (string) --
The SHA-256 hash of the layer archive.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
LayerArn (string) --
The ARN of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Version (integer) --
The version number.
CompatibleRuntimes (list) --
The layer's compatible runtimes.
(string) --
LicenseInfo (string) --
The layer's software license.
CompatibleArchitectures (list) --
A list of compatible instruction set architectures .
(string) --
{'CompatibleRuntimes': {'nodejs16.x'}}
Returns information about a version of an Lambda layer , with a link to download the layer archive that's valid for 10 minutes.
See also: AWS API Documentation
Request Syntax
client.get_layer_version_by_arn(
Arn='string'
)
string
[REQUIRED]
The ARN of the layer version.
dict
Response Syntax
{
'Content': {
'Location': 'string',
'CodeSha256': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
'LayerArn': 'string',
'LayerVersionArn': 'string',
'Description': 'string',
'CreatedDate': 'string',
'Version': 123,
'CompatibleRuntimes': [
'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',
],
'LicenseInfo': 'string',
'CompatibleArchitectures': [
'x86_64'|'arm64',
]
}
Response Structure
(dict) --
Content (dict) --
Details about the layer version.
Location (string) --
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
CodeSha256 (string) --
The SHA-256 hash of the layer archive.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
LayerArn (string) --
The ARN of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Version (integer) --
The version number.
CompatibleRuntimes (list) --
The layer's compatible runtimes.
(string) --
LicenseInfo (string) --
The layer's software license.
CompatibleArchitectures (list) --
A list of compatible instruction set architectures .
(string) --
{'Functions': {'Runtime': {'nodejs16.x'}}}
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.
Note
The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction .
See also: AWS API Documentation
Request Syntax
client.list_functions(
MasterRegion='string',
FunctionVersion='ALL',
Marker='string',
MaxItems=123
)
string
For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL .
string
Set to ALL to include entries for all published versions of each function.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
integer
The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.
dict
Response Syntax
{
'NextMarker': 'string',
'Functions': [
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
},
]
}
Response Structure
(dict) --
A list of Lambda functions.
NextMarker (string) --
The pagination token that's included if more results are available.
Functions (list) --
A list of Lambda functions.
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
{'CompatibleRuntime': {'nodejs16.x'}}
Response {'LayerVersions': {'CompatibleRuntimes': {'nodejs16.x'}}}
Lists the versions of an Lambda layer . Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.
See also: AWS API Documentation
Request Syntax
client.list_layer_versions(
CompatibleRuntime='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',
LayerName='string',
Marker='string',
MaxItems=123,
CompatibleArchitecture='x86_64'|'arm64'
)
string
A runtime identifier. For example, go1.x .
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
string
A pagination token returned by a previous call.
integer
The maximum number of versions to return.
string
The compatible instruction set architecture .
dict
Response Syntax
{
'NextMarker': 'string',
'LayerVersions': [
{
'LayerVersionArn': 'string',
'Version': 123,
'Description': 'string',
'CreatedDate': 'string',
'CompatibleRuntimes': [
'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',
],
'LicenseInfo': 'string',
'CompatibleArchitectures': [
'x86_64'|'arm64',
]
},
]
}
Response Structure
(dict) --
NextMarker (string) --
A pagination token returned when the response doesn't contain all versions.
LayerVersions (list) --
A list of versions.
(dict) --
Details about a version of an Lambda layer .
LayerVersionArn (string) --
The ARN of the layer version.
Version (integer) --
The version number.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000 .
CompatibleRuntimes (list) --
The layer's compatible runtimes.
(string) --
LicenseInfo (string) --
The layer's open-source license.
CompatibleArchitectures (list) --
A list of compatible instruction set architectures .
(string) --
{'CompatibleRuntime': {'nodejs16.x'}}
Response {'Layers': {'LatestMatchingVersion': {'CompatibleRuntimes': {'nodejs16.x'}}}}
Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture .
See also: AWS API Documentation
Request Syntax
client.list_layers(
CompatibleRuntime='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',
Marker='string',
MaxItems=123,
CompatibleArchitecture='x86_64'|'arm64'
)
string
A runtime identifier. For example, go1.x .
string
A pagination token returned by a previous call.
integer
The maximum number of layers to return.
string
The compatible instruction set architecture .
dict
Response Syntax
{
'NextMarker': 'string',
'Layers': [
{
'LayerName': 'string',
'LayerArn': 'string',
'LatestMatchingVersion': {
'LayerVersionArn': 'string',
'Version': 123,
'Description': 'string',
'CreatedDate': 'string',
'CompatibleRuntimes': [
'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',
],
'LicenseInfo': 'string',
'CompatibleArchitectures': [
'x86_64'|'arm64',
]
}
},
]
}
Response Structure
(dict) --
NextMarker (string) --
A pagination token returned when the response doesn't contain all layers.
Layers (list) --
A list of function layers.
(dict) --
Details about an Lambda layer .
LayerName (string) --
The name of the layer.
LayerArn (string) --
The Amazon Resource Name (ARN) of the function layer.
LatestMatchingVersion (dict) --
The newest version of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Version (integer) --
The version number.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000 .
CompatibleRuntimes (list) --
The layer's compatible runtimes.
(string) --
LicenseInfo (string) --
The layer's open-source license.
CompatibleArchitectures (list) --
A list of compatible instruction set architectures .
(string) --
{'Versions': {'Runtime': {'nodejs16.x'}}}
Returns a list of versions , with the version-specific configuration of each. Lambda returns up to 50 versions per call.
See also: AWS API Documentation
Request Syntax
client.list_versions_by_function(
FunctionName='string',
Marker='string',
MaxItems=123
)
string
[REQUIRED]
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.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
integer
The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.
dict
Response Syntax
{
'NextMarker': 'string',
'Versions': [
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
},
]
}
Response Structure
(dict) --
NextMarker (string) --
The pagination token that's included if more results are available.
Versions (list) --
A list of Lambda function versions.
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
{'CompatibleRuntimes': {'nodejs16.x'}}
Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration .
See also: AWS API Documentation
Request Syntax
client.publish_layer_version(
LayerName='string',
Description='string',
Content={
'S3Bucket': 'string',
'S3Key': 'string',
'S3ObjectVersion': 'string',
'ZipFile': b'bytes'
},
CompatibleRuntimes=[
'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',
],
LicenseInfo='string',
CompatibleArchitectures=[
'x86_64'|'arm64',
]
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the layer.
string
The description of the version.
dict
[REQUIRED]
The function layer archive.
S3Bucket (string) --
The Amazon S3 bucket of the layer archive.
S3Key (string) --
The Amazon S3 key of the layer archive.
S3ObjectVersion (string) --
For versioned objects, the version of the layer archive object to use.
ZipFile (bytes) --
The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
list
A list of compatible function runtimes . Used for filtering with ListLayers and ListLayerVersions .
(string) --
string
The layer's software license. It can be any of the following:
An SPDX license identifier . For example, MIT .
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT .
The full text of the license.
list
A list of compatible instruction set architectures .
(string) --
dict
Response Syntax
{
'Content': {
'Location': 'string',
'CodeSha256': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
'LayerArn': 'string',
'LayerVersionArn': 'string',
'Description': 'string',
'CreatedDate': 'string',
'Version': 123,
'CompatibleRuntimes': [
'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',
],
'LicenseInfo': 'string',
'CompatibleArchitectures': [
'x86_64'|'arm64',
]
}
Response Structure
(dict) --
Content (dict) --
Details about the layer version.
Location (string) --
A link to the layer archive in Amazon S3 that is valid for 10 minutes.
CodeSha256 (string) --
The SHA-256 hash of the layer archive.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
LayerArn (string) --
The ARN of the layer.
LayerVersionArn (string) --
The ARN of the layer version.
Description (string) --
The description of the version.
CreatedDate (string) --
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Version (integer) --
The version number.
CompatibleRuntimes (list) --
The layer's compatible runtimes.
(string) --
LicenseInfo (string) --
The layer's software license.
CompatibleArchitectures (list) --
A list of compatible instruction set architectures .
(string) --
{'Runtime': {'nodejs16.x'}}
Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.
Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.
Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias .
See also: AWS API Documentation
Request Syntax
client.publish_version(
FunctionName='string',
CodeSha256='string',
Description='string',
RevisionId='string'
)
string
[REQUIRED]
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.
string
Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode .
string
A description for the version to override the description in the function configuration.
string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
}
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
{'Runtime': {'nodejs16.x'}}
Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing .
If the function's package type is Image , you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.
If the function's package type is Zip , you must specify the deployment package as a .zip file archive . Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.
The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64 ).
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
Note
For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.
See also: AWS API Documentation
Request Syntax
client.update_function_code(
FunctionName='string',
ZipFile=b'bytes',
S3Bucket='string',
S3Key='string',
S3ObjectVersion='string',
ImageUri='string',
Publish=True|False,
DryRun=True|False,
RevisionId='string',
Architectures=[
'x86_64'|'arm64',
]
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - my-function .
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN - 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
bytes
The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.
string
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.
string
The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
string
For versioned objects, the version of the deployment package object to use.
string
URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.
boolean
Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.
boolean
Set to true to validate the request parameters and access permissions without modifying the function code.
string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
list
The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64 .
(string) --
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
}
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.
{'Runtime': {'nodejs16.x'}}
Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus , LastUpdateStatusReason , and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States .
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency . To grant invoke permissions to an account or Amazon Web Services service, use AddPermission .
See also: AWS API Documentation
Request Syntax
client.update_function_configuration(
FunctionName='string',
Role='string',
Handler='string',
Description='string',
Timeout=123,
MemorySize=123,
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
Environment={
'Variables': {
'string': 'string'
}
},
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',
DeadLetterConfig={
'TargetArn': 'string'
},
KMSKeyArn='string',
TracingConfig={
'Mode': 'Active'|'PassThrough'
},
RevisionId='string',
Layers=[
'string',
],
FileSystemConfigs=[
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
ImageConfig={
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
EphemeralStorage={
'Size': 123
}
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name - my-function .
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN - 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
The Amazon Resource Name (ARN) of the function's execution role.
string
The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model .
string
A description of the function.
integer
The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment .
integer
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
dict
For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings .
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
dict
Environment variables that are accessible from function code during execution.
Variables (dict) --
Environment variable key-value pairs. For more information, see Using Lambda environment variables .
(string) --
(string) --
string
The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive.
dict
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues .
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
string
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
dict
Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .
Mode (string) --
The tracing mode.
string
Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.
list
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
(string) --
list
Connection settings for an Amazon EFS file system.
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) -- [REQUIRED]
The path where the function can access the file system, starting with /mnt/ .
dict
Container image configuration values that override the values in the container image Docker file.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
dict
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.
Size (integer) -- [REQUIRED]
The size of the function’s /tmp directory.
dict
Response Syntax
{
'FunctionName': 'string',
'FunctionArn': 'string',
'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',
'Role': 'string',
'Handler': 'string',
'CodeSize': 123,
'Description': 'string',
'Timeout': 123,
'MemorySize': 123,
'LastModified': 'string',
'CodeSha256': 'string',
'Version': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DeadLetterConfig': {
'TargetArn': 'string'
},
'Environment': {
'Variables': {
'string': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'KMSKeyArn': 'string',
'TracingConfig': {
'Mode': 'Active'|'PassThrough'
},
'MasterArn': 'string',
'RevisionId': 'string',
'Layers': [
{
'Arn': 'string',
'CodeSize': 123,
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string'
},
],
'State': 'Pending'|'Active'|'Inactive'|'Failed',
'StateReason': 'string',
'StateReasonCode': 'Idle'|'Creating'|'Restoring'|'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'LastUpdateStatus': 'Successful'|'Failed'|'InProgress',
'LastUpdateStatusReason': 'string',
'LastUpdateStatusReasonCode': 'EniLimitExceeded'|'InsufficientRolePermissions'|'InvalidConfiguration'|'InternalError'|'SubnetOutOfIPAddresses'|'InvalidSubnet'|'InvalidSecurityGroup'|'ImageDeleted'|'ImageAccessDenied'|'InvalidImage',
'FileSystemConfigs': [
{
'Arn': 'string',
'LocalMountPath': 'string'
},
],
'PackageType': 'Zip'|'Image',
'ImageConfigResponse': {
'ImageConfig': {
'EntryPoint': [
'string',
],
'Command': [
'string',
],
'WorkingDirectory': 'string'
},
'Error': {
'ErrorCode': 'string',
'Message': 'string'
}
},
'SigningProfileVersionArn': 'string',
'SigningJobArn': 'string',
'Architectures': [
'x86_64'|'arm64',
],
'EphemeralStorage': {
'Size': 123
}
}
Response Structure
(dict) --
Details about a function's configuration.
FunctionName (string) --
The name of the function.
FunctionArn (string) --
The function's Amazon Resource Name (ARN).
Runtime (string) --
The runtime environment for the Lambda function.
Role (string) --
The function's execution role.
Handler (string) --
The function that Lambda calls to begin executing your function.
CodeSize (integer) --
The size of the function's deployment package, in bytes.
Description (string) --
The function's description.
Timeout (integer) --
The amount of time in seconds that Lambda allows a function to run before stopping it.
MemorySize (integer) --
The amount of memory available to the function at runtime.
LastModified (string) --
The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
CodeSha256 (string) --
The SHA256 hash of the function's deployment package.
Version (string) --
The version of the Lambda function.
VpcConfig (dict) --
The function's networking configuration.
SubnetIds (list) --
A list of VPC subnet IDs.
(string) --
SecurityGroupIds (list) --
A list of VPC security groups IDs.
(string) --
VpcId (string) --
The ID of the VPC.
DeadLetterConfig (dict) --
The function's dead letter queue.
TargetArn (string) --
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment (dict) --
The function's environment variables .
Variables (dict) --
Environment variable key-value pairs.
(string) --
(string) --
Error (dict) --
Error messages for environment variables that couldn't be applied.
ErrorCode (string) --
The error code.
Message (string) --
The error message.
KMSKeyArn (string) --
The 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.
TracingConfig (dict) --
The function's X-Ray tracing configuration.
Mode (string) --
The tracing mode.
MasterArn (string) --
For Lambda@Edge functions, the ARN of the main function.
RevisionId (string) --
The latest updated revision of the function or alias.
Layers (list) --
The function's layers .
(dict) --
An Lambda layer .
Arn (string) --
The Amazon Resource Name (ARN) of the function layer.
CodeSize (integer) --
The size of the layer archive in bytes.
SigningProfileVersionArn (string) --
The Amazon Resource Name (ARN) for a signing profile version.
SigningJobArn (string) --
The Amazon Resource Name (ARN) of a signing job.
State (string) --
The current state of the function. When the state is Inactive , you can reactivate the function by invoking it.
StateReason (string) --
The reason for the function's current state.
StateReasonCode (string) --
The reason code for the function's current state. When the code is Creating , you can't invoke or modify the function.
LastUpdateStatus (string) --
The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
LastUpdateStatusReason (string) --
The reason for the last update that was performed on the function.
LastUpdateStatusReasonCode (string) --
The reason code for the last update that was performed on the function.
FileSystemConfigs (list) --
Connection settings for an Amazon EFS file system .
(dict) --
Details about the connection between a Lambda function and an Amazon EFS file system .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath (string) --
The path where the function can access the file system, starting with /mnt/ .
PackageType (string) --
The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
ImageConfigResponse (dict) --
The function's image configuration values.
ImageConfig (dict) --
Configuration values that override the container image Dockerfile.
EntryPoint (list) --
Specifies the entry point to their application, which is typically the location of the runtime executable.
(string) --
Command (list) --
Specifies parameters that you want to pass in with ENTRYPOINT.
(string) --
WorkingDirectory (string) --
Specifies the working directory.
Error (dict) --
Error response to GetFunctionConfiguration.
ErrorCode (string) --
Error code.
Message (string) --
Error message.
SigningProfileVersionArn (string) --
The ARN of the signing profile version.
SigningJobArn (string) --
The ARN of the signing job.
Architectures (list) --
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 .
(string) --
EphemeralStorage (dict) --
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.
Size (integer) --
The size of the function’s /tmp directory.