dynamodb_batch_write_item: The BatchWriteItem operation puts or deletes multiple items...

View source: R/dynamodb_operations.R

dynamodb_batch_write_itemR Documentation

The BatchWriteItem operation puts or deletes multiple items in one or more tables

Description

The batch_write_item operation puts or deletes multiple items in one or more tables. A single call to batch_write_item can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

See https://www.paws-r-sdk.com/docs/dynamodb_batch_write_item/ for full documentation.

Usage

dynamodb_batch_write_item(
  RequestItems,
  ReturnConsumedCapacity = NULL,
  ReturnItemCollectionMetrics = NULL
)

Arguments

RequestItems

[required] A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

  • DeleteRequest - Perform a delete_item operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • PutRequest - Perform a put_item operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.

      If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

ReturnConsumedCapacity
ReturnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.


paws.database documentation built on Sept. 12, 2024, 6:37 a.m.