Struct InvokeInput

#[non_exhaustive]
pub struct InvokeInput {
    pub function_name: Option<String>,
    pub invocation_type: Option<InvocationType>,
    pub log_type: Option<LogType>,
    pub client_context: Option<String>,
    pub payload: Option<Blob>,
    pub qualifier: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

function_name: 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.

invocation_type: 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.

log_type: Option<LogType>

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

client_context: 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.

payload: 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.

qualifier: Option<String>

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

Implementations

impl InvokeInput

pub fn function_name(&self) -> Option<&str>

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) -> 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) -> Option<&LogType>

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

pub fn client_context(&self) -> Option<&str>

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) -> 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) -> Option<&str>

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

impl InvokeInput

pub fn builder() -> InvokeInputBuilder

Creates a new builder-style object to manufacture InvokeInput.

Trait Implementations

impl Clone for InvokeInput

fn clone(&self) -> InvokeInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeInput

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

Formats the value using the given formatter.

impl PartialEq for InvokeInput

fn eq(&self, other: &InvokeInput) -> 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 InvokeInput