Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

InvokeAsync

This action has been deprecated.

Note

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

Note

The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke.

Note

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.

Request Syntax


POST /2014-11-13/functions/FunctionName/invoke-async HTTP/1.1

InvokeArgs

URI Request Parameters

The request uses the following URI parameters.

FunctionName

The name or ARN 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.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST(\.PUBLISHED)?|[a-zA-Z0-9-_]+))?

Required: Yes

Request Body

The request accepts the following binary data.

InvokeArgs

The JSON that you want to provide to your Lambda function as input.

Required: Yes

Response Syntax


HTTP/1.1 Status

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The status code.

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidRequestContentException

The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId' header is not a valid UUID string.

message: The exception message.
Type: The exception type.

HTTP Status Code: 400

InvalidRuntimeException

The runtime or runtime version specified is not supported.

HTTP Status Code: 502

ModeNotSupportedException

The Lambda function doesn't support the invocation mode requested. For example, calling Invoke with InvocationType=RequestResponse on a function configured for asynchronous-only invocation, or vice versa. For more information about invocation types, see Invoking Lambda functions.

message: The exception message.
Type: The exception type.

HTTP Status Code: 400

ResourceConflictException

The resource already exists, or another operation is in progress.

message: The exception message.
Type: The exception type.

HTTP Status Code: 409

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ServiceException

The AWS Lambda service encountered an internal error.

HTTP Status Code: 500

ServiceQuotaExceededException

The request would exceed a service quota. For more information about Lambda service quotas, see Lambda quotas. To request a quota increase, see Requesting a quota increase in the Service Quotas User Guide.

Message: The exception message.
Type: The exception type.

HTTP Status Code: 402

SnapStartRegenerationFailureException

Lambda couldn't regenerate the SnapStart snapshot for the function. SnapStart-enabled functions periodically regenerate snapshots when their underlying runtime or dependencies change; this regeneration failed. Wait for Lambda to retry, or update the function's configuration to trigger a new snapshot. For more information, see Lambda SnapStart.

Message: The exception message.
Type: The exception type.

HTTP Status Code: 409