Struct aws_sdk_dynamodb::output::batch_write_item_output::Builder

pub struct Builder { /* private fields */ }

A builder for BatchWriteItemOutput.

Implementations

impl Builder

pub fn unprocessed_items(self, k: impl Into<String>, v: Vec<WriteRequest>) -> Self

Adds a key-value pair to unprocessed_items.

To override the contents of this collection use set_unprocessed_items.

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 a DeleteItem 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.

• PutRequest - Perform a PutItem 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 will be 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.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

pub fn set_unprocessed_items(
    self,
    input: Option<HashMap<String, Vec<WriteRequest>>>
) -> Self

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 a DeleteItem 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.

• PutRequest - Perform a PutItem 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 will be 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.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

Examples found in repository

src/json_deser.rs (lines 425-427)

pub(crate) fn deser_operation_crate_operation_batch_write_item(
    value: &[u8],
    mut builder: crate::output::batch_write_item_output::Builder,
) -> Result<
    crate::output::batch_write_item_output::Builder,
    aws_smithy_json::deserialize::error::DeserializeError,
> {
    let mut tokens_owned =
        aws_smithy_json::deserialize::json_token_iter(crate::json_deser::or_empty_doc(value))
            .peekable();
    let tokens = &mut tokens_owned;
    aws_smithy_json::deserialize::token::expect_start_object(tokens.next())?;
    loop {
        match tokens.next().transpose()? {
            Some(aws_smithy_json::deserialize::Token::EndObject { .. }) => break,
            Some(aws_smithy_json::deserialize::Token::ObjectKey { key, .. }) => {
                match key.to_unescaped()?.as_ref() {
                    "UnprocessedItems" => {
                        builder = builder.set_unprocessed_items(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_batch_write_item_request_map(tokens)?
                        );
                    }
                    "ItemCollectionMetrics" => {
                        builder = builder.set_item_collection_metrics(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_item_collection_metrics_per_table(tokens)?
                        );
                    }
                    "ConsumedCapacity" => {
                        builder = builder.set_consumed_capacity(
                            crate::json_deser::deser_list_com_amazonaws_dynamodb_consumed_capacity_multiple(tokens)?
                        );
                    }
                    _ => aws_smithy_json::deserialize::token::skip_value(tokens)?,
                }
            }
            other => {
                return Err(
                    aws_smithy_json::deserialize::error::DeserializeError::custom(format!(
                        "expected object key or end object, found: {:?}",
                        other
                    )),
                )
            }
        }
    }
    if tokens.next().is_some() {
        return Err(
            aws_smithy_json::deserialize::error::DeserializeError::custom(
                "found more JSON tokens after completing parsing",
            ),
        );
    }
    Ok(builder)
}

pub fn item_collection_metrics(
    self,
    k: impl Into<String>,
    v: Vec<ItemCollectionMetrics>
) -> Self

Adds a key-value pair to item_collection_metrics.

To override the contents of this collection use set_item_collection_metrics.

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.

pub fn set_item_collection_metrics(
    self,
    input: Option<HashMap<String, Vec<ItemCollectionMetrics>>>
) -> Self

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.

Examples found in repository

src/json_deser.rs (lines 430-432)

pub(crate) fn deser_operation_crate_operation_batch_write_item(
    value: &[u8],
    mut builder: crate::output::batch_write_item_output::Builder,
) -> Result<
    crate::output::batch_write_item_output::Builder,
    aws_smithy_json::deserialize::error::DeserializeError,
