aws_sdk_pinpointsmsvoicev2/client/
delete_keyword.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 [`DeleteKeyword`](crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`origination_identity(impl Into<String>)`](crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder::origination_identity) / [`set_origination_identity(Option<String>)`](crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder::set_origination_identity):<br>required: **true**<br><p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use <code>DescribePhoneNumbers</code> to find the values for PhoneNumberId and PhoneNumberArn and <code>DescribePools</code> to find the values of PoolId and PoolArn.</p><important>  <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
7    ///   - [`keyword(impl Into<String>)`](crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder::keyword) / [`set_keyword(Option<String>)`](crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder::set_keyword):<br>required: **true**<br><p>The keyword to delete.</p><br>
8    /// - On success, responds with [`DeleteKeywordOutput`](crate::operation::delete_keyword::DeleteKeywordOutput) with field(s):
9    ///   - [`origination_identity_arn(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::origination_identity_arn): <p>The PhoneNumberArn or PoolArn that the keyword was associated with.</p>
10    ///   - [`origination_identity(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::origination_identity): <p>The PhoneNumberId or PoolId that the keyword was associated with.</p>
11    ///   - [`keyword(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::keyword): <p>The keyword that was deleted.</p>
12    ///   - [`keyword_message(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::keyword_message): <p>The message that was associated with the deleted keyword.</p>
13    ///   - [`keyword_action(Option<KeywordAction>)`](crate::operation::delete_keyword::DeleteKeywordOutput::keyword_action): <p>The action that was associated with the deleted keyword.</p>
14    /// - On failure, responds with [`SdkError<DeleteKeywordError>`](crate::operation::delete_keyword::DeleteKeywordError)
15    pub fn delete_keyword(&self) -> crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder {
16        crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder::new(self.handle.clone())
17    }
18}