Class: Aws::Honeycode::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Honeycode::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'lib/aws-sdk-honeycode/client.rb', line 410 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1433 1434 1435 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1433 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1436 1437 1438 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1436 def errors_module Errors 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.
498 499 500 501 |
# File 'lib/aws-sdk-honeycode/client.rb', line 498 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.
563 564 565 566 |
# File 'lib/aws-sdk-honeycode/client.rb', line 563 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 (“”).
646 647 648 649 |
# File 'lib/aws-sdk-honeycode/client.rb', line 646 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 (“”).
744 745 746 747 |
# File 'lib/aws-sdk-honeycode/client.rb', line 744 def batch_upsert_table_rows(params = {}, = {}) req = build_request(:batch_upsert_table_rows, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1411 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-honeycode' context[:gem_version] = '1.32.0' Seahorse::Client::Request.new(handlers, context) 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.
806 807 808 809 |
# File 'lib/aws-sdk-honeycode/client.rb', line 806 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.
886 887 888 889 |
# File 'lib/aws-sdk-honeycode/client.rb', line 886 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.
960 961 962 963 |
# File 'lib/aws-sdk-honeycode/client.rb', line 960 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.
1018 1019 1020 1021 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1018 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.
1098 1099 1100 1101 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1098 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.
1151 1152 1153 1154 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1151 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.
1180 1181 1182 1183 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1180 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.
1257 1258 1259 1260 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1257 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.
1345 1346 1347 1348 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1345 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.
1374 1375 1376 1377 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1374 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.
1402 1403 1404 1405 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1402 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1426 1427 1428 |
# File 'lib/aws-sdk-honeycode/client.rb', line 1426 def waiter_names [] end |