Class: Aws::Honeycode::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Honeycode::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb
Overview
An API client for Honeycode. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Honeycode::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_create_table_rows(params = {}) ⇒ Types::BatchCreateTableRowsResult
The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.
-
#batch_delete_table_rows(params = {}) ⇒ Types::BatchDeleteTableRowsResult
The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.
-
#batch_update_table_rows(params = {}) ⇒ Types::BatchUpdateTableRowsResult
The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.
-
#batch_upsert_table_rows(params = {}) ⇒ Types::BatchUpsertTableRowsResult
The BatchUpsertTableRows API allows you to upsert one or more rows in a table.
-
#describe_table_data_import_job(params = {}) ⇒ Types::DescribeTableDataImportJobResult
The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
-
#get_screen_data(params = {}) ⇒ Types::GetScreenDataResult
The GetScreenData API allows retrieval of data from a screen in a Honeycode app.
-
#invoke_screen_automation(params = {}) ⇒ Types::InvokeScreenAutomationResult
The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.
-
#list_table_columns(params = {}) ⇒ Types::ListTableColumnsResult
The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
-
#list_table_rows(params = {}) ⇒ Types::ListTableRowsResult
The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
-
#list_tables(params = {}) ⇒ Types::ListTablesResult
The ListTables API allows you to retrieve a list of all the tables in a workbook.
-
#query_table_rows(params = {}) ⇒ Types::QueryTableRowsResult
The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
-
#start_table_data_import_job(params = {}) ⇒ Types::StartTableDataImportJobResult
The StartTableDataImportJob API allows you to start an import job on a table.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#batch_create_table_rows(params = {}) ⇒ Types::BatchCreateTableRowsResult
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.
411 412 413 414 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 411 def batch_create_table_rows(params = {}, = {}) req = build_request(:batch_create_table_rows, params) req.send_request() end |
#batch_delete_table_rows(params = {}) ⇒ Types::BatchDeleteTableRowsResult
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.
476 477 478 479 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 476 def batch_delete_table_rows(params = {}, = {}) req = build_request(:batch_delete_table_rows, params) req.send_request() end |
#batch_update_table_rows(params = {}) ⇒ Types::BatchUpdateTableRowsResult
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 ("").
558 559 560 561 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 558 def batch_update_table_rows(params = {}, = {}) req = build_request(:batch_update_table_rows, params) req.send_request() end |
#batch_upsert_table_rows(params = {}) ⇒ Types::BatchUpsertTableRowsResult
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 ("").
655 656 657 658 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 655 def batch_upsert_table_rows(params = {}, = {}) req = build_request(:batch_upsert_table_rows, params) req.send_request() end |
#describe_table_data_import_job(params = {}) ⇒ Types::DescribeTableDataImportJobResult
The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
715 716 717 718 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 715 def describe_table_data_import_job(params = {}, = {}) req = build_request(:describe_table_data_import_job, params) req.send_request() end |
#get_screen_data(params = {}) ⇒ Types::GetScreenDataResult
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.
795 796 797 798 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 795 def get_screen_data(params = {}, = {}) req = build_request(:get_screen_data, params) req.send_request() end |
#invoke_screen_automation(params = {}) ⇒ Types::InvokeScreenAutomationResult
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.
869 870 871 872 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 869 def invoke_screen_automation(params = {}, = {}) req = build_request(:invoke_screen_automation, params) req.send_request() end |
#list_table_columns(params = {}) ⇒ Types::ListTableColumnsResult
The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
927 928 929 930 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 927 def list_table_columns(params = {}, = {}) req = build_request(:list_table_columns, params) req.send_request() end |
#list_table_rows(params = {}) ⇒ Types::ListTableRowsResult
The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1005 def list_table_rows(params = {}, = {}) req = build_request(:list_table_rows, params) req.send_request() end |
#list_tables(params = {}) ⇒ Types::ListTablesResult
The ListTables API allows you to retrieve a list of all the tables in a workbook.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1058 def list_tables(params = {}, = {}) req = build_request(:list_tables, params) req.send_request() end |
#query_table_rows(params = {}) ⇒ Types::QueryTableRowsResult
The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1133 1134 1135 1136 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1133 def query_table_rows(params = {}, = {}) req = build_request(:query_table_rows, params) req.send_request() end |
#start_table_data_import_job(params = {}) ⇒ Types::StartTableDataImportJobResult
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.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1221 def start_table_data_import_job(params = {}, = {}) req = build_request(:start_table_data_import_job, params) req.send_request() end |