Struct aws_sdk_dynamodb::output::BatchWriteItemOutput [−][src]
#[non_exhaustive]pub struct BatchWriteItemOutput {
pub unprocessed_items: Option<HashMap<String, Vec<WriteRequest>>>,
pub item_collection_metrics: Option<HashMap<String, Vec<ItemCollectionMetrics>>>,
pub consumed_capacity: Option<Vec<ConsumedCapacity>>,
}
Expand description
Represents the output of a BatchWriteItem
operation.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.unprocessed_items: Option<HashMap<String, Vec<WriteRequest>>>
A map of tables and requests against those tables that were not processed. The
UnprocessedItems
value is in the same form as RequestItems
, so you can provide
this value directly to a subsequent BatchGetItem
operation. For more information, see
RequestItems
in the Request Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of
operations to perform (DeleteRequest
or PutRequest
).
-
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
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.
-
-
PutRequest
- Perform aPutItem
operation on the specified item. The item to be put is identified by anItem
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 will be rejected with aValidationException
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.
-
If there are no unprocessed items remaining, the response contains an empty
UnprocessedItems
map.
item_collection_metrics: Option<HashMap<String, Vec<ItemCollectionMetrics>>>
A list of tables that were processed by BatchWriteItem
and, for each table,
information about any item collections that were affected by individual DeleteItem
or
PutItem
operations.
Each entry consists of the following subelements:
-
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item. -
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
consumed_capacity: Option<Vec<ConsumedCapacity>>
The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
-
TableName
- The table that consumed the provisioned throughput. -
CapacityUnits
- The total number of capacity units consumed.
Implementations
A map of tables and requests against those tables that were not processed. The
UnprocessedItems
value is in the same form as RequestItems
, so you can provide
this value directly to a subsequent BatchGetItem
operation. For more information, see
RequestItems
in the Request Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that table, a list of
operations to perform (DeleteRequest
or PutRequest
).
-
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
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.
-
-
PutRequest
- Perform aPutItem
operation on the specified item. The item to be put is identified by anItem
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 will be rejected with aValidationException
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.
-
If there are no unprocessed items remaining, the response contains an empty
UnprocessedItems
map.
A list of tables that were processed by BatchWriteItem
and, for each table,
information about any item collections that were affected by individual DeleteItem
or
PutItem
operations.
Each entry consists of the following subelements:
-
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item. -
SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
-
TableName
- The table that consumed the provisioned throughput. -
CapacityUnits
- The total number of capacity units consumed.
Creates a new builder-style object to manufacture BatchWriteItemOutput
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for BatchWriteItemOutput
impl Send for BatchWriteItemOutput
impl Sync for BatchWriteItemOutput
impl Unpin for BatchWriteItemOutput
impl UnwindSafe for BatchWriteItemOutput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more