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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
// 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 DescribeExperienceOutput {
/// <p>Shows the identifier of your Amazon Kendra experience.</p>
pub id: ::std::option::Option<::std::string::String>,
/// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
pub index_id: ::std::option::Option<::std::string::String>,
/// <p>Shows the name of your Amazon Kendra experience.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
pub endpoints: ::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>>,
/// <p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>
pub configuration: ::std::option::Option<crate::types::ExperienceConfiguration>,
/// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Shows the description for your Amazon Kendra experience.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>
pub status: ::std::option::Option<crate::types::ExperienceStatus>,
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>The reason your Amazon Kendra experience could not properly process.</p>
pub error_message: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeExperienceOutput {
/// <p>Shows the identifier of your Amazon Kendra experience.</p>
pub fn id(&self) -> ::std::option::Option<&str> {
self.id.as_deref()
}
/// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
pub fn index_id(&self) -> ::std::option::Option<&str> {
self.index_id.as_deref()
}
/// <p>Shows the name of your Amazon Kendra experience.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</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 `.endpoints.is_none()`.
pub fn endpoints(&self) -> &[crate::types::ExperienceEndpoint] {
self.endpoints.as_deref().unwrap_or_default()
}
/// <p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>
pub fn configuration(&self) -> ::std::option::Option<&crate::types::ExperienceConfiguration> {
self.configuration.as_ref()
}
/// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.created_at.as_ref()
}
/// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.updated_at.as_ref()
}
/// <p>Shows the description for your Amazon Kendra experience.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>
pub fn status(&self) -> ::std::option::Option<&crate::types::ExperienceStatus> {
self.status.as_ref()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>The reason your Amazon Kendra experience could not properly process.</p>
pub fn error_message(&self) -> ::std::option::Option<&str> {
self.error_message.as_deref()
}
}
impl ::aws_types::request_id::RequestId for DescribeExperienceOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeExperienceOutput {
/// Creates a new builder-style object to manufacture [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput).
pub fn builder() -> crate::operation::describe_experience::builders::DescribeExperienceOutputBuilder {
crate::operation::describe_experience::builders::DescribeExperienceOutputBuilder::default()
}
}
/// A builder for [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeExperienceOutputBuilder {
pub(crate) id: ::std::option::Option<::std::string::String>,
pub(crate) index_id: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) endpoints: ::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>>,
pub(crate) configuration: ::std::option::Option<crate::types::ExperienceConfiguration>,
pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) status: ::std::option::Option<crate::types::ExperienceStatus>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) error_message: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeExperienceOutputBuilder {
/// <p>Shows the identifier of your Amazon Kendra experience.</p>
pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.id = ::std::option::Option::Some(input.into());
self
}
/// <p>Shows the identifier of your Amazon Kendra experience.</p>
pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.id = input;
self
}
/// <p>Shows the identifier of your Amazon Kendra experience.</p>
pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
&self.id
}
/// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
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>Shows the identifier of the index for your Amazon Kendra experience.</p>
pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.index_id = input;
self
}
/// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
&self.index_id
}
/// <p>Shows the name of your Amazon Kendra experience.</p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>Shows the name of your Amazon Kendra experience.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>Shows the name of your Amazon Kendra experience.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// Appends an item to `endpoints`.
///
/// To override the contents of this collection use [`set_endpoints`](Self::set_endpoints).
///
/// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
pub fn endpoints(mut self, input: crate::types::ExperienceEndpoint) -> Self {
let mut v = self.endpoints.unwrap_or_default();
v.push(input);
self.endpoints = ::std::option::Option::Some(v);
self
}
/// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
pub fn set_endpoints(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>>) -> Self {
self.endpoints = input;
self
}
/// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
pub fn get_endpoints(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>> {
&self.endpoints
}
/// <p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>
pub fn configuration(mut self, input: crate::types::ExperienceConfiguration) -> Self {
self.configuration = ::std::option::Option::Some(input);
self
}
/// <p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>
pub fn set_configuration(mut self, input: ::std::option::Option<crate::types::ExperienceConfiguration>) -> Self {
self.configuration = input;
self
}
/// <p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>
pub fn get_configuration(&self) -> &::std::option::Option<crate::types::ExperienceConfiguration> {
&self.configuration
}
/// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.created_at = ::std::option::Option::Some(input);
self
}
/// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.created_at = input;
self
}
/// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.created_at
}
/// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.updated_at = ::std::option::Option::Some(input);
self
}
/// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.updated_at = input;
self
}
/// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.updated_at
}
/// <p>Shows the description for your Amazon Kendra experience.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>Shows the description for your Amazon Kendra experience.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Shows the description for your Amazon Kendra experience.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>
pub fn status(mut self, input: crate::types::ExperienceStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::ExperienceStatus>) -> Self {
self.status = input;
self
}
/// <p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::ExperienceStatus> {
&self.status
}
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information.</p>
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>The reason your Amazon Kendra experience could not properly process.</p>
pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.error_message = ::std::option::Option::Some(input.into());
self
}
/// <p>The reason your Amazon Kendra experience could not properly process.</p>
pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.error_message = input;
self
}
/// <p>The reason your Amazon Kendra experience could not properly process.</p>
pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
&self.error_message
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput).
pub fn build(self) -> crate::operation::describe_experience::DescribeExperienceOutput {
crate::operation::describe_experience::DescribeExperienceOutput {
id: self.id,
index_id: self.index_id,
name: self.name,
endpoints: self.endpoints,
configuration: self.configuration,
created_at: self.created_at,
updated_at: self.updated_at,
description: self.description,
status: self.status,
role_arn: self.role_arn,
error_message: self.error_message,
_request_id: self._request_id,
}
}
}