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
@@ -33,6 +33,7 @@ module Aws::Honeycode
|
|
33
33
|
# * {InternalServerException}
|
34
34
|
# * {RequestTimeoutException}
|
35
35
|
# * {ResourceNotFoundException}
|
36
|
+
# * {ServiceQuotaExceededException}
|
36
37
|
# * {ServiceUnavailableException}
|
37
38
|
# * {ThrottlingException}
|
38
39
|
# * {ValidationException}
|
@@ -133,6 +134,21 @@ module Aws::Honeycode
|
|
133
134
|
end
|
134
135
|
end
|
135
136
|
|
137
|
+
class ServiceQuotaExceededException < ServiceError
|
138
|
+
|
139
|
+
# @param [Seahorse::Client::RequestContext] context
|
140
|
+
# @param [String] message
|
141
|
+
# @param [Aws::Honeycode::Types::ServiceQuotaExceededException] data
|
142
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
143
|
+
super(context, message, data)
|
144
|
+
end
|
145
|
+
|
146
|
+
# @return [String]
|
147
|
+
def message
|
148
|
+
@message || @data[:message]
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
136
152
|
class ServiceUnavailableException < ServiceError
|
137
153
|
|
138
154
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -12,7 +12,7 @@ module Aws::Honeycode
|
|
12
12
|
|
13
13
|
# You do not have sufficient access to perform this action. Check that
|
14
14
|
# the workbook is owned by you and your IAM policy allows access to the
|
15
|
-
#
|
15
|
+
# resource in the request.
|
16
16
|
#
|
17
17
|
# @!attribute [rw] message
|
18
18
|
# @return [String]
|
@@ -51,95 +51,1076 @@ module Aws::Honeycode
|
|
51
51
|
include Aws::Structure
|
52
52
|
end
|
53
53
|
|
54
|
+
# @note When making an API call, you may pass BatchCreateTableRowsRequest
|
55
|
+
# data as a hash:
|
56
|
+
#
|
57
|
+
# {
|
58
|
+
# workbook_id: "ResourceId", # required
|
59
|
+
# table_id: "ResourceId", # required
|
60
|
+
# rows_to_create: [ # required
|
61
|
+
# {
|
62
|
+
# batch_item_id: "BatchItemId", # required
|
63
|
+
# cells_to_create: { # required
|
64
|
+
# "ResourceId" => {
|
65
|
+
# fact: "Fact",
|
66
|
+
# },
|
67
|
+
# },
|
68
|
+
# },
|
69
|
+
# ],
|
70
|
+
# client_request_token: "ClientRequestToken",
|
71
|
+
# }
|
72
|
+
#
|
73
|
+
# @!attribute [rw] workbook_id
|
74
|
+
# The ID of the workbook where the new rows are being added.
|
75
|
+
#
|
76
|
+
# If a workbook with the specified ID could not be found, this API
|
77
|
+
# throws ResourceNotFoundException.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] table_id
|
81
|
+
# The ID of the table where the new rows are being added.
|
82
|
+
#
|
83
|
+
# If a table with the specified ID could not be found, this API throws
|
84
|
+
# ResourceNotFoundException.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] rows_to_create
|
88
|
+
# The list of rows to create at the end of the table. Each item in
|
89
|
+
# this list needs to have a batch item id to uniquely identify the
|
90
|
+
# element in the request and the cells to create for that row. You
|
91
|
+
# need to specify at least one item in this list.
|
92
|
+
#
|
93
|
+
# Note that if one of the column ids in any of the rows in the request
|
94
|
+
# does not exist in the table, then the request fails and no updates
|
95
|
+
# are made to the table.
|
96
|
+
# @return [Array<Types::CreateRowData>]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] client_request_token
|
99
|
+
# The request token for performing the batch create operation. Request
|
100
|
+
# tokens help to identify duplicate requests. If a call times out or
|
101
|
+
# fails due to a transient error like a failed network connection, you
|
102
|
+
# can retry the call with the same request token. The service ensures
|
103
|
+
# that if the first call using that request token is successfully
|
104
|
+
# performed, the second call will not perform the operation again.
|
105
|
+
#
|
106
|
+
# Note that request tokens are valid only for a few minutes. You
|
107
|
+
# cannot use request tokens to dedupe requests spanning hours or days.
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchCreateTableRowsRequest AWS API Documentation
|
111
|
+
#
|
112
|
+
class BatchCreateTableRowsRequest < Struct.new(
|
113
|
+
:workbook_id,
|
114
|
+
:table_id,
|
115
|
+
:rows_to_create,
|
116
|
+
:client_request_token)
|
117
|
+
SENSITIVE = []
|
118
|
+
include Aws::Structure
|
119
|
+
end
|
120
|
+
|
121
|
+
# @!attribute [rw] workbook_cursor
|
122
|
+
# The updated workbook cursor after adding the new rows at the end of
|
123
|
+
# the table.
|
124
|
+
# @return [Integer]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] created_rows
|
127
|
+
# The map of batch item id to the row id that was created for that
|
128
|
+
# item.
|
129
|
+
# @return [Hash<String,String>]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] failed_batch_items
|
132
|
+
# The list of batch items in the request that could not be added to
|
133
|
+
# the table. Each element in this list contains one item from the
|
134
|
+
# request that could not be added to the table along with the reason
|
135
|
+
# why that item could not be added.
|
136
|
+
# @return [Array<Types::FailedBatchItem>]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchCreateTableRowsResult AWS API Documentation
|
139
|
+
#
|
140
|
+
class BatchCreateTableRowsResult < Struct.new(
|
141
|
+
:workbook_cursor,
|
142
|
+
:created_rows,
|
143
|
+
:failed_batch_items)
|
144
|
+
SENSITIVE = []
|
145
|
+
include Aws::Structure
|
146
|
+
end
|
147
|
+
|
148
|
+
# @note When making an API call, you may pass BatchDeleteTableRowsRequest
|
149
|
+
# data as a hash:
|
150
|
+
#
|
151
|
+
# {
|
152
|
+
# workbook_id: "ResourceId", # required
|
153
|
+
# table_id: "ResourceId", # required
|
154
|
+
# row_ids: ["RowId"], # required
|
155
|
+
# client_request_token: "ClientRequestToken",
|
156
|
+
# }
|
157
|
+
#
|
158
|
+
# @!attribute [rw] workbook_id
|
159
|
+
# The ID of the workbook where the rows are being deleted.
|
160
|
+
#
|
161
|
+
# If a workbook with the specified id could not be found, this API
|
162
|
+
# throws ResourceNotFoundException.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] table_id
|
166
|
+
# The ID of the table where the rows are being deleted.
|
167
|
+
#
|
168
|
+
# If a table with the specified id could not be found, this API throws
|
169
|
+
# ResourceNotFoundException.
|
170
|
+
# @return [String]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] row_ids
|
173
|
+
# The list of row ids to delete from the table. You need to specify at
|
174
|
+
# least one row id in this list.
|
175
|
+
#
|
176
|
+
# Note that if one of the row ids provided in the request does not
|
177
|
+
# exist in the table, then the request fails and no rows are deleted
|
178
|
+
# from the table.
|
179
|
+
# @return [Array<String>]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] client_request_token
|
182
|
+
# The request token for performing the delete action. Request tokens
|
183
|
+
# help to identify duplicate requests. If a call times out or fails
|
184
|
+
# due to a transient error like a failed network connection, you can
|
185
|
+
# retry the call with the same request token. The service ensures that
|
186
|
+
# if the first call using that request token is successfully
|
187
|
+
# performed, the second call will not perform the action again.
|
188
|
+
#
|
189
|
+
# Note that request tokens are valid only for a few minutes. You
|
190
|
+
# cannot use request tokens to dedupe requests spanning hours or days.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchDeleteTableRowsRequest AWS API Documentation
|
194
|
+
#
|
195
|
+
class BatchDeleteTableRowsRequest < Struct.new(
|
196
|
+
:workbook_id,
|
197
|
+
:table_id,
|
198
|
+
:row_ids,
|
199
|
+
:client_request_token)
|
200
|
+
SENSITIVE = []
|
201
|
+
include Aws::Structure
|
202
|
+
end
|
203
|
+
|
204
|
+
# @!attribute [rw] workbook_cursor
|
205
|
+
# The updated workbook cursor after deleting the rows from the table.
|
206
|
+
# @return [Integer]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] failed_batch_items
|
209
|
+
# The list of row ids in the request that could not be deleted from
|
210
|
+
# the table. Each element in this list contains one row id from the
|
211
|
+
# request that could not be deleted along with the reason why that
|
212
|
+
# item could not be deleted.
|
213
|
+
# @return [Array<Types::FailedBatchItem>]
|
214
|
+
#
|
215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchDeleteTableRowsResult AWS API Documentation
|
216
|
+
#
|
217
|
+
class BatchDeleteTableRowsResult < Struct.new(
|
218
|
+
:workbook_cursor,
|
219
|
+
:failed_batch_items)
|
220
|
+
SENSITIVE = []
|
221
|
+
include Aws::Structure
|
222
|
+
end
|
223
|
+
|
224
|
+
# @note When making an API call, you may pass BatchUpdateTableRowsRequest
|
225
|
+
# data as a hash:
|
226
|
+
#
|
227
|
+
# {
|
228
|
+
# workbook_id: "ResourceId", # required
|
229
|
+
# table_id: "ResourceId", # required
|
230
|
+
# rows_to_update: [ # required
|
231
|
+
# {
|
232
|
+
# row_id: "RowId", # required
|
233
|
+
# cells_to_update: { # required
|
234
|
+
# "ResourceId" => {
|
235
|
+
# fact: "Fact",
|
236
|
+
# },
|
237
|
+
# },
|
238
|
+
# },
|
239
|
+
# ],
|
240
|
+
# client_request_token: "ClientRequestToken",
|
241
|
+
# }
|
242
|
+
#
|
243
|
+
# @!attribute [rw] workbook_id
|
244
|
+
# The ID of the workbook where the rows are being updated.
|
245
|
+
#
|
246
|
+
# If a workbook with the specified id could not be found, this API
|
247
|
+
# throws ResourceNotFoundException.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] table_id
|
251
|
+
# The ID of the table where the rows are being updated.
|
252
|
+
#
|
253
|
+
# If a table with the specified id could not be found, this API throws
|
254
|
+
# ResourceNotFoundException.
|
255
|
+
# @return [String]
|
256
|
+
#
|
257
|
+
# @!attribute [rw] rows_to_update
|
258
|
+
# The list of rows to update in the table. Each item in this list
|
259
|
+
# needs to contain the row id to update along with the map of column
|
260
|
+
# id to cell values for each column in that row that needs to be
|
261
|
+
# updated. You need to specify at least one row in this list, and for
|
262
|
+
# each row, you need to specify at least one column to update.
|
263
|
+
#
|
264
|
+
# Note that if one of the row or column ids in the request does not
|
265
|
+
# exist in the table, then the request fails and no updates are made
|
266
|
+
# to the table.
|
267
|
+
# @return [Array<Types::UpdateRowData>]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] client_request_token
|
270
|
+
# The request token for performing the update action. Request tokens
|
271
|
+
# help to identify duplicate requests. If a call times out or fails
|
272
|
+
# due to a transient error like a failed network connection, you can
|
273
|
+
# retry the call with the same request token. The service ensures that
|
274
|
+
# if the first call using that request token is successfully
|
275
|
+
# performed, the second call will not perform the action again.
|
276
|
+
#
|
277
|
+
# Note that request tokens are valid only for a few minutes. You
|
278
|
+
# cannot use request tokens to dedupe requests spanning hours or days.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchUpdateTableRowsRequest AWS API Documentation
|
282
|
+
#
|
283
|
+
class BatchUpdateTableRowsRequest < Struct.new(
|
284
|
+
:workbook_id,
|
285
|
+
:table_id,
|
286
|
+
:rows_to_update,
|
287
|
+
:client_request_token)
|
288
|
+
SENSITIVE = []
|
289
|
+
include Aws::Structure
|
290
|
+
end
|
291
|
+
|
292
|
+
# @!attribute [rw] workbook_cursor
|
293
|
+
# The updated workbook cursor after adding the new rows at the end of
|
294
|
+
# the table.
|
295
|
+
# @return [Integer]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] failed_batch_items
|
298
|
+
# The list of batch items in the request that could not be updated in
|
299
|
+
# the table. Each element in this list contains one item from the
|
300
|
+
# request that could not be updated in the table along with the reason
|
301
|
+
# why that item could not be updated.
|
302
|
+
# @return [Array<Types::FailedBatchItem>]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchUpdateTableRowsResult AWS API Documentation
|
305
|
+
#
|
306
|
+
class BatchUpdateTableRowsResult < Struct.new(
|
307
|
+
:workbook_cursor,
|
308
|
+
:failed_batch_items)
|
309
|
+
SENSITIVE = []
|
310
|
+
include Aws::Structure
|
311
|
+
end
|
312
|
+
|
313
|
+
# @note When making an API call, you may pass BatchUpsertTableRowsRequest
|
314
|
+
# data as a hash:
|
315
|
+
#
|
316
|
+
# {
|
317
|
+
# workbook_id: "ResourceId", # required
|
318
|
+
# table_id: "ResourceId", # required
|
319
|
+
# rows_to_upsert: [ # required
|
320
|
+
# {
|
321
|
+
# batch_item_id: "BatchItemId", # required
|
322
|
+
# filter: { # required
|
323
|
+
# formula: "Formula", # required
|
324
|
+
# context_row_id: "RowId",
|
325
|
+
# },
|
326
|
+
# cells_to_update: { # required
|
327
|
+
# "ResourceId" => {
|
328
|
+
# fact: "Fact",
|
329
|
+
# },
|
330
|
+
# },
|
331
|
+
# },
|
332
|
+
# ],
|
333
|
+
# client_request_token: "ClientRequestToken",
|
334
|
+
# }
|
335
|
+
#
|
336
|
+
# @!attribute [rw] workbook_id
|
337
|
+
# The ID of the workbook where the rows are being upserted.
|
338
|
+
#
|
339
|
+
# If a workbook with the specified id could not be found, this API
|
340
|
+
# throws ResourceNotFoundException.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] table_id
|
344
|
+
# The ID of the table where the rows are being upserted.
|
345
|
+
#
|
346
|
+
# If a table with the specified id could not be found, this API throws
|
347
|
+
# ResourceNotFoundException.
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] rows_to_upsert
|
351
|
+
# The list of rows to upsert in the table. Each item in this list
|
352
|
+
# needs to have a batch item id to uniquely identify the element in
|
353
|
+
# the request, a filter expression to find the rows to update for that
|
354
|
+
# element and the cell values to set for each column in the upserted
|
355
|
+
# rows. You need to specify at least one item in this list.
|
356
|
+
#
|
357
|
+
# Note that if one of the filter formulas in the request fails to
|
358
|
+
# evaluate because of an error or one of the column ids in any of the
|
359
|
+
# rows does not exist in the table, then the request fails and no
|
360
|
+
# updates are made to the table.
|
361
|
+
# @return [Array<Types::UpsertRowData>]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] client_request_token
|
364
|
+
# The request token for performing the update action. Request tokens
|
365
|
+
# help to identify duplicate requests. If a call times out or fails
|
366
|
+
# due to a transient error like a failed network connection, you can
|
367
|
+
# retry the call with the same request token. The service ensures that
|
368
|
+
# if the first call using that request token is successfully
|
369
|
+
# performed, the second call will not perform the action again.
|
370
|
+
#
|
371
|
+
# Note that request tokens are valid only for a few minutes. You
|
372
|
+
# cannot use request tokens to dedupe requests spanning hours or days.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchUpsertTableRowsRequest AWS API Documentation
|
376
|
+
#
|
377
|
+
class BatchUpsertTableRowsRequest < Struct.new(
|
378
|
+
:workbook_id,
|
379
|
+
:table_id,
|
380
|
+
:rows_to_upsert,
|
381
|
+
:client_request_token)
|
382
|
+
SENSITIVE = []
|
383
|
+
include Aws::Structure
|
384
|
+
end
|
385
|
+
|
386
|
+
# @!attribute [rw] rows
|
387
|
+
# A map with the batch item id as the key and the result of the upsert
|
388
|
+
# operation as the value. The result of the upsert operation specifies
|
389
|
+
# whether existing rows were updated or a new row was appended, along
|
390
|
+
# with the list of row ids that were affected.
|
391
|
+
# @return [Hash<String,Types::UpsertRowsResult>]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] workbook_cursor
|
394
|
+
# The updated workbook cursor after updating or appending rows in the
|
395
|
+
# table.
|
396
|
+
# @return [Integer]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] failed_batch_items
|
399
|
+
# The list of batch items in the request that could not be updated or
|
400
|
+
# appended in the table. Each element in this list contains one item
|
401
|
+
# from the request that could not be updated in the table along with
|
402
|
+
# the reason why that item could not be updated or appended.
|
403
|
+
# @return [Array<Types::FailedBatchItem>]
|
404
|
+
#
|
405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/BatchUpsertTableRowsResult AWS API Documentation
|
406
|
+
#
|
407
|
+
class BatchUpsertTableRowsResult < Struct.new(
|
408
|
+
:rows,
|
409
|
+
:workbook_cursor,
|
410
|
+
:failed_batch_items)
|
411
|
+
SENSITIVE = []
|
412
|
+
include Aws::Structure
|
413
|
+
end
|
414
|
+
|
415
|
+
# An object that represents a single cell in a table.
|
416
|
+
#
|
417
|
+
# @!attribute [rw] formula
|
418
|
+
# The formula contained in the cell. This field is empty if a cell
|
419
|
+
# does not have a formula.
|
420
|
+
# @return [String]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] format
|
423
|
+
# The format of the cell. If this field is empty, then the format is
|
424
|
+
# either not specified in the workbook or the format is set to AUTO.
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] raw_value
|
428
|
+
# The raw value of the data contained in the cell. The raw value
|
429
|
+
# depends on the format of the data in the cell. However the attribute
|
430
|
+
# in the API return value is always a string containing the raw value.
|
431
|
+
#
|
432
|
+
# Cells with format DATE, DATE\_TIME or TIME have the raw value as a
|
433
|
+
# floating point number where the whole number represents the number
|
434
|
+
# of days since 1/1/1900 and the fractional part represents the
|
435
|
+
# fraction of the day since midnight. For example, a cell with date
|
436
|
+
# 11/3/2020 has the raw value "44138". A cell with the time 9:00 AM
|
437
|
+
# has the raw value "0.375" and a cell with date/time value of
|
438
|
+
# 11/3/2020 9:00 AM has the raw value "44138.375". Notice that even
|
439
|
+
# though the raw value is a number in all three cases, it is still
|
440
|
+
# represented as a string.
|
441
|
+
#
|
442
|
+
# Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have
|
443
|
+
# the raw value of the data as the number representing the data being
|
444
|
+
# displayed. For example, the number 1.325 with two decimal places in
|
445
|
+
# the format will have it's raw value as "1.325" and formatted
|
446
|
+
# value as "1.33". A currency value for $10 will have the raw value
|
447
|
+
# as "10" and formatted value as "$10.00". A value representing
|
448
|
+
# 20% with two decimal places in the format will have its raw value as
|
449
|
+
# "0.2" and the formatted value as "20.00%". An accounting value
|
450
|
+
# of -$25 will have "-25" as the raw value and "$ (25.00)" as the
|
451
|
+
# formatted value.
|
452
|
+
#
|
453
|
+
# Cells with format TEXT will have the raw text as the raw value. For
|
454
|
+
# example, a cell with text "John Smith" will have "John Smith" as
|
455
|
+
# both the raw value and the formatted value.
|
456
|
+
#
|
457
|
+
# Cells with format CONTACT will have the name of the contact as a
|
458
|
+
# formatted value and the email address of the contact as the raw
|
459
|
+
# value. For example, a contact for John Smith will have "John
|
460
|
+
# Smith" as the formatted value and "john.smith@example.com" as the
|
461
|
+
# raw value.
|
462
|
+
#
|
463
|
+
# Cells with format ROWLINK (aka picklist) will have the first column
|
464
|
+
# of the linked row as the formatted value and the row id of the
|
465
|
+
# linked row as the raw value. For example, a cell containing a
|
466
|
+
# picklist to a table that displays task status might have
|
467
|
+
# "Completed" as the formatted value and
|
468
|
+
# "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
|
469
|
+
# as the raw value.
|
470
|
+
#
|
471
|
+
# Cells with format AUTO or cells without any format that are
|
472
|
+
# auto-detected as one of the formats above will contain the raw and
|
473
|
+
# formatted values as mentioned above, based on the auto-detected
|
474
|
+
# formats. If there is no auto-detected format, the raw and formatted
|
475
|
+
# values will be the same as the data in the cell.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] formatted_value
|
479
|
+
# The formatted value of the cell. This is the value that you see
|
480
|
+
# displayed in the cell in the UI.
|
481
|
+
#
|
482
|
+
# Note that the formatted value of a cell is always represented as a
|
483
|
+
# string irrespective of the data that is stored in the cell. For
|
484
|
+
# example, if a cell contains a date, the formatted value of the cell
|
485
|
+
# is the string representation of the formatted date being shown in
|
486
|
+
# the cell in the UI. See details in the rawValue field below for how
|
487
|
+
# cells of different formats will have different raw and formatted
|
488
|
+
# values.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/Cell AWS API Documentation
|
492
|
+
#
|
493
|
+
class Cell < Struct.new(
|
494
|
+
:formula,
|
495
|
+
:format,
|
496
|
+
:raw_value,
|
497
|
+
:formatted_value)
|
498
|
+
SENSITIVE = [:formula]
|
499
|
+
include Aws::Structure
|
500
|
+
end
|
501
|
+
|
502
|
+
# CellInput object contains the data needed to create or update cells in
|
503
|
+
# a table.
|
504
|
+
#
|
505
|
+
# @note When making an API call, you may pass CellInput
|
506
|
+
# data as a hash:
|
507
|
+
#
|
508
|
+
# {
|
509
|
+
# fact: "Fact",
|
510
|
+
# }
|
511
|
+
#
|
512
|
+
# @!attribute [rw] fact
|
513
|
+
# Fact represents the data that is entered into a cell. This data can
|
514
|
+
# be free text or a formula. Formulas need to start with the equals
|
515
|
+
# (=) sign.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/CellInput AWS API Documentation
|
519
|
+
#
|
520
|
+
class CellInput < Struct.new(
|
521
|
+
:fact)
|
522
|
+
SENSITIVE = [:fact]
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
54
526
|
# Metadata for column in the table.
|
55
527
|
#
|
56
528
|
# @!attribute [rw] name
|
57
529
|
# The name of the column.
|
58
530
|
# @return [String]
|
59
531
|
#
|
60
|
-
# @!attribute [rw] format
|
61
|
-
# The format of the column.
|
532
|
+
# @!attribute [rw] format
|
533
|
+
# The format of the column.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ColumnMetadata AWS API Documentation
|
537
|
+
#
|
538
|
+
class ColumnMetadata < Struct.new(
|
539
|
+
:name,
|
540
|
+
:format)
|
541
|
+
SENSITIVE = [:name]
|
542
|
+
include Aws::Structure
|
543
|
+
end
|
544
|
+
|
545
|
+
# Data needed to create a single row in a table as part of the
|
546
|
+
# BatchCreateTableRows request.
|
547
|
+
#
|
548
|
+
# @note When making an API call, you may pass CreateRowData
|
549
|
+
# data as a hash:
|
550
|
+
#
|
551
|
+
# {
|
552
|
+
# batch_item_id: "BatchItemId", # required
|
553
|
+
# cells_to_create: { # required
|
554
|
+
# "ResourceId" => {
|
555
|
+
# fact: "Fact",
|
556
|
+
# },
|
557
|
+
# },
|
558
|
+
# }
|
559
|
+
#
|
560
|
+
# @!attribute [rw] batch_item_id
|
561
|
+
# An external identifier that represents the single row that is being
|
562
|
+
# created as part of the BatchCreateTableRows request. This can be any
|
563
|
+
# string that you can use to identify the row in the request. The
|
564
|
+
# BatchCreateTableRows API puts the batch item id in the results to
|
565
|
+
# allow you to link data in the request to data in the results.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] cells_to_create
|
569
|
+
# A map representing the cells to create in the new row. The key is
|
570
|
+
# the column id of the cell and the value is the CellInput object that
|
571
|
+
# represents the data to set in that cell.
|
572
|
+
# @return [Hash<String,Types::CellInput>]
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/CreateRowData AWS API Documentation
|
575
|
+
#
|
576
|
+
class CreateRowData < Struct.new(
|
577
|
+
:batch_item_id,
|
578
|
+
:cells_to_create)
|
579
|
+
SENSITIVE = []
|
580
|
+
include Aws::Structure
|
581
|
+
end
|
582
|
+
|
583
|
+
# The data in a particular data cell defined on the screen.
|
584
|
+
#
|
585
|
+
# @!attribute [rw] override_format
|
586
|
+
# The overrideFormat is optional and is specified only if a particular
|
587
|
+
# row of data has a different format for the data than the default
|
588
|
+
# format defined on the screen or the table.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] raw_value
|
592
|
+
# The raw value of the data. e.g. jsmith@example.com
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] formatted_value
|
596
|
+
# The formatted value of the data. e.g. John Smith.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DataItem AWS API Documentation
|
600
|
+
#
|
601
|
+
class DataItem < Struct.new(
|
602
|
+
:override_format,
|
603
|
+
:raw_value,
|
604
|
+
:formatted_value)
|
605
|
+
SENSITIVE = []
|
606
|
+
include Aws::Structure
|
607
|
+
end
|
608
|
+
|
609
|
+
# An object that contains the options relating to parsing delimited text
|
610
|
+
# as part of an import request.
|
611
|
+
#
|
612
|
+
# @note When making an API call, you may pass DelimitedTextImportOptions
|
613
|
+
# data as a hash:
|
614
|
+
#
|
615
|
+
# {
|
616
|
+
# delimiter: "DelimitedTextDelimiter", # required
|
617
|
+
# has_header_row: false,
|
618
|
+
# ignore_empty_rows: false,
|
619
|
+
# data_character_encoding: "UTF-8", # accepts UTF-8, US-ASCII, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16
|
620
|
+
# }
|
621
|
+
#
|
622
|
+
# @!attribute [rw] delimiter
|
623
|
+
# The delimiter to use for separating columns in a single row of the
|
624
|
+
# input.
|
625
|
+
# @return [String]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] has_header_row
|
628
|
+
# Indicates whether the input file has a header row at the top
|
629
|
+
# containing the column names.
|
630
|
+
# @return [Boolean]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] ignore_empty_rows
|
633
|
+
# A parameter to indicate whether empty rows should be ignored or be
|
634
|
+
# included in the import.
|
635
|
+
# @return [Boolean]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] data_character_encoding
|
638
|
+
# The encoding of the data in the input file.
|
639
|
+
# @return [String]
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DelimitedTextImportOptions AWS API Documentation
|
642
|
+
#
|
643
|
+
class DelimitedTextImportOptions < Struct.new(
|
644
|
+
:delimiter,
|
645
|
+
:has_header_row,
|
646
|
+
:ignore_empty_rows,
|
647
|
+
:data_character_encoding)
|
648
|
+
SENSITIVE = []
|
649
|
+
include Aws::Structure
|
650
|
+
end
|
651
|
+
|
652
|
+
# @note When making an API call, you may pass DescribeTableDataImportJobRequest
|
653
|
+
# data as a hash:
|
654
|
+
#
|
655
|
+
# {
|
656
|
+
# workbook_id: "ResourceId", # required
|
657
|
+
# table_id: "ResourceId", # required
|
658
|
+
# job_id: "JobId", # required
|
659
|
+
# }
|
660
|
+
#
|
661
|
+
# @!attribute [rw] workbook_id
|
662
|
+
# The ID of the workbook into which data was imported.
|
663
|
+
#
|
664
|
+
# If a workbook with the specified id could not be found, this API
|
665
|
+
# throws ResourceNotFoundException.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] table_id
|
669
|
+
# The ID of the table into which data was imported.
|
670
|
+
#
|
671
|
+
# If a table with the specified id could not be found, this API throws
|
672
|
+
# ResourceNotFoundException.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] 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
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DescribeTableDataImportJobRequest AWS API Documentation
|
684
|
+
#
|
685
|
+
class DescribeTableDataImportJobRequest < Struct.new(
|
686
|
+
:workbook_id,
|
687
|
+
:table_id,
|
688
|
+
:job_id)
|
689
|
+
SENSITIVE = []
|
690
|
+
include Aws::Structure
|
691
|
+
end
|
692
|
+
|
693
|
+
# @!attribute [rw] job_status
|
694
|
+
# The current status of the import job.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] message
|
698
|
+
# A message providing more details about the current status of the
|
699
|
+
# import job.
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @!attribute [rw] job_metadata
|
703
|
+
# The metadata about the job that was submitted for import.
|
704
|
+
# @return [Types::TableDataImportJobMetadata]
|
705
|
+
#
|
706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DescribeTableDataImportJobResult AWS API Documentation
|
707
|
+
#
|
708
|
+
class DescribeTableDataImportJobResult < Struct.new(
|
709
|
+
:job_status,
|
710
|
+
:message,
|
711
|
+
:job_metadata)
|
712
|
+
SENSITIVE = []
|
713
|
+
include Aws::Structure
|
714
|
+
end
|
715
|
+
|
716
|
+
# An object that contains the options relating to the destination of the
|
717
|
+
# import request.
|
718
|
+
#
|
719
|
+
# @note When making an API call, you may pass DestinationOptions
|
720
|
+
# data as a hash:
|
721
|
+
#
|
722
|
+
# {
|
723
|
+
# column_map: {
|
724
|
+
# "ResourceId" => {
|
725
|
+
# column_index: 1,
|
726
|
+
# },
|
727
|
+
# },
|
728
|
+
# }
|
729
|
+
#
|
730
|
+
# @!attribute [rw] column_map
|
731
|
+
# A map of the column id to the import properties for each column.
|
732
|
+
# @return [Hash<String,Types::SourceDataColumnProperties>]
|
733
|
+
#
|
734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DestinationOptions AWS API Documentation
|
735
|
+
#
|
736
|
+
class DestinationOptions < Struct.new(
|
737
|
+
:column_map)
|
738
|
+
SENSITIVE = []
|
739
|
+
include Aws::Structure
|
740
|
+
end
|
741
|
+
|
742
|
+
# A single item in a batch that failed to perform the intended action
|
743
|
+
# because of an error preventing it from succeeding.
|
744
|
+
#
|
745
|
+
# @!attribute [rw] id
|
746
|
+
# The id of the batch item that failed. This is the batch item id for
|
747
|
+
# the BatchCreateTableRows and BatchUpsertTableRows operations and the
|
748
|
+
# row id for the BatchUpdateTableRows and BatchDeleteTableRows
|
749
|
+
# operations.
|
750
|
+
# @return [String]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] error_message
|
753
|
+
# The error message that indicates why the batch item failed.
|
754
|
+
# @return [String]
|
755
|
+
#
|
756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/FailedBatchItem AWS API Documentation
|
757
|
+
#
|
758
|
+
class FailedBatchItem < Struct.new(
|
759
|
+
:id,
|
760
|
+
:error_message)
|
761
|
+
SENSITIVE = []
|
762
|
+
include Aws::Structure
|
763
|
+
end
|
764
|
+
|
765
|
+
# An object that represents a filter formula along with the id of the
|
766
|
+
# context row under which the filter function needs to evaluate.
|
767
|
+
#
|
768
|
+
# @note When making an API call, you may pass Filter
|
769
|
+
# data as a hash:
|
770
|
+
#
|
771
|
+
# {
|
772
|
+
# formula: "Formula", # required
|
773
|
+
# context_row_id: "RowId",
|
774
|
+
# }
|
775
|
+
#
|
776
|
+
# @!attribute [rw] formula
|
777
|
+
# A formula representing a filter function that returns zero or more
|
778
|
+
# matching rows from a table. Valid formulas in this field return a
|
779
|
+
# list of rows from a table. The most common ways of writing a formula
|
780
|
+
# to return a list of rows are to use the FindRow() or Filter()
|
781
|
+
# functions. Any other formula that returns zero or more rows is also
|
782
|
+
# acceptable. For example, you can use a formula that points to a cell
|
783
|
+
# that contains a filter function.
|
784
|
+
# @return [String]
|
785
|
+
#
|
786
|
+
# @!attribute [rw] context_row_id
|
787
|
+
# The optional contextRowId attribute can be used to specify the row
|
788
|
+
# id of the context row if the filter formula contains unqualified
|
789
|
+
# references to table columns and needs a context row to evaluate them
|
790
|
+
# successfully.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/Filter AWS API Documentation
|
794
|
+
#
|
795
|
+
class Filter < Struct.new(
|
796
|
+
:formula,
|
797
|
+
:context_row_id)
|
798
|
+
SENSITIVE = [:formula]
|
799
|
+
include Aws::Structure
|
800
|
+
end
|
801
|
+
|
802
|
+
# @note When making an API call, you may pass GetScreenDataRequest
|
803
|
+
# data as a hash:
|
804
|
+
#
|
805
|
+
# {
|
806
|
+
# workbook_id: "ResourceId", # required
|
807
|
+
# app_id: "ResourceId", # required
|
808
|
+
# screen_id: "ResourceId", # required
|
809
|
+
# variables: {
|
810
|
+
# "VariableName" => {
|
811
|
+
# raw_value: "RawValue", # required
|
812
|
+
# },
|
813
|
+
# },
|
814
|
+
# max_results: 1,
|
815
|
+
# next_token: "PaginationToken",
|
816
|
+
# }
|
817
|
+
#
|
818
|
+
# @!attribute [rw] workbook_id
|
819
|
+
# The ID of the workbook that contains the screen.
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] app_id
|
823
|
+
# The ID of the app that contains the screem.
|
824
|
+
# @return [String]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] screen_id
|
827
|
+
# The ID of the screen.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] variables
|
831
|
+
# Variables are optional and are needed only if the screen requires
|
832
|
+
# them to render correctly. Variables are specified as a map where the
|
833
|
+
# key is the name of the variable as defined on the screen. The value
|
834
|
+
# is an object which currently has only one property, rawValue, which
|
835
|
+
# holds the value of the variable to be passed to the screen.
|
836
|
+
# @return [Hash<String,Types::VariableValue>]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] max_results
|
839
|
+
# The number of results to be returned on a single page. Specify a
|
840
|
+
# number between 1 and 100. The maximum value is 100.
|
841
|
+
#
|
842
|
+
# This parameter is optional. If you don't specify this parameter,
|
843
|
+
# the default page size is 100.
|
844
|
+
# @return [Integer]
|
845
|
+
#
|
846
|
+
# @!attribute [rw] next_token
|
847
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
848
|
+
# returns the first page of data.
|
849
|
+
#
|
850
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
851
|
+
# returned more than an hour back, the API will throw
|
852
|
+
# ValidationException.
|
853
|
+
# @return [String]
|
854
|
+
#
|
855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/GetScreenDataRequest AWS API Documentation
|
856
|
+
#
|
857
|
+
class GetScreenDataRequest < Struct.new(
|
858
|
+
:workbook_id,
|
859
|
+
:app_id,
|
860
|
+
:screen_id,
|
861
|
+
:variables,
|
862
|
+
:max_results,
|
863
|
+
:next_token)
|
864
|
+
SENSITIVE = [:variables]
|
865
|
+
include Aws::Structure
|
866
|
+
end
|
867
|
+
|
868
|
+
# @!attribute [rw] results
|
869
|
+
# A map of all the rows on the screen keyed by block name.
|
870
|
+
# @return [Hash<String,Types::ResultSet>]
|
871
|
+
#
|
872
|
+
# @!attribute [rw] workbook_cursor
|
873
|
+
# Indicates the cursor of the workbook at which the data returned by
|
874
|
+
# this workbook is read. Workbook cursor keeps increasing with every
|
875
|
+
# update and the increments are not sequential.
|
876
|
+
# @return [Integer]
|
877
|
+
#
|
878
|
+
# @!attribute [rw] next_token
|
879
|
+
# Provides the pagination token to load the next page if there are
|
880
|
+
# more results matching the request. If a pagination token is not
|
881
|
+
# present in the response, it means that all data matching the query
|
882
|
+
# has been loaded.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/GetScreenDataResult AWS API Documentation
|
886
|
+
#
|
887
|
+
class GetScreenDataResult < Struct.new(
|
888
|
+
:results,
|
889
|
+
:workbook_cursor,
|
890
|
+
:next_token)
|
891
|
+
SENSITIVE = []
|
892
|
+
include Aws::Structure
|
893
|
+
end
|
894
|
+
|
895
|
+
# An object that has details about the source of the data that was
|
896
|
+
# submitted for import.
|
897
|
+
#
|
898
|
+
# @note When making an API call, you may pass ImportDataSource
|
899
|
+
# data as a hash:
|
900
|
+
#
|
901
|
+
# {
|
902
|
+
# data_source_config: { # required
|
903
|
+
# data_source_url: "SecureURL",
|
904
|
+
# },
|
905
|
+
# }
|
906
|
+
#
|
907
|
+
# @!attribute [rw] data_source_config
|
908
|
+
# The configuration parameters for the data source of the import
|
909
|
+
# @return [Types::ImportDataSourceConfig]
|
910
|
+
#
|
911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ImportDataSource AWS API Documentation
|
912
|
+
#
|
913
|
+
class ImportDataSource < Struct.new(
|
914
|
+
:data_source_config)
|
915
|
+
SENSITIVE = []
|
916
|
+
include Aws::Structure
|
917
|
+
end
|
918
|
+
|
919
|
+
# An object that contains the configuration parameters for the data
|
920
|
+
# source of an import request.
|
921
|
+
#
|
922
|
+
# @note When making an API call, you may pass ImportDataSourceConfig
|
923
|
+
# data as a hash:
|
924
|
+
#
|
925
|
+
# {
|
926
|
+
# data_source_url: "SecureURL",
|
927
|
+
# }
|
928
|
+
#
|
929
|
+
# @!attribute [rw] data_source_url
|
930
|
+
# The URL from which source data will be downloaded for the import
|
931
|
+
# request.
|
62
932
|
# @return [String]
|
63
933
|
#
|
64
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ImportDataSourceConfig AWS API Documentation
|
65
935
|
#
|
66
|
-
class
|
67
|
-
:
|
68
|
-
|
69
|
-
SENSITIVE = [:name]
|
936
|
+
class ImportDataSourceConfig < Struct.new(
|
937
|
+
:data_source_url)
|
938
|
+
SENSITIVE = []
|
70
939
|
include Aws::Structure
|
71
940
|
end
|
72
941
|
|
73
|
-
#
|
942
|
+
# An object that contains the attributes of the submitter of the import
|
943
|
+
# job.
|
74
944
|
#
|
75
|
-
# @!attribute [rw]
|
76
|
-
# The
|
77
|
-
# row of data has a different format for the data than the default
|
78
|
-
# format defined on the screen or the table.
|
945
|
+
# @!attribute [rw] email
|
946
|
+
# The email id of the submitter of the import job, if available.
|
79
947
|
# @return [String]
|
80
948
|
#
|
81
|
-
# @!attribute [rw]
|
82
|
-
# The
|
949
|
+
# @!attribute [rw] user_arn
|
950
|
+
# The AWS user ARN of the submitter of the import job, if available.
|
83
951
|
# @return [String]
|
84
952
|
#
|
85
|
-
#
|
86
|
-
#
|
953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ImportJobSubmitter AWS API Documentation
|
954
|
+
#
|
955
|
+
class ImportJobSubmitter < Struct.new(
|
956
|
+
:email,
|
957
|
+
:user_arn)
|
958
|
+
SENSITIVE = [:email]
|
959
|
+
include Aws::Structure
|
960
|
+
end
|
961
|
+
|
962
|
+
# An object that contains the options specified by the sumitter of the
|
963
|
+
# import request.
|
964
|
+
#
|
965
|
+
# @note When making an API call, you may pass ImportOptions
|
966
|
+
# data as a hash:
|
967
|
+
#
|
968
|
+
# {
|
969
|
+
# destination_options: {
|
970
|
+
# column_map: {
|
971
|
+
# "ResourceId" => {
|
972
|
+
# column_index: 1,
|
973
|
+
# },
|
974
|
+
# },
|
975
|
+
# },
|
976
|
+
# delimited_text_options: {
|
977
|
+
# delimiter: "DelimitedTextDelimiter", # required
|
978
|
+
# has_header_row: false,
|
979
|
+
# ignore_empty_rows: false,
|
980
|
+
# data_character_encoding: "UTF-8", # accepts UTF-8, US-ASCII, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16
|
981
|
+
# },
|
982
|
+
# }
|
983
|
+
#
|
984
|
+
# @!attribute [rw] destination_options
|
985
|
+
# Options relating to the destination of the import request.
|
986
|
+
# @return [Types::DestinationOptions]
|
987
|
+
#
|
988
|
+
# @!attribute [rw] delimited_text_options
|
989
|
+
# Options relating to parsing delimited text. Required if dataFormat
|
990
|
+
# is DELIMITED\_TEXT.
|
991
|
+
# @return [Types::DelimitedTextImportOptions]
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ImportOptions AWS API Documentation
|
994
|
+
#
|
995
|
+
class ImportOptions < Struct.new(
|
996
|
+
:destination_options,
|
997
|
+
:delimited_text_options)
|
998
|
+
SENSITIVE = []
|
999
|
+
include Aws::Structure
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
# There were unexpected errors from the server.
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] message
|
87
1005
|
# @return [String]
|
88
1006
|
#
|
89
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/
|
1007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InternalServerException AWS API Documentation
|
90
1008
|
#
|
91
|
-
class
|
92
|
-
:
|
93
|
-
:raw_value,
|
94
|
-
:formatted_value)
|
1009
|
+
class InternalServerException < Struct.new(
|
1010
|
+
:message)
|
95
1011
|
SENSITIVE = []
|
96
1012
|
include Aws::Structure
|
97
1013
|
end
|
98
1014
|
|
99
|
-
# @note When making an API call, you may pass
|
1015
|
+
# @note When making an API call, you may pass InvokeScreenAutomationRequest
|
100
1016
|
# data as a hash:
|
101
1017
|
#
|
102
1018
|
# {
|
103
1019
|
# workbook_id: "ResourceId", # required
|
104
1020
|
# app_id: "ResourceId", # required
|
105
1021
|
# screen_id: "ResourceId", # required
|
1022
|
+
# screen_automation_id: "ResourceId", # required
|
106
1023
|
# variables: {
|
107
1024
|
# "VariableName" => {
|
108
1025
|
# raw_value: "RawValue", # required
|
109
1026
|
# },
|
110
1027
|
# },
|
111
|
-
#
|
112
|
-
#
|
1028
|
+
# row_id: "RowId",
|
1029
|
+
# client_request_token: "ClientRequestToken",
|
113
1030
|
# }
|
114
1031
|
#
|
115
1032
|
# @!attribute [rw] workbook_id
|
116
|
-
# The ID of the workbook that contains the screen.
|
1033
|
+
# The ID of the workbook that contains the screen automation.
|
117
1034
|
# @return [String]
|
118
1035
|
#
|
119
1036
|
# @!attribute [rw] app_id
|
120
|
-
# The ID of the app that contains the
|
1037
|
+
# The ID of the app that contains the screen automation.
|
121
1038
|
# @return [String]
|
122
1039
|
#
|
123
1040
|
# @!attribute [rw] screen_id
|
124
|
-
# The ID of the screen.
|
1041
|
+
# The ID of the screen that contains the screen automation.
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] screen_automation_id
|
1045
|
+
# The ID of the automation action to be performed.
|
125
1046
|
# @return [String]
|
126
1047
|
#
|
127
1048
|
# @!attribute [rw] variables
|
128
|
-
# Variables are
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
1049
|
+
# Variables are specified as a map where the key is the name of the
|
1050
|
+
# variable as defined on the screen. The value is an object which
|
1051
|
+
# currently has only one property, rawValue, which holds the value of
|
1052
|
+
# the variable to be passed to the screen. Any variables defined in a
|
1053
|
+
# screen are required to be passed in the call.
|
133
1054
|
# @return [Hash<String,Types::VariableValue>]
|
134
1055
|
#
|
135
|
-
# @!attribute [rw]
|
136
|
-
# The
|
137
|
-
#
|
1056
|
+
# @!attribute [rw] row_id
|
1057
|
+
# The row ID for the automation if the automation is defined inside a
|
1058
|
+
# block with source or list.
|
1059
|
+
# @return [String]
|
138
1060
|
#
|
139
|
-
#
|
140
|
-
#
|
1061
|
+
# @!attribute [rw] client_request_token
|
1062
|
+
# The request token for performing the automation action. Request
|
1063
|
+
# tokens help to identify duplicate requests. If a call times out or
|
1064
|
+
# fails due to a transient error like a failed network connection, you
|
1065
|
+
# can retry the call with the same request token. The service ensures
|
1066
|
+
# that if the first call using that request token is successfully
|
1067
|
+
# performed, the second call will return the response of the previous
|
1068
|
+
# call rather than performing the action again.
|
1069
|
+
#
|
1070
|
+
# Note that request tokens are valid only for a few minutes. You
|
1071
|
+
# cannot use request tokens to dedupe requests spanning hours or days.
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InvokeScreenAutomationRequest AWS API Documentation
|
1075
|
+
#
|
1076
|
+
class InvokeScreenAutomationRequest < Struct.new(
|
1077
|
+
:workbook_id,
|
1078
|
+
:app_id,
|
1079
|
+
:screen_id,
|
1080
|
+
:screen_automation_id,
|
1081
|
+
:variables,
|
1082
|
+
:row_id,
|
1083
|
+
:client_request_token)
|
1084
|
+
SENSITIVE = [:variables]
|
1085
|
+
include Aws::Structure
|
1086
|
+
end
|
1087
|
+
|
1088
|
+
# @!attribute [rw] workbook_cursor
|
1089
|
+
# The updated workbook cursor after performing the automation action.
|
141
1090
|
# @return [Integer]
|
142
1091
|
#
|
1092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InvokeScreenAutomationResult AWS API Documentation
|
1093
|
+
#
|
1094
|
+
class InvokeScreenAutomationResult < Struct.new(
|
1095
|
+
:workbook_cursor)
|
1096
|
+
SENSITIVE = []
|
1097
|
+
include Aws::Structure
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# @note When making an API call, you may pass ListTableColumnsRequest
|
1101
|
+
# data as a hash:
|
1102
|
+
#
|
1103
|
+
# {
|
1104
|
+
# workbook_id: "ResourceId", # required
|
1105
|
+
# table_id: "ResourceId", # required
|
1106
|
+
# next_token: "PaginationToken",
|
1107
|
+
# }
|
1108
|
+
#
|
1109
|
+
# @!attribute [rw] workbook_id
|
1110
|
+
# The ID of the workbook that contains the table whose columns are
|
1111
|
+
# being retrieved.
|
1112
|
+
#
|
1113
|
+
# If a workbook with the specified id could not be found, this API
|
1114
|
+
# throws ResourceNotFoundException.
|
1115
|
+
# @return [String]
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] table_id
|
1118
|
+
# The ID of the table whose columns are being retrieved.
|
1119
|
+
#
|
1120
|
+
# If a table with the specified id could not be found, this API throws
|
1121
|
+
# ResourceNotFoundException.
|
1122
|
+
# @return [String]
|
1123
|
+
#
|
143
1124
|
# @!attribute [rw] next_token
|
144
1125
|
# This parameter is optional. If a nextToken is not specified, the API
|
145
1126
|
# returns the first page of data.
|
@@ -149,139 +1130,293 @@ module Aws::Honeycode
|
|
149
1130
|
# ValidationException.
|
150
1131
|
# @return [String]
|
151
1132
|
#
|
152
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/
|
1133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTableColumnsRequest AWS API Documentation
|
153
1134
|
#
|
154
|
-
class
|
1135
|
+
class ListTableColumnsRequest < Struct.new(
|
155
1136
|
:workbook_id,
|
156
|
-
:
|
157
|
-
:screen_id,
|
158
|
-
:variables,
|
159
|
-
:max_results,
|
1137
|
+
:table_id,
|
160
1138
|
:next_token)
|
161
|
-
SENSITIVE = [
|
1139
|
+
SENSITIVE = []
|
162
1140
|
include Aws::Structure
|
163
1141
|
end
|
164
1142
|
|
165
|
-
# @!attribute [rw]
|
166
|
-
#
|
167
|
-
# @return [
|
1143
|
+
# @!attribute [rw] table_columns
|
1144
|
+
# The list of columns in the table.
|
1145
|
+
# @return [Array<Types::TableColumn>]
|
1146
|
+
#
|
1147
|
+
# @!attribute [rw] next_token
|
1148
|
+
# Provides the pagination token to load the next page if there are
|
1149
|
+
# more results matching the request. If a pagination token is not
|
1150
|
+
# present in the response, it means that all data matching the request
|
1151
|
+
# has been loaded.
|
1152
|
+
# @return [String]
|
168
1153
|
#
|
169
1154
|
# @!attribute [rw] workbook_cursor
|
170
1155
|
# Indicates the cursor of the workbook at which the data returned by
|
171
|
-
# this
|
1156
|
+
# this request is read. Workbook cursor keeps increasing with every
|
172
1157
|
# update and the increments are not sequential.
|
173
1158
|
# @return [Integer]
|
174
1159
|
#
|
1160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTableColumnsResult AWS API Documentation
|
1161
|
+
#
|
1162
|
+
class ListTableColumnsResult < Struct.new(
|
1163
|
+
:table_columns,
|
1164
|
+
:next_token,
|
1165
|
+
:workbook_cursor)
|
1166
|
+
SENSITIVE = []
|
1167
|
+
include Aws::Structure
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
# @note When making an API call, you may pass ListTableRowsRequest
|
1171
|
+
# data as a hash:
|
1172
|
+
#
|
1173
|
+
# {
|
1174
|
+
# workbook_id: "ResourceId", # required
|
1175
|
+
# table_id: "ResourceId", # required
|
1176
|
+
# row_ids: ["RowId"],
|
1177
|
+
# max_results: 1,
|
1178
|
+
# next_token: "PaginationToken",
|
1179
|
+
# }
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] workbook_id
|
1182
|
+
# The ID of the workbook that contains the table whose rows are being
|
1183
|
+
# retrieved.
|
1184
|
+
#
|
1185
|
+
# If a workbook with the specified id could not be found, this API
|
1186
|
+
# throws ResourceNotFoundException.
|
1187
|
+
# @return [String]
|
1188
|
+
#
|
1189
|
+
# @!attribute [rw] table_id
|
1190
|
+
# The ID of the table whose rows are being retrieved.
|
1191
|
+
#
|
1192
|
+
# If a table with the specified id could not be found, this API throws
|
1193
|
+
# ResourceNotFoundException.
|
1194
|
+
# @return [String]
|
1195
|
+
#
|
1196
|
+
# @!attribute [rw] row_ids
|
1197
|
+
# This parameter is optional. If one or more row ids are specified in
|
1198
|
+
# this list, then only the specified row ids are returned in the
|
1199
|
+
# result. If no row ids are specified here, then all the rows in the
|
1200
|
+
# table are returned.
|
1201
|
+
# @return [Array<String>]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] max_results
|
1204
|
+
# The maximum number of rows to return in each page of the results.
|
1205
|
+
# @return [Integer]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] next_token
|
1208
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
1209
|
+
# returns the first page of data.
|
1210
|
+
#
|
1211
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
1212
|
+
# returned more than an hour back, the API will throw
|
1213
|
+
# ValidationException.
|
1214
|
+
# @return [String]
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTableRowsRequest AWS API Documentation
|
1217
|
+
#
|
1218
|
+
class ListTableRowsRequest < Struct.new(
|
1219
|
+
:workbook_id,
|
1220
|
+
:table_id,
|
1221
|
+
:row_ids,
|
1222
|
+
:max_results,
|
1223
|
+
:next_token)
|
1224
|
+
SENSITIVE = []
|
1225
|
+
include Aws::Structure
|
1226
|
+
end
|
1227
|
+
|
1228
|
+
# @!attribute [rw] column_ids
|
1229
|
+
# The list of columns in the table whose row data is returned in the
|
1230
|
+
# result.
|
1231
|
+
# @return [Array<String>]
|
1232
|
+
#
|
1233
|
+
# @!attribute [rw] rows
|
1234
|
+
# The list of rows in the table. Note that this result is paginated,
|
1235
|
+
# so this list contains a maximum of 100 rows.
|
1236
|
+
# @return [Array<Types::TableRow>]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] row_ids_not_found
|
1239
|
+
# The list of row ids included in the request that were not found in
|
1240
|
+
# the table.
|
1241
|
+
# @return [Array<String>]
|
1242
|
+
#
|
175
1243
|
# @!attribute [rw] next_token
|
176
1244
|
# Provides the pagination token to load the next page if there are
|
177
1245
|
# more results matching the request. If a pagination token is not
|
178
|
-
# present in the response, it means that all data matching the
|
1246
|
+
# present in the response, it means that all data matching the request
|
179
1247
|
# has been loaded.
|
180
1248
|
# @return [String]
|
181
1249
|
#
|
182
|
-
#
|
1250
|
+
# @!attribute [rw] workbook_cursor
|
1251
|
+
# Indicates the cursor of the workbook at which the data returned by
|
1252
|
+
# this request is read. Workbook cursor keeps increasing with every
|
1253
|
+
# update and the increments are not sequential.
|
1254
|
+
# @return [Integer]
|
1255
|
+
#
|
1256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTableRowsResult AWS API Documentation
|
1257
|
+
#
|
1258
|
+
class ListTableRowsResult < Struct.new(
|
1259
|
+
:column_ids,
|
1260
|
+
:rows,
|
1261
|
+
:row_ids_not_found,
|
1262
|
+
:next_token,
|
1263
|
+
:workbook_cursor)
|
1264
|
+
SENSITIVE = []
|
1265
|
+
include Aws::Structure
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# @note When making an API call, you may pass ListTablesRequest
|
1269
|
+
# data as a hash:
|
1270
|
+
#
|
1271
|
+
# {
|
1272
|
+
# workbook_id: "ResourceId", # required
|
1273
|
+
# max_results: 1,
|
1274
|
+
# next_token: "PaginationToken",
|
1275
|
+
# }
|
1276
|
+
#
|
1277
|
+
# @!attribute [rw] workbook_id
|
1278
|
+
# The ID of the workbook whose tables are being retrieved.
|
1279
|
+
#
|
1280
|
+
# If a workbook with the specified id could not be found, this API
|
1281
|
+
# throws ResourceNotFoundException.
|
1282
|
+
# @return [String]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] max_results
|
1285
|
+
# The maximum number of tables to return in each page of the results.
|
1286
|
+
# @return [Integer]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] next_token
|
1289
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
1290
|
+
# returns the first page of data.
|
1291
|
+
#
|
1292
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
1293
|
+
# returned more than an hour back, the API will throw
|
1294
|
+
# ValidationException.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTablesRequest AWS API Documentation
|
183
1298
|
#
|
184
|
-
class
|
185
|
-
:
|
186
|
-
:
|
1299
|
+
class ListTablesRequest < Struct.new(
|
1300
|
+
:workbook_id,
|
1301
|
+
:max_results,
|
187
1302
|
:next_token)
|
188
1303
|
SENSITIVE = []
|
189
1304
|
include Aws::Structure
|
190
1305
|
end
|
191
1306
|
|
192
|
-
#
|
1307
|
+
# @!attribute [rw] tables
|
1308
|
+
# The list of tables in the workbook.
|
1309
|
+
# @return [Array<Types::Table>]
|
193
1310
|
#
|
194
|
-
# @!attribute [rw]
|
1311
|
+
# @!attribute [rw] next_token
|
1312
|
+
# Provides the pagination token to load the next page if there are
|
1313
|
+
# more results matching the request. If a pagination token is not
|
1314
|
+
# present in the response, it means that all data matching the request
|
1315
|
+
# has been loaded.
|
195
1316
|
# @return [String]
|
196
1317
|
#
|
197
|
-
#
|
1318
|
+
# @!attribute [rw] workbook_cursor
|
1319
|
+
# Indicates the cursor of the workbook at which the data returned by
|
1320
|
+
# this request is read. Workbook cursor keeps increasing with every
|
1321
|
+
# update and the increments are not sequential.
|
1322
|
+
# @return [Integer]
|
198
1323
|
#
|
199
|
-
|
200
|
-
|
1324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ListTablesResult AWS API Documentation
|
1325
|
+
#
|
1326
|
+
class ListTablesResult < Struct.new(
|
1327
|
+
:tables,
|
1328
|
+
:next_token,
|
1329
|
+
:workbook_cursor)
|
201
1330
|
SENSITIVE = []
|
202
1331
|
include Aws::Structure
|
203
1332
|
end
|
204
1333
|
|
205
|
-
# @note When making an API call, you may pass
|
1334
|
+
# @note When making an API call, you may pass QueryTableRowsRequest
|
206
1335
|
# data as a hash:
|
207
1336
|
#
|
208
1337
|
# {
|
209
1338
|
# workbook_id: "ResourceId", # required
|
210
|
-
#
|
211
|
-
#
|
212
|
-
#
|
213
|
-
#
|
214
|
-
# "VariableName" => {
|
215
|
-
# raw_value: "RawValue", # required
|
216
|
-
# },
|
1339
|
+
# table_id: "ResourceId", # required
|
1340
|
+
# filter_formula: { # required
|
1341
|
+
# formula: "Formula", # required
|
1342
|
+
# context_row_id: "RowId",
|
217
1343
|
# },
|
218
|
-
#
|
219
|
-
#
|
1344
|
+
# max_results: 1,
|
1345
|
+
# next_token: "PaginationToken",
|
220
1346
|
# }
|
221
1347
|
#
|
222
1348
|
# @!attribute [rw] workbook_id
|
223
|
-
# The ID of the workbook
|
224
|
-
# @return [String]
|
1349
|
+
# The ID of the workbook whose table rows are being queried.
|
225
1350
|
#
|
226
|
-
#
|
227
|
-
#
|
1351
|
+
# If a workbook with the specified id could not be found, this API
|
1352
|
+
# throws ResourceNotFoundException.
|
228
1353
|
# @return [String]
|
229
1354
|
#
|
230
|
-
# @!attribute [rw]
|
231
|
-
# The ID of the
|
232
|
-
# @return [String]
|
1355
|
+
# @!attribute [rw] table_id
|
1356
|
+
# The ID of the table whose rows are being queried.
|
233
1357
|
#
|
234
|
-
#
|
235
|
-
#
|
1358
|
+
# If a table with the specified id could not be found, this API throws
|
1359
|
+
# ResourceNotFoundException.
|
236
1360
|
# @return [String]
|
237
1361
|
#
|
238
|
-
# @!attribute [rw]
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
# is an object which currently has only one property, rawValue, which
|
243
|
-
# holds the value of the variable to be passed to the screen.
|
244
|
-
# @return [Hash<String,Types::VariableValue>]
|
1362
|
+
# @!attribute [rw] filter_formula
|
1363
|
+
# An object that represents a filter formula along with the id of the
|
1364
|
+
# context row under which the filter function needs to evaluate.
|
1365
|
+
# @return [Types::Filter]
|
245
1366
|
#
|
246
|
-
# @!attribute [rw]
|
247
|
-
# The
|
248
|
-
#
|
249
|
-
# @return [String]
|
1367
|
+
# @!attribute [rw] max_results
|
1368
|
+
# The maximum number of rows to return in each page of the results.
|
1369
|
+
# @return [Integer]
|
250
1370
|
#
|
251
|
-
# @!attribute [rw]
|
252
|
-
#
|
253
|
-
#
|
254
|
-
# fails due to a transient error like a failed network connection, you
|
255
|
-
# can retry the call with the same request token. The service ensures
|
256
|
-
# that if the first call using that request token is successfully
|
257
|
-
# performed, the second call will return the response of the previous
|
258
|
-
# call rather than performing the action again.
|
1371
|
+
# @!attribute [rw] next_token
|
1372
|
+
# This parameter is optional. If a nextToken is not specified, the API
|
1373
|
+
# returns the first page of data.
|
259
1374
|
#
|
260
|
-
#
|
261
|
-
#
|
1375
|
+
# Pagination tokens expire after 1 hour. If you use a token that was
|
1376
|
+
# returned more than an hour back, the API will throw
|
1377
|
+
# ValidationException.
|
262
1378
|
# @return [String]
|
263
1379
|
#
|
264
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/
|
1380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/QueryTableRowsRequest AWS API Documentation
|
265
1381
|
#
|
266
|
-
class
|
1382
|
+
class QueryTableRowsRequest < Struct.new(
|
267
1383
|
:workbook_id,
|
268
|
-
:
|
269
|
-
:
|
270
|
-
:
|
271
|
-
:
|
272
|
-
|
273
|
-
:client_request_token)
|
274
|
-
SENSITIVE = [:variables]
|
1384
|
+
:table_id,
|
1385
|
+
:filter_formula,
|
1386
|
+
:max_results,
|
1387
|
+
:next_token)
|
1388
|
+
SENSITIVE = []
|
275
1389
|
include Aws::Structure
|
276
1390
|
end
|
277
1391
|
|
1392
|
+
# @!attribute [rw] column_ids
|
1393
|
+
# The list of columns in the table whose row data is returned in the
|
1394
|
+
# result.
|
1395
|
+
# @return [Array<String>]
|
1396
|
+
#
|
1397
|
+
# @!attribute [rw] rows
|
1398
|
+
# The list of rows in the table that match the query filter.
|
1399
|
+
# @return [Array<Types::TableRow>]
|
1400
|
+
#
|
1401
|
+
# @!attribute [rw] next_token
|
1402
|
+
# Provides the pagination token to load the next page if there are
|
1403
|
+
# more results matching the request. If a pagination token is not
|
1404
|
+
# present in the response, it means that all data matching the request
|
1405
|
+
# has been loaded.
|
1406
|
+
# @return [String]
|
1407
|
+
#
|
278
1408
|
# @!attribute [rw] workbook_cursor
|
279
|
-
#
|
1409
|
+
# Indicates the cursor of the workbook at which the data returned by
|
1410
|
+
# this request is read. Workbook cursor keeps increasing with every
|
1411
|
+
# update and the increments are not sequential.
|
280
1412
|
# @return [Integer]
|
281
1413
|
#
|
282
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/
|
1414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/QueryTableRowsResult AWS API Documentation
|
283
1415
|
#
|
284
|
-
class
|
1416
|
+
class QueryTableRowsResult < Struct.new(
|
1417
|
+
:column_ids,
|
1418
|
+
:rows,
|
1419
|
+
:next_token,
|
285
1420
|
:workbook_cursor)
|
286
1421
|
SENSITIVE = []
|
287
1422
|
include Aws::Structure
|
@@ -300,8 +1435,8 @@ module Aws::Honeycode
|
|
300
1435
|
include Aws::Structure
|
301
1436
|
end
|
302
1437
|
|
303
|
-
# A Workbook, App, Screen or Screen Automation was not found with
|
304
|
-
# given ID.
|
1438
|
+
# A Workbook, Table, App, Screen or Screen Automation was not found with
|
1439
|
+
# the given ID.
|
305
1440
|
#
|
306
1441
|
# @!attribute [rw] message
|
307
1442
|
# @return [String]
|
@@ -369,6 +1504,19 @@ module Aws::Honeycode
|
|
369
1504
|
include Aws::Structure
|
370
1505
|
end
|
371
1506
|
|
1507
|
+
# The request caused service quota to be breached.
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] message
|
1510
|
+
# @return [String]
|
1511
|
+
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ServiceQuotaExceededException AWS API Documentation
|
1513
|
+
#
|
1514
|
+
class ServiceQuotaExceededException < Struct.new(
|
1515
|
+
:message)
|
1516
|
+
SENSITIVE = []
|
1517
|
+
include Aws::Structure
|
1518
|
+
end
|
1519
|
+
|
372
1520
|
# Remote service is unreachable.
|
373
1521
|
#
|
374
1522
|
# @!attribute [rw] message
|
@@ -382,6 +1530,228 @@ module Aws::Honeycode
|
|
382
1530
|
include Aws::Structure
|
383
1531
|
end
|
384
1532
|
|
1533
|
+
# An object that contains the properties for importing data to a
|
1534
|
+
# specific column in a table.
|
1535
|
+
#
|
1536
|
+
# @note When making an API call, you may pass SourceDataColumnProperties
|
1537
|
+
# data as a hash:
|
1538
|
+
#
|
1539
|
+
# {
|
1540
|
+
# column_index: 1,
|
1541
|
+
# }
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] column_index
|
1544
|
+
# The index of the column in the input file.
|
1545
|
+
# @return [Integer]
|
1546
|
+
#
|
1547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/SourceDataColumnProperties AWS API Documentation
|
1548
|
+
#
|
1549
|
+
class SourceDataColumnProperties < Struct.new(
|
1550
|
+
:column_index)
|
1551
|
+
SENSITIVE = []
|
1552
|
+
include Aws::Structure
|
1553
|
+
end
|
1554
|
+
|
1555
|
+
# @note When making an API call, you may pass StartTableDataImportJobRequest
|
1556
|
+
# data as a hash:
|
1557
|
+
#
|
1558
|
+
# {
|
1559
|
+
# workbook_id: "ResourceId", # required
|
1560
|
+
# data_source: { # required
|
1561
|
+
# data_source_config: { # required
|
1562
|
+
# data_source_url: "SecureURL",
|
1563
|
+
# },
|
1564
|
+
# },
|
1565
|
+
# data_format: "DELIMITED_TEXT", # required, accepts DELIMITED_TEXT
|
1566
|
+
# destination_table_id: "ResourceId", # required
|
1567
|
+
# import_options: { # required
|
1568
|
+
# destination_options: {
|
1569
|
+
# column_map: {
|
1570
|
+
# "ResourceId" => {
|
1571
|
+
# column_index: 1,
|
1572
|
+
# },
|
1573
|
+
# },
|
1574
|
+
# },
|
1575
|
+
# delimited_text_options: {
|
1576
|
+
# delimiter: "DelimitedTextDelimiter", # required
|
1577
|
+
# has_header_row: false,
|
1578
|
+
# ignore_empty_rows: false,
|
1579
|
+
# data_character_encoding: "UTF-8", # accepts UTF-8, US-ASCII, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16
|
1580
|
+
# },
|
1581
|
+
# },
|
1582
|
+
# client_request_token: "ClientRequestToken", # required
|
1583
|
+
# }
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] workbook_id
|
1586
|
+
# The ID of the workbook where the rows are being imported.
|
1587
|
+
#
|
1588
|
+
# If a workbook with the specified id could not be found, this API
|
1589
|
+
# throws ResourceNotFoundException.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] data_source
|
1593
|
+
# The source of the data that is being imported. The size of source
|
1594
|
+
# must be no larger than 100 MB. Source must have no more than 100,000
|
1595
|
+
# cells and no more than 1,000 rows.
|
1596
|
+
# @return [Types::ImportDataSource]
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] data_format
|
1599
|
+
# The format of the data that is being imported. Currently the only
|
1600
|
+
# option supported is "DELIMITED\_TEXT".
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] destination_table_id
|
1604
|
+
# The ID of the table where the rows are being imported.
|
1605
|
+
#
|
1606
|
+
# If a table with the specified id could not be found, this API throws
|
1607
|
+
# ResourceNotFoundException.
|
1608
|
+
# @return [String]
|
1609
|
+
#
|
1610
|
+
# @!attribute [rw] import_options
|
1611
|
+
# The options for customizing this import request.
|
1612
|
+
# @return [Types::ImportOptions]
|
1613
|
+
#
|
1614
|
+
# @!attribute [rw] client_request_token
|
1615
|
+
# The request token for performing the update action. Request tokens
|
1616
|
+
# help to identify duplicate requests. If a call times out or fails
|
1617
|
+
# due to a transient error like a failed network connection, you can
|
1618
|
+
# retry the call with the same request token. The service ensures that
|
1619
|
+
# if the first call using that request token is successfully
|
1620
|
+
# performed, the second call will not perform the action again.
|
1621
|
+
#
|
1622
|
+
# Note that request tokens are valid only for a few minutes. You
|
1623
|
+
# cannot use request tokens to dedupe requests spanning hours or days.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/StartTableDataImportJobRequest AWS API Documentation
|
1627
|
+
#
|
1628
|
+
class StartTableDataImportJobRequest < Struct.new(
|
1629
|
+
:workbook_id,
|
1630
|
+
:data_source,
|
1631
|
+
:data_format,
|
1632
|
+
:destination_table_id,
|
1633
|
+
:import_options,
|
1634
|
+
:client_request_token)
|
1635
|
+
SENSITIVE = []
|
1636
|
+
include Aws::Structure
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# @!attribute [rw] job_id
|
1640
|
+
# The id that is assigned to this import job. Future requests to find
|
1641
|
+
# out the status of this import job need to send this id in the
|
1642
|
+
# appropriate parameter in the request.
|
1643
|
+
# @return [String]
|
1644
|
+
#
|
1645
|
+
# @!attribute [rw] job_status
|
1646
|
+
# The status of the import job immediately after submitting the
|
1647
|
+
# request.
|
1648
|
+
# @return [String]
|
1649
|
+
#
|
1650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/StartTableDataImportJobResult AWS API Documentation
|
1651
|
+
#
|
1652
|
+
class StartTableDataImportJobResult < Struct.new(
|
1653
|
+
:job_id,
|
1654
|
+
:job_status)
|
1655
|
+
SENSITIVE = []
|
1656
|
+
include Aws::Structure
|
1657
|
+
end
|
1658
|
+
|
1659
|
+
# An object representing the properties of a table in a workbook.
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] table_id
|
1662
|
+
# The id of the table.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] table_name
|
1666
|
+
# The name of the table.
|
1667
|
+
# @return [String]
|
1668
|
+
#
|
1669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/Table AWS API Documentation
|
1670
|
+
#
|
1671
|
+
class Table < Struct.new(
|
1672
|
+
:table_id,
|
1673
|
+
:table_name)
|
1674
|
+
SENSITIVE = []
|
1675
|
+
include Aws::Structure
|
1676
|
+
end
|
1677
|
+
|
1678
|
+
# An object that contains attributes about a single column in a table
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] table_column_id
|
1681
|
+
# The id of the column in the table.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] table_column_name
|
1685
|
+
# The name of the column in the table.
|
1686
|
+
# @return [String]
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] format
|
1689
|
+
# The column level format that is applied in the table. An empty value
|
1690
|
+
# in this field means that the column format is the default value
|
1691
|
+
# 'AUTO'.
|
1692
|
+
# @return [String]
|
1693
|
+
#
|
1694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/TableColumn AWS API Documentation
|
1695
|
+
#
|
1696
|
+
class TableColumn < Struct.new(
|
1697
|
+
:table_column_id,
|
1698
|
+
:table_column_name,
|
1699
|
+
:format)
|
1700
|
+
SENSITIVE = []
|
1701
|
+
include Aws::Structure
|
1702
|
+
end
|
1703
|
+
|
1704
|
+
# The metadata associated with the table data import job that was
|
1705
|
+
# submitted.
|
1706
|
+
#
|
1707
|
+
# @!attribute [rw] submitter
|
1708
|
+
# Details about the submitter of the import request.
|
1709
|
+
# @return [Types::ImportJobSubmitter]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] submit_time
|
1712
|
+
# The timestamp when the job was submitted for import.
|
1713
|
+
# @return [Time]
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] import_options
|
1716
|
+
# The options that was specified at the time of submitting the import
|
1717
|
+
# request.
|
1718
|
+
# @return [Types::ImportOptions]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] data_source
|
1721
|
+
# The source of the data that was submitted for import.
|
1722
|
+
# @return [Types::ImportDataSource]
|
1723
|
+
#
|
1724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/TableDataImportJobMetadata AWS API Documentation
|
1725
|
+
#
|
1726
|
+
class TableDataImportJobMetadata < Struct.new(
|
1727
|
+
:submitter,
|
1728
|
+
:submit_time,
|
1729
|
+
:import_options,
|
1730
|
+
:data_source)
|
1731
|
+
SENSITIVE = []
|
1732
|
+
include Aws::Structure
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# An object that contains attributes about a single row in a table
|
1736
|
+
#
|
1737
|
+
# @!attribute [rw] row_id
|
1738
|
+
# The id of the row in the table.
|
1739
|
+
# @return [String]
|
1740
|
+
#
|
1741
|
+
# @!attribute [rw] cells
|
1742
|
+
# A list of cells in the table row. The cells appear in the same order
|
1743
|
+
# as the columns of the table.
|
1744
|
+
# @return [Array<Types::Cell>]
|
1745
|
+
#
|
1746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/TableRow AWS API Documentation
|
1747
|
+
#
|
1748
|
+
class TableRow < Struct.new(
|
1749
|
+
:row_id,
|
1750
|
+
:cells)
|
1751
|
+
SENSITIVE = []
|
1752
|
+
include Aws::Structure
|
1753
|
+
end
|
1754
|
+
|
385
1755
|
# Tps(transactions per second) rate reached.
|
386
1756
|
#
|
387
1757
|
# @!attribute [rw] message
|
@@ -395,6 +1765,122 @@ module Aws::Honeycode
|
|
395
1765
|
include Aws::Structure
|
396
1766
|
end
|
397
1767
|
|
1768
|
+
# Data needed to create a single row in a table as part of the
|
1769
|
+
# BatchCreateTableRows request.
|
1770
|
+
#
|
1771
|
+
# @note When making an API call, you may pass UpdateRowData
|
1772
|
+
# data as a hash:
|
1773
|
+
#
|
1774
|
+
# {
|
1775
|
+
# row_id: "RowId", # required
|
1776
|
+
# cells_to_update: { # required
|
1777
|
+
# "ResourceId" => {
|
1778
|
+
# fact: "Fact",
|
1779
|
+
# },
|
1780
|
+
# },
|
1781
|
+
# }
|
1782
|
+
#
|
1783
|
+
# @!attribute [rw] row_id
|
1784
|
+
# The id of the row that needs to be updated.
|
1785
|
+
# @return [String]
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] cells_to_update
|
1788
|
+
# A map representing the cells to update in the given row. The key is
|
1789
|
+
# the column id of the cell and the value is the CellInput object that
|
1790
|
+
# represents the data to set in that cell.
|
1791
|
+
# @return [Hash<String,Types::CellInput>]
|
1792
|
+
#
|
1793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/UpdateRowData AWS API Documentation
|
1794
|
+
#
|
1795
|
+
class UpdateRowData < Struct.new(
|
1796
|
+
:row_id,
|
1797
|
+
:cells_to_update)
|
1798
|
+
SENSITIVE = []
|
1799
|
+
include Aws::Structure
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# Data needed to upsert rows in a table as part of a single item in the
|
1803
|
+
# BatchUpsertTableRows request.
|
1804
|
+
#
|
1805
|
+
# @note When making an API call, you may pass UpsertRowData
|
1806
|
+
# data as a hash:
|
1807
|
+
#
|
1808
|
+
# {
|
1809
|
+
# batch_item_id: "BatchItemId", # required
|
1810
|
+
# filter: { # required
|
1811
|
+
# formula: "Formula", # required
|
1812
|
+
# context_row_id: "RowId",
|
1813
|
+
# },
|
1814
|
+
# cells_to_update: { # required
|
1815
|
+
# "ResourceId" => {
|
1816
|
+
# fact: "Fact",
|
1817
|
+
# },
|
1818
|
+
# },
|
1819
|
+
# }
|
1820
|
+
#
|
1821
|
+
# @!attribute [rw] batch_item_id
|
1822
|
+
# An external identifier that represents a single item in the request
|
1823
|
+
# that is being upserted as part of the BatchUpsertTableRows request.
|
1824
|
+
# This can be any string that you can use to identify the item in the
|
1825
|
+
# request. The BatchUpsertTableRows API puts the batch item id in the
|
1826
|
+
# results to allow you to link data in the request to data in the
|
1827
|
+
# results.
|
1828
|
+
# @return [String]
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] filter
|
1831
|
+
# The filter formula to use to find existing matching rows to update.
|
1832
|
+
# The formula needs to return zero or more rows. If the formula
|
1833
|
+
# returns 0 rows, then a new row will be appended in the target table.
|
1834
|
+
# If the formula returns one or more rows, then the returned rows will
|
1835
|
+
# be updated.
|
1836
|
+
#
|
1837
|
+
# Note that the filter formula needs to return rows from the target
|
1838
|
+
# table for the upsert operation to succeed. If the filter formula has
|
1839
|
+
# a syntax error or it doesn't evaluate to zero or more rows in the
|
1840
|
+
# target table for any one item in the input list, then the entire
|
1841
|
+
# BatchUpsertTableRows request fails and no updates are made to the
|
1842
|
+
# table.
|
1843
|
+
# @return [Types::Filter]
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] cells_to_update
|
1846
|
+
# A map representing the cells to update for the matching rows or an
|
1847
|
+
# appended row. The key is the column id of the cell and the value is
|
1848
|
+
# the CellInput object that represents the data to set in that cell.
|
1849
|
+
# @return [Hash<String,Types::CellInput>]
|
1850
|
+
#
|
1851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/UpsertRowData AWS API Documentation
|
1852
|
+
#
|
1853
|
+
class UpsertRowData < Struct.new(
|
1854
|
+
:batch_item_id,
|
1855
|
+
:filter,
|
1856
|
+
:cells_to_update)
|
1857
|
+
SENSITIVE = []
|
1858
|
+
include Aws::Structure
|
1859
|
+
end
|
1860
|
+
|
1861
|
+
# An object that represents the result of a single upsert row request.
|
1862
|
+
#
|
1863
|
+
# @!attribute [rw] row_ids
|
1864
|
+
# The list of row ids that were changed as part of an upsert row
|
1865
|
+
# operation. If the upsert resulted in an update, this list could
|
1866
|
+
# potentially contain multiple rows that matched the filter and hence
|
1867
|
+
# got updated. If the upsert resulted in an append, this list would
|
1868
|
+
# only have the single row that was appended.
|
1869
|
+
# @return [Array<String>]
|
1870
|
+
#
|
1871
|
+
# @!attribute [rw] upsert_action
|
1872
|
+
# The result of the upsert action.
|
1873
|
+
# @return [String]
|
1874
|
+
#
|
1875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/UpsertRowsResult AWS API Documentation
|
1876
|
+
#
|
1877
|
+
class UpsertRowsResult < Struct.new(
|
1878
|
+
:row_ids,
|
1879
|
+
:upsert_action)
|
1880
|
+
SENSITIVE = []
|
1881
|
+
include Aws::Structure
|
1882
|
+
end
|
1883
|
+
|
398
1884
|
# Request is invalid. The message in the response contains details on
|
399
1885
|
# why the request is invalid.
|
400
1886
|
#
|