aws-sdk-pinpointsmsvoicev2 1.124.0

AWS SDK for Amazon Pinpoint SMS Voice V2
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteKeyword`](crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
    ///   - [`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>
    /// - On success, responds with [`DeleteKeywordOutput`](crate::operation::delete_keyword::DeleteKeywordOutput) with field(s):
    ///   - [`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>
    ///   - [`origination_identity(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::origination_identity): <p>The PhoneNumberId or PoolId that the keyword was associated with.</p>
    ///   - [`keyword(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::keyword): <p>The keyword that was deleted.</p>
    ///   - [`keyword_message(Option<String>)`](crate::operation::delete_keyword::DeleteKeywordOutput::keyword_message): <p>The message that was associated with the deleted keyword.</p>
    ///   - [`keyword_action(Option<KeywordAction>)`](crate::operation::delete_keyword::DeleteKeywordOutput::keyword_action): <p>The action that was associated with the deleted keyword.</p>
    /// - On failure, responds with [`SdkError<DeleteKeywordError>`](crate::operation::delete_keyword::DeleteKeywordError)
    pub fn delete_keyword(&self) -> crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder {
        crate::operation::delete_keyword::builders::DeleteKeywordFluentBuilder::new(self.handle.clone())
    }
}