1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeKeywordsInput {
/// <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find 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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub origination_identity: ::std::option::Option<::std::string::String>,
/// <p>An array of keywords to search for.</p>
pub keywords: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>An array of keyword filters to filter the results.</p>
pub filters: ::std::option::Option<::std::vec::Vec<crate::types::KeywordFilter>>,
/// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of results to return per each request.</p>
pub max_results: ::std::option::Option<i32>,
}
impl DescribeKeywordsInput {
/// <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find 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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn origination_identity(&self) -> ::std::option::Option<&str> {
self.origination_identity.as_deref()
}
/// <p>An array of keywords to search for.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.keywords.is_none()`.
pub fn keywords(&self) -> &[::std::string::String] {
self.keywords.as_deref().unwrap_or_default()
}
/// <p>An array of keyword filters to filter the results.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
pub fn filters(&self) -> &[crate::types::KeywordFilter] {
self.filters.as_deref().unwrap_or_default()
}
/// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of results to return per each request.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
}
impl DescribeKeywordsInput {
/// Creates a new builder-style object to manufacture [`DescribeKeywordsInput`](crate::operation::describe_keywords::DescribeKeywordsInput).
pub fn builder() -> crate::operation::describe_keywords::builders::DescribeKeywordsInputBuilder {
crate::operation::describe_keywords::builders::DescribeKeywordsInputBuilder::default()
}
}
/// A builder for [`DescribeKeywordsInput`](crate::operation::describe_keywords::DescribeKeywordsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeKeywordsInputBuilder {
pub(crate) origination_identity: ::std::option::Option<::std::string::String>,
pub(crate) keywords: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::KeywordFilter>>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
}
impl DescribeKeywordsInputBuilder {
/// <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find 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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
/// This field is required.
pub fn origination_identity(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.origination_identity = ::std::option::Option::Some(input.into());
self
}
/// <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find 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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn set_origination_identity(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.origination_identity = input;
self
}
/// <p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find 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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p>
/// </important>
pub fn get_origination_identity(&self) -> &::std::option::Option<::std::string::String> {
&self.origination_identity
}
/// Appends an item to `keywords`.
///
/// To override the contents of this collection use [`set_keywords`](Self::set_keywords).
///
/// <p>An array of keywords to search for.</p>
pub fn keywords(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.keywords.unwrap_or_default();
v.push(input.into());
self.keywords = ::std::option::Option::Some(v);
self
}
/// <p>An array of keywords to search for.</p>
pub fn set_keywords(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.keywords = input;
self
}
/// <p>An array of keywords to search for.</p>
pub fn get_keywords(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.keywords
}
/// Appends an item to `filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>An array of keyword filters to filter the results.</p>
pub fn filters(mut self, input: crate::types::KeywordFilter) -> Self {
let mut v = self.filters.unwrap_or_default();
v.push(input);
self.filters = ::std::option::Option::Some(v);
self
}
/// <p>An array of keyword filters to filter the results.</p>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::KeywordFilter>>) -> Self {
self.filters = input;
self
}
/// <p>An array of keyword filters to filter the results.</p>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::KeywordFilter>> {
&self.filters
}
/// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The maximum number of results to return per each request.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of results to return per each request.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of results to return per each request.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// Consumes the builder and constructs a [`DescribeKeywordsInput`](crate::operation::describe_keywords::DescribeKeywordsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_keywords::DescribeKeywordsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_keywords::DescribeKeywordsInput {
origination_identity: self.origination_identity,
keywords: self.keywords,
filters: self.filters,
next_token: self.next_token,
max_results: self.max_results,
})
}
}