aws_sdk_connect/operation/start_attached_file_upload/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_attached_file_upload::_start_attached_file_upload_output::StartAttachedFileUploadOutputBuilder;
3
4pub use crate::operation::start_attached_file_upload::_start_attached_file_upload_input::StartAttachedFileUploadInputBuilder;
5
6impl crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadInputBuilder {
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::start_attached_file_upload::StartAttachedFileUploadOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_attached_file_upload::StartAttachedFileUploadError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_attached_file_upload();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartAttachedFileUpload`.
24///
25/// <p>Provides a pre-signed Amazon S3 URL in response for uploading your content.</p><important>
26/// <p>You may only use this API to upload attachments to an <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Amazon Connect Case</a> or <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Amazon Connect Email</a>.</p>
27/// </important>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct StartAttachedFileUploadFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput,
37        crate::operation::start_attached_file_upload::StartAttachedFileUploadError,
38    > for StartAttachedFileUploadFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput,
46            crate::operation::start_attached_file_upload::StartAttachedFileUploadError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl StartAttachedFileUploadFluentBuilder {
53    /// Creates a new `StartAttachedFileUploadFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the StartAttachedFileUpload as a reference.
62    pub fn as_input(&self) -> &crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::start_attached_file_upload::StartAttachedFileUploadError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::start_attached_file_upload::StartAttachedFileUpload::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::start_attached_file_upload::StartAttachedFileUpload::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput,
99        crate::operation::start_attached_file_upload::StartAttachedFileUploadError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
114    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.client_token(input.into());
116        self
117    }
118    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
119    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_client_token(input);
121        self
122    }
123    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
124    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_client_token()
126    }
127    /// <p>The unique identifier of the Amazon Connect instance.</p>
128    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.instance_id(input.into());
130        self
131    }
132    /// <p>The unique identifier of the Amazon Connect instance.</p>
133    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_instance_id(input);
135        self
136    }
137    /// <p>The unique identifier of the Amazon Connect instance.</p>
138    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_instance_id()
140    }
141    /// <p>A case-sensitive name of the attached file being uploaded.</p>
142    pub fn file_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.file_name(input.into());
144        self
145    }
146    /// <p>A case-sensitive name of the attached file being uploaded.</p>
147    pub fn set_file_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_file_name(input);
149        self
150    }
151    /// <p>A case-sensitive name of the attached file being uploaded.</p>
152    pub fn get_file_name(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_file_name()
154    }
155    /// <p>The size of the attached file in bytes.</p>
156    pub fn file_size_in_bytes(mut self, input: i64) -> Self {
157        self.inner = self.inner.file_size_in_bytes(input);
158        self
159    }
160    /// <p>The size of the attached file in bytes.</p>
161    pub fn set_file_size_in_bytes(mut self, input: ::std::option::Option<i64>) -> Self {
162        self.inner = self.inner.set_file_size_in_bytes(input);
163        self
164    }
165    /// <p>The size of the attached file in bytes.</p>
166    pub fn get_file_size_in_bytes(&self) -> &::std::option::Option<i64> {
167        self.inner.get_file_size_in_bytes()
168    }
169    /// <p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>
170    pub fn url_expiry_in_seconds(mut self, input: i32) -> Self {
171        self.inner = self.inner.url_expiry_in_seconds(input);
172        self
173    }
174    /// <p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>
175    pub fn set_url_expiry_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
176        self.inner = self.inner.set_url_expiry_in_seconds(input);
177        self
178    }
179    /// <p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>
180    pub fn get_url_expiry_in_seconds(&self) -> &::std::option::Option<i32> {
181        self.inner.get_url_expiry_in_seconds()
182    }
183    /// <p>The use case for the file.</p><important>
184    /// <p>Only <code>ATTACHMENTS</code> are supported.</p>
185    /// </important>
186    pub fn file_use_case_type(mut self, input: crate::types::FileUseCaseType) -> Self {
187        self.inner = self.inner.file_use_case_type(input);
188        self
189    }
190    /// <p>The use case for the file.</p><important>
191    /// <p>Only <code>ATTACHMENTS</code> are supported.</p>
192    /// </important>
193    pub fn set_file_use_case_type(mut self, input: ::std::option::Option<crate::types::FileUseCaseType>) -> Self {
194        self.inner = self.inner.set_file_use_case_type(input);
195        self
196    }
197    /// <p>The use case for the file.</p><important>
198    /// <p>Only <code>ATTACHMENTS</code> are supported.</p>
199    /// </important>
200    pub fn get_file_use_case_type(&self) -> &::std::option::Option<crate::types::FileUseCaseType> {
201        self.inner.get_file_use_case_type()
202    }
203    /// <p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p><note>
204    /// <p>This value must be a valid ARN.</p>
205    /// </note>
206    pub fn associated_resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
207        self.inner = self.inner.associated_resource_arn(input.into());
208        self
209    }
210    /// <p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p><note>
211    /// <p>This value must be a valid ARN.</p>
212    /// </note>
213    pub fn set_associated_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
214        self.inner = self.inner.set_associated_resource_arn(input);
215        self
216    }
217    /// <p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p><note>
218    /// <p>This value must be a valid ARN.</p>
219    /// </note>
220    pub fn get_associated_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
221        self.inner.get_associated_resource_arn()
222    }
223    /// <p>Represents the identity that created the file.</p>
224    pub fn created_by(mut self, input: crate::types::CreatedByInfo) -> Self {
225        self.inner = self.inner.created_by(input);
226        self
227    }
228    /// <p>Represents the identity that created the file.</p>
229    pub fn set_created_by(mut self, input: ::std::option::Option<crate::types::CreatedByInfo>) -> Self {
230        self.inner = self.inner.set_created_by(input);
231        self
232    }
233    /// <p>Represents the identity that created the file.</p>
234    pub fn get_created_by(&self) -> &::std::option::Option<crate::types::CreatedByInfo> {
235        self.inner.get_created_by()
236    }
237    ///
238    /// Adds a key-value pair to `Tags`.
239    ///
240    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
241    ///
242    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
243    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
244        self.inner = self.inner.tags(k.into(), v.into());
245        self
246    }
247    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
248    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
249        self.inner = self.inner.set_tags(input);
250        self
251    }
252    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
253    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
254        self.inner.get_tags()
255    }
256}