Honeycode / Client / invoke_screen_automation

invoke_screen_automation

Honeycode.Client.invoke_screen_automation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.invoke_screen_automation(
    workbookId='string',
    appId='string',
    screenId='string',
    screenAutomationId='string',
    variables={
        'string': {
            'rawValue': 'string'
        }
    },
    rowId='string',
    clientRequestToken='string'
)

Parameters:

• workbookId (string) –

  [REQUIRED]

  The ID of the workbook that contains the screen automation.

• appId (string) –

  [REQUIRED]

  The ID of the app that contains the screen automation.

• screenId (string) –

  [REQUIRED]

  The ID of the screen that contains the screen automation.

• screenAutomationId (string) –

  [REQUIRED]

  The ID of the automation action to be performed.

• variables (dict) –

  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.

  • (string) –

    • (dict) –

      The input variables to the app to be used by the InvokeScreenAutomation action request.

      • rawValue (string) – [REQUIRED]

        Raw value of the variable.

• rowId (string) – The row ID for the automation if the automation is defined inside a block with source or list.

• clientRequestToken (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.

Return type:

dict

Returns:

Response Syntax

{
    'workbookCursor': 123
}

Response Structure

• (dict) –

  • workbookCursor (integer) –

    The updated workbook cursor after performing the automation action.

Exceptions

• Honeycode.Client.exceptions.AccessDeniedException

• Honeycode.Client.exceptions.InternalServerException

• Honeycode.Client.exceptions.ResourceNotFoundException

• Honeycode.Client.exceptions.ValidationException

• Honeycode.Client.exceptions.ThrottlingException

• Honeycode.Client.exceptions.ServiceUnavailableException

• Honeycode.Client.exceptions.AutomationExecutionException

• Honeycode.Client.exceptions.AutomationExecutionTimeoutException

• Honeycode.Client.exceptions.RequestTimeoutException

• Honeycode.Client.exceptions.ServiceQuotaExceededException