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

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.

Servers

https://lambda.{region}.amazonaws.com
https://lambda.{region}.amazonaws.com.cn

Path parameters

Name Type Required Description

Name	Type	Required	Description
`FunctionName`	String	Yes	The name of the Lambda function. Name formats Function name – `my-function`. Function ARN – `arn:aws:lambda:us-west-2:123456789012:function:my-function`. Partial ARN – `123456789012: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.

FunctionName

String

Yes

The name of the Lambda function.

Name formats

Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012: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.

Request headers

Name	Type	Required	Description
`X-Amz-Content-Sha256`	String	No
`X-Amz-Credential`	String	No
`X-Amz-Client-Context`	String	No	Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`X-Amz-Date`	String	No
`X-Amz-Log-Type`	String	No	Set to `Tail` to include the execution log in the response. Applies to synchronously invoked functions only. Possible values: `"Tail"` `"None"`
`X-Amz-Algorithm`	String	No
`X-Amz-SignedHeaders`	String	No
`X-Amz-Security-Token`	String	No
`X-Amz-Invocation-Type`	String	No	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. Possible values: `"DryRun"` `"RequestResponse"`
`X-Amz-Signature`	String	No

Query parameters

Name	Type	Required	Description
`Qualifier`	String	No	The alias name.

Request body fields

Name Type Required Description

Name	Type	Required	Description
`Payload`	String	No	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`.

Payload

String

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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.