Class: Aws::Honeycode::Types::BatchCreateTableRowsRequest

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

{
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  rows_to_create: [ # required
    {
      batch_item_id: "BatchItemId", # required
      cells_to_create: { # 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 batch create operation. 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 operation 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)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 112

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

#rows_to_createArray<Types::CreateRowData>

The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.

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

Returns:



112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 112

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

#table_idString

The ID of the table where the new rows are being added.

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

Returns:

  • (String)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 112

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

#workbook_idString

The ID of the workbook where the new rows are being added.

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

Returns:

  • (String)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/types.rb', line 112

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