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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// 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 GetSnapshotsInput {
/// <p>The identifier of the index to get search metrics data.</p>
pub index_id: ::std::option::Option<::std::string::String>,
/// <p>The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:</p>
/// <ul>
/// <li>
/// <p><code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>THIS_MONTH</code>: The current month, starting on the first day of the month and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the month and ending on the last day of the month.</p></li>
/// <li>
/// <p><code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</p></li>
/// </ul>
pub interval: ::std::option::Option<crate::types::Interval>,
/// <p>The metric you want to retrieve. You can specify only one metric per call.</p>
/// <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</p>
pub metric_type: ::std::option::Option<crate::types::MetricType>,
/// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of returned data for the metric.</p>
pub max_results: ::std::option::Option<i32>,
}
impl GetSnapshotsInput {
/// <p>The identifier of the index to get search metrics data.</p>
pub fn index_id(&self) -> ::std::option::Option<&str> {
self.index_id.as_deref()
}
/// <p>The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:</p>
/// <ul>
/// <li>
/// <p><code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>THIS_MONTH</code>: The current month, starting on the first day of the month and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the month and ending on the last day of the month.</p></li>
/// <li>
/// <p><code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</p></li>
/// </ul>
pub fn interval(&self) -> ::std::option::Option<&crate::types::Interval> {
self.interval.as_ref()
}
/// <p>The metric you want to retrieve. You can specify only one metric per call.</p>
/// <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</p>
pub fn metric_type(&self) -> ::std::option::Option<&crate::types::MetricType> {
self.metric_type.as_ref()
}
/// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of returned data for the metric.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
}
impl GetSnapshotsInput {
/// Creates a new builder-style object to manufacture [`GetSnapshotsInput`](crate::operation::get_snapshots::GetSnapshotsInput).
pub fn builder() -> crate::operation::get_snapshots::builders::GetSnapshotsInputBuilder {
crate::operation::get_snapshots::builders::GetSnapshotsInputBuilder::default()
}
}
/// A builder for [`GetSnapshotsInput`](crate::operation::get_snapshots::GetSnapshotsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetSnapshotsInputBuilder {
pub(crate) index_id: ::std::option::Option<::std::string::String>,
pub(crate) interval: ::std::option::Option<crate::types::Interval>,
pub(crate) metric_type: ::std::option::Option<crate::types::MetricType>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
}
impl GetSnapshotsInputBuilder {
/// <p>The identifier of the index to get search metrics data.</p>
/// This field is required.
pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.index_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the index to get search metrics data.</p>
pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.index_id = input;
self
}
/// <p>The identifier of the index to get search metrics data.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
&self.index_id
}
/// <p>The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:</p>
/// <ul>
/// <li>
/// <p><code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>THIS_MONTH</code>: The current month, starting on the first day of the month and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the month and ending on the last day of the month.</p></li>
/// <li>
/// <p><code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</p></li>
/// </ul>
/// This field is required.
pub fn interval(mut self, input: crate::types::Interval) -> Self {
self.interval = ::std::option::Option::Some(input);
self
}
/// <p>The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:</p>
/// <ul>
/// <li>
/// <p><code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>THIS_MONTH</code>: The current month, starting on the first day of the month and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the month and ending on the last day of the month.</p></li>
/// <li>
/// <p><code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</p></li>
/// </ul>
pub fn set_interval(mut self, input: ::std::option::Option<crate::types::Interval>) -> Self {
self.interval = input;
self
}
/// <p>The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:</p>
/// <ul>
/// <li>
/// <p><code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</p></li>
/// <li>
/// <p><code>THIS_MONTH</code>: The current month, starting on the first day of the month and ending on the day before the current date.</p></li>
/// <li>
/// <p><code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the month and ending on the last day of the month.</p></li>
/// <li>
/// <p><code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</p></li>
/// </ul>
pub fn get_interval(&self) -> &::std::option::Option<crate::types::Interval> {
&self.interval
}
/// <p>The metric you want to retrieve. You can specify only one metric per call.</p>
/// <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</p>
/// This field is required.
pub fn metric_type(mut self, input: crate::types::MetricType) -> Self {
self.metric_type = ::std::option::Option::Some(input);
self
}
/// <p>The metric you want to retrieve. You can specify only one metric per call.</p>
/// <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</p>
pub fn set_metric_type(mut self, input: ::std::option::Option<crate::types::MetricType>) -> Self {
self.metric_type = input;
self
}
/// <p>The metric you want to retrieve. You can specify only one metric per call.</p>
/// <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</p>
pub fn get_metric_type(&self) -> &::std::option::Option<crate::types::MetricType> {
&self.metric_type
}
/// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.</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>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The maximum number of returned data for the metric.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of returned data for the metric.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of returned data for the metric.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// Consumes the builder and constructs a [`GetSnapshotsInput`](crate::operation::get_snapshots::GetSnapshotsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::get_snapshots::GetSnapshotsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_snapshots::GetSnapshotsInput {
index_id: self.index_id,
interval: self.interval,
metric_type: self.metric_type,
next_token: self.next_token,
max_results: self.max_results,
})
}
}