1  import {Request} from '../lib/request';
  2  import {Response} from '../lib/response';
  3  import {AWSError} from '../lib/error';
  4  import {Service} from '../lib/service';
  5  import {ServiceConfigurationOptions} from '../lib/service';
  6  import {ConfigBase as Config} from '../lib/config-base';
  7  interface Blob {}
  8  declare class Honeycode extends Service {
  9    /**
 10     * Constructs a service object. This object has one method for each API operation.
 11     */
 12    constructor(options?: Honeycode.Types.ClientConfiguration)
 13    config: Config & Honeycode.Types.ClientConfiguration;
 14    /**
 15     *  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. 
 16     */
 17    batchCreateTableRows(params: Honeycode.Types.BatchCreateTableRowsRequest, callback?: (err: AWSError, data: Honeycode.Types.BatchCreateTableRowsResult) => void): Request<Honeycode.Types.BatchCreateTableRowsResult, AWSError>;
 18    /**
 19     *  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. 
 20     */
 21    batchCreateTableRows(callback?: (err: AWSError, data: Honeycode.Types.BatchCreateTableRowsResult) => void): Request<Honeycode.Types.BatchCreateTableRowsResult, AWSError>;
 22    /**
 23     *  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. 
 24     */
 25    batchDeleteTableRows(params: Honeycode.Types.BatchDeleteTableRowsRequest, callback?: (err: AWSError, data: Honeycode.Types.BatchDeleteTableRowsResult) => void): Request<Honeycode.Types.BatchDeleteTableRowsResult, AWSError>;
 26    /**
 27     *  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. 
 28     */
 29    batchDeleteTableRows(callback?: (err: AWSError, data: Honeycode.Types.BatchDeleteTableRowsResult) => void): Request<Honeycode.Types.BatchDeleteTableRowsResult, AWSError>;
 30    /**
 31     *  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 (""). 
 32     */
 33    batchUpdateTableRows(params: Honeycode.Types.BatchUpdateTableRowsRequest, callback?: (err: AWSError, data: Honeycode.Types.BatchUpdateTableRowsResult) => void): Request<Honeycode.Types.BatchUpdateTableRowsResult, AWSError>;
 34    /**
 35     *  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 (""). 
 36     */
 37    batchUpdateTableRows(callback?: (err: AWSError, data: Honeycode.Types.BatchUpdateTableRowsResult) => void): Request<Honeycode.Types.BatchUpdateTableRowsResult, AWSError>;
 38    /**
 39     *  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 (""). 
 40     */
 41    batchUpsertTableRows(params: Honeycode.Types.BatchUpsertTableRowsRequest, callback?: (err: AWSError, data: Honeycode.Types.BatchUpsertTableRowsResult) => void): Request<Honeycode.Types.BatchUpsertTableRowsResult, AWSError>;
 42    /**
 43     *  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 (""). 
 44     */
 45    batchUpsertTableRows(callback?: (err: AWSError, data: Honeycode.Types.BatchUpsertTableRowsResult) => void): Request<Honeycode.Types.BatchUpsertTableRowsResult, AWSError>;
 46    /**
 47     *  The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job. 
 48     */
 49    describeTableDataImportJob(params: Honeycode.Types.DescribeTableDataImportJobRequest, callback?: (err: AWSError, data: Honeycode.Types.DescribeTableDataImportJobResult) => void): Request<Honeycode.Types.DescribeTableDataImportJobResult, AWSError>;
 50    /**
 51     *  The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job. 
 52     */
 53    describeTableDataImportJob(callback?: (err: AWSError, data: Honeycode.Types.DescribeTableDataImportJobResult) => void): Request<Honeycode.Types.DescribeTableDataImportJobResult, AWSError>;
 54    /**
 55     *  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. 
 56     */
 57    getScreenData(params: Honeycode.Types.GetScreenDataRequest, callback?: (err: AWSError, data: Honeycode.Types.GetScreenDataResult) => void): Request<Honeycode.Types.GetScreenDataResult, AWSError>;
 58    /**
 59     *  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. 
 60     */
 61    getScreenData(callback?: (err: AWSError, data: Honeycode.Types.GetScreenDataResult) => void): Request<Honeycode.Types.GetScreenDataResult, AWSError>;
 62    /**
 63     *  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. 
 64     */
 65    invokeScreenAutomation(params: Honeycode.Types.InvokeScreenAutomationRequest, callback?: (err: AWSError, data: Honeycode.Types.InvokeScreenAutomationResult) => void): Request<Honeycode.Types.InvokeScreenAutomationResult, AWSError>;
 66    /**
 67     *  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. 
 68     */
 69    invokeScreenAutomation(callback?: (err: AWSError, data: Honeycode.Types.InvokeScreenAutomationResult) => void): Request<Honeycode.Types.InvokeScreenAutomationResult, AWSError>;
 70    /**
 71     *  The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook. 
 72     */
 73    listTableColumns(params: Honeycode.Types.ListTableColumnsRequest, callback?: (err: AWSError, data: Honeycode.Types.ListTableColumnsResult) => void): Request<Honeycode.Types.ListTableColumnsResult, AWSError>;
 74    /**
 75     *  The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook. 
 76     */
 77    listTableColumns(callback?: (err: AWSError, data: Honeycode.Types.ListTableColumnsResult) => void): Request<Honeycode.Types.ListTableColumnsResult, AWSError>;
 78    /**
 79     *  The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook. 
 80     */
 81    listTableRows(params: Honeycode.Types.ListTableRowsRequest, callback?: (err: AWSError, data: Honeycode.Types.ListTableRowsResult) => void): Request<Honeycode.Types.ListTableRowsResult, AWSError>;
 82    /**
 83     *  The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook. 
 84     */
 85    listTableRows(callback?: (err: AWSError, data: Honeycode.Types.ListTableRowsResult) => void): Request<Honeycode.Types.ListTableRowsResult, AWSError>;
 86    /**
 87     *  The ListTables API allows you to retrieve a list of all the tables in a workbook. 
 88     */
 89    listTables(params: Honeycode.Types.ListTablesRequest, callback?: (err: AWSError, data: Honeycode.Types.ListTablesResult) => void): Request<Honeycode.Types.ListTablesResult, AWSError>;
 90    /**
 91     *  The ListTables API allows you to retrieve a list of all the tables in a workbook. 
 92     */
 93    listTables(callback?: (err: AWSError, data: Honeycode.Types.ListTablesResult) => void): Request<Honeycode.Types.ListTablesResult, AWSError>;
 94    /**
 95     *  The QueryTableRows API allows you to use a filter formula to query for specific rows in a table. 
 96     */
 97    queryTableRows(params: Honeycode.Types.QueryTableRowsRequest, callback?: (err: AWSError, data: Honeycode.Types.QueryTableRowsResult) => void): Request<Honeycode.Types.QueryTableRowsResult, AWSError>;
 98    /**
 99     *  The QueryTableRows API allows you to use a filter formula to query for specific rows in a table. 
100     */
101    queryTableRows(callback?: (err: AWSError, data: Honeycode.Types.QueryTableRowsResult) => void): Request<Honeycode.Types.QueryTableRowsResult, AWSError>;
102    /**
103     *  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. 
104     */
105    startTableDataImportJob(params: Honeycode.Types.StartTableDataImportJobRequest, callback?: (err: AWSError, data: Honeycode.Types.StartTableDataImportJobResult) => void): Request<Honeycode.Types.StartTableDataImportJobResult, AWSError>;
106    /**
107     *  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. 
108     */
109    startTableDataImportJob(callback?: (err: AWSError, data: Honeycode.Types.StartTableDataImportJobResult) => void): Request<Honeycode.Types.StartTableDataImportJobResult, AWSError>;
110  }
111  declare namespace Honeycode {
112    export type AwsUserArn = string;
113    export interface BatchCreateTableRowsRequest {
114      /**
115       * 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. 
116       */
117      workbookId: ResourceId;
118      /**
119       * 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. 
120       */
121      tableId: ResourceId;
122      /**
123       *  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. 
124       */
125      rowsToCreate: CreateRowDataList;
126      /**
127       *  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. 
128       */
129      clientRequestToken?: ClientRequestToken;
130    }
131    export interface BatchCreateTableRowsResult {
132      /**
133       * The updated workbook cursor after adding the new rows at the end of the table.
134       */
135      workbookCursor: WorkbookCursor;
136      /**
137       * The map of batch item id to the row id that was created for that item.
138       */
139      createdRows: CreatedRowsMap;
140      /**
141       *  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. 
142       */
143      failedBatchItems?: FailedBatchItems;
144    }
145    export interface BatchDeleteTableRowsRequest {
146      /**
147       * 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. 
148       */
149      workbookId: ResourceId;
150      /**
151       * 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. 
152       */
153      tableId: ResourceId;
154      /**
155       *  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. 
156       */
157      rowIds: RowIdList;
158      /**
159       *  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. 
160       */
161      clientRequestToken?: ClientRequestToken;
162    }
163    export interface BatchDeleteTableRowsResult {
164      /**
165       * The updated workbook cursor after deleting the rows from the table.
166       */
167      workbookCursor: WorkbookCursor;
168      /**
169       *  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. 
170       */
171      failedBatchItems?: FailedBatchItems;
172    }
173    export type BatchErrorMessage = string;
174    export type BatchItemId = string;
175    export interface BatchUpdateTableRowsRequest {
176      /**
177       * 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. 
178       */
179      workbookId: ResourceId;
180      /**
181       * 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. 
182       */
183      tableId: ResourceId;
184      /**
185       *  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. 
186       */
187      rowsToUpdate: UpdateRowDataList;
188      /**
189       *  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. 
190       */
191      clientRequestToken?: ClientRequestToken;
192    }
193    export interface BatchUpdateTableRowsResult {
194      /**
195       * The updated workbook cursor after adding the new rows at the end of the table.
196       */
197      workbookCursor: WorkbookCursor;
198      /**
199       *  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. 
200       */
201      failedBatchItems?: FailedBatchItems;
202    }
203    export interface BatchUpsertTableRowsRequest {
204      /**
205       * 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. 
206       */
207      workbookId: ResourceId;
208      /**
209       * 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. 
210       */
211      tableId: ResourceId;
212      /**
213       *  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. 
214       */
215      rowsToUpsert: UpsertRowDataList;
216      /**
217       *  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. 
218       */
219      clientRequestToken?: ClientRequestToken;
220    }
221    export interface BatchUpsertTableRowsResult {
222      /**
223       *  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. 
224       */
225      rows: UpsertRowsResultMap;
226      /**
227       * The updated workbook cursor after updating or appending rows in the table.
228       */
229      workbookCursor: WorkbookCursor;
230      /**
231       *  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. 
232       */
233      failedBatchItems?: FailedBatchItems;
234    }
235    export interface Cell {
236      /**
237       *  The formula contained in the cell. This field is empty if a cell does not have a formula. 
238       */
239      formula?: Formula;
240      /**
241       * 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.
242       */
243      format?: Format;
244      /**
245       *  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. 
246       */
247      rawValue?: RawValue;
248      /**
249       *  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. 
250       */
251      formattedValue?: FormattedValue;
252    }
253    export interface CellInput {
254      /**
255       *  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. 
256       */
257      fact?: Fact;
258    }
259    export type Cells = Cell[];
260    export type ClientRequestToken = string;
261    export interface ColumnMetadata {
262      /**
263       * The name of the column.
264       */
265      name: Name;
266      /**
267       * The format of the column.
268       */
269      format: Format;
270    }
271    export interface CreateRowData {
272      /**
273       *  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. 
274       */
275      batchItemId: BatchItemId;
276      /**
277       *  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. 
278       */
279      cellsToCreate: RowDataInput;
280    }
281    export type CreateRowDataList = CreateRowData[];
282    export type CreatedRowsMap = {[key: string]: RowId};
283    export interface DataItem {
284      /**
285       *  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. 
286       */
287      overrideFormat?: Format;
288      /**
289       * The raw value of the data. e.g. jsmith@example.com
290       */
291      rawValue?: RawValue;
292      /**
293       * The formatted value of the data. e.g. John Smith.
294       */
295      formattedValue?: FormattedValue;
296    }
297    export type DataItems = DataItem[];
298    export type DelimitedTextDelimiter = string;
299    export interface DelimitedTextImportOptions {
300      /**
301       * The delimiter to use for separating columns in a single row of the input.
302       */
303      delimiter: DelimitedTextDelimiter;
304      /**
305       * Indicates whether the input file has a header row at the top containing the column names.
306       */
307      hasHeaderRow?: HasHeaderRow;
308      /**
309       * A parameter to indicate whether empty rows should be ignored or be included in the import.
310       */
311      ignoreEmptyRows?: IgnoreEmptyRows;
312      /**
313       * The encoding of the data in the input file.
314       */
315      dataCharacterEncoding?: ImportDataCharacterEncoding;
316    }
317    export interface DescribeTableDataImportJobRequest {
318      /**
319       * 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. 
320       */
321      workbookId: ResourceId;
322      /**
323       * 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. 
324       */
325      tableId: ResourceId;
326      /**
327       * 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. 
328       */
329      jobId: JobId;
330    }
331    export interface DescribeTableDataImportJobResult {
332      /**
333       *  The current status of the import job. 
334       */
335      jobStatus: TableDataImportJobStatus;
336      /**
337       *  A message providing more details about the current status of the import job. 
338       */
339      message: TableDataImportJobMessage;
340      /**
341       *  The metadata about the job that was submitted for import. 
342       */
343      jobMetadata: TableDataImportJobMetadata;
344    }
345    export interface DestinationOptions {
346      /**
347       * A map of the column id to the import properties for each column.
348       */
349      columnMap?: ImportColumnMap;
350    }
351    export type Email = string;
352    export type Fact = string;
353    export interface FailedBatchItem {
354      /**
355       *  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. 
356       */
357      id: BatchItemId;
358      /**
359       *  The error message that indicates why the batch item failed. 
360       */
361      errorMessage: BatchErrorMessage;
362    }
363    export type FailedBatchItems = FailedBatchItem[];
364    export interface Filter {
365      /**
366       *  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. 
367       */
368      formula: Formula;
369      /**
370       *  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. 
371       */
372      contextRowId?: RowId;
373    }
374    export type Format = "AUTO"|"NUMBER"|"CURRENCY"|"DATE"|"TIME"|"DATE_TIME"|"PERCENTAGE"|"TEXT"|"ACCOUNTING"|"CONTACT"|"ROWLINK"|string;
375    export type FormattedValue = string;
376    export type Formula = string;
377    export interface GetScreenDataRequest {
378      /**
379       * The ID of the workbook that contains the screen.
380       */
381      workbookId: ResourceId;
382      /**
383       * The ID of the app that contains the screem.
384       */
385      appId: ResourceId;
386      /**
387       * The ID of the screen.
388       */
389      screenId: ResourceId;
390      /**
391       *  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. 
392       */
393      variables?: VariableValueMap;
394      /**
395       *  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. 
396       */
397      maxResults?: MaxResults;
398      /**
399       *  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. 
400       */
401      nextToken?: PaginationToken;
402    }
403    export interface GetScreenDataResult {
404      /**
405       * A map of all the rows on the screen keyed by block name.
406       */
407      results: ResultSetMap;
408      /**
409       *  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. 
410       */
411      workbookCursor: WorkbookCursor;
412      /**
413       *  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. 
414       */
415      nextToken?: PaginationToken;
416    }
417    export type HasHeaderRow = boolean;
418    export type IgnoreEmptyRows = boolean;
419    export type ImportColumnMap = {[key: string]: SourceDataColumnProperties};
420    export type ImportDataCharacterEncoding = "UTF-8"|"US-ASCII"|"ISO-8859-1"|"UTF-16BE"|"UTF-16LE"|"UTF-16"|string;
421    export interface ImportDataSource {
422      /**
423       * The configuration parameters for the data source of the import
424       */
425      dataSourceConfig: ImportDataSourceConfig;
426    }
427    export interface ImportDataSourceConfig {
428      /**
429       *  The URL from which source data will be downloaded for the import request. 
430       */
431      dataSourceUrl?: SecureURL;
432    }
433    export interface ImportJobSubmitter {
434      /**
435       * The email id of the submitter of the import job, if available.
436       */
437      email?: Email;
438      /**
439       * The AWS user ARN of the submitter of the import job, if available.
440       */
441      userArn?: AwsUserArn;
442    }
443    export interface ImportOptions {
444      /**
445       * Options relating to the destination of the import request.
446       */
447      destinationOptions?: DestinationOptions;
448      /**
449       * Options relating to parsing delimited text. Required if dataFormat is DELIMITED_TEXT.
450       */
451      delimitedTextOptions?: DelimitedTextImportOptions;
452    }
453    export type ImportSourceDataFormat = "DELIMITED_TEXT"|string;
454    export interface InvokeScreenAutomationRequest {
455      /**
456       * The ID of the workbook that contains the screen automation.
457       */
458      workbookId: ResourceId;
459      /**
460       * The ID of the app that contains the screen automation.
461       */
462      appId: ResourceId;
463      /**
464       * The ID of the screen that contains the screen automation.
465       */
466      screenId: ResourceId;
467      /**
468       * The ID of the automation action to be performed.
469       */
470      screenAutomationId: ResourceId;
471      /**
472       *  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. 
473       */
474      variables?: VariableValueMap;
475      /**
476       *  The row ID for the automation if the automation is defined inside a block with source or list. 
477       */
478      rowId?: RowId;
479      /**
480       *  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. 
481       */
482      clientRequestToken?: ClientRequestToken;
483    }
484    export interface InvokeScreenAutomationResult {
485      /**
486       * The updated workbook cursor after performing the automation action.
487       */
488      workbookCursor: WorkbookCursor;
489    }
490    export type JobId = string;
491    export interface ListTableColumnsRequest {
492      /**
493       * 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. 
494       */
495      workbookId: ResourceId;
496      /**
497       * 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. 
498       */
499      tableId: ResourceId;
500      /**
501       *  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. 
502       */
503      nextToken?: PaginationToken;
504    }
505    export interface ListTableColumnsResult {
506      /**
507       *  The list of columns in the table. 
508       */
509      tableColumns: TableColumns;
510      /**
511       *  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. 
512       */
513      nextToken?: PaginationToken;
514      /**
515       *  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. 
516       */
517      workbookCursor?: WorkbookCursor;
518    }
519    export interface ListTableRowsRequest {
520      /**
521       * 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. 
522       */
523      workbookId: ResourceId;
524      /**
525       * 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. 
526       */
527      tableId: ResourceId;
528      /**
529       *  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. 
530       */
531      rowIds?: RowIdList;
532      /**
533       * The maximum number of rows to return in each page of the results.
534       */
535      maxResults?: MaxResults;
536      /**
537       *  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. 
538       */
539      nextToken?: PaginationToken;
540    }
541    export interface ListTableRowsResult {
542      /**
543       *  The list of columns in the table whose row data is returned in the result. 
544       */
545      columnIds: ResourceIds;
546      /**
547       *  The list of rows in the table. Note that this result is paginated, so this list contains a maximum of 100 rows. 
548       */
549      rows: TableRows;
550      /**
551       *  The list of row ids included in the request that were not found in the table. 
552       */
553      rowIdsNotFound?: RowIdList;
554      /**
555       *  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. 
556       */
557      nextToken?: PaginationToken;
558      /**
559       *  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. 
560       */
561      workbookCursor: WorkbookCursor;
562    }
563    export interface ListTablesRequest {
564      /**
565       * 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. 
566       */
567      workbookId: ResourceId;
568      /**
569       * The maximum number of tables to return in each page of the results.
570       */
571      maxResults?: MaxResults;
572      /**
573       *  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. 
574       */
575      nextToken?: PaginationToken;
576    }
577    export interface ListTablesResult {
578      /**
579       *  The list of tables in the workbook. 
580       */
581      tables: Tables;
582      /**
583       *  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. 
584       */
585      nextToken?: PaginationToken;
586      /**
587       *  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. 
588       */
589      workbookCursor?: WorkbookCursor;
590    }
591    export type MaxResults = number;
592    export type Name = string;
593    export type PaginationToken = string;
594    export interface QueryTableRowsRequest {
595      /**
596       * 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. 
597       */
598      workbookId: ResourceId;
599      /**
600       * 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. 
601       */
602      tableId: ResourceId;
603      /**
604       * An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.
605       */
606      filterFormula: Filter;
607      /**
608       * The maximum number of rows to return in each page of the results.
609       */
610      maxResults?: MaxResults;
611      /**
612       *  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. 
613       */
614      nextToken?: PaginationToken;
615    }
616    export interface QueryTableRowsResult {
617      /**
618       *  The list of columns in the table whose row data is returned in the result. 
619       */
620      columnIds: ResourceIds;
621      /**
622       *  The list of rows in the table that match the query filter. 
623       */
624      rows: TableRows;
625      /**
626       *  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. 
627       */
628      nextToken?: PaginationToken;
629      /**
630       *  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. 
631       */
632      workbookCursor: WorkbookCursor;
633    }
634    export type RawValue = string;
635    export type ResourceId = string;
636    export type ResourceIds = ResourceId[];
637    export type ResultHeader = ColumnMetadata[];
638    export interface ResultRow {
639      /**
640       * The ID for a particular row.
641       */
642      rowId?: RowId;
643      /**
644       * List of all the data cells in a row.
645       */
646      dataItems: DataItems;
647    }
648    export type ResultRows = ResultRow[];
649    export interface ResultSet {
650      /**
651       *  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. 
652       */
653      headers: ResultHeader;
654      /**
655       *  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. 
656       */
657      rows: ResultRows;
658    }
659    export type ResultSetMap = {[key: string]: ResultSet};
660    export type RowDataInput = {[key: string]: CellInput};
661    export type RowId = string;
662    export type RowIdList = RowId[];
663    export type SecureURL = string;
664    export type SourceDataColumnIndex = number;
665    export interface SourceDataColumnProperties {
666      /**
667       * The index of the column in the input file.
668       */
669      columnIndex?: SourceDataColumnIndex;
670    }
671    export interface StartTableDataImportJobRequest {
672      /**
673       * 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. 
674       */
675      workbookId: ResourceId;
676      /**
677       *  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. 
678       */
679      dataSource: ImportDataSource;
680      /**
681       *  The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT". 
682       */
683      dataFormat: ImportSourceDataFormat;
684      /**
685       * 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. 
686       */
687      destinationTableId: ResourceId;
688      /**
689       *  The options for customizing this import request. 
690       */
691      importOptions: ImportOptions;
692      /**
693       *  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. 
694       */
695      clientRequestToken: ClientRequestToken;
696    }
697    export interface StartTableDataImportJobResult {
698      /**
699       *  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. 
700       */
701      jobId: JobId;
702      /**
703       *  The status of the import job immediately after submitting the request. 
704       */
705      jobStatus: TableDataImportJobStatus;
706    }
707    export interface Table {
708      /**
709       * The id of the table.
710       */
711      tableId?: ResourceId;
712      /**
713       * The name of the table.
714       */
715      tableName?: TableName;
716    }
717    export interface TableColumn {
718      /**
719       * The id of the column in the table.
720       */
721      tableColumnId?: ResourceId;
722      /**
723       * The name of the column in the table.
724       */
725      tableColumnName?: TableColumnName;
726      /**
727       *  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'. 
728       */
729      format?: Format;
730    }
731    export type TableColumnName = string;
732    export type TableColumns = TableColumn[];
733    export type TableDataImportJobMessage = string;
734    export interface TableDataImportJobMetadata {
735      /**
736       * Details about the submitter of the import request.
737       */
738      submitter: ImportJobSubmitter;
739      /**
740       * The timestamp when the job was submitted for import.
741       */
742      submitTime: TimestampInMillis;
743      /**
744       * The options that was specified at the time of submitting the import request.
745       */
746      importOptions: ImportOptions;
747      /**
748       * The source of the data that was submitted for import.
749       */
750      dataSource: ImportDataSource;
751    }
752    export type TableDataImportJobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|string;
753    export type TableName = string;
754    export interface TableRow {
755      /**
756       * The id of the row in the table.
757       */
758      rowId: RowId;
759      /**
760       * A list of cells in the table row. The cells appear in the same order as the columns of the table. 
761       */
762      cells: Cells;
763    }
764    export type TableRows = TableRow[];
765    export type Tables = Table[];
766    export type TimestampInMillis = Date;
767    export interface UpdateRowData {
768      /**
769       *  The id of the row that needs to be updated. 
770       */
771      rowId: RowId;
772      /**
773       *  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. 
774       */
775      cellsToUpdate: RowDataInput;
776    }
777    export type UpdateRowDataList = UpdateRowData[];
778    export type UpsertAction = "UPDATED"|"APPENDED"|string;
779    export interface UpsertRowData {
780      /**
781       *  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. 
782       */
783      batchItemId: BatchItemId;
784      /**
785       *  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. 
786       */
787      filter: Filter;
788      /**
789       *  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. 
790       */
791      cellsToUpdate: RowDataInput;
792    }
793    export type UpsertRowDataList = UpsertRowData[];
794    export interface UpsertRowsResult {
795      /**
796       *  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. 
797       */
798      rowIds: RowIdList;
799      /**
800       *  The result of the upsert action. 
801       */
802      upsertAction: UpsertAction;
803    }
804    export type UpsertRowsResultMap = {[key: string]: UpsertRowsResult};
805    export type VariableName = string;
806    export interface VariableValue {
807      /**
808       * Raw value of the variable.
809       */
810      rawValue: RawValue;
811    }
812    export type VariableValueMap = {[key: string]: VariableValue};
813    export type WorkbookCursor = number;
814    /**
815     * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
816     */
817    export type apiVersion = "2020-03-01"|"latest"|string;
818    export interface ClientApiVersions {
819      /**
820       * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
821       */
822      apiVersion?: apiVersion;
823    }
824    export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
825    /**
826     * Contains interfaces for use with the Honeycode client.
827     */
828    export import Types = Honeycode;
829  }
830  export = Honeycode;