AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the InvokeWithResponseStream operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lambda.AmazonLambdaRequest
      Amazon.Lambda.Model.InvokeWithResponseStreamRequest

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

C# 
public class InvokeWithResponseStreamRequest : AmazonLambdaRequest
         IAmazonWebServiceRequest

The InvokeWithResponseStreamRequest type exposes the following members

Constructors

NameDescription
Public Method InvokeWithResponseStreamRequest()

Properties

NameTypeDescription
Public Property ClientContext System.String

Gets and sets the property ClientContext.

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

Public Property FunctionName System.String

Gets and sets the property FunctionName.

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.

Public Property InvocationType Amazon.Lambda.ResponseStreamingInvocationType

Gets and sets the property 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.

Public Property LogType Amazon.Lambda.LogType

Gets and sets the property LogType.

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

Public Property Payload System.IO.MemoryStream

Gets and sets the property 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.

Public Property Qualifier System.String

Gets and sets the property Qualifier.

The alias name.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5