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.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
The ListTagsForResource API allows you to return a resource's tags.
-
#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.
-
#tag_resource(params = {}) ⇒ Struct
The TagResource API allows you to add tags to an ARN-able resource.
-
#untag_resource(params = {}) ⇒ Struct
The UntagResource API allows you to removes tags from an ARN-able resource.
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.
385 386 387 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 385 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.
473 474 475 476 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 473 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.
538 539 540 541 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 538 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 ("").
621 622 623 624 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 621 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 ("").
719 720 721 722 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 719 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.
781 782 783 784 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 781 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.
861 862 863 864 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 861 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.
935 936 937 938 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 935 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.
993 994 995 996 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 993 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1073 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.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1126 def list_tables(params = {}, = {}) req = build_request(:list_tables, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
The ListTagsForResource API allows you to return a resource's tags.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1155 def (params = {}, = {}) req = build_request(:list_tags_for_resource, 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.
1232 1233 1234 1235 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1232 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.
1320 1321 1322 1323 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1320 def start_table_data_import_job(params = {}, = {}) req = build_request(:start_table_data_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1349 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1377 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |