Class: Aws::Honeycode::Types::BatchUpsertTableRowsRequest

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 BatchUpsertTableRowsRequest data as a hash:

{
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  rows_to_upsert: [ # required
    {
      batch_item_id: "BatchItemId", # required
      filter: { # required
        formula: "Formula", # required
        context_row_id: "RowId",
      },
      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)


377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 377

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

#rows_to_upsertArray<Types::UpsertRowData>

The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.

Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.

Returns:



377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 377

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

#table_idString

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

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

Returns:

  • (String)


377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 377

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

#workbook_idString

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

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

Returns:

  • (String)


377
378
379
380
381
382
383
384
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 377

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