Skip to content

/AWS1/CL_LMD=>INVOKEWITHRESPONSESTREAM()

About InvokeWithResponseStream

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

Method Signature

IMPORTING

Required arguments:

IV_FUNCTIONNAME TYPE /AWS1/LMDNAMESPACEDFUNCNAME /AWS1/LMDNAMESPACEDFUNCNAME

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

Optional arguments:

IV_INVOCATIONTYPE TYPE /AWS1/LMDRSPSTREAMINGINVCTYPE /AWS1/LMDRSPSTREAMINGINVCTYPE

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.

IV_LOGTYPE TYPE /AWS1/LMDLOGTYPE /AWS1/LMDLOGTYPE

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

IV_CLIENTCONTEXT TYPE /AWS1/LMDSTRING /AWS1/LMDSTRING

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

IV_QUALIFIER TYPE /AWS1/LMDQUALIFIER /AWS1/LMDQUALIFIER

The alias name.

IV_PAYLOAD TYPE /AWS1/LMDBLOB /AWS1/LMDBLOB

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_LMDINVKWITHRSPSTRMRSP /AWS1/CL_LMDINVKWITHRSPSTRMRSP