POST

/2021-11-15/functions/{FunctionName}/response-streaming-invocations

http://lambda.{region}.amazonaws.com/2021-11-15/functions/{FunctionName}/response-streaming-invocations

Configure your Lambda functions to stream response payloads back to clients. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html">Configuring a Lambda function to stream responses</a>. This operation requires permission for the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html">lambda:InvokeFunction</a> action. For details on how to set up permissions for cross-account invocations, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountinvoke">Granting function access to other accounts</a>.

Access Token Required: API Key

Path Parameters

FunctionNamestringrequired

The name of the Lambda function. Name formats <ul> <li> Function name – <code>my-function</code>. </li> <li> Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>. </li> <li> Partial ARN – <code>123456789012:function:my-function</code>. </li> </ul> The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Query Params

Qualifierstring

The alias name.

Body Params

Payloadstring

The JSON that you want to provide to your Lambda function as input. You can enter the JSON directly. For example, <code>--payload '{ "key": "value" }'</code>. You can also specify a file path. For example, <code>--payload file://payload.json</code>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://lambda.{region}.amazonaws.com/2021-11-15/functions/{FunctionName}/response-streaming-invocations' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}