Struct InvokeInputBuilder

#[non_exhaustive]
pub struct InvokeInputBuilder { /* private fields */ }

A builder for InvokeInput.

Implementations

impl InvokeInputBuilder

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.

This field is required.

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.

pub fn build(self) -> Result<InvokeInput, BuildError>

Consumes the builder and constructs a InvokeInput.

impl InvokeInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<InvokeOutput, SdkError<InvokeError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for InvokeInputBuilder

fn clone(&self) -> InvokeInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeInputBuilder

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

Formats the value using the given formatter.

impl Default for InvokeInputBuilder

fn default() -> InvokeInputBuilder

Returns the “default value” for a type.

impl PartialEq for InvokeInputBuilder

fn eq(&self, other: &InvokeInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InvokeInputBuilder