aws_sdk_kendra/operation/describe_experience/_describe_experience_output.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeExperienceOutput {
6 /// <p>Shows the identifier of your Amazon Kendra experience.</p>
7 pub id: ::std::option::Option<::std::string::String>,
8 /// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
9 pub index_id: ::std::option::Option<::std::string::String>,
10 /// <p>Shows the name of your Amazon Kendra experience.</p>
11 pub name: ::std::option::Option<::std::string::String>,
12 /// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
13 pub endpoints: ::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>>,
14 /// <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>
15 pub configuration: ::std::option::Option<crate::types::ExperienceConfiguration>,
16 /// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
17 pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
18 /// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
19 pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
20 /// <p>Shows the description for your Amazon Kendra experience.</p>
21 pub description: ::std::option::Option<::std::string::String>,
22 /// <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>
23 pub status: ::std::option::Option<crate::types::ExperienceStatus>,
24 /// <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>
25 pub role_arn: ::std::option::Option<::std::string::String>,
26 /// <p>The reason your Amazon Kendra experience could not properly process.</p>
27 pub error_message: ::std::option::Option<::std::string::String>,
28 _request_id: Option<String>,
29}
30impl DescribeExperienceOutput {
31 /// <p>Shows the identifier of your Amazon Kendra experience.</p>
32 pub fn id(&self) -> ::std::option::Option<&str> {
33 self.id.as_deref()
34 }
35 /// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
36 pub fn index_id(&self) -> ::std::option::Option<&str> {
37 self.index_id.as_deref()
38 }
39 /// <p>Shows the name of your Amazon Kendra experience.</p>
40 pub fn name(&self) -> ::std::option::Option<&str> {
41 self.name.as_deref()
42 }
43 /// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
44 ///
45 /// 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()`.
46 pub fn endpoints(&self) -> &[crate::types::ExperienceEndpoint] {
47 self.endpoints.as_deref().unwrap_or_default()
48 }
49 /// <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>
50 pub fn configuration(&self) -> ::std::option::Option<&crate::types::ExperienceConfiguration> {
51 self.configuration.as_ref()
52 }
53 /// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
54 pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
55 self.created_at.as_ref()
56 }
57 /// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
58 pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
59 self.updated_at.as_ref()
60 }
61 /// <p>Shows the description for your Amazon Kendra experience.</p>
62 pub fn description(&self) -> ::std::option::Option<&str> {
63 self.description.as_deref()
64 }
65 /// <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>
66 pub fn status(&self) -> ::std::option::Option<&crate::types::ExperienceStatus> {
67 self.status.as_ref()
68 }
69 /// <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>
70 pub fn role_arn(&self) -> ::std::option::Option<&str> {
71 self.role_arn.as_deref()
72 }
73 /// <p>The reason your Amazon Kendra experience could not properly process.</p>
74 pub fn error_message(&self) -> ::std::option::Option<&str> {
75 self.error_message.as_deref()
76 }
77}
78impl ::aws_types::request_id::RequestId for DescribeExperienceOutput {
79 fn request_id(&self) -> Option<&str> {
80 self._request_id.as_deref()
81 }
82}
83impl DescribeExperienceOutput {
84 /// Creates a new builder-style object to manufacture [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput).
85 pub fn builder() -> crate::operation::describe_experience::builders::DescribeExperienceOutputBuilder {
86 crate::operation::describe_experience::builders::DescribeExperienceOutputBuilder::default()
87 }
88}
89
90/// A builder for [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput).
91#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
92#[non_exhaustive]
93pub struct DescribeExperienceOutputBuilder {
94 pub(crate) id: ::std::option::Option<::std::string::String>,
95 pub(crate) index_id: ::std::option::Option<::std::string::String>,
96 pub(crate) name: ::std::option::Option<::std::string::String>,
97 pub(crate) endpoints: ::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>>,
98 pub(crate) configuration: ::std::option::Option<crate::types::ExperienceConfiguration>,
99 pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
100 pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
101 pub(crate) description: ::std::option::Option<::std::string::String>,
102 pub(crate) status: ::std::option::Option<crate::types::ExperienceStatus>,
103 pub(crate) role_arn: ::std::option::Option<::std::string::String>,
104 pub(crate) error_message: ::std::option::Option<::std::string::String>,
105 _request_id: Option<String>,
106}
107impl DescribeExperienceOutputBuilder {
108 /// <p>Shows the identifier of your Amazon Kendra experience.</p>
109 pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
110 self.id = ::std::option::Option::Some(input.into());
111 self
112 }
113 /// <p>Shows the identifier of your Amazon Kendra experience.</p>
114 pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
115 self.id = input;
116 self
117 }
118 /// <p>Shows the identifier of your Amazon Kendra experience.</p>
119 pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
120 &self.id
121 }
122 /// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
123 pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124 self.index_id = ::std::option::Option::Some(input.into());
125 self
126 }
127 /// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
128 pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
129 self.index_id = input;
130 self
131 }
132 /// <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
133 pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
134 &self.index_id
135 }
136 /// <p>Shows the name of your Amazon Kendra experience.</p>
137 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
138 self.name = ::std::option::Option::Some(input.into());
139 self
140 }
141 /// <p>Shows the name of your Amazon Kendra experience.</p>
142 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
143 self.name = input;
144 self
145 }
146 /// <p>Shows the name of your Amazon Kendra experience.</p>
147 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
148 &self.name
149 }
150 /// Appends an item to `endpoints`.
151 ///
152 /// To override the contents of this collection use [`set_endpoints`](Self::set_endpoints).
153 ///
154 /// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
155 pub fn endpoints(mut self, input: crate::types::ExperienceEndpoint) -> Self {
156 let mut v = self.endpoints.unwrap_or_default();
157 v.push(input);
158 self.endpoints = ::std::option::Option::Some(v);
159 self
160 }
161 /// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
162 pub fn set_endpoints(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>>) -> Self {
163 self.endpoints = input;
164 self
165 }
166 /// <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
167 pub fn get_endpoints(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ExperienceEndpoint>> {
168 &self.endpoints
169 }
170 /// <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>
171 pub fn configuration(mut self, input: crate::types::ExperienceConfiguration) -> Self {
172 self.configuration = ::std::option::Option::Some(input);
173 self
174 }
175 /// <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>
176 pub fn set_configuration(mut self, input: ::std::option::Option<crate::types::ExperienceConfiguration>) -> Self {
177 self.configuration = input;
178 self
179 }
180 /// <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>
181 pub fn get_configuration(&self) -> &::std::option::Option<crate::types::ExperienceConfiguration> {
182 &self.configuration
183 }
184 /// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
185 pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
186 self.created_at = ::std::option::Option::Some(input);
187 self
188 }
189 /// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
190 pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
191 self.created_at = input;
192 self
193 }
194 /// <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
195 pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
196 &self.created_at
197 }
198 /// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
199 pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
200 self.updated_at = ::std::option::Option::Some(input);
201 self
202 }
203 /// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
204 pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
205 self.updated_at = input;
206 self
207 }
208 /// <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
209 pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
210 &self.updated_at
211 }
212 /// <p>Shows the description for your Amazon Kendra experience.</p>
213 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
214 self.description = ::std::option::Option::Some(input.into());
215 self
216 }
217 /// <p>Shows the description for your Amazon Kendra experience.</p>
218 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
219 self.description = input;
220 self
221 }
222 /// <p>Shows the description for your Amazon Kendra experience.</p>
223 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
224 &self.description
225 }
226 /// <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>
227 pub fn status(mut self, input: crate::types::ExperienceStatus) -> Self {
228 self.status = ::std::option::Option::Some(input);
229 self
230 }
231 /// <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>
232 pub fn set_status(mut self, input: ::std::option::Option<crate::types::ExperienceStatus>) -> Self {
233 self.status = input;
234 self
235 }
236 /// <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>
237 pub fn get_status(&self) -> &::std::option::Option<crate::types::ExperienceStatus> {
238 &self.status
239 }
240 /// <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>
241 pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
242 self.role_arn = ::std::option::Option::Some(input.into());
243 self
244 }
245 /// <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>
246 pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
247 self.role_arn = input;
248 self
249 }
250 /// <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>
251 pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
252 &self.role_arn
253 }
254 /// <p>The reason your Amazon Kendra experience could not properly process.</p>
255 pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
256 self.error_message = ::std::option::Option::Some(input.into());
257 self
258 }
259 /// <p>The reason your Amazon Kendra experience could not properly process.</p>
260 pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
261 self.error_message = input;
262 self
263 }
264 /// <p>The reason your Amazon Kendra experience could not properly process.</p>
265 pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
266 &self.error_message
267 }
268 pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
269 self._request_id = Some(request_id.into());
270 self
271 }
272
273 pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
274 self._request_id = request_id;
275 self
276 }
277 /// Consumes the builder and constructs a [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput).
278 pub fn build(self) -> crate::operation::describe_experience::DescribeExperienceOutput {
279 crate::operation::describe_experience::DescribeExperienceOutput {
280 id: self.id,
281 index_id: self.index_id,
282 name: self.name,
283 endpoints: self.endpoints,
284 configuration: self.configuration,
285 created_at: self.created_at,
286 updated_at: self.updated_at,
287 description: self.description,
288 status: self.status,
289 role_arn: self.role_arn,
290 error_message: self.error_message,
291 _request_id: self._request_id,
292 }
293 }
294}