POST /2015-03-31/functions
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, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container image, then you set the package type to 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.
If the deployment package is a .zip file archive, then you set the package type to Zip. 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, then 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 Lambda 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 of signing profiles, which define the trusted publishers for this function.
If another Amazon Web Services account or an Amazon Web Service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (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, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
Servers
- https://lambda.{region}.amazonaws.com
- https://lambda.{region}.amazonaws.com.cn
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Amz-Content-Sha256 |
String | No | |
X-Amz-Credential |
String | No | |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Amz-Date |
String | No | |
X-Amz-Algorithm |
String | No | |
X-Amz-SignedHeaders |
String | No | |
X-Amz-Security-Token |
String | No | |
X-Amz-Signature |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
Code |
Object | Yes |
The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image. |
Code.S3Bucket |
String | No |
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. |
Code.S3ObjectVersion |
String | No |
For versioned objects, the version of the deployment package object to use. |
Code.ZipFile |
String | No |
The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. |
Code.ImageUri |
String | No |
URI of a container image in the Amazon ECR registry. |
Code.S3Key |
String | No |
The Amazon S3 key of the deployment package. |
PackageType |
String | No |
The type of deployment package. Set to Possible values:
|
Environment |
Object | No |
A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration. |
CodeSigningConfigArn |
String | No |
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. |
Runtime |
String | No |
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see Runtime deprecation policy. Possible values:
|
Layers[] |
Array | No |
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. |
Tags |
Object | No |
A list of tags to apply to the function. |
FunctionName |
String | Yes |
The name of the Lambda function. Name 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. |
KMSKeyArn |
String | No |
The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key. |
Architectures[] |
Array | No |
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 |
DeadLetterConfig |
Object | No |
The dead-letter queue for failed asynchronous invocations. |
DeadLetterConfig.TargetArn |
String | No |
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. |
FileSystemConfigs[] |
Array | No |
Connection settings for an Amazon EFS file system. |
FileSystemConfigs[].Arn |
String | Yes |
The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. |
FileSystemConfigs[].LocalMountPath |
String | Yes |
The path where the function can access the file system, starting with |
Role |
String | Yes |
The Amazon Resource Name (ARN) of the function's execution role. |
Description |
String | No |
A description of the function. |
VpcConfig |
Object | No |
The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC. |
VpcConfig.SubnetIds[] |
Array | No |
A list of VPC subnet IDs. |
VpcConfig.SecurityGroupIds[] |
Array | No |
A list of VPC security group IDs. |
ImageConfig |
Object | No |
Configuration values that override the container image Dockerfile settings. For more information, see Container image settings. |
ImageConfig.EntryPoint[] |
Array | No |
Specifies the entry point to their application, which is typically the location of the runtime executable. |
ImageConfig.WorkingDirectory |
String | No |
Specifies the working directory. |
ImageConfig.Command[] |
Array | No |
Specifies parameters that you want to pass in with ENTRYPOINT. |
Timeout |
Integer | No |
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 more information, see Lambda execution environment. |
EphemeralStorage |
Object | No |
The size of the function's |
EphemeralStorage.Size |
Integer | No |
The size of the function's |
MemorySize |
Integer | No |
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. |
Publish |
Boolean | No |
Set to true to publish the first version of the function during creation. |
TracingConfig |
Object | No |
The function's X-Ray tracing configuration. To sample and record incoming requests, set |
TracingConfig.Mode |
String | No |
The tracing mode. Possible values:
|
SnapStart |
Object | No |
The function's Lambda SnapStart setting. Set SnapStart is supported with the |
SnapStart.ApplyOn |
String | No |
Set to Possible values:
|
Handler |
String | No |
The name of the method within your code that Lambda calls to run 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 Lambda programming model. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.