Struct aws_sdk_lambda::operation::invoke::builders::InvokeFluentBuilder

pub struct InvokeFluentBuilder { /* private fields */ }

Fluent builder constructing a request to Invoke.

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

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 InvokeFluentBuilder

pub fn as_input(&self) -> &InvokeInputBuilder

Access the Invoke as a reference.

pub async fn send( self ) -> Result<InvokeOutput, SdkError<InvokeError, 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<InvokeOutput, InvokeError, 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, version, or alias.

Name formats

• Function name – my-function (name-only), my-function:v1 (with alias).

• Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. 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, version, or alias.

Name formats

• Function name – my-function (name-only), my-function:v1 (with alias).

• Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. 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, version, or alias.

Name formats

• Function name – my-function (name-only), my-function:v1 (with alias).

• Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. 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: InvocationType) -> Self

Choose from the following options.

• RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

• Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

• DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

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

Choose from the following options.

• RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

• Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

• DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

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

Choose from the following options.

• RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

• Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

• DryRun – Validate parameter values and verify that the 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. Lambda passes the ClientContext object to your function for synchronous invocations only.

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. Lambda passes the ClientContext object to your function for synchronous invocations only.

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. Lambda passes the ClientContext object to your function for synchronous invocations only.

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.

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

Specify a version or alias to invoke a published version of the function.

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

Specify a version or alias to invoke a published version of the function.

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

Specify a version or alias to invoke a published version of the function.

Trait Implementations

impl Clone for InvokeFluentBuilder

fn clone(&self) -> InvokeFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeFluentBuilder

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

Formats the value using the given formatter.