Struct InvokeWithResponseStreamFluentBuilder

pub struct InvokeWithResponseStreamFluentBuilder { /* private fields */ }

Fluent builder constructing a request to InvokeWithResponseStream.

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.

Implementations

impl InvokeWithResponseStreamFluentBuilder

pub fn as_input(&self) -> &InvokeWithResponseStreamInputBuilder

Access the InvokeWithResponseStream as a reference.

pub async fn send( self, ) -> Result<InvokeWithResponseStreamOutput, SdkError<InvokeWithResponseStreamError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<InvokeWithResponseStreamOutput, InvokeWithResponseStreamError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn function_name(self, input: impl Into<String>) -> Self

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.

pub fn set_function_name(self, input: Option<String>) -> Self

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.

pub fn get_function_name(&self) -> &Option<String>

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.

pub fn invocation_type(self, input: ResponseStreamingInvocationType) -> Self

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.

pub fn set_invocation_type( self, input: Option<ResponseStreamingInvocationType>, ) -> Self

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.

pub fn get_invocation_type(&self) -> &Option<ResponseStreamingInvocationType>

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.

pub fn log_type(self, input: LogType) -> Self

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

pub fn set_log_type(self, input: Option<LogType>) -> Self

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

pub fn get_log_type(&self) -> &Option<LogType>

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

pub fn client_context(self, input: impl Into<String>) -> Self

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

pub fn set_client_context(self, input: Option<String>) -> Self

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

pub fn get_client_context(&self) -> &Option<String>

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

pub fn qualifier(self, input: impl Into<String>) -> Self

The alias name.

pub fn set_qualifier(self, input: Option<String>) -> Self

The alias name.

pub fn get_qualifier(&self) -> &Option<String>

The alias name.

pub fn payload(self, input: Blob) -> Self

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.

pub fn set_payload(self, input: Option<Blob>) -> Self

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.

pub fn get_payload(&self) -> &Option<Blob>

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.

Trait Implementations

impl Clone for InvokeWithResponseStreamFluentBuilder

fn clone(&self) -> InvokeWithResponseStreamFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InvokeWithResponseStreamFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.