aws_sdk_cloudfrontkeyvaluestore/client/
delete_key.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteKey`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`kvs_arn(impl Into<String>)`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder::kvs_arn) / [`set_kvs_arn(Option<String>)`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder::set_kvs_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the Key Value Store.</p><br>
7    ///   - [`key(impl Into<String>)`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder::set_key):<br>required: **true**<br><p>The key to delete.</p><br>
8    ///   - [`if_match(impl Into<String>)`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder::if_match) / [`set_if_match(Option<String>)`](crate::operation::delete_key::builders::DeleteKeyFluentBuilder::set_if_match):<br>required: **true**<br><p>The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.</p><br>
9    /// - On success, responds with [`DeleteKeyOutput`](crate::operation::delete_key::DeleteKeyOutput) with field(s):
10    ///   - [`item_count(i32)`](crate::operation::delete_key::DeleteKeyOutput::item_count): <p>Number of key value pairs in the Key Value Store after the successful delete.</p>
11    ///   - [`total_size_in_bytes(i64)`](crate::operation::delete_key::DeleteKeyOutput::total_size_in_bytes): <p>Total size of the Key Value Store after the successful delete, in bytes.</p>
12    ///   - [`e_tag(String)`](crate::operation::delete_key::DeleteKeyOutput::e_tag): <p>The current version identifier of the Key Value Store after the successful delete.</p>
13    /// - On failure, responds with [`SdkError<DeleteKeyError>`](crate::operation::delete_key::DeleteKeyError)
14    pub fn delete_key(&self) -> crate::operation::delete_key::builders::DeleteKeyFluentBuilder {
15        crate::operation::delete_key::builders::DeleteKeyFluentBuilder::new(self.handle.clone())
16    }
17}