aws-sdk-honeycode 1.3.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-honeycode.rb +2 -2
- data/lib/aws-sdk-honeycode/client.rb +748 -6
- data/lib/aws-sdk-honeycode/client_api.rb +472 -0
- data/lib/aws-sdk-honeycode/errors.rb +16 -0
- data/lib/aws-sdk-honeycode/types.rb +1599 -113
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: df67cdb23bfe305c60176c66f3f3aa3f2ef0e9d36e182da1f0dcf0f18486cfd0
|
4
|
+
data.tar.gz: 2f505e711673d059d54832998435c4197f48f4a993d5f0199f8d23d581b6823d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c31fee2f67e202e0ce9d2a2522476828adf41511afd32ac7c95fcccd1802ebf6ed37bea291ac5e4d31d98221c7e9edf1676fbb4357e10755e6d1ea70cf0baa3d
|
7
|
+
data.tar.gz: 15b84e77f8cfc1ef1323c2f6305d1c713adc361a3697fb88e01c0277aefcdb527f9aa254a20ac1f957ce4b3fe3ae9b6a2b7d2590498c535b8c601f03852f5b04
|
data/lib/aws-sdk-honeycode.rb
CHANGED
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-honeycode/customizations'
|
|
28
28
|
# structure.
|
29
29
|
#
|
30
30
|
# honeycode = Aws::Honeycode::Client.new
|
31
|
-
# resp = honeycode.
|
31
|
+
# resp = honeycode.batch_create_table_rows(params)
|
32
32
|
#
|
33
33
|
# See {Client} for more information.
|
34
34
|
#
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-honeycode/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::Honeycode
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.4.0'
|
52
52
|
|
53
53
|
end
|
@@ -327,6 +327,396 @@ module Aws::Honeycode
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# The BatchCreateTableRows API allows you to create one or more rows at
|
331
|
+
# the end of a table in a workbook. The API allows you to specify the
|
332
|
+
# values to set in some or all of the columns in the new rows.
|
333
|
+
#
|
334
|
+
# If a column is not explicitly set in a specific row, then the column
|
335
|
+
# level formula specified in the table will be applied to the new row.
|
336
|
+
# If there is no column level formula but the last row of the table has
|
337
|
+
# a formula, then that formula will be copied down to the new row. If
|
338
|
+
# there is no column level formula and no formula in the last row of the
|
339
|
+
# table, then that column will be left blank for the new rows.
|
340
|
+
#
|
341
|
+
# @option params [required, String] :workbook_id
|
342
|
+
# The ID of the workbook where the new rows are being added.
|
343
|
+
#
|
344
|
+
# If a workbook with the specified ID could not be found, this API
|
345
|
+
# throws ResourceNotFoundException.
|
346
|
+
#
|
347
|
+
# @option params [required, String] :table_id
|
348
|
+
# The ID of the table where the new rows are being added.
|
349
|
+
#
|
350
|
+
# If a table with the specified ID could not be found, this API throws
|
351
|
+
# ResourceNotFoundException.
|
352
|
+
#
|
353
|
+
# @option params [required, Array<Types::CreateRowData>] :rows_to_create
|
354
|
+
# The list of rows to create at the end of the table. Each item in this
|
355
|
+
# list needs to have a batch item id to uniquely identify the element in
|
356
|
+
# the request and the cells to create for that row. You need to specify
|
357
|
+
# at least one item in this list.
|
358
|
+
#
|
359
|
+
# Note that if one of the column ids in any of the rows in the request
|
360
|
+
# does not exist in the table, then the request fails and no updates are
|
361
|
+
# made to the table.
|
362
|
+
#
|
363
|
+
# @option params [String] :client_request_token
|
364
|
+
# The request token for performing the batch create operation. Request
|
365
|
+
# tokens help to identify duplicate requests. If a call times out or
|
366
|
+
# fails due to a transient error like a failed network connection, you
|
367
|
+
# can retry the call with the same request token. The service ensures
|
368
|
+
# that if the first call using that request token is successfully
|
369
|
+
# performed, the second call will not perform the operation again.
|
370
|
+
#
|
371
|
+
# Note that request tokens are valid only for a few minutes. You cannot
|
372
|
+
# use request tokens to dedupe requests spanning hours or days.
|
373
|
+
#
|
374
|
+
# @return [Types::BatchCreateTableRowsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
375
|
+
#
|
376
|
+
# * {Types::BatchCreateTableRowsResult#workbook_cursor #workbook_cursor} => Integer
|
377
|
+
# * {Types::BatchCreateTableRowsResult#created_rows #created_rows} => Hash<String,String>
|
378
|
+
# * {Types::BatchCreateTableRowsResult#failed_batch_items #failed_batch_items} => Array<Types::FailedBatchItem>
|
379
|
+
#
|
380
|
+
# @example Request syntax with placeholder values
|
381
|
+
#
|
382
|
+
# resp = client.batch_create_table_rows({
|
383
|
+
# workbook_id: "ResourceId", # required
|
384
|
+
# table_id: "ResourceId", # required
|
385
|
+
# rows_to_create: [ # required
|
386
|
+
# {
|
387
|
+
# batch_item_id: "BatchItemId", # required
|
388
|
+
# cells_to_create: { # required
|
389
|
+
# "ResourceId" => {
|
390
|
+
# fact: "Fact",
|
391
|
+
# },
|
392
|
+
# },
|
393
|
+
# },
|
394
|
+
# ],
|
395
|
+
# client_request_token: "ClientRequestToken",
|
396
|
+
# })
|
397
|
+
#
|
398
|
+
# @example Response structure
|
399
|
+
#
|
400
|
+
# resp.workbook_cursor #=> Integer
|
401
|
+
# resp.created_rows #=> Hash
|
402
|
+
# resp.created_rows["BatchItemId"] #=> String
|
403
|
+
# resp.failed_batch_items #=> Array
|
404
|
+
# resp.failed_batch_items[0].id #=> String
|
405
|
+
# resp.failed_batch_items[0].error_message #=> String
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchCreateTableRows AWS API Documentation
|
408
|
+
#
|
409
|
+
# @overload batch_create_table_rows(params = {})
|
410
|
+
# @param [Hash] params ({})
|
411
|
+
def batch_create_table_rows(params = {}, options = {})
|
412
|
+
req = build_request(:batch_create_table_rows, params)
|
413
|
+
req.send_request(options)
|
414
|
+
end
|
415
|
+
|
416
|
+
# The BatchDeleteTableRows API allows you to delete one or more rows
|
417
|
+
# from a table in a workbook. You need to specify the ids of the rows
|
418
|
+
# that you want to delete from the table.
|
419
|
+
#
|
420
|
+
# @option params [required, String] :workbook_id
|
421
|
+
# The ID of the workbook where the rows are being deleted.
|
422
|
+
#
|
423
|
+
# If a workbook with the specified id could not be found, this API
|
424
|
+
# throws ResourceNotFoundException.
|
425
|
+
#
|
426
|
+
# @option params [required, String] :table_id
|
427
|
+
# The ID of the table where the rows are being deleted.
|
428
|
+
#
|
429
|
+
# If a table with the specified id could not be found, this API throws
|
430
|
+
# ResourceNotFoundException.
|
431
|
+
#
|
432
|
+
# @option params [required, Array<String>] :row_ids
|
433
|
+
# The list of row ids to delete from the table. You need to specify at
|
434
|
+
# least one row id in this list.
|
435
|
+
#
|
436
|
+
# Note that if one of the row ids provided in the request does not exist
|
437
|
+
# in the table, then the request fails and no rows are deleted from the
|
438
|
+
# table.
|
439
|
+
#
|
440
|
+
# @option params [String] :client_request_token
|
441
|
+
# The request token for performing the delete action. Request tokens
|
442
|
+
# help to identify duplicate requests. If a call times out or fails due
|
443
|
+
# to a transient error like a failed network connection, you can retry
|
444
|
+
# the call with the same request token. The service ensures that if the
|
445
|
+
# first call using that request token is successfully performed, the
|
446
|
+
# second call will not perform the action again.
|
447
|
+
#
|
448
|
+
# Note that request tokens are valid only for a few minutes. You cannot
|
449
|
+
# use request tokens to dedupe requests spanning hours or days.
|
450
|
+
#
|
451
|
+
# @return [Types::BatchDeleteTableRowsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
452
|
+
#
|
453
|
+
# * {Types::BatchDeleteTableRowsResult#workbook_cursor #workbook_cursor} => Integer
|
454
|
+
# * {Types::BatchDeleteTableRowsResult#failed_batch_items #failed_batch_items} => Array<Types::FailedBatchItem>
|
455
|
+
#
|
456
|
+
# @example Request syntax with placeholder values
|
457
|
+
#
|
458
|
+
# resp = client.batch_delete_table_rows({
|
459
|
+
# workbook_id: "ResourceId", # required
|
460
|
+
# table_id: "ResourceId", # required
|
461
|
+
# row_ids: ["RowId"], # required
|
462
|
+
# client_request_token: "ClientRequestToken",
|
463
|
+
# })
|
464
|
+
#
|
465
|
+
# @example Response structure
|
466
|
+
#
|
467
|
+
# resp.workbook_cursor #=> Integer
|
468
|
+
# resp.failed_batch_items #=> Array
|
469
|
+
# resp.failed_batch_items[0].id #=> String
|
470
|
+
# resp.failed_batch_items[0].error_message #=> String
|
471
|
+
#
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchDeleteTableRows AWS API Documentation
|
473
|
+
#
|
474
|
+
# @overload batch_delete_table_rows(params = {})
|
475
|
+
# @param [Hash] params ({})
|
476
|
+
def batch_delete_table_rows(params = {}, options = {})
|
477
|
+
req = build_request(:batch_delete_table_rows, params)
|
478
|
+
req.send_request(options)
|
479
|
+
end
|
480
|
+
|
481
|
+
# The BatchUpdateTableRows API allows you to update one or more rows in
|
482
|
+
# a table in a workbook.
|
483
|
+
#
|
484
|
+
# You can specify the values to set in some or all of the columns in the
|
485
|
+
# table for the specified rows. If a column is not explicitly specified
|
486
|
+
# in a particular row, then that column will not be updated for that
|
487
|
+
# row. To clear out the data in a specific cell, you need to set the
|
488
|
+
# value as an empty string ("").
|
489
|
+
#
|
490
|
+
# @option params [required, String] :workbook_id
|
491
|
+
# The ID of the workbook where the rows are being updated.
|
492
|
+
#
|
493
|
+
# If a workbook with the specified id could not be found, this API
|
494
|
+
# throws ResourceNotFoundException.
|
495
|
+
#
|
496
|
+
# @option params [required, String] :table_id
|
497
|
+
# The ID of the table where the rows are being updated.
|
498
|
+
#
|
499
|
+
# If a table with the specified id could not be found, this API throws
|
500
|
+
# ResourceNotFoundException.
|
501
|
+
#
|
502
|
+
# @option params [required, Array<Types::UpdateRowData>] :rows_to_update
|
503
|
+
# The list of rows to update in the table. Each item in this list needs
|
504
|
+
# to contain the row id to update along with the map of column id to
|
505
|
+
# cell values for each column in that row that needs to be updated. You
|
506
|
+
# need to specify at least one row in this list, and for each row, you
|
507
|
+
# need to specify at least one column to update.
|
508
|
+
#
|
509
|
+
# Note that if one of the row or column ids in the request does not
|
510
|
+
# exist in the table, then the request fails and no updates are made to
|
511
|
+
# the table.
|
512
|
+
#
|
513
|
+
# @option params [String] :client_request_token
|
514
|
+
# The request token for performing the update action. Request tokens
|
515
|
+
# help to identify duplicate requests. If a call times out or fails due
|
516
|
+
# to a transient error like a failed network connection, you can retry
|
517
|
+
# the call with the same request token. The service ensures that if the
|
518
|
+
# first call using that request token is successfully performed, the
|
519
|
+
# second call will not perform the action again.
|
520
|
+
#
|
521
|
+
# Note that request tokens are valid only for a few minutes. You cannot
|
522
|
+
# use request tokens to dedupe requests spanning hours or days.
|
523
|
+
#
|
524
|
+
# @return [Types::BatchUpdateTableRowsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
525
|
+
#
|
526
|
+
# * {Types::BatchUpdateTableRowsResult#workbook_cursor #workbook_cursor} => Integer
|
527
|
+
# * {Types::BatchUpdateTableRowsResult#failed_batch_items #failed_batch_items} => Array<Types::FailedBatchItem>
|
528
|
+
#
|
529
|
+
# @example Request syntax with placeholder values
|
530
|
+
#
|
531
|
+
# resp = client.batch_update_table_rows({
|
532
|
+
# workbook_id: "ResourceId", # required
|
533
|
+
# table_id: "ResourceId", # required
|
534
|
+
# rows_to_update: [ # required
|
535
|
+
# {
|
536
|
+
# row_id: "RowId", # required
|
537
|
+
# cells_to_update: { # required
|
538
|
+
# "ResourceId" => {
|
539
|
+
# fact: "Fact",
|
540
|
+
# },
|
541
|
+
# },
|
542
|
+
# },
|
543
|
+
# ],
|
544
|
+
# client_request_token: "ClientRequestToken",
|
545
|
+
# })
|
546
|
+
#
|
547
|
+
# @example Response structure
|
548
|
+
#
|
549
|
+
# resp.workbook_cursor #=> Integer
|
550
|
+
# resp.failed_batch_items #=> Array
|
551
|
+
# resp.failed_batch_items[0].id #=> String
|
552
|
+
# resp.failed_batch_items[0].error_message #=> String
|
553
|
+
#
|
554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchUpdateTableRows AWS API Documentation
|
555
|
+
#
|
556
|
+
# @overload batch_update_table_rows(params = {})
|
557
|
+
# @param [Hash] params ({})
|
558
|
+
def batch_update_table_rows(params = {}, options = {})
|
559
|
+
req = build_request(:batch_update_table_rows, params)
|
560
|
+
req.send_request(options)
|
561
|
+
end
|
562
|
+
|
563
|
+
# The BatchUpsertTableRows API allows you to upsert one or more rows in
|
564
|
+
# a table. The upsert operation takes a filter expression as input and
|
565
|
+
# evaluates it to find matching rows on the destination table. If
|
566
|
+
# matching rows are found, it will update the cells in the matching rows
|
567
|
+
# to new values specified in the request. If no matching rows are found,
|
568
|
+
# a new row is added at the end of the table and the cells in that row
|
569
|
+
# are set to the new values specified in the request.
|
570
|
+
#
|
571
|
+
# You can specify the values to set in some or all of the columns in the
|
572
|
+
# table for the matching or newly appended rows. If a column is not
|
573
|
+
# explicitly specified for a particular row, then that column will not
|
574
|
+
# be updated for that row. To clear out the data in a specific cell, you
|
575
|
+
# need to set the value as an empty string ("").
|
576
|
+
#
|
577
|
+
# @option params [required, String] :workbook_id
|
578
|
+
# The ID of the workbook where the rows are being upserted.
|
579
|
+
#
|
580
|
+
# If a workbook with the specified id could not be found, this API
|
581
|
+
# throws ResourceNotFoundException.
|
582
|
+
#
|
583
|
+
# @option params [required, String] :table_id
|
584
|
+
# The ID of the table where the rows are being upserted.
|
585
|
+
#
|
586
|
+
# If a table with the specified id could not be found, this API throws
|
587
|
+
# ResourceNotFoundException.
|
588
|
+
#
|
589
|
+
# @option params [required, Array<Types::UpsertRowData>] :rows_to_upsert
|
590
|
+
# The list of rows to upsert in the table. Each item in this list needs
|
591
|
+
# to have a batch item id to uniquely identify the element in the
|
592
|
+
# request, a filter expression to find the rows to update for that
|
593
|
+
# element and the cell values to set for each column in the upserted
|
594
|
+
# rows. You need to specify at least one item in this list.
|
595
|
+
#
|
596
|
+
# Note that if one of the filter formulas in the request fails to
|
597
|
+
# evaluate because of an error or one of the column ids in any of the
|
598
|
+
# rows does not exist in the table, then the request fails and no
|
599
|
+
# updates are made to the table.
|
600
|
+
#
|
601
|
+
# @option params [String] :client_request_token
|
602
|
+
# The request token for performing the update action. Request tokens
|
603
|
+
# help to identify duplicate requests. If a call times out or fails due
|
604
|
+
# to a transient error like a failed network connection, you can retry
|
605
|
+
# the call with the same request token. The service ensures that if the
|
606
|
+
# first call using that request token is successfully performed, the
|
607
|
+
# second call will not perform the action again.
|
608
|
+
#
|
609
|
+
# Note that request tokens are valid only for a few minutes. You cannot
|
610
|
+
# use request tokens to dedupe requests spanning hours or days.
|
611
|
+
#
|
612
|
+
# @return [Types::BatchUpsertTableRowsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
613
|
+
#
|
614
|
+
# * {Types::BatchUpsertTableRowsResult#rows #rows} => Hash<String,Types::UpsertRowsResult>
|
615
|
+
# * {Types::BatchUpsertTableRowsResult#workbook_cursor #workbook_cursor} => Integer
|
616
|
+
# * {Types::BatchUpsertTableRowsResult#failed_batch_items #failed_batch_items} => Array<Types::FailedBatchItem>
|
617
|
+
#
|
618
|
+
# @example Request syntax with placeholder values
|
619
|
+
#
|
620
|
+
# resp = client.batch_upsert_table_rows({
|
621
|
+
# workbook_id: "ResourceId", # required
|
622
|
+
# table_id: "ResourceId", # required
|
623
|
+
# rows_to_upsert: [ # required
|
624
|
+
# {
|
625
|
+
# batch_item_id: "BatchItemId", # required
|
626
|
+
# filter: { # required
|
627
|
+
# formula: "Formula", # required
|
628
|
+
# context_row_id: "RowId",
|
629
|
+
# },
|
630
|
+
# cells_to_update: { # required
|
631
|
+
# "ResourceId" => {
|
632
|
+
# fact: "Fact",
|
633
|
+
# },
|
634
|
+
# },
|
635
|
+
# },
|
636
|
+
# ],
|
637
|
+
# client_request_token: "ClientRequestToken",
|
638
|
+
# })
|
639
|
+
#
|
640
|
+
# @example Response structure
|
641
|
+
#
|
642
|
+
# resp.rows #=> Hash
|
643
|
+
# resp.rows["BatchItemId"].row_ids #=> Array
|
644
|
+
# resp.rows["BatchItemId"].row_ids[0] #=> String
|
645
|
+
# resp.rows["BatchItemId"].upsert_action #=> String, one of "UPDATED", "APPENDED"
|
646
|
+
# resp.workbook_cursor #=> Integer
|
647
|
+
# resp.failed_batch_items #=> Array
|
648
|
+
# resp.failed_batch_items[0].id #=> String
|
649
|
+
# resp.failed_batch_items[0].error_message #=> String
|
650
|
+
#
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchUpsertTableRows AWS API Documentation
|
652
|
+
#
|
653
|
+
# @overload batch_upsert_table_rows(params = {})
|
654
|
+
# @param [Hash] params ({})
|
655
|
+
def batch_upsert_table_rows(params = {}, options = {})
|
656
|
+
req = build_request(:batch_upsert_table_rows, params)
|
657
|
+
req.send_request(options)
|
658
|
+
end
|
659
|
+
|
660
|
+
# The DescribeTableDataImportJob API allows you to retrieve the status
|
661
|
+
# and details of a table data import job.
|
662
|
+
#
|
663
|
+
# @option params [required, String] :workbook_id
|
664
|
+
# The ID of the workbook into which data was imported.
|
665
|
+
#
|
666
|
+
# If a workbook with the specified id could not be found, this API
|
667
|
+
# throws ResourceNotFoundException.
|
668
|
+
#
|
669
|
+
# @option params [required, String] :table_id
|
670
|
+
# The ID of the table into which data was imported.
|
671
|
+
#
|
672
|
+
# If a table with the specified id could not be found, this API throws
|
673
|
+
# ResourceNotFoundException.
|
674
|
+
#
|
675
|
+
# @option params [required, String] :job_id
|
676
|
+
# The ID of the job that was returned by the StartTableDataImportJob
|
677
|
+
# request.
|
678
|
+
#
|
679
|
+
# If a job with the specified id could not be found, this API throws
|
680
|
+
# ResourceNotFoundException.
|
681
|
+
#
|
682
|
+
# @return [Types::DescribeTableDataImportJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
683
|
+
#
|
684
|
+
# * {Types::DescribeTableDataImportJobResult#job_status #job_status} => String
|
685
|
+
# * {Types::DescribeTableDataImportJobResult#message #message} => String
|
686
|
+
# * {Types::DescribeTableDataImportJobResult#job_metadata #job_metadata} => Types::TableDataImportJobMetadata
|
687
|
+
#
|
688
|
+
# @example Request syntax with placeholder values
|
689
|
+
#
|
690
|
+
# resp = client.describe_table_data_import_job({
|
691
|
+
# workbook_id: "ResourceId", # required
|
692
|
+
# table_id: "ResourceId", # required
|
693
|
+
# job_id: "JobId", # required
|
694
|
+
# })
|
695
|
+
#
|
696
|
+
# @example Response structure
|
697
|
+
#
|
698
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
|
699
|
+
# resp.message #=> String
|
700
|
+
# resp.job_metadata.submitter.email #=> String
|
701
|
+
# resp.job_metadata.submitter.user_arn #=> String
|
702
|
+
# resp.job_metadata.submit_time #=> Time
|
703
|
+
# resp.job_metadata.import_options.destination_options.column_map #=> Hash
|
704
|
+
# resp.job_metadata.import_options.destination_options.column_map["ResourceId"].column_index #=> Integer
|
705
|
+
# resp.job_metadata.import_options.delimited_text_options.delimiter #=> String
|
706
|
+
# resp.job_metadata.import_options.delimited_text_options.has_header_row #=> Boolean
|
707
|
+
# resp.job_metadata.import_options.delimited_text_options.ignore_empty_rows #=> Boolean
|
708
|
+
# resp.job_metadata.import_options.delimited_text_options.data_character_encoding #=> String, one of "UTF-8", "US-ASCII", "ISO-8859-1", "UTF-16BE", "UTF-16LE", "UTF-16"
|
709
|
+
# resp.job_metadata.data_source.data_source_config.data_source_url #=> String
|
710
|
+
#
|
711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DescribeTableDataImportJob AWS API Documentation
|
712
|
+
#
|
713
|
+
# @overload describe_table_data_import_job(params = {})
|
714
|
+
# @param [Hash] params ({})
|
715
|
+
def describe_table_data_import_job(params = {}, options = {})
|
716
|
+
req = build_request(:describe_table_data_import_job, params)
|
717
|
+
req.send_request(options)
|
718
|
+
end
|
719
|
+
|
330
720
|
# The GetScreenData API allows retrieval of data from a screen in a
|
331
721
|
# Honeycode app. The API allows setting local variables in the screen to
|
332
722
|
# filter, sort or otherwise affect what will be displayed on the screen.
|
@@ -426,11 +816,11 @@ module Aws::Honeycode
|
|
426
816
|
# The ID of the automation action to be performed.
|
427
817
|
#
|
428
818
|
# @option params [Hash<String,Types::VariableValue>] :variables
|
429
|
-
# Variables are
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
819
|
+
# Variables are specified as a map where the key is the name of the
|
820
|
+
# variable as defined on the screen. The value is an object which
|
821
|
+
# currently has only one property, rawValue, which holds the value of
|
822
|
+
# the variable to be passed to the screen. Any variables defined in a
|
823
|
+
# screen are required to be passed in the call.
|
434
824
|
#
|
435
825
|
# @option params [String] :row_id
|
436
826
|
# The row ID for the automation if the automation is defined inside a
|
@@ -481,6 +871,358 @@ module Aws::Honeycode
|
|
481
871
|
req.send_request(options)
|
482
872
|
end
|
483
873
|
|
874
|
+
# The ListTableColumns API allows you to retrieve a list of all the
|
875
|
+
# columns in a table in a workbook.
|
876
|
+
#
|
877
|
+
# @option params [required, String] :workbook_id
|
878
|
+
# The ID of the workbook that contains the table whose columns are being
|
879
|
+
# retrieved.
|
880
|
+
#
|
881
|
+
# If a workbook with the specified id could not be found, this API
|
882
|
+
# throws ResourceNotFoundException.
|
883
|
+
#
|
884
|
+
# @option params [required, String] :table_id
|
885
|
+
# The ID of the table whose columns are being retrieved.
|
886
|
+
#
|
887
|
+
# If a table with the specified id could not be found, this API throws
|
888
|
+
# ResourceNotFoundException.
|
889
|
+
#
|
890
|
+
# @option params [String] :next_token
|
891
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
892
|
+
# returns the first page of data.
|
893
|
+
#
|
894
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
895
|
+
# returned more than an hour back, the API will throw
|
896
|
+
# ValidationException.
|
897
|
+
#
|
898
|
+
# @return [Types::ListTableColumnsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
899
|
+
#
|
900
|
+
# * {Types::ListTableColumnsResult#table_columns #table_columns} => Array<Types::TableColumn>
|
901
|
+
# * {Types::ListTableColumnsResult#next_token #next_token} => String
|
902
|
+
# * {Types::ListTableColumnsResult#workbook_cursor #workbook_cursor} => Integer
|
903
|
+
#
|
904
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
905
|
+
#
|
906
|
+
# @example Request syntax with placeholder values
|
907
|
+
#
|
908
|
+
# resp = client.list_table_columns({
|
909
|
+
# workbook_id: "ResourceId", # required
|
910
|
+
# table_id: "ResourceId", # required
|
911
|
+
# next_token: "PaginationToken",
|
912
|
+
# })
|
913
|
+
#
|
914
|
+
# @example Response structure
|
915
|
+
#
|
916
|
+
# resp.table_columns #=> Array
|
917
|
+
# resp.table_columns[0].table_column_id #=> String
|
918
|
+
# resp.table_columns[0].table_column_name #=> String
|
919
|
+
# resp.table_columns[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK"
|
920
|
+
# resp.next_token #=> String
|
921
|
+
# resp.workbook_cursor #=> Integer
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTableColumns AWS API Documentation
|
924
|
+
#
|
925
|
+
# @overload list_table_columns(params = {})
|
926
|
+
# @param [Hash] params ({})
|
927
|
+
def list_table_columns(params = {}, options = {})
|
928
|
+
req = build_request(:list_table_columns, params)
|
929
|
+
req.send_request(options)
|
930
|
+
end
|
931
|
+
|
932
|
+
# The ListTableRows API allows you to retrieve a list of all the rows in
|
933
|
+
# a table in a workbook.
|
934
|
+
#
|
935
|
+
# @option params [required, String] :workbook_id
|
936
|
+
# The ID of the workbook that contains the table whose rows are being
|
937
|
+
# retrieved.
|
938
|
+
#
|
939
|
+
# If a workbook with the specified id could not be found, this API
|
940
|
+
# throws ResourceNotFoundException.
|
941
|
+
#
|
942
|
+
# @option params [required, String] :table_id
|
943
|
+
# The ID of the table whose rows are being retrieved.
|
944
|
+
#
|
945
|
+
# If a table with the specified id could not be found, this API throws
|
946
|
+
# ResourceNotFoundException.
|
947
|
+
#
|
948
|
+
# @option params [Array<String>] :row_ids
|
949
|
+
# This parameter is optional. If one or more row ids are specified in
|
950
|
+
# this list, then only the specified row ids are returned in the result.
|
951
|
+
# If no row ids are specified here, then all the rows in the table are
|
952
|
+
# returned.
|
953
|
+
#
|
954
|
+
# @option params [Integer] :max_results
|
955
|
+
# The maximum number of rows to return in each page of the results.
|
956
|
+
#
|
957
|
+
# @option params [String] :next_token
|
958
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
959
|
+
# returns the first page of data.
|
960
|
+
#
|
961
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
962
|
+
# returned more than an hour back, the API will throw
|
963
|
+
# ValidationException.
|
964
|
+
#
|
965
|
+
# @return [Types::ListTableRowsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
966
|
+
#
|
967
|
+
# * {Types::ListTableRowsResult#column_ids #column_ids} => Array<String>
|
968
|
+
# * {Types::ListTableRowsResult#rows #rows} => Array<Types::TableRow>
|
969
|
+
# * {Types::ListTableRowsResult#row_ids_not_found #row_ids_not_found} => Array<String>
|
970
|
+
# * {Types::ListTableRowsResult#next_token #next_token} => String
|
971
|
+
# * {Types::ListTableRowsResult#workbook_cursor #workbook_cursor} => Integer
|
972
|
+
#
|
973
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
974
|
+
#
|
975
|
+
# @example Request syntax with placeholder values
|
976
|
+
#
|
977
|
+
# resp = client.list_table_rows({
|
978
|
+
# workbook_id: "ResourceId", # required
|
979
|
+
# table_id: "ResourceId", # required
|
980
|
+
# row_ids: ["RowId"],
|
981
|
+
# max_results: 1,
|
982
|
+
# next_token: "PaginationToken",
|
983
|
+
# })
|
984
|
+
#
|
985
|
+
# @example Response structure
|
986
|
+
#
|
987
|
+
# resp.column_ids #=> Array
|
988
|
+
# resp.column_ids[0] #=> String
|
989
|
+
# resp.rows #=> Array
|
990
|
+
# resp.rows[0].row_id #=> String
|
991
|
+
# resp.rows[0].cells #=> Array
|
992
|
+
# resp.rows[0].cells[0].formula #=> String
|
993
|
+
# resp.rows[0].cells[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK"
|
994
|
+
# resp.rows[0].cells[0].raw_value #=> String
|
995
|
+
# resp.rows[0].cells[0].formatted_value #=> String
|
996
|
+
# resp.row_ids_not_found #=> Array
|
997
|
+
# resp.row_ids_not_found[0] #=> String
|
998
|
+
# resp.next_token #=> String
|
999
|
+
# resp.workbook_cursor #=> Integer
|
1000
|
+
#
|
1001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTableRows AWS API Documentation
|
1002
|
+
#
|
1003
|
+
# @overload list_table_rows(params = {})
|
1004
|
+
# @param [Hash] params ({})
|
1005
|
+
def list_table_rows(params = {}, options = {})
|
1006
|
+
req = build_request(:list_table_rows, params)
|
1007
|
+
req.send_request(options)
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# The ListTables API allows you to retrieve a list of all the tables in
|
1011
|
+
# a workbook.
|
1012
|
+
#
|
1013
|
+
# @option params [required, String] :workbook_id
|
1014
|
+
# The ID of the workbook whose tables are being retrieved.
|
1015
|
+
#
|
1016
|
+
# If a workbook with the specified id could not be found, this API
|
1017
|
+
# throws ResourceNotFoundException.
|
1018
|
+
#
|
1019
|
+
# @option params [Integer] :max_results
|
1020
|
+
# The maximum number of tables to return in each page of the results.
|
1021
|
+
#
|
1022
|
+
# @option params [String] :next_token
|
1023
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
1024
|
+
# returns the first page of data.
|
1025
|
+
#
|
1026
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
1027
|
+
# returned more than an hour back, the API will throw
|
1028
|
+
# ValidationException.
|
1029
|
+
#
|
1030
|
+
# @return [Types::ListTablesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1031
|
+
#
|
1032
|
+
# * {Types::ListTablesResult#tables #tables} => Array<Types::Table>
|
1033
|
+
# * {Types::ListTablesResult#next_token #next_token} => String
|
1034
|
+
# * {Types::ListTablesResult#workbook_cursor #workbook_cursor} => Integer
|
1035
|
+
#
|
1036
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1037
|
+
#
|
1038
|
+
# @example Request syntax with placeholder values
|
1039
|
+
#
|
1040
|
+
# resp = client.list_tables({
|
1041
|
+
# workbook_id: "ResourceId", # required
|
1042
|
+
# max_results: 1,
|
1043
|
+
# next_token: "PaginationToken",
|
1044
|
+
# })
|
1045
|
+
#
|
1046
|
+
# @example Response structure
|
1047
|
+
#
|
1048
|
+
# resp.tables #=> Array
|
1049
|
+
# resp.tables[0].table_id #=> String
|
1050
|
+
# resp.tables[0].table_name #=> String
|
1051
|
+
# resp.next_token #=> String
|
1052
|
+
# resp.workbook_cursor #=> Integer
|
1053
|
+
#
|
1054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTables AWS API Documentation
|
1055
|
+
#
|
1056
|
+
# @overload list_tables(params = {})
|
1057
|
+
# @param [Hash] params ({})
|
1058
|
+
def list_tables(params = {}, options = {})
|
1059
|
+
req = build_request(:list_tables, params)
|
1060
|
+
req.send_request(options)
|
1061
|
+
end
|
1062
|
+
|
1063
|
+
# The QueryTableRows API allows you to use a filter formula to query for
|
1064
|
+
# specific rows in a table.
|
1065
|
+
#
|
1066
|
+
# @option params [required, String] :workbook_id
|
1067
|
+
# The ID of the workbook whose table rows are being queried.
|
1068
|
+
#
|
1069
|
+
# If a workbook with the specified id could not be found, this API
|
1070
|
+
# throws ResourceNotFoundException.
|
1071
|
+
#
|
1072
|
+
# @option params [required, String] :table_id
|
1073
|
+
# The ID of the table whose rows are being queried.
|
1074
|
+
#
|
1075
|
+
# If a table with the specified id could not be found, this API throws
|
1076
|
+
# ResourceNotFoundException.
|
1077
|
+
#
|
1078
|
+
# @option params [required, Types::Filter] :filter_formula
|
1079
|
+
# An object that represents a filter formula along with the id of the
|
1080
|
+
# context row under which the filter function needs to evaluate.
|
1081
|
+
#
|
1082
|
+
# @option params [Integer] :max_results
|
1083
|
+
# The maximum number of rows to return in each page of the results.
|
1084
|
+
#
|
1085
|
+
# @option params [String] :next_token
|
1086
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
1087
|
+
# returns the first page of data.
|
1088
|
+
#
|
1089
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
1090
|
+
# returned more than an hour back, the API will throw
|
1091
|
+
# ValidationException.
|
1092
|
+
#
|
1093
|
+
# @return [Types::QueryTableRowsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1094
|
+
#
|
1095
|
+
# * {Types::QueryTableRowsResult#column_ids #column_ids} => Array<String>
|
1096
|
+
# * {Types::QueryTableRowsResult#rows #rows} => Array<Types::TableRow>
|
1097
|
+
# * {Types::QueryTableRowsResult#next_token #next_token} => String
|
1098
|
+
# * {Types::QueryTableRowsResult#workbook_cursor #workbook_cursor} => Integer
|
1099
|
+
#
|
1100
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1101
|
+
#
|
1102
|
+
# @example Request syntax with placeholder values
|
1103
|
+
#
|
1104
|
+
# resp = client.query_table_rows({
|
1105
|
+
# workbook_id: "ResourceId", # required
|
1106
|
+
# table_id: "ResourceId", # required
|
1107
|
+
# filter_formula: { # required
|
1108
|
+
# formula: "Formula", # required
|
1109
|
+
# context_row_id: "RowId",
|
1110
|
+
# },
|
1111
|
+
# max_results: 1,
|
1112
|
+
# next_token: "PaginationToken",
|
1113
|
+
# })
|
1114
|
+
#
|
1115
|
+
# @example Response structure
|
1116
|
+
#
|
1117
|
+
# resp.column_ids #=> Array
|
1118
|
+
# resp.column_ids[0] #=> String
|
1119
|
+
# resp.rows #=> Array
|
1120
|
+
# resp.rows[0].row_id #=> String
|
1121
|
+
# resp.rows[0].cells #=> Array
|
1122
|
+
# resp.rows[0].cells[0].formula #=> String
|
1123
|
+
# resp.rows[0].cells[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK"
|
1124
|
+
# resp.rows[0].cells[0].raw_value #=> String
|
1125
|
+
# resp.rows[0].cells[0].formatted_value #=> String
|
1126
|
+
# resp.next_token #=> String
|
1127
|
+
# resp.workbook_cursor #=> Integer
|
1128
|
+
#
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/QueryTableRows AWS API Documentation
|
1130
|
+
#
|
1131
|
+
# @overload query_table_rows(params = {})
|
1132
|
+
# @param [Hash] params ({})
|
1133
|
+
def query_table_rows(params = {}, options = {})
|
1134
|
+
req = build_request(:query_table_rows, params)
|
1135
|
+
req.send_request(options)
|
1136
|
+
end
|
1137
|
+
|
1138
|
+
# The StartTableDataImportJob API allows you to start an import job on a
|
1139
|
+
# table. This API will only return the id of the job that was started.
|
1140
|
+
# To find out the status of the import request, you need to call the
|
1141
|
+
# DescribeTableDataImportJob API.
|
1142
|
+
#
|
1143
|
+
# @option params [required, String] :workbook_id
|
1144
|
+
# The ID of the workbook where the rows are being imported.
|
1145
|
+
#
|
1146
|
+
# If a workbook with the specified id could not be found, this API
|
1147
|
+
# throws ResourceNotFoundException.
|
1148
|
+
#
|
1149
|
+
# @option params [required, Types::ImportDataSource] :data_source
|
1150
|
+
# The source of the data that is being imported. The size of source must
|
1151
|
+
# be no larger than 100 MB. Source must have no more than 100,000 cells
|
1152
|
+
# and no more than 1,000 rows.
|
1153
|
+
#
|
1154
|
+
# @option params [required, String] :data_format
|
1155
|
+
# The format of the data that is being imported. Currently the only
|
1156
|
+
# option supported is "DELIMITED\_TEXT".
|
1157
|
+
#
|
1158
|
+
# @option params [required, String] :destination_table_id
|
1159
|
+
# The ID of the table where the rows are being imported.
|
1160
|
+
#
|
1161
|
+
# If a table with the specified id could not be found, this API throws
|
1162
|
+
# ResourceNotFoundException.
|
1163
|
+
#
|
1164
|
+
# @option params [required, Types::ImportOptions] :import_options
|
1165
|
+
# The options for customizing this import request.
|
1166
|
+
#
|
1167
|
+
# @option params [required, String] :client_request_token
|
1168
|
+
# The request token for performing the update action. Request tokens
|
1169
|
+
# help to identify duplicate requests. If a call times out or fails due
|
1170
|
+
# to a transient error like a failed network connection, you can retry
|
1171
|
+
# the call with the same request token. The service ensures that if the
|
1172
|
+
# first call using that request token is successfully performed, the
|
1173
|
+
# second call will not perform the action again.
|
1174
|
+
#
|
1175
|
+
# Note that request tokens are valid only for a few minutes. You cannot
|
1176
|
+
# use request tokens to dedupe requests spanning hours or days.
|
1177
|
+
#
|
1178
|
+
# @return [Types::StartTableDataImportJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1179
|
+
#
|
1180
|
+
# * {Types::StartTableDataImportJobResult#job_id #job_id} => String
|
1181
|
+
# * {Types::StartTableDataImportJobResult#job_status #job_status} => String
|
1182
|
+
#
|
1183
|
+
# @example Request syntax with placeholder values
|
1184
|
+
#
|
1185
|
+
# resp = client.start_table_data_import_job({
|
1186
|
+
# workbook_id: "ResourceId", # required
|
1187
|
+
# data_source: { # required
|
1188
|
+
# data_source_config: { # required
|
1189
|
+
# data_source_url: "SecureURL",
|
1190
|
+
# },
|
1191
|
+
# },
|
1192
|
+
# data_format: "DELIMITED_TEXT", # required, accepts DELIMITED_TEXT
|
1193
|
+
# destination_table_id: "ResourceId", # required
|
1194
|
+
# import_options: { # required
|
1195
|
+
# destination_options: {
|
1196
|
+
# column_map: {
|
1197
|
+
# "ResourceId" => {
|
1198
|
+
# column_index: 1,
|
1199
|
+
# },
|
1200
|
+
# },
|
1201
|
+
# },
|
1202
|
+
# delimited_text_options: {
|
1203
|
+
# delimiter: "DelimitedTextDelimiter", # required
|
1204
|
+
# has_header_row: false,
|
1205
|
+
# ignore_empty_rows: false,
|
1206
|
+
# data_character_encoding: "UTF-8", # accepts UTF-8, US-ASCII, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16
|
1207
|
+
# },
|
1208
|
+
# },
|
1209
|
+
# client_request_token: "ClientRequestToken", # required
|
1210
|
+
# })
|
1211
|
+
#
|
1212
|
+
# @example Response structure
|
1213
|
+
#
|
1214
|
+
# resp.job_id #=> String
|
1215
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
|
1216
|
+
#
|
1217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/StartTableDataImportJob AWS API Documentation
|
1218
|
+
#
|
1219
|
+
# @overload start_table_data_import_job(params = {})
|
1220
|
+
# @param [Hash] params ({})
|
1221
|
+
def start_table_data_import_job(params = {}, options = {})
|
1222
|
+
req = build_request(:start_table_data_import_job, params)
|
1223
|
+
req.send_request(options)
|
1224
|
+
end
|
1225
|
+
|
484
1226
|
# @!endgroup
|
485
1227
|
|
486
1228
|
# @param params ({})
|
@@ -494,7 +1236,7 @@ module Aws::Honeycode
|
|
494
1236
|
params: params,
|
495
1237
|
config: config)
|
496
1238
|
context[:gem_name] = 'aws-sdk-honeycode'
|
497
|
-
context[:gem_version] = '1.
|
1239
|
+
context[:gem_version] = '1.4.0'
|
498
1240
|
Seahorse::Client::Request.new(handlers, context)
|
499
1241
|
end
|
500
1242
|
|