Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface InvokeWithResponseStreamRequest

Hierarchy

  • InvokeWithResponseStreamRequest

Properties

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.

Name formats

  • Function namemy-function.

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

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

InvocationType?: string

Use one of the following options:

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

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

LogType?: string

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

Payload?: Uint8Array

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

You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

Qualifier?: string

The alias name.