Method: Aws::Honeycode::Client#batch_delete_table_rows

Defined in:

lib/aws-sdk-honeycode/client.rb

#batch_delete_table_rows(params = {}) ⇒ Types::BatchDeleteTableRowsResult

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.

Examples:

Request syntax with placeholder values

resp = client.batch_delete_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  row_ids: ["RowId"], # required
  client_request_token: "ClientRequestToken",
})

Response structure

resp.workbook_cursor #=> Integer
resp.failed_batch_items #=> Array
resp.failed_batch_items[0].id #=> String
resp.failed_batch_items[0].error_message #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :workbook_id (required, String) —

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

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

• :table_id (required, String) —

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

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

• :row_ids (required, Array<String>) —

  The list of row ids to delete from the table. You need to specify at least one row id in this list.

  Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.

• :client_request_token (String) —

  The request token for performing the delete 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:

• (Types::BatchDeleteTableRowsResult) —

  Returns a response object which responds to the following methods:

  • #workbook_cursor => Integer

  • #failed_batch_items => Array&lt;Types::FailedBatchItem&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-honeycode/client.rb', line 562

def batch_delete_table_rows(params = {}, options = {})
  req = build_request(:batch_delete_table_rows, params)
  req.send_request(options)
end