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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
// 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 DescribeDataSourceOutput {
/// <p>The identifier of the data source connector.</p>
pub id: ::std::option::Option<::std::string::String>,
/// <p>The identifier of the index used with the data source connector.</p>
pub index_id: ::std::option::Option<::std::string::String>,
/// <p>The name for the data source connector.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
pub r#type: ::std::option::Option<crate::types::DataSourceType>,
/// <p>Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.</p>
pub configuration: ::std::option::Option<crate::types::DataSourceConfiguration>,
/// <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
pub vpc_configuration: ::std::option::Option<crate::types::DataSourceVpcConfiguration>,
/// <p>The Unix timestamp when the data source connector was created.</p>
pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The Unix timestamp when the data source connector was last updated.</p>
pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The description for the data source connector.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The current status of the data source connector. When the status is <code>ACTIVE</code> the data source is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
pub status: ::std::option::Option<crate::types::DataSourceStatus>,
/// <p>The schedule for Amazon Kendra to update the index.</p>
pub schedule: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source to fail.</p>
pub error_message: ::std::option::Option<::std::string::String>,
/// <p>The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub language_code: ::std::option::Option<::std::string::String>,
/// <p>Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.</p>
/// <p>For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>
pub custom_document_enrichment_configuration: ::std::option::Option<crate::types::CustomDocumentEnrichmentConfiguration>,
_request_id: Option<String>,
}
impl DescribeDataSourceOutput {
/// <p>The identifier of the data source connector.</p>
pub fn id(&self) -> ::std::option::Option<&str> {
self.id.as_deref()
}
/// <p>The identifier of the index used with the data source connector.</p>
pub fn index_id(&self) -> ::std::option::Option<&str> {
self.index_id.as_deref()
}
/// <p>The name for the data source connector.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
pub fn r#type(&self) -> ::std::option::Option<&crate::types::DataSourceType> {
self.r#type.as_ref()
}
/// <p>Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.</p>
pub fn configuration(&self) -> ::std::option::Option<&crate::types::DataSourceConfiguration> {
self.configuration.as_ref()
}
/// <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
pub fn vpc_configuration(&self) -> ::std::option::Option<&crate::types::DataSourceVpcConfiguration> {
self.vpc_configuration.as_ref()
}
/// <p>The Unix timestamp when the data source connector 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 the data source connector was last updated.</p>
pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.updated_at.as_ref()
}
/// <p>The description for the data source connector.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The current status of the data source connector. When the status is <code>ACTIVE</code> the data source is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
pub fn status(&self) -> ::std::option::Option<&crate::types::DataSourceStatus> {
self.status.as_ref()
}
/// <p>The schedule for Amazon Kendra to update the index.</p>
pub fn schedule(&self) -> ::std::option::Option<&str> {
self.schedule.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source to fail.</p>
pub fn error_message(&self) -> ::std::option::Option<&str> {
self.error_message.as_deref()
}
/// <p>The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn language_code(&self) -> ::std::option::Option<&str> {
self.language_code.as_deref()
}
/// <p>Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.</p>
/// <p>For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>
pub fn custom_document_enrichment_configuration(&self) -> ::std::option::Option<&crate::types::CustomDocumentEnrichmentConfiguration> {
self.custom_document_enrichment_configuration.as_ref()
}
}
impl ::aws_types::request_id::RequestId for DescribeDataSourceOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeDataSourceOutput {
/// Creates a new builder-style object to manufacture [`DescribeDataSourceOutput`](crate::operation::describe_data_source::DescribeDataSourceOutput).
pub fn builder() -> crate::operation::describe_data_source::builders::DescribeDataSourceOutputBuilder {
crate::operation::describe_data_source::builders::DescribeDataSourceOutputBuilder::default()
}
}
/// A builder for [`DescribeDataSourceOutput`](crate::operation::describe_data_source::DescribeDataSourceOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeDataSourceOutputBuilder {
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) r#type: ::std::option::Option<crate::types::DataSourceType>,
pub(crate) configuration: ::std::option::Option<crate::types::DataSourceConfiguration>,
pub(crate) vpc_configuration: ::std::option::Option<crate::types::DataSourceVpcConfiguration>,
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::DataSourceStatus>,
pub(crate) schedule: ::std::option::Option<::std::string::String>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) error_message: ::std::option::Option<::std::string::String>,
pub(crate) language_code: ::std::option::Option<::std::string::String>,
pub(crate) custom_document_enrichment_configuration: ::std::option::Option<crate::types::CustomDocumentEnrichmentConfiguration>,
_request_id: Option<String>,
}
impl DescribeDataSourceOutputBuilder {
/// <p>The identifier of the data source connector.</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>The identifier of the data source connector.</p>
pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.id = input;
self
}
/// <p>The identifier of the data source connector.</p>
pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
&self.id
}
/// <p>The identifier of the index used with the data source connector.</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>The identifier of the index used with the data source connector.</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 used with the data source connector.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
&self.index_id
}
/// <p>The name for the data source connector.</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>The name for the data source connector.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name for the data source connector.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
pub fn r#type(mut self, input: crate::types::DataSourceType) -> Self {
self.r#type = ::std::option::Option::Some(input);
self
}
/// <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
pub fn set_type(mut self, input: ::std::option::Option<crate::types::DataSourceType>) -> Self {
self.r#type = input;
self
}
/// <p>The type of the data source. For example, <code>SHAREPOINT</code>.</p>
pub fn get_type(&self) -> &::std::option::Option<crate::types::DataSourceType> {
&self.r#type
}
/// <p>Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.</p>
pub fn configuration(mut self, input: crate::types::DataSourceConfiguration) -> Self {
self.configuration = ::std::option::Option::Some(input);
self
}
/// <p>Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.</p>
pub fn set_configuration(mut self, input: ::std::option::Option<crate::types::DataSourceConfiguration>) -> Self {
self.configuration = input;
self
}
/// <p>Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.</p>
pub fn get_configuration(&self) -> &::std::option::Option<crate::types::DataSourceConfiguration> {
&self.configuration
}
/// <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
pub fn vpc_configuration(mut self, input: crate::types::DataSourceVpcConfiguration) -> Self {
self.vpc_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
pub fn set_vpc_configuration(mut self, input: ::std::option::Option<crate::types::DataSourceVpcConfiguration>) -> Self {
self.vpc_configuration = input;
self
}
/// <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
pub fn get_vpc_configuration(&self) -> &::std::option::Option<crate::types::DataSourceVpcConfiguration> {
&self.vpc_configuration
}
/// <p>The Unix timestamp when the data source connector 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 the data source connector 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 the data source connector was created.</p>
pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.created_at
}
/// <p>The Unix timestamp when the data source connector 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 the data source connector 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 the data source connector was last updated.</p>
pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.updated_at
}
/// <p>The description for the data source connector.</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>The description for the data source connector.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description for the data source connector.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The current status of the data source connector. When the status is <code>ACTIVE</code> the data source is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
pub fn status(mut self, input: crate::types::DataSourceStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The current status of the data source connector. When the status is <code>ACTIVE</code> the data source is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::DataSourceStatus>) -> Self {
self.status = input;
self
}
/// <p>The current status of the data source connector. When the status is <code>ACTIVE</code> the data source is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that the data source failed.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::DataSourceStatus> {
&self.status
}
/// <p>The schedule for Amazon Kendra to update the index.</p>
pub fn schedule(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.schedule = ::std::option::Option::Some(input.into());
self
}
/// <p>The schedule for Amazon Kendra to update the index.</p>
pub fn set_schedule(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.schedule = input;
self
}
/// <p>The schedule for Amazon Kendra to update the index.</p>
pub fn get_schedule(&self) -> &::std::option::Option<::std::string::String> {
&self.schedule
}
/// <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.</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 data source and required resources.</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 data source and required resources.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source to fail.</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>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source to fail.</p>
pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.error_message = input;
self
}
/// <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source to fail.</p>
pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
&self.error_message
}
/// <p>The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn language_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.language_code = ::std::option::Option::Some(input.into());
self
}
/// <p>The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn set_language_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.language_code = input;
self
}
/// <p>The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>
pub fn get_language_code(&self) -> &::std::option::Option<::std::string::String> {
&self.language_code
}
/// <p>Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.</p>
/// <p>For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>
pub fn custom_document_enrichment_configuration(mut self, input: crate::types::CustomDocumentEnrichmentConfiguration) -> Self {
self.custom_document_enrichment_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.</p>
/// <p>For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>
pub fn set_custom_document_enrichment_configuration(
mut self,
input: ::std::option::Option<crate::types::CustomDocumentEnrichmentConfiguration>,
) -> Self {
self.custom_document_enrichment_configuration = input;
self
}
/// <p>Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.</p>
/// <p>For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>
pub fn get_custom_document_enrichment_configuration(&self) -> &::std::option::Option<crate::types::CustomDocumentEnrichmentConfiguration> {
&self.custom_document_enrichment_configuration
}
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 [`DescribeDataSourceOutput`](crate::operation::describe_data_source::DescribeDataSourceOutput).
pub fn build(self) -> crate::operation::describe_data_source::DescribeDataSourceOutput {
crate::operation::describe_data_source::DescribeDataSourceOutput {
id: self.id,
index_id: self.index_id,
name: self.name,
r#type: self.r#type,
configuration: self.configuration,
vpc_configuration: self.vpc_configuration,
created_at: self.created_at,
updated_at: self.updated_at,
description: self.description,
status: self.status,
schedule: self.schedule,
role_arn: self.role_arn,
error_message: self.error_message,
language_code: self.language_code,
custom_document_enrichment_configuration: self.custom_document_enrichment_configuration,
_request_id: self._request_id,
}
}
}