Invoke With Response Stream

lambda_invoke_with_response_stream

R Documentation

Configure your Lambda functions to stream response payloads back to clients¶

Description¶

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.

Usage¶

lambda_invoke_with_response_stream(FunctionName, InvocationType,
  LogType, ClientContext, Qualifier, Payload)

Arguments¶

FunctionName

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

InvocationType

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

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

ClientContext

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

Qualifier

The alias name.

Payload

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⁠.

Value¶

A list with the following syntax:

list(
  StatusCode = 123,
  ExecutedVersion = "string",
  EventStream = list(
    PayloadChunk = list(
      Payload = raw
    ),
    InvokeComplete = list(
      ErrorCode = "string",
      ErrorDetails = "string",
      LogResult = "string"
    )
  ),
  ResponseStreamContentType = "string"
)

Request syntax¶

svc$invoke_with_response_stream(
  FunctionName = "string",
  InvocationType = "RequestResponse"|"DryRun",
  LogType = "None"|"Tail",
  ClientContext = "string",
  Qualifier = "string",
  Payload = raw
)