Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.HoneyCode.InvokeScreenAutomation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data InvokeScreenAutomation = InvokeScreenAutomation' {
- clientRequestToken :: Maybe Text
- rowId :: Maybe Text
- variables :: Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))
- workbookId :: Text
- appId :: Text
- screenId :: Text
- screenAutomationId :: Text
}
newInvokeScreenAutomation :: Text -> Text -> Text -> Text -> InvokeScreenAutomation
invokeScreenAutomation_clientRequestToken :: Lens' InvokeScreenAutomation (Maybe Text)
invokeScreenAutomation_rowId :: Lens' InvokeScreenAutomation (Maybe Text)
invokeScreenAutomation_variables :: Lens' InvokeScreenAutomation (Maybe (HashMap Text VariableValue))
invokeScreenAutomation_workbookId :: Lens' InvokeScreenAutomation Text
invokeScreenAutomation_appId :: Lens' InvokeScreenAutomation Text
invokeScreenAutomation_screenId :: Lens' InvokeScreenAutomation Text
invokeScreenAutomation_screenAutomationId :: Lens' InvokeScreenAutomation Text
data InvokeScreenAutomationResponse = InvokeScreenAutomationResponse' {
- httpStatus :: Int
- workbookCursor :: Integer
}
newInvokeScreenAutomationResponse :: Int -> Integer -> InvokeScreenAutomationResponse
invokeScreenAutomationResponse_httpStatus :: Lens' InvokeScreenAutomationResponse Int
invokeScreenAutomationResponse_workbookCursor :: Lens' InvokeScreenAutomationResponse Integer

Creating a Request

data InvokeScreenAutomation Source #

See: newInvokeScreenAutomation smart constructor.

Constructors

InvokeScreenAutomation'

Fields

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

ToJSON InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods toJSON :: InvokeScreenAutomation -> Value # toEncoding :: InvokeScreenAutomation -> Encoding # toJSONList :: [InvokeScreenAutomation] -> Value # toEncodingList :: [InvokeScreenAutomation] -> Encoding #
ToHeaders InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods toHeaders :: InvokeScreenAutomation -> [Header] #
ToPath InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods toPath :: InvokeScreenAutomation -> ByteString #
ToQuery InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods toQuery :: InvokeScreenAutomation -> QueryString #
AWSRequest InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Associated Types type AWSResponse InvokeScreenAutomation # Methods request :: (Service -> Service) -> InvokeScreenAutomation -> Request InvokeScreenAutomation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InvokeScreenAutomation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InvokeScreenAutomation))) #
Generic InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Associated Types type Rep InvokeScreenAutomation :: Type -> Type # Methods from :: InvokeScreenAutomation -> Rep InvokeScreenAutomation x # to :: Rep InvokeScreenAutomation x -> InvokeScreenAutomation #
Show InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods showsPrec :: Int -> InvokeScreenAutomation -> ShowS # show :: InvokeScreenAutomation -> String # showList :: [InvokeScreenAutomation] -> ShowS #
NFData InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods rnf :: InvokeScreenAutomation -> () #
Eq InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods (==) :: InvokeScreenAutomation -> InvokeScreenAutomation -> Bool # (/=) :: InvokeScreenAutomation -> InvokeScreenAutomation -> Bool #
Hashable InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods hashWithSalt :: Int -> InvokeScreenAutomation -> Int # hash :: InvokeScreenAutomation -> Int #
type AWSResponse InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation type AWSResponse InvokeScreenAutomation = InvokeScreenAutomationResponse
type Rep InvokeScreenAutomation Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation type Rep InvokeScreenAutomation = D1 ('MetaData "InvokeScreenAutomation" "Amazonka.HoneyCode.InvokeScreenAutomation" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "InvokeScreenAutomation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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 "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)))))

newInvokeScreenAutomation Source #

Arguments

:: Text	`$sel:workbookId:InvokeScreenAutomation'`
-> Text	`$sel:appId:InvokeScreenAutomation'`
-> Text	`$sel:screenId:InvokeScreenAutomation'`
-> Text	`$sel:screenAutomationId:InvokeScreenAutomation'`
-> InvokeScreenAutomation

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: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.

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: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_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_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_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 httpStatus :: Int The response's http status code. workbookCursor :: Integer The updated workbook cursor after performing the automation action.

Instances

Instances details

Generic InvokeScreenAutomationResponse Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Associated Types type Rep InvokeScreenAutomationResponse :: Type -> Type # Methods from :: InvokeScreenAutomationResponse -> Rep InvokeScreenAutomationResponse x # to :: Rep InvokeScreenAutomationResponse x -> InvokeScreenAutomationResponse #
Read InvokeScreenAutomationResponse Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods readsPrec :: Int -> ReadS InvokeScreenAutomationResponse # readList :: ReadS [InvokeScreenAutomationResponse] # readPrec :: ReadPrec InvokeScreenAutomationResponse # readListPrec :: ReadPrec [InvokeScreenAutomationResponse] #
Show InvokeScreenAutomationResponse Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods showsPrec :: Int -> InvokeScreenAutomationResponse -> ShowS # show :: InvokeScreenAutomationResponse -> String # showList :: [InvokeScreenAutomationResponse] -> ShowS #
NFData InvokeScreenAutomationResponse Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods rnf :: InvokeScreenAutomationResponse -> () #
Eq InvokeScreenAutomationResponse Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation Methods (==) :: InvokeScreenAutomationResponse -> InvokeScreenAutomationResponse -> Bool # (/=) :: InvokeScreenAutomationResponse -> InvokeScreenAutomationResponse -> Bool #
type Rep InvokeScreenAutomationResponse Source #
Instance details Defined in Amazonka.HoneyCode.InvokeScreenAutomation type Rep InvokeScreenAutomationResponse = D1 ('MetaData "InvokeScreenAutomationResponse" "Amazonka.HoneyCode.InvokeScreenAutomation" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" '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 #

Arguments

:: Int	`$sel:httpStatus:InvokeScreenAutomationResponse'`
-> Integer	`$sel:workbookCursor:InvokeScreenAutomationResponse'`
-> InvokeScreenAutomationResponse

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_httpStatus :: Lens' InvokeScreenAutomationResponse Int Source #

The response's http status code.

invokeScreenAutomationResponse_workbookCursor :: Lens' InvokeScreenAutomationResponse Integer Source #

The updated workbook cursor after performing the automation action.