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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_explainability_export::_create_explainability_export_input::CreateExplainabilityExportInputBuilder;
pub use crate::operation::create_explainability_export::_create_explainability_export_output::CreateExplainabilityExportOutputBuilder;
impl crate::operation::create_explainability_export::builders::CreateExplainabilityExportInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::create_explainability_export::CreateExplainabilityExportOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_explainability_export::CreateExplainabilityExportError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.create_explainability_export();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `CreateExplainabilityExport`.
///
/// <p>Exports an Explainability resource created by the <code>CreateExplainability</code> operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.</p>
/// <p>You must specify a <code>DataDestination</code> object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see <code>aws-forecast-iam-roles</code>.</p><note>
/// <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you can access the export in your Amazon S3 bucket. To get the status, use the <code>DescribeExplainabilityExport</code> operation.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateExplainabilityExportFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_explainability_export::builders::CreateExplainabilityExportInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::create_explainability_export::CreateExplainabilityExportOutput,
crate::operation::create_explainability_export::CreateExplainabilityExportError,
> for CreateExplainabilityExportFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::create_explainability_export::CreateExplainabilityExportOutput,
crate::operation::create_explainability_export::CreateExplainabilityExportError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl CreateExplainabilityExportFluentBuilder {
/// Creates a new `CreateExplainabilityExportFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the CreateExplainabilityExport as a reference.
pub fn as_input(&self) -> &crate::operation::create_explainability_export::builders::CreateExplainabilityExportInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::create_explainability_export::CreateExplainabilityExportOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_explainability_export::CreateExplainabilityExportError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::create_explainability_export::CreateExplainabilityExport::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::create_explainability_export::CreateExplainabilityExport::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::create_explainability_export::CreateExplainabilityExportOutput,
crate::operation::create_explainability_export::CreateExplainabilityExportError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>A unique name for the Explainability export.</p>
pub fn explainability_export_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.explainability_export_name(input.into());
self
}
/// <p>A unique name for the Explainability export.</p>
pub fn set_explainability_export_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_explainability_export_name(input);
self
}
/// <p>A unique name for the Explainability export.</p>
pub fn get_explainability_export_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_explainability_export_name()
}
/// <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
pub fn explainability_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.explainability_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
pub fn set_explainability_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_explainability_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
pub fn get_explainability_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_explainability_arn()
}
/// <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).</p>
pub fn destination(mut self, input: crate::types::DataDestination) -> Self {
self.inner = self.inner.destination(input);
self
}
/// <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).</p>
pub fn set_destination(mut self, input: ::std::option::Option<crate::types::DataDestination>) -> Self {
self.inner = self.inner.set_destination(input);
self
}
/// <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).</p>
pub fn get_destination(&self) -> &::std::option::Option<crate::types::DataDestination> {
self.inner.get_destination()
}
///
/// 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 {
self.inner = self.inner.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 set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.inner = self.inner.set_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.inner.get_tags()
}
/// <p>The format of the exported data, CSV or PARQUET.</p>
pub fn format(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.format(input.into());
self
}
/// <p>The format of the exported data, CSV or PARQUET.</p>
pub fn set_format(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_format(input);
self
}
/// <p>The format of the exported data, CSV or PARQUET.</p>
pub fn get_format(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_format()
}
}