Honeycode

import { Honeycode } from "https://aws-api.deno.dev/v0.3/services/honeycode.ts?docs=full";

class Honeycode {

constructor(apiFactory: client.ApiFactory);

async batchCreateTableRows(params: BatchCreateTableRowsRequest, opts?: client.RequestOptions): Promise<BatchCreateTableRowsResult>;

async batchDeleteTableRows(params: BatchDeleteTableRowsRequest, opts?: client.RequestOptions): Promise<BatchDeleteTableRowsResult>;

async batchUpdateTableRows(params: BatchUpdateTableRowsRequest, opts?: client.RequestOptions): Promise<BatchUpdateTableRowsResult>;

async batchUpsertTableRows(params: BatchUpsertTableRowsRequest, opts?: client.RequestOptions): Promise<BatchUpsertTableRowsResult>;

async describeTableDataImportJob(params: DescribeTableDataImportJobRequest, opts?: client.RequestOptions): Promise<DescribeTableDataImportJobResult>;

async getScreenData(params: GetScreenDataRequest, opts?: client.RequestOptions): Promise<GetScreenDataResult>;

async invokeScreenAutomation(params: InvokeScreenAutomationRequest, opts?: client.RequestOptions): Promise<InvokeScreenAutomationResult>;

async listTableColumns(params: ListTableColumnsRequest, opts?: client.RequestOptions): Promise<ListTableColumnsResult>;

async listTableRows(params: ListTableRowsRequest, opts?: client.RequestOptions): Promise<ListTableRowsResult>;

async listTables(params: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResult>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResult>;

async queryTableRows(params: QueryTableRowsRequest, opts?: client.RequestOptions): Promise<QueryTableRowsResult>;

async startTableDataImportJob(params: StartTableDataImportJobRequest, opts?: client.RequestOptions): Promise<StartTableDataImportJobResult>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Honeycode(apiFactory: client.ApiFactory)

[src]

§Methods

batchCreateTableRows(params: BatchCreateTableRowsRequest, opts?: client.RequestOptions): Promise<BatchCreateTableRowsResult>

[src]

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.

batchDeleteTableRows(params: BatchDeleteTableRowsRequest, opts?: client.RequestOptions): Promise<BatchDeleteTableRowsResult>

[src]

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.

batchUpdateTableRows(params: BatchUpdateTableRowsRequest, opts?: client.RequestOptions): Promise<BatchUpdateTableRowsResult>

[src]

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 ("").

batchUpsertTableRows(params: BatchUpsertTableRowsRequest, opts?: client.RequestOptions): Promise<BatchUpsertTableRowsResult>

[src]

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 ("").

describeTableDataImportJob(params: DescribeTableDataImportJobRequest, opts?: client.RequestOptions): Promise<DescribeTableDataImportJobResult>

[src]

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

getScreenData(params: GetScreenDataRequest, opts?: client.RequestOptions): Promise<GetScreenDataResult>

[src]

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.

invokeScreenAutomation(params: InvokeScreenAutomationRequest, opts?: client.RequestOptions): Promise<InvokeScreenAutomationResult>

[src]

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.

listTableColumns(params: ListTableColumnsRequest, opts?: client.RequestOptions): Promise<ListTableColumnsResult>

[src]

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

listTableRows(params: ListTableRowsRequest, opts?: client.RequestOptions): Promise<ListTableRowsResult>

[src]

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

listTables(params: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResult>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResult>

[src]

The ListTagsForResource API allows you to return a resource's tags.

queryTableRows(params: QueryTableRowsRequest, opts?: client.RequestOptions): Promise<QueryTableRowsResult>

[src]

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

startTableDataImportJob(params: StartTableDataImportJobRequest, opts?: client.RequestOptions): Promise<StartTableDataImportJobResult>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]