aws_sdk_textract/operation/create_adapter_version/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_adapter_version::_create_adapter_version_output::CreateAdapterVersionOutputBuilder;
3
4pub use crate::operation::create_adapter_version::_create_adapter_version_input::CreateAdapterVersionInputBuilder;
5
6impl crate::operation::create_adapter_version::builders::CreateAdapterVersionInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::create_adapter_version::CreateAdapterVersionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_adapter_version::CreateAdapterVersionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_adapter_version();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateAdapterVersion`.
24///
25/// <p>Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateAdapterVersionFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::create_adapter_version::builders::CreateAdapterVersionInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::create_adapter_version::CreateAdapterVersionOutput,
35 crate::operation::create_adapter_version::CreateAdapterVersionError,
36 > for CreateAdapterVersionFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::create_adapter_version::CreateAdapterVersionOutput,
44 crate::operation::create_adapter_version::CreateAdapterVersionError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl CreateAdapterVersionFluentBuilder {
51 /// Creates a new `CreateAdapterVersionFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the CreateAdapterVersion as a reference.
60 pub fn as_input(&self) -> &crate::operation::create_adapter_version::builders::CreateAdapterVersionInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::create_adapter_version::CreateAdapterVersionOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::create_adapter_version::CreateAdapterVersionError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::create_adapter_version::CreateAdapterVersion::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::create_adapter_version::CreateAdapterVersion::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::create_adapter_version::CreateAdapterVersionOutput,
97 crate::operation::create_adapter_version::CreateAdapterVersionError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>A string containing a unique ID for the adapter that will receive a new version.</p>
112 pub fn adapter_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.adapter_id(input.into());
114 self
115 }
116 /// <p>A string containing a unique ID for the adapter that will receive a new version.</p>
117 pub fn set_adapter_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_adapter_id(input);
119 self
120 }
121 /// <p>A string containing a unique ID for the adapter that will receive a new version.</p>
122 pub fn get_adapter_id(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_adapter_id()
124 }
125 /// <p>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
126 pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.client_request_token(input.into());
128 self
129 }
130 /// <p>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
131 pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_client_request_token(input);
133 self
134 }
135 /// <p>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
136 pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_client_request_token()
138 }
139 /// <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.</p>
140 pub fn dataset_config(mut self, input: crate::types::AdapterVersionDatasetConfig) -> Self {
141 self.inner = self.inner.dataset_config(input);
142 self
143 }
144 /// <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.</p>
145 pub fn set_dataset_config(mut self, input: ::std::option::Option<crate::types::AdapterVersionDatasetConfig>) -> Self {
146 self.inner = self.inner.set_dataset_config(input);
147 self
148 }
149 /// <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.</p>
150 pub fn get_dataset_config(&self) -> &::std::option::Option<crate::types::AdapterVersionDatasetConfig> {
151 self.inner.get_dataset_config()
152 }
153 /// <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
154 pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155 self.inner = self.inner.kms_key_id(input.into());
156 self
157 }
158 /// <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
159 pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160 self.inner = self.inner.set_kms_key_id(input);
161 self
162 }
163 /// <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
164 pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
165 self.inner.get_kms_key_id()
166 }
167 /// <p>Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.</p>
168 /// <p><code>OutputConfig</code> is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the <code>KMSKeyID</code> parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
169 /// <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a></p>
170 /// <p>For more information on data privacy, see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy FAQ</a>.</p>
171 pub fn output_config(mut self, input: crate::types::OutputConfig) -> Self {
172 self.inner = self.inner.output_config(input);
173 self
174 }
175 /// <p>Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.</p>
176 /// <p><code>OutputConfig</code> is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the <code>KMSKeyID</code> parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
177 /// <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a></p>
178 /// <p>For more information on data privacy, see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy FAQ</a>.</p>
179 pub fn set_output_config(mut self, input: ::std::option::Option<crate::types::OutputConfig>) -> Self {
180 self.inner = self.inner.set_output_config(input);
181 self
182 }
183 /// <p>Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.</p>
184 /// <p><code>OutputConfig</code> is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With <code>OutputConfig</code> enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the <code>KMSKeyID</code> parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.</p>
185 /// <p>Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a></p>
186 /// <p>For more information on data privacy, see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy FAQ</a>.</p>
187 pub fn get_output_config(&self) -> &::std::option::Option<crate::types::OutputConfig> {
188 self.inner.get_output_config()
189 }
190 ///
191 /// Adds a key-value pair to `Tags`.
192 ///
193 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
194 ///
195 /// <p>A set of tags (key-value pairs) that you want to attach to the adapter version.</p>
196 pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
197 self.inner = self.inner.tags(k.into(), v.into());
198 self
199 }
200 /// <p>A set of tags (key-value pairs) that you want to attach to the adapter version.</p>
201 pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
202 self.inner = self.inner.set_tags(input);
203 self
204 }
205 /// <p>A set of tags (key-value pairs) that you want to attach to the adapter version.</p>
206 pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
207 self.inner.get_tags()
208 }
209}