Skip to content

Lambda  >  Operations  >  invoke_async

invoke_async

Operation

invoke_async async 

invoke_async(input: InvokeAsyncInput, plugins: list[Plugin] | None = None) -> InvokeAsyncOutput
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.

Parameters:

Name Type Description Default
input InvokeAsyncInput

An instance of InvokeAsyncInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
InvokeAsyncOutput

An instance of InvokeAsyncOutput.

Input

InvokeAsyncInput dataclass

Dataclass for InvokeAsyncInput structure.

Attributes

function_name class-attribute instance-attribute 
function_name: str | None = None

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.

invoke_args class-attribute instance-attribute 
invoke_args: StreamingBlob | None = None

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

Output

InvokeAsyncOutput dataclass

A success response (202 Accepted) indicates that the request is queued for invocation.

Attributes

status class-attribute instance-attribute 
status: int = 0

The status code.