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.
post/2021-11-15/functions/{FunctionName}/response-streaming-invocations
Path parameters
FunctionNamestring required
<p>The name of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
Query parameters
Qualifierstring
The alias name.
Headers
X-Amz-Invocation-Type'RequestResponse' | 'DryRun'
<p>Use one of the following options:</p> <ul> <li> <p> <code>RequestResponse</code> (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.</p> </li> <li> <p> <code>DryRun</code> – Validate parameter values and verify that the IAM user or role has permission to invoke the function.</p> </li> </ul>
X-Amz-Log-Type'None' | 'Tail'
Set to <code>Tail</code> to include the execution log in the response. Applies to synchronously invoked functions only.
X-Amz-Client-Contextstring
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
Request body
Response
Success