aws_sdk_honeycode/client/

invoke_screen_automation.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`InvokeScreenAutomation`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`workbook_id(impl Into<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::workbook_id) / [`set_workbook_id(Option<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_workbook_id):<br>required: **true**<br><p>The ID of the workbook that contains the screen automation.</p><br>
    ///   - [`app_id(impl Into<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_app_id):<br>required: **true**<br><p>The ID of the app that contains the screen automation.</p><br>
    ///   - [`screen_id(impl Into<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::screen_id) / [`set_screen_id(Option<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_screen_id):<br>required: **true**<br><p>The ID of the screen that contains the screen automation.</p><br>
    ///   - [`screen_automation_id(impl Into<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::screen_automation_id) / [`set_screen_automation_id(Option<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_screen_automation_id):<br>required: **true**<br><p>The ID of the automation action to be performed.</p><br>
    ///   - [`variables(impl Into<String>, VariableValue)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::variables) / [`set_variables(Option<HashMap::<String, VariableValue>>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_variables):<br>required: **false**<br><p>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.</p><br>
    ///   - [`row_id(impl Into<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::row_id) / [`set_row_id(Option<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_row_id):<br>required: **false**<br><p>The row ID for the automation if the automation is defined inside a block with source or list.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::set_client_request_token):<br>required: **false**<br><p>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.</p> <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p><br>
    /// - On success, responds with [`InvokeScreenAutomationOutput`](crate::operation::invoke_screen_automation::InvokeScreenAutomationOutput) with field(s):
    ///   - [`workbook_cursor(i64)`](crate::operation::invoke_screen_automation::InvokeScreenAutomationOutput::workbook_cursor): <p>The updated workbook cursor after performing the automation action.</p>
    /// - On failure, responds with [`SdkError<InvokeScreenAutomationError>`](crate::operation::invoke_screen_automation::InvokeScreenAutomationError)
    pub fn invoke_screen_automation(&self) -> crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder {
        crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationFluentBuilder::new(self.handle.clone())
    }
}