Class: Aws::Honeycode::Types::BatchDeleteTableRowsRequest

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

{
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  row_ids: ["RowId"], # required
  client_request_token: "ClientRequestToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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:

  • (String)


195
196
197
198
199
200
201
202
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 195

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

#row_idsArray<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.

Returns:

  • (Array<String>)


195
196
197
198
199
200
201
202
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 195

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

#table_idString

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.

Returns:

  • (String)


195
196
197
198
199
200
201
202
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 195

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

#workbook_idString

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.

Returns:

  • (String)


195
196
197
198
199
200
201
202
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 195

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