> {
    let mut tokens_owned =
        aws_smithy_json::deserialize::json_token_iter(crate::json_deser::or_empty_doc(value))
            .peekable();
    let tokens = &mut tokens_owned;
    aws_smithy_json::deserialize::token::expect_start_object(tokens.next())?;
    loop {
        match tokens.next().transpose()? {
            Some(aws_smithy_json::deserialize::Token::EndObject { .. }) => break,
            Some(aws_smithy_json::deserialize::Token::ObjectKey { key, .. }) => {
                match key.to_unescaped()?.as_ref() {
                    "UnprocessedItems" => {
                        builder = builder.set_unprocessed_items(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_batch_write_item_request_map(tokens)?
                        );
                    }
                    "ItemCollectionMetrics" => {
                        builder = builder.set_item_collection_metrics(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_item_collection_metrics_per_table(tokens)?
                        );
                    }
                    "ConsumedCapacity" => {
                        builder = builder.set_consumed_capacity(
                            crate::json_deser::deser_list_com_amazonaws_dynamodb_consumed_capacity_multiple(tokens)?
                        );
                    }
                    _ => aws_smithy_json::deserialize::token::skip_value(tokens)?,
                }
            }
            other => {
                return Err(
                    aws_smithy_json::deserialize::error::DeserializeError::custom(format!(
                        "expected object key or end object, found: {:?}",
                        other
                    )),
                )
            }
        }
    }
    if tokens.next().is_some() {
        return Err(
            aws_smithy_json::deserialize::error::DeserializeError::custom(
                "found more JSON tokens after completing parsing",
            ),
        );
    }
    Ok(builder)
}

pub fn consumed_capacity(self, input: ConsumedCapacity) -> Self

Appends an item to consumed_capacity.

To override the contents of this collection use set_consumed_capacity.

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.

pub fn set_consumed_capacity(self, input: Option<Vec<ConsumedCapacity>>) -> Self

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.

Examples found in repository

src/json_deser.rs (lines 435-437)

pub(crate) fn deser_operation_crate_operation_batch_write_item(
    value: &[u8],
    mut builder: crate::output::batch_write_item_output::Builder,
) -> Result<
    crate::output::batch_write_item_output::Builder,
    aws_smithy_json::deserialize::error::DeserializeError,
> {
    let mut tokens_owned =
        aws_smithy_json::deserialize::json_token_iter(crate::json_deser::or_empty_doc(value))
            .peekable();
    let tokens = &mut tokens_owned;
    aws_smithy_json::deserialize::token::expect_start_object(tokens.next())?;
    loop {
        match tokens.next().transpose()? {
            Some(aws_smithy_json::deserialize::Token::EndObject { .. }) => break,
            Some(aws_smithy_json::deserialize::Token::ObjectKey { key, .. }) => {
                match key.to_unescaped()?.as_ref() {
                    "UnprocessedItems" => {
                        builder = builder.set_unprocessed_items(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_batch_write_item_request_map(tokens)?
                        );
                    }
                    "ItemCollectionMetrics" => {
                        builder = builder.set_item_collection_metrics(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_item_collection_metrics_per_table(tokens)?
                        );
                    }
                    "ConsumedCapacity" => {
                        builder = builder.set_consumed_capacity(
                            crate::json_deser::deser_list_com_amazonaws_dynamodb_consumed_capacity_multiple(tokens)?
                        );
                    }
                    _ => aws_smithy_json::deserialize::token::skip_value(tokens)?,
                }
            }
            other => {
                return Err(
                    aws_smithy_json::deserialize::error::DeserializeError::custom(format!(
                        "expected object key or end object, found: {:?}",
                        other
                    )),
                )
            }
        }
    }
    if tokens.next().is_some() {
        return Err(
            aws_smithy_json::deserialize::error::DeserializeError::custom(
                "found more JSON tokens after completing parsing",
            ),
        );
    }
    Ok(builder)
}

pub fn build(self) -> BatchWriteItemOutput

Consumes the builder and constructs a BatchWriteItemOutput.

Examples found in repository

src/operation_deser.rs (line 330)

pub fn parse_batch_write_item_response(
    response: &http::Response<bytes::Bytes>,
) -> std::result::Result<crate::output::BatchWriteItemOutput, crate::error::BatchWriteItemError> {
    Ok({
        #[allow(unused_mut)]
        let mut output = crate::output::batch_write_item_output::Builder::default();
        let _ = response;
        output = crate::json_deser::deser_operation_crate_operation_batch_write_item(
            response.body().as_ref(),
            output,
        )
        .map_err(crate::error::BatchWriteItemError::unhandled)?;
        output.build()
    })
}

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder