You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Honeycode::Types::InvokeScreenAutomationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InvokeScreenAutomationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  workbook_id: "ResourceId", # required
  app_id: "ResourceId", # required
  screen_id: "ResourceId", # required
  screen_automation_id: "ResourceId", # required
  variables: {
    "VariableName" => {
      raw_value: "RawValue", # required
    },
  },
  row_id: "RowId",
  client_request_token: "ClientRequestToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The ID of the app that contains the screen automation.

Returns:

  • (String) —

    The ID of the app that contains the screen automation.

#client_request_token ⇒ String

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.

Returns:

  • (String) —

    The request token for performing the automation action.

#row_id ⇒ String

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

Returns:

  • (String) —

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

#screen_automation_id ⇒ String

The ID of the automation action to be performed.

Returns:

  • (String) —

    The ID of the automation action to be performed.

#screen_id ⇒ String

The ID of the screen that contains the screen automation.

Returns:

  • (String) —

    The ID of the screen that contains the screen automation.

#variables ⇒ Hash<String,Types::VariableValue>

Variables are optional and are needed only if the screen requires them to render correctly. 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.

Returns:

  • (Hash<String,Types::VariableValue>) —

    Variables are optional and are needed only if the screen requires them to render correctly.

#workbook_id ⇒ String

The ID of the workbook that contains the screen automation.

Returns:

  • (String) —

    The ID of the workbook that contains the screen automation.