aws_sdk_pinpointsmsvoicev2/client/
put_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 [`PutKeyword`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`origination_identity(impl Into<String>)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::origination_identity) / [`set_origination_identity(Option<String>)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::set_origination_identity):<br>required: **true**<br><p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> get the values for PhoneNumberId and PhoneNumberArn while <code>DescribeSenderIds</code> can be used to get the values for SenderId and SenderIdArn.</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::put_keyword::builders::PutKeywordFluentBuilder::keyword) / [`set_keyword(Option<String>)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::set_keyword):<br>required: **true**<br><p>The new keyword to add.</p><br>
8    ///   - [`keyword_message(impl Into<String>)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::keyword_message) / [`set_keyword_message(Option<String>)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::set_keyword_message):<br>required: **true**<br><p>The message associated with the keyword.</p><br>
9    ///   - [`keyword_action(KeywordAction)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::keyword_action) / [`set_keyword_action(Option<KeywordAction>)`](crate::operation::put_keyword::builders::PutKeywordFluentBuilder::set_keyword_action):<br>required: **false**<br><p>The action to perform for the new keyword when it is received.</p> <ul>  <li>   <p>AUTOMATIC_RESPONSE: A message is sent to the recipient.</p></li>  <li>   <p>OPT_OUT: Keeps the recipient from receiving future messages.</p></li>  <li>   <p>OPT_IN: The recipient wants to receive future messages.</p></li> </ul><br>
10    /// - On success, responds with [`PutKeywordOutput`](crate::operation::put_keyword::PutKeywordOutput) with field(s):
11    ///   - [`origination_identity_arn(Option<String>)`](crate::operation::put_keyword::PutKeywordOutput::origination_identity_arn): <p>The PhoneNumberArn or PoolArn that the keyword was associated with.</p>
12    ///   - [`origination_identity(Option<String>)`](crate::operation::put_keyword::PutKeywordOutput::origination_identity): <p>The PhoneNumberId or PoolId that the keyword was associated with.</p>
13    ///   - [`keyword(Option<String>)`](crate::operation::put_keyword::PutKeywordOutput::keyword): <p>The keyword that was added.</p>
14    ///   - [`keyword_message(Option<String>)`](crate::operation::put_keyword::PutKeywordOutput::keyword_message): <p>The message associated with the keyword.</p>
15    ///   - [`keyword_action(Option<KeywordAction>)`](crate::operation::put_keyword::PutKeywordOutput::keyword_action): <p>The action to perform when the keyword is used.</p>
16    /// - On failure, responds with [`SdkError<PutKeywordError>`](crate::operation::put_keyword::PutKeywordError)
17    pub fn put_keyword(&self) -> crate::operation::put_keyword::builders::PutKeywordFluentBuilder {
18        crate::operation::put_keyword::builders::PutKeywordFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_pinpointsmsvoicev2/client/put_keyword.rs

aws_sdk_pinpointsmsvoicev2/client/
put_keyword.rs
