Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface InvokeCommandInputProtected

The input for InvokeCommand.



ClientContext?: string

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

FunctionName: undefined | string

The name of the Lambda function, version, or alias.

Name formats

  • Function namemy-function (name-only), my-function:v1 (with alias).

  • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN123456789012: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.

InvocationType?: InvocationType

Choose from the following options.

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

  • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

  • DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

LogType?: LogType

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

Payload?: BlobPayloadInputTypes
Qualifier?: string

Specify a version or alias to invoke a published version of the function.