Struct aws_sdk_lambda::input::invoke_input::Builder

pub struct Builder { /* private fields */ }

A builder for InvokeInput.

Implementations

impl Builder

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

The name 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.

Examples found in repository

src/client.rs (line 5142)

        pub fn function_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.function_name(input.into());
            self
        }

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

The name 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.

Examples found in repository

src/client.rs (line 5157)

        pub fn set_function_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_function_name(input);
            self
        }

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 it's 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.

Examples found in repository

src/client.rs (line 5167)

        pub fn invocation_type(mut self, input: crate::model::InvocationType) -> Self {
            self.inner = self.inner.invocation_type(input);
            self
        }

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 it's 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.

Examples found in repository

src/client.rs (line 5180)

        pub fn set_invocation_type(
            mut self,
            input: std::option::Option<crate::model::InvocationType>,
        ) -> Self {
            self.inner = self.inner.set_invocation_type(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 5185)

        pub fn log_type(mut self, input: crate::model::LogType) -> Self {
            self.inner = self.inner.log_type(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 5190)

        pub fn set_log_type(mut self, input: std::option::Option<crate::model::LogType>) -> Self {
            self.inner = self.inner.set_log_type(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 5195)

        pub fn client_context(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.client_context(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 5203)

        pub fn set_client_context(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_client_context(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 5209)

        pub fn payload(mut self, input: aws_smithy_types::Blob) -> Self {
            self.inner = self.inner.payload(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 5215)

        pub fn set_payload(mut self, input: std::option::Option<aws_smithy_types::Blob>) -> Self {
            self.inner = self.inner.set_payload(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 5220)

        pub fn qualifier(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.qualifier(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 5225)

        pub fn set_qualifier(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_qualifier(input);
            self
        }

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

Consumes the builder and constructs a InvokeInput.

Examples found in repository

src/client.rs (line 5102)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::Invoke,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::InvokeError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::InvokeOutput,
            aws_smithy_http::result::SdkError<crate::error::InvokeError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Builder