Struct aws_sdk_honeycode::client::fluent_builders::InvokeScreenAutomation

pub struct InvokeScreenAutomation { /* private fields */ }

Fluent builder constructing a request to InvokeScreenAutomation.

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

Implementations

impl InvokeScreenAutomation

pub async fn send(
    self
) -> Result<InvokeScreenAutomationOutput, SdkError<InvokeScreenAutomationError>>

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 workbook_id(self, input: impl Into<String>) -> Self

The ID of the workbook that contains the screen automation.

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

The ID of the workbook that contains the screen automation.

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

The ID of the app that contains the screen automation.

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

The ID of the app that contains the screen automation.

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

The ID of the screen that contains the screen automation.

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

The ID of the screen that contains the screen automation.

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

The ID of the automation action to be performed.

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

The ID of the automation action to be performed.

pub fn variables(self, k: impl Into<String>, v: VariableValue) -> Self

Adds a key-value pair to variables.

To override the contents of this collection use set_variables.

Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.

pub fn set_variables(
    self,
    input: Option<HashMap<String, VariableValue>>
) -> Self

Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.

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

The row ID for the automation if the automation is defined inside a block with source or list.

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

The row ID for the automation if the automation is defined inside a block with source or list.

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

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

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

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Trait Implementations

impl Clone for InvokeScreenAutomation

fn clone(&self) -> InvokeScreenAutomation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeScreenAutomation

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

Formats the value using the given formatter.