Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.Honeycode

Inherits:
AWS.Service show all
Identifier:
honeycode
API Version:
2020-03-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

Sending a Request Using Honeycode

var honeycode = new AWS.Honeycode();
honeycode.batchCreateTableRows(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Honeycode object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var honeycode = new AWS.Honeycode({apiVersion: '2020-03-01'});

You can also set the API version globally in AWS.config.apiVersions using the honeycode service identifier:

AWS.config.apiVersions = {
  honeycode: '2020-03-01',
  // other service API versions
};

var honeycode = new AWS.Honeycode();

Version:

  • 2020-03-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Honeycode(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Honeycode object

var honeycode = new AWS.Honeycode({apiVersion: '2020-03-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Honeycode.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Honeycode.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Honeycode.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchCreateTableRows(params = {}, callback) ⇒ AWS.Request

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.

If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.

Service Reference:

Examples:

Calling the batchCreateTableRows operation

var params = {
  rowsToCreate: [ /* required */
    {
      batchItemId: 'STRING_VALUE', /* required */
      cellsToCreate: { /* required */
        '<ResourceId>': {
          fact: 'STRING_VALUE'
        },
        /* '<ResourceId>': ... */
      }
    },
    /* more items */
  ],
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE'
};
honeycode.batchCreateTableRows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook where the new rows are being added.

      If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table where the new rows are being added.

      If a table with the specified ID could not be found, this API throws ResourceNotFoundException.

    • rowsToCreate — (Array<map>)

      The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

      Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.

      • batchItemIdrequired — (String)

        An external identifier that represents the single row that is being created as part of the BatchCreateTableRows request. This can be any string that you can use to identify the row in the request. The BatchCreateTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

      • cellsToCreaterequired — (map<map>)

        A map representing the cells to create in the new row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

        • fact — (String)

          Fact represents the data that is entered into a cell. This data can be free text or a formula. Formulas need to start with the equals (=) sign.

    • clientRequestToken — (String)

      The request token for performing the batch create operation. 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 not perform the operation again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workbookCursor — (Integer)

        The updated workbook cursor after adding the new rows at the end of the table.

      • createdRows — (map<String>)

        The map of batch item id to the row id that was created for that item.

      • failedBatchItems — (Array<map>)

        The list of batch items in the request that could not be added to the table. Each element in this list contains one item from the request that could not be added to the table along with the reason why that item could not be added.

        • idrequired — (String)

          The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

        • errorMessagerequired — (String)

          The error message that indicates why the batch item failed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchDeleteTableRows(params = {}, callback) ⇒ AWS.Request

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.

Service Reference:

Examples:

Calling the batchDeleteTableRows operation

var params = {
  rowIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE'
};
honeycode.batchDeleteTableRows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook where the rows are being deleted.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table where the rows are being deleted.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • rowIds — (Array<String>)

      The list of row ids to delete from the table. You need to specify at least one row id in this list.

      Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.

    • clientRequestToken — (String)

      The request token for performing the delete 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 not perform 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workbookCursor — (Integer)

        The updated workbook cursor after deleting the rows from the table.

      • failedBatchItems — (Array<map>)

        The list of row ids in the request that could not be deleted from the table. Each element in this list contains one row id from the request that could not be deleted along with the reason why that item could not be deleted.

        • idrequired — (String)

          The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

        • errorMessagerequired — (String)

          The error message that indicates why the batch item failed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchUpdateTableRows(params = {}, callback) ⇒ AWS.Request

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

Service Reference:

Examples:

Calling the batchUpdateTableRows operation

var params = {
  rowsToUpdate: [ /* required */
    {
      cellsToUpdate: { /* required */
        '<ResourceId>': {
          fact: 'STRING_VALUE'
        },
        /* '<ResourceId>': ... */
      },
      rowId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE'
};
honeycode.batchUpdateTableRows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook where the rows are being updated.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table where the rows are being updated.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • rowsToUpdate — (Array<map>)

      The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

      Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

      • rowIdrequired — (String)

        The id of the row that needs to be updated.

      • cellsToUpdaterequired — (map<map>)

        A map representing the cells to update in the given row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

        • fact — (String)

          Fact represents the data that is entered into a cell. This data can be free text or a formula. Formulas need to start with the equals (=) sign.

    • clientRequestToken — (String)

      The request token for performing the update 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 not perform 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workbookCursor — (Integer)

        The updated workbook cursor after adding the new rows at the end of the table.

      • failedBatchItems — (Array<map>)

        The list of batch items in the request that could not be updated in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated.

        • idrequired — (String)

          The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

        • errorMessagerequired — (String)

          The error message that indicates why the batch item failed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchUpsertTableRows(params = {}, callback) ⇒ AWS.Request

The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.

You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

Service Reference:

Examples:

Calling the batchUpsertTableRows operation

var params = {
  rowsToUpsert: [ /* required */
    {
      batchItemId: 'STRING_VALUE', /* required */
      cellsToUpdate: { /* required */
        '<ResourceId>': {
          fact: 'STRING_VALUE'
        },
        /* '<ResourceId>': ... */
      },
      filter: { /* required */
        formula: 'STRING_VALUE', /* required */
        contextRowId: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE'
};
honeycode.batchUpsertTableRows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook where the rows are being upserted.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table where the rows are being upserted.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • rowsToUpsert — (Array<map>)

      The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

      Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

      • batchItemIdrequired — (String)

        An external identifier that represents a single item in the request that is being upserted as part of the BatchUpsertTableRows request. This can be any string that you can use to identify the item in the request. The BatchUpsertTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.

      • filterrequired — (map)

        The filter formula to use to find existing matching rows to update. The formula needs to return zero or more rows. If the formula returns 0 rows, then a new row will be appended in the target table. If the formula returns one or more rows, then the returned rows will be updated.

        Note that the filter formula needs to return rows from the target table for the upsert operation to succeed. If the filter formula has a syntax error or it doesn't evaluate to zero or more rows in the target table for any one item in the input list, then the entire BatchUpsertTableRows request fails and no updates are made to the table.

        • formularequired — (String)

          A formula representing a filter function that returns zero or more matching rows from a table. Valid formulas in this field return a list of rows from a table. The most common ways of writing a formula to return a list of rows are to use the FindRow() or Filter() functions. Any other formula that returns zero or more rows is also acceptable. For example, you can use a formula that points to a cell that contains a filter function.

        • contextRowId — (String)

          The optional contextRowId attribute can be used to specify the row id of the context row if the filter formula contains unqualified references to table columns and needs a context row to evaluate them successfully.

      • cellsToUpdaterequired — (map<map>)

        A map representing the cells to update for the matching rows or an appended row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.

        • fact — (String)

          Fact represents the data that is entered into a cell. This data can be free text or a formula. Formulas need to start with the equals (=) sign.

    • clientRequestToken — (String)

      The request token for performing the update 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 not perform 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • rows — (map<map>)

        A map with the batch item id as the key and the result of the upsert operation as the value. The result of the upsert operation specifies whether existing rows were updated or a new row was appended, along with the list of row ids that were affected.

        • rowIdsrequired — (Array<String>)

          The list of row ids that were changed as part of an upsert row operation. If the upsert resulted in an update, this list could potentially contain multiple rows that matched the filter and hence got updated. If the upsert resulted in an append, this list would only have the single row that was appended.

        • upsertActionrequired — (String)

          The result of the upsert action.

          Possible values include:
          • "UPDATED"
          • "APPENDED"
      • workbookCursor — (Integer)

        The updated workbook cursor after updating or appending rows in the table.

      • failedBatchItems — (Array<map>)

        The list of batch items in the request that could not be updated or appended in the table. Each element in this list contains one item from the request that could not be updated in the table along with the reason why that item could not be updated or appended.

        • idrequired — (String)

          The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.

        • errorMessagerequired — (String)

          The error message that indicates why the batch item failed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTableDataImportJob(params = {}, callback) ⇒ AWS.Request

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Service Reference:

Examples:

Calling the describeTableDataImportJob operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE' /* required */
};
honeycode.describeTableDataImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook into which data was imported.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table into which data was imported.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • jobId — (String)

      The ID of the job that was returned by the StartTableDataImportJob request.

      If a job with the specified id could not be found, this API throws ResourceNotFoundException.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobStatus — (String)

        The current status of the import job.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
      • message — (String)

        A message providing more details about the current status of the import job.

      • jobMetadata — (map)

        The metadata about the job that was submitted for import.

        • submitterrequired — (map)

          Details about the submitter of the import request.

          • email — (String)

            The email id of the submitter of the import job, if available.

          • userArn — (String)

            The AWS user ARN of the submitter of the import job, if available.

        • submitTimerequired — (Date)

          The timestamp when the job was submitted for import.

        • importOptionsrequired — (map)

          The options that was specified at the time of submitting the import request.

          • destinationOptions — (map)

            Options relating to the destination of the import request.

            • columnMap — (map<map>)

              A map of the column id to the import properties for each column.

              • columnIndex — (Integer)

                The index of the column in the input file.

          • delimitedTextOptions — (map)

            Options relating to parsing delimited text. Required if dataFormat is DELIMITED_TEXT.

            • delimiterrequired — (String)

              The delimiter to use for separating columns in a single row of the input.

            • hasHeaderRow — (Boolean)

              Indicates whether the input file has a header row at the top containing the column names.

            • ignoreEmptyRows — (Boolean)

              A parameter to indicate whether empty rows should be ignored or be included in the import.

            • dataCharacterEncoding — (String)

              The encoding of the data in the input file.

              Possible values include:
              • "UTF-8"
              • "US-ASCII"
              • "ISO-8859-1"
              • "UTF-16BE"
              • "UTF-16LE"
              • "UTF-16"
        • dataSourcerequired — (map)

          The source of the data that was submitted for import.

          • dataSourceConfigrequired — (map)

            The configuration parameters for the data source of the import

            • dataSourceUrl — (String)

              The URL from which source data will be downloaded for the import request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getScreenData(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getScreenData operation

var params = {
  appId: 'STRING_VALUE', /* required */
  screenId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  variables: {
    '<VariableName>': {
      rawValue: 'STRING_VALUE' /* required */
    },
    /* '<VariableName>': ... */
  }
};
honeycode.getScreenData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook that contains the screen.

    • appId — (String)

      The ID of the app that contains the screem.

    • screenId — (String)

      The ID of the screen.

    • variables — (map<map>)

      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.

      • rawValuerequired — (String)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • results — (map<map>)

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

        • headersrequired — (Array<map>)

          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"}, "Due Date", "format": "DATE", "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.

          • namerequired — (String)

            The name of the column.

          • formatrequired — (String)

            The format of the column.

            Possible values include:
            • "AUTO"
            • "NUMBER"
            • "CURRENCY"
            • "DATE"
            • "TIME"
            • "DATE_TIME"
            • "PERCENTAGE"
            • "TEXT"
            • "ACCOUNTING"
            • "CONTACT"
            • "ROWLINK"
        • rowsrequired — (Array<map>)

          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.

          • rowId — (String)

            The ID for a particular row.

          • dataItemsrequired — (Array<map>)

            List of all the data cells in a row.

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

              Possible values include:
              • "AUTO"
              • "NUMBER"
              • "CURRENCY"
              • "DATE"
              • "TIME"
              • "DATE_TIME"
              • "PERCENTAGE"
              • "TEXT"
              • "ACCOUNTING"
              • "CONTACT"
              • "ROWLINK"
            • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

invokeScreenAutomation(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the invokeScreenAutomation operation

var params = {
  appId: 'STRING_VALUE', /* required */
  screenAutomationId: 'STRING_VALUE', /* required */
  screenId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE',
  rowId: 'STRING_VALUE',
  variables: {
    '<VariableName>': {
      rawValue: 'STRING_VALUE' /* required */
    },
    /* '<VariableName>': ... */
  }
};
honeycode.invokeScreenAutomation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook that contains the screen automation.

    • appId — (String)

      The ID of the app that contains the screen automation.

    • screenId — (String)

      The ID of the screen that contains the screen automation.

    • screenAutomationId — (String)

      The ID of the automation action to be performed.

    • variables — (map<map>)

      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.

      • rawValuerequired — (String)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workbookCursor — (Integer)

        The updated workbook cursor after performing the automation action.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTableColumns(params = {}, callback) ⇒ AWS.Request

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

Service Reference:

Examples:

Calling the listTableColumns operation

var params = {
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE'
};
honeycode.listTableColumns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook that contains the table whose columns are being retrieved.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table whose columns are being retrieved.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tableColumns — (Array<map>)

        The list of columns in the table.

        • tableColumnId — (String)

          The id of the column in the table.

        • tableColumnName — (String)

          The name of the column in the table.

        • format — (String)

          The column level format that is applied in the table. An empty value in this field means that the column format is the default value 'AUTO'.

          Possible values include:
          • "AUTO"
          • "NUMBER"
          • "CURRENCY"
          • "DATE"
          • "TIME"
          • "DATE_TIME"
          • "PERCENTAGE"
          • "TEXT"
          • "ACCOUNTING"
          • "CONTACT"
          • "ROWLINK"
      • 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 request has been loaded.

      • workbookCursor — (Integer)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTableRows(params = {}, callback) ⇒ AWS.Request

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

Service Reference:

Examples:

Calling the listTableRows operation

var params = {
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  rowIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
honeycode.listTableRows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook that contains the table whose rows are being retrieved.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table whose rows are being retrieved.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • rowIds — (Array<String>)

      This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

    • maxResults — (Integer)

      The maximum number of rows to return in each page of the results.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • columnIds — (Array<String>)

        The list of columns in the table whose row data is returned in the result.

      • rows — (Array<map>)

        The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows.

        • rowIdrequired — (String)

          The id of the row in the table.

        • cellsrequired — (Array<map>)

          A list of cells in the table row. The cells appear in the same order as the columns of the table.

          • formula — (String)

            The formula contained in the cell. This field is empty if a cell does not have a formula.

          • format — (String)

            The format of the cell. If this field is empty, then the format is either not specified in the workbook or the format is set to AUTO.

            Possible values include:
            • "AUTO"
            • "NUMBER"
            • "CURRENCY"
            • "DATE"
            • "TIME"
            • "DATE_TIME"
            • "PERCENTAGE"
            • "TEXT"
            • "ACCOUNTING"
            • "CONTACT"
            • "ROWLINK"
          • rawValue — (String)

            The raw value of the data contained in the cell. The raw value depends on the format of the data in the cell. However the attribute in the API return value is always a string containing the raw value.

            Cells with format DATE, DATE_TIME or TIME have the raw value as a floating point number where the whole number represents the number of days since 1/1/1900 and the fractional part represents the fraction of the day since midnight. For example, a cell with date 11/3/2020 has the raw value "44138". A cell with the time 9:00 AM has the raw value "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the raw value "44138.375". Notice that even though the raw value is a number in all three cases, it is still represented as a string.

            Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the raw value of the data as the number representing the data being displayed. For example, the number 1.325 with two decimal places in the format will have it's raw value as "1.325" and formatted value as "1.33". A currency value for $10 will have the raw value as "10" and formatted value as "$10.00". A value representing 20% with two decimal places in the format will have its raw value as "0.2" and the formatted value as "20.00%". An accounting value of -$25 will have "-25" as the raw value and "$ (25.00)" as the formatted value.

            Cells with format TEXT will have the raw text as the raw value. For example, a cell with text "John Smith" will have "John Smith" as both the raw value and the formatted value.

            Cells with format CONTACT will have the name of the contact as a formatted value and the email address of the contact as the raw value. For example, a contact for John Smith will have "John Smith" as the formatted value and "john.smith@example.com" as the raw value.

            Cells with format ROWLINK (aka picklist) will have the first column of the linked row as the formatted value and the row id of the linked row as the raw value. For example, a cell containing a picklist to a table that displays task status might have "Completed" as the formatted value and "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.

            Cells with format AUTO or cells without any format that are auto-detected as one of the formats above will contain the raw and formatted values as mentioned above, based on the auto-detected formats. If there is no auto-detected format, the raw and formatted values will be the same as the data in the cell.

          • formattedValue — (String)

            The formatted value of the cell. This is the value that you see displayed in the cell in the UI.

            Note that the formatted value of a cell is always represented as a string irrespective of the data that is stored in the cell. For example, if a cell contains a date, the formatted value of the cell is the string representation of the formatted date being shown in the cell in the UI. See details in the rawValue field below for how cells of different formats will have different raw and formatted values.

      • rowIdsNotFound — (Array<String>)

        The list of row ids included in the request that were not found in the table.

      • 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 request has been loaded.

      • workbookCursor — (Integer)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTables(params = {}, callback) ⇒ AWS.Request

The ListTables API allows you to retrieve a list of all the tables in a workbook.

Service Reference:

Examples:

Calling the listTables operation

var params = {
  workbookId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
honeycode.listTables(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook whose tables are being retrieved.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • maxResults — (Integer)

      The maximum number of tables to return in each page of the results.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tables — (Array<map>)

        The list of tables in the workbook.

        • tableId — (String)

          The id of the table.

        • tableName — (String)

          The name of the table.

      • 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 request has been loaded.

      • workbookCursor — (Integer)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

queryTableRows(params = {}, callback) ⇒ AWS.Request

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

Service Reference:

Examples:

Calling the queryTableRows operation

var params = {
  filterFormula: { /* required */
    formula: 'STRING_VALUE', /* required */
    contextRowId: 'STRING_VALUE'
  },
  tableId: 'STRING_VALUE', /* required */
  workbookId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
honeycode.queryTableRows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook whose table rows are being queried.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • tableId — (String)

      The ID of the table whose rows are being queried.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • filterFormula — (map)

      An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

      • formularequired — (String)

        A formula representing a filter function that returns zero or more matching rows from a table. Valid formulas in this field return a list of rows from a table. The most common ways of writing a formula to return a list of rows are to use the FindRow() or Filter() functions. Any other formula that returns zero or more rows is also acceptable. For example, you can use a formula that points to a cell that contains a filter function.

      • contextRowId — (String)

        The optional contextRowId attribute can be used to specify the row id of the context row if the filter formula contains unqualified references to table columns and needs a context row to evaluate them successfully.

    • maxResults — (Integer)

      The maximum number of rows to return in each page of the results.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • columnIds — (Array<String>)

        The list of columns in the table whose row data is returned in the result.

      • rows — (Array<map>)

        The list of rows in the table that match the query filter.

        • rowIdrequired — (String)

          The id of the row in the table.

        • cellsrequired — (Array<map>)

          A list of cells in the table row. The cells appear in the same order as the columns of the table.

          • formula — (String)

            The formula contained in the cell. This field is empty if a cell does not have a formula.

          • format — (String)

            The format of the cell. If this field is empty, then the format is either not specified in the workbook or the format is set to AUTO.

            Possible values include:
            • "AUTO"
            • "NUMBER"
            • "CURRENCY"
            • "DATE"
            • "TIME"
            • "DATE_TIME"
            • "PERCENTAGE"
            • "TEXT"
            • "ACCOUNTING"
            • "CONTACT"
            • "ROWLINK"
          • rawValue — (String)

            The raw value of the data contained in the cell. The raw value depends on the format of the data in the cell. However the attribute in the API return value is always a string containing the raw value.

            Cells with format DATE, DATE_TIME or TIME have the raw value as a floating point number where the whole number represents the number of days since 1/1/1900 and the fractional part represents the fraction of the day since midnight. For example, a cell with date 11/3/2020 has the raw value "44138". A cell with the time 9:00 AM has the raw value "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the raw value "44138.375". Notice that even though the raw value is a number in all three cases, it is still represented as a string.

            Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the raw value of the data as the number representing the data being displayed. For example, the number 1.325 with two decimal places in the format will have it's raw value as "1.325" and formatted value as "1.33". A currency value for $10 will have the raw value as "10" and formatted value as "$10.00". A value representing 20% with two decimal places in the format will have its raw value as "0.2" and the formatted value as "20.00%". An accounting value of -$25 will have "-25" as the raw value and "$ (25.00)" as the formatted value.

            Cells with format TEXT will have the raw text as the raw value. For example, a cell with text "John Smith" will have "John Smith" as both the raw value and the formatted value.

            Cells with format CONTACT will have the name of the contact as a formatted value and the email address of the contact as the raw value. For example, a contact for John Smith will have "John Smith" as the formatted value and "john.smith@example.com" as the raw value.

            Cells with format ROWLINK (aka picklist) will have the first column of the linked row as the formatted value and the row id of the linked row as the raw value. For example, a cell containing a picklist to a table that displays task status might have "Completed" as the formatted value and "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.

            Cells with format AUTO or cells without any format that are auto-detected as one of the formats above will contain the raw and formatted values as mentioned above, based on the auto-detected formats. If there is no auto-detected format, the raw and formatted values will be the same as the data in the cell.

          • formattedValue — (String)

            The formatted value of the cell. This is the value that you see displayed in the cell in the UI.

            Note that the formatted value of a cell is always represented as a string irrespective of the data that is stored in the cell. For example, if a cell contains a date, the formatted value of the cell is the string representation of the formatted date being shown in the cell in the UI. See details in the rawValue field below for how cells of different formats will have different raw and formatted values.

      • 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 request has been loaded.

      • workbookCursor — (Integer)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startTableDataImportJob(params = {}, callback) ⇒ AWS.Request

The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.

Service Reference:

Examples:

Calling the startTableDataImportJob operation

var params = {
  clientRequestToken: 'STRING_VALUE', /* required */
  dataFormat: DELIMITED_TEXT, /* required */
  dataSource: { /* required */
    dataSourceConfig: { /* required */
      dataSourceUrl: 'STRING_VALUE'
    }
  },
  destinationTableId: 'STRING_VALUE', /* required */
  importOptions: { /* required */
    delimitedTextOptions: {
      delimiter: 'STRING_VALUE', /* required */
      dataCharacterEncoding: UTF-8 | US-ASCII | ISO-8859-1 | UTF-16BE | UTF-16LE | UTF-16,
      hasHeaderRow: true || false,
      ignoreEmptyRows: true || false
    },
    destinationOptions: {
      columnMap: {
        '<ResourceId>': {
          columnIndex: 'NUMBER_VALUE'
        },
        /* '<ResourceId>': ... */
      }
    }
  },
  workbookId: 'STRING_VALUE' /* required */
};
honeycode.startTableDataImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workbookId — (String)

      The ID of the workbook where the rows are being imported.

      If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

    • dataSource — (map)

      The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.

      • dataSourceConfigrequired — (map)

        The configuration parameters for the data source of the import

        • dataSourceUrl — (String)

          The URL from which source data will be downloaded for the import request.

    • dataFormat — (String)

      The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".

      Possible values include:
      • "DELIMITED_TEXT"
    • destinationTableId — (String)

      The ID of the table where the rows are being imported.

      If a table with the specified id could not be found, this API throws ResourceNotFoundException.

    • importOptions — (map)

      The options for customizing this import request.

      • destinationOptions — (map)

        Options relating to the destination of the import request.

        • columnMap — (map<map>)

          A map of the column id to the import properties for each column.

          • columnIndex — (Integer)

            The index of the column in the input file.

      • delimitedTextOptions — (map)

        Options relating to parsing delimited text. Required if dataFormat is DELIMITED_TEXT.

        • delimiterrequired — (String)

          The delimiter to use for separating columns in a single row of the input.

        • hasHeaderRow — (Boolean)

          Indicates whether the input file has a header row at the top containing the column names.

        • ignoreEmptyRows — (Boolean)

          A parameter to indicate whether empty rows should be ignored or be included in the import.

        • dataCharacterEncoding — (String)

          The encoding of the data in the input file.

          Possible values include:
          • "UTF-8"
          • "US-ASCII"
          • "ISO-8859-1"
          • "UTF-16BE"
          • "UTF-16LE"
          • "UTF-16"
    • clientRequestToken — (String)

      The request token for performing the update 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 not perform 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobId — (String)

        The id that is assigned to this import job. Future requests to find out the status of this import job need to send this id in the appropriate parameter in the request.

      • jobStatus — (String)

        The status of the import job immediately after submitting the request.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.