libZSservicesZSamazonka-honeycodeZSamazonka-honeycode
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.HoneyCode.InvokeScreenAutomation

Description

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.

Synopsis

Creating a Request

data InvokeScreenAutomation Source #

See: newInvokeScreenAutomation smart constructor.

Constructors

InvokeScreenAutomation' 

Fields

  • rowId :: Maybe Text

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

  • variables :: Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))

    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.

  • clientRequestToken :: Maybe Text

    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.

  • workbookId :: Text

    The ID of the workbook that contains the screen automation.

  • appId :: Text

    The ID of the app that contains the screen automation.

  • screenId :: Text

    The ID of the screen that contains the screen automation.

  • screenAutomationId :: Text

    The ID of the automation action to be performed.

Instances

Instances details
Eq InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Show InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Generic InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Associated Types

type Rep InvokeScreenAutomation :: Type -> Type #

NFData InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Methods

rnf :: InvokeScreenAutomation -> () #

Hashable InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

ToJSON InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

AWSRequest InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Associated Types

type AWSResponse InvokeScreenAutomation #

ToHeaders InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

ToPath InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

ToQuery InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

type Rep InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

type Rep InvokeScreenAutomation = D1 ('MetaData "InvokeScreenAutomation" "Amazonka.HoneyCode.InvokeScreenAutomation" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "InvokeScreenAutomation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text (Sensitive VariableValue))))) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "workbookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "screenId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "screenAutomationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse InvokeScreenAutomation Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

newInvokeScreenAutomation Source #

Create a value of InvokeScreenAutomation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rowId:InvokeScreenAutomation', invokeScreenAutomation_rowId - The row ID for the automation if the automation is defined inside a block with source or list.

$sel:variables:InvokeScreenAutomation', invokeScreenAutomation_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.

$sel:clientRequestToken:InvokeScreenAutomation', invokeScreenAutomation_clientRequestToken - 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.

$sel:workbookId:InvokeScreenAutomation', invokeScreenAutomation_workbookId - The ID of the workbook that contains the screen automation.

$sel:appId:InvokeScreenAutomation', invokeScreenAutomation_appId - The ID of the app that contains the screen automation.

$sel:screenId:InvokeScreenAutomation', invokeScreenAutomation_screenId - The ID of the screen that contains the screen automation.

$sel:screenAutomationId:InvokeScreenAutomation', invokeScreenAutomation_screenAutomationId - The ID of the automation action to be performed.

Request Lenses

invokeScreenAutomation_rowId :: Lens' InvokeScreenAutomation (Maybe Text) Source #

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

invokeScreenAutomation_variables :: Lens' InvokeScreenAutomation (Maybe (HashMap Text VariableValue)) Source #

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.

invokeScreenAutomation_clientRequestToken :: Lens' InvokeScreenAutomation (Maybe Text) Source #

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.

invokeScreenAutomation_workbookId :: Lens' InvokeScreenAutomation Text Source #

The ID of the workbook that contains the screen automation.

invokeScreenAutomation_appId :: Lens' InvokeScreenAutomation Text Source #

The ID of the app that contains the screen automation.

invokeScreenAutomation_screenId :: Lens' InvokeScreenAutomation Text Source #

The ID of the screen that contains the screen automation.

invokeScreenAutomation_screenAutomationId :: Lens' InvokeScreenAutomation Text Source #

The ID of the automation action to be performed.

Destructuring the Response

data InvokeScreenAutomationResponse Source #

See: newInvokeScreenAutomationResponse smart constructor.

Constructors

InvokeScreenAutomationResponse' 

Fields

Instances

Instances details
Eq InvokeScreenAutomationResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Read InvokeScreenAutomationResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Show InvokeScreenAutomationResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Generic InvokeScreenAutomationResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

Associated Types

type Rep InvokeScreenAutomationResponse :: Type -> Type #

NFData InvokeScreenAutomationResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

type Rep InvokeScreenAutomationResponse Source # 
Instance details

Defined in Amazonka.HoneyCode.InvokeScreenAutomation

type Rep InvokeScreenAutomationResponse = D1 ('MetaData "InvokeScreenAutomationResponse" "Amazonka.HoneyCode.InvokeScreenAutomation" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "InvokeScreenAutomationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workbookCursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))

newInvokeScreenAutomationResponse Source #

Create a value of InvokeScreenAutomationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:InvokeScreenAutomationResponse', invokeScreenAutomationResponse_httpStatus - The response's http status code.

$sel:workbookCursor:InvokeScreenAutomationResponse', invokeScreenAutomationResponse_workbookCursor - The updated workbook cursor after performing the automation action.

Response Lenses

invokeScreenAutomationResponse_workbookCursor :: Lens' InvokeScreenAutomationResponse Integer Source #

The updated workbook cursor after performing the automation action.