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
// 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 CreateExplainabilityInput {
/// <p>A unique name for the Explainability.</p>
pub explainability_name: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>
pub resource_arn: ::std::option::Option<::std::string::String>,
/// <p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>
pub explainability_config: ::std::option::Option<crate::types::ExplainabilityConfig>,
/// <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.</p>
pub data_source: ::std::option::Option<crate::types::DataSource>,
/// <p>Defines the fields of a dataset.</p>
pub schema: ::std::option::Option<crate::types::Schema>,
/// <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
pub enable_visualization: ::std::option::Option<bool>,
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub start_date_time: ::std::option::Option<::std::string::String>,
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub end_date_time: ::std::option::Option<::std::string::String>,
/// <p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p>
/// <p>The following restrictions apply to tags:</p>
/// <ul>
/// <li>
/// <p>For each resource, each tag key must be unique and each tag key must have one value.</p></li>
/// <li>
/// <p>Maximum number of tags per resource: 50.</p></li>
/// <li>
/// <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.</p></li>
/// <li>
/// <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p></li>
/// </ul>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateExplainabilityInput {
/// <p>A unique name for the Explainability.</p>
pub fn explainability_name(&self) -> ::std::option::Option<&str> {
self.explainability_name.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>
pub fn resource_arn(&self) -> ::std::option::Option<&str> {
self.resource_arn.as_deref()
}
/// <p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>
pub fn explainability_config(&self) -> ::std::option::Option<&crate::types::ExplainabilityConfig> {
self.explainability_config.as_ref()
}
/// <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.</p>
pub fn data_source(&self) -> ::std::option::Option<&crate::types::DataSource> {
self.data_source.as_ref()
}
/// <p>Defines the fields of a dataset.</p>
pub fn schema(&self) -> ::std::option::Option<&crate::types::Schema> {
self.schema.as_ref()
}
/// <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
pub fn enable_visualization(&self) -> ::std::option::Option<bool> {
self.enable_visualization
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn start_date_time(&self) -> ::std::option::Option<&str> {
self.start_date_time.as_deref()
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn end_date_time(&self) -> ::std::option::Option<&str> {
self.end_date_time.as_deref()
}
/// <p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p>
/// <p>The following restrictions apply to tags:</p>
/// <ul>
/// <li>
/// <p>For each resource, each tag key must be unique and each tag key must have one value.</p></li>
/// <li>
/// <p>Maximum number of tags per resource: 50.</p></li>
/// <li>
/// <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.</p></li>
/// <li>
/// <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
}
impl CreateExplainabilityInput {
/// Creates a new builder-style object to manufacture [`CreateExplainabilityInput`](crate::operation::create_explainability::CreateExplainabilityInput).
pub fn builder() -> crate::operation::create_explainability::builders::CreateExplainabilityInputBuilder {
crate::operation::create_explainability::builders::CreateExplainabilityInputBuilder::default()
}
}
/// A builder for [`CreateExplainabilityInput`](crate::operation::create_explainability::CreateExplainabilityInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateExplainabilityInputBuilder {
pub(crate) explainability_name: ::std::option::Option<::std::string::String>,
pub(crate) resource_arn: ::std::option::Option<::std::string::String>,
pub(crate) explainability_config: ::std::option::Option<crate::types::ExplainabilityConfig>,
pub(crate) data_source: ::std::option::Option<crate::types::DataSource>,
pub(crate) schema: ::std::option::Option<crate::types::Schema>,
pub(crate) enable_visualization: ::std::option::Option<bool>,
pub(crate) start_date_time: ::std::option::Option<::std::string::String>,
pub(crate) end_date_time: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateExplainabilityInputBuilder {
/// <p>A unique name for the Explainability.</p>
/// This field is required.
pub fn explainability_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.explainability_name = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique name for the Explainability.</p>
pub fn set_explainability_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.explainability_name = input;
self
}
/// <p>A unique name for the Explainability.</p>
pub fn get_explainability_name(&self) -> &::std::option::Option<::std::string::String> {
&self.explainability_name
}
/// <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>
/// This field is required.
pub fn resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.resource_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>
pub fn set_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.resource_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>
pub fn get_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.resource_arn
}
/// <p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>
/// This field is required.
pub fn explainability_config(mut self, input: crate::types::ExplainabilityConfig) -> Self {
self.explainability_config = ::std::option::Option::Some(input);
self
}
/// <p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>
pub fn set_explainability_config(mut self, input: ::std::option::Option<crate::types::ExplainabilityConfig>) -> Self {
self.explainability_config = input;
self
}
/// <p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>
pub fn get_explainability_config(&self) -> &::std::option::Option<crate::types::ExplainabilityConfig> {
&self.explainability_config
}
/// <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.</p>
pub fn data_source(mut self, input: crate::types::DataSource) -> Self {
self.data_source = ::std::option::Option::Some(input);
self
}
/// <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.</p>
pub fn set_data_source(mut self, input: ::std::option::Option<crate::types::DataSource>) -> Self {
self.data_source = input;
self
}
/// <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.</p>
pub fn get_data_source(&self) -> &::std::option::Option<crate::types::DataSource> {
&self.data_source
}
/// <p>Defines the fields of a dataset.</p>
pub fn schema(mut self, input: crate::types::Schema) -> Self {
self.schema = ::std::option::Option::Some(input);
self
}
/// <p>Defines the fields of a dataset.</p>
pub fn set_schema(mut self, input: ::std::option::Option<crate::types::Schema>) -> Self {
self.schema = input;
self
}
/// <p>Defines the fields of a dataset.</p>
pub fn get_schema(&self) -> &::std::option::Option<crate::types::Schema> {
&self.schema
}
/// <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
pub fn enable_visualization(mut self, input: bool) -> Self {
self.enable_visualization = ::std::option::Option::Some(input);
self
}
/// <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
pub fn set_enable_visualization(mut self, input: ::std::option::Option<bool>) -> Self {
self.enable_visualization = input;
self
}
/// <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
pub fn get_enable_visualization(&self) -> &::std::option::Option<bool> {
&self.enable_visualization
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn start_date_time(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.start_date_time = ::std::option::Option::Some(input.into());
self
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn set_start_date_time(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.start_date_time = input;
self
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn get_start_date_time(&self) -> &::std::option::Option<::std::string::String> {
&self.start_date_time
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn end_date_time(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.end_date_time = ::std::option::Option::Some(input.into());
self
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn set_end_date_time(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.end_date_time = input;
self
}
/// <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p>
/// <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
pub fn get_end_date_time(&self) -> &::std::option::Option<::std::string::String> {
&self.end_date_time
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p>
/// <p>The following restrictions apply to tags:</p>
/// <ul>
/// <li>
/// <p>For each resource, each tag key must be unique and each tag key must have one value.</p></li>
/// <li>
/// <p>Maximum number of tags per resource: 50.</p></li>
/// <li>
/// <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.</p></li>
/// <li>
/// <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p></li>
/// </ul>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p>
/// <p>The following restrictions apply to tags:</p>
/// <ul>
/// <li>
/// <p>For each resource, each tag key must be unique and each tag key must have one value.</p></li>
/// <li>
/// <p>Maximum number of tags per resource: 50.</p></li>
/// <li>
/// <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.</p></li>
/// <li>
/// <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p></li>
/// </ul>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p>
/// <p>The following restrictions apply to tags:</p>
/// <ul>
/// <li>
/// <p>For each resource, each tag key must be unique and each tag key must have one value.</p></li>
/// <li>
/// <p>Maximum number of tags per resource: 50.</p></li>
/// <li>
/// <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>
/// <li>
/// <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.</p></li>
/// <li>
/// <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p></li>
/// </ul>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`CreateExplainabilityInput`](crate::operation::create_explainability::CreateExplainabilityInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_explainability::CreateExplainabilityInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::create_explainability::CreateExplainabilityInput {
explainability_name: self.explainability_name,
resource_arn: self.resource_arn,
explainability_config: self.explainability_config,
data_source: self.data_source,
schema: self.schema,
enable_visualization: self.enable_visualization,
start_date_time: self.start_date_time,
end_date_time: self.end_date_time,
tags: self.tags,
})
}
}