Honeycode

Client

class Honeycode.Client

A low-level client representing Amazon Honeycode:

client = session.create_client('honeycode')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_screen_data(**kwargs)

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

See also: AWS API Documentation

Request Syntax

response = client.get_screen_data(
    workbookId='string',
    appId='string',
    screenId='string',
    variables={
        'string': {
            'rawValue': 'string'
        }
    },
    maxResults=123,
    nextToken='string'
)
Parameters
  • workbookId (string) --

    [REQUIRED]

    The ID of the workbook that contains the screen.

  • appId (string) --

    [REQUIRED]

    The ID of the app that contains the screem.

  • screenId (string) --

    [REQUIRED]

    The ID of the screen.

  • variables (dict) --

    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.

    • (string) --
      • (dict) --

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

        • rawValue (string) -- [REQUIRED]

          Raw value of the variable.

  • maxResults (integer) --

    The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

    This parameter is optional. If you don't specify this parameter, the default page size is 100.

  • nextToken (string) --

    This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

    Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Return type

dict

Returns

Response Syntax

{
    'results': {
        'string': {
            'headers': [
                {
                    'name': 'string',
                    'format': 'AUTO'|'NUMBER'|'CURRENCY'|'DATE'|'TIME'|'DATE_TIME'|'PERCENTAGE'|'TEXT'|'ACCOUNTING'|'CONTACT'|'ROWLINK'
                },
            ],
            'rows': [
                {
                    'rowId': 'string',
                    'dataItems': [
                        {
                            'overrideFormat': 'AUTO'|'NUMBER'|'CURRENCY'|'DATE'|'TIME'|'DATE_TIME'|'PERCENTAGE'|'TEXT'|'ACCOUNTING'|'CONTACT'|'ROWLINK',
                            'rawValue': 'string',
                            'formattedValue': 'string'
                        },
                    ]
                },
            ]
        }
    },
    'workbookCursor': 123,
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • results (dict) --

      A map of all the rows on the screen keyed by block name.

      • (string) --

        • (dict) --

          ResultSet contains the results of the request for a single block or list defined on the screen.

          • headers (list) --

            List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

            For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

            • (dict) --

              Metadata for column in the table.

              • name (string) --

                The name of the column.

              • format (string) --

                The format of the column.

          • rows (list) --

            List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

            • (dict) --

              A single row in the ResultSet.

              • rowId (string) --

                The ID for a particular row.

              • dataItems (list) --

                List of all the data cells in a row.

                • (dict) --

                  The data in a particular data cell defined on the screen.

                  • overrideFormat (string) --

                    The overrideFormat is optional and is specified only if a particular row of data has a different format for the data than the default format defined on the screen or the table.

                  • rawValue (string) --

                    The raw value of the data. e.g. jsmith@example.com

                  • formattedValue (string) --

                    The formatted value of the data. e.g. John Smith.

    • workbookCursor (integer) --

      Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

    • nextToken (string) --

      Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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 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.

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

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Honeycode.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.AutomationExecutionException

The automation execution did not end successfully.

Example

try:
  ...
except client.exceptions.AutomationExecutionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The automation execution did not end successfully.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.AutomationExecutionTimeoutException

The automation execution timed out.

Example

try:
  ...
except client.exceptions.AutomationExecutionTimeoutException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The automation execution timed out.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.InternalServerException

There were unexpected errors from the server.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There were unexpected errors from the server.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.RequestTimeoutException

The request timed out.

Example

try:
  ...
except client.exceptions.RequestTimeoutException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request timed out.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.ResourceNotFoundException

A Workbook, App, Screen or Screen Automation was not found with the given ID.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A Workbook, App, Screen or Screen Automation was not found with the given ID.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.ServiceUnavailableException

Remote service is unreachable.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Remote service is unreachable.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.ThrottlingException

Tps(transactions per second) rate reached.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Tps(transactions per second) rate reached.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Honeycode.Client.exceptions.ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Request is invalid. The message in the response contains details on why the request is invalid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: