Class: Aws::Honeycode::Types::BatchUpdateTableRowsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb

Overview

Note:

When making an API call, you may pass BatchUpdateTableRowsRequest data as a hash:

{
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  rows_to_update: [ # required
    {
      row_id: "RowId", # required
      cells_to_update: { # required
        "ResourceId" => {
          fact: "Fact",
        },
      },
    },
  ],
  client_request_token: "ClientRequestToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Returns:

  • (String)


283
284
285
286
287
288
289
290
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 283

class BatchUpdateTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :rows_to_update,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#rows_to_updateArray<Types::UpdateRowData>

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

Returns:



283
284
285
286
287
288
289
290
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 283

class BatchUpdateTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :rows_to_update,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#table_idString

The ID of the table where the rows are being updated.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Returns:

  • (String)


283
284
285
286
287
288
289
290
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 283

class BatchUpdateTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :rows_to_update,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#workbook_idString

The ID of the workbook where the rows are being updated.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Returns:

  • (String)


283
284
285
286
287
288
289
290
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 283

class BatchUpdateTableRowsRequest < Struct.new(
  :workbook_id,
  :table_id,
  :rows_to_update,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end