aws_sdk_connect/client/
start_attached_file_upload.rs

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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartAttachedFileUpload`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_instance_id):<br>required: **true**<br><p>The unique identifier of the Amazon Connect instance.</p><br>
    ///   - [`file_name(impl Into<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::file_name) / [`set_file_name(Option<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_file_name):<br>required: **true**<br><p>A case-sensitive name of the attached file being uploaded.</p><br>
    ///   - [`file_size_in_bytes(i64)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::file_size_in_bytes) / [`set_file_size_in_bytes(Option<i64>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_file_size_in_bytes):<br>required: **true**<br><p>The size of the attached file in bytes.</p><br>
    ///   - [`url_expiry_in_seconds(i32)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::url_expiry_in_seconds) / [`set_url_expiry_in_seconds(Option<i32>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_url_expiry_in_seconds):<br>required: **false**<br><p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p><br>
    ///   - [`file_use_case_type(FileUseCaseType)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::file_use_case_type) / [`set_file_use_case_type(Option<FileUseCaseType>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_file_use_case_type):<br>required: **true**<br><p>The use case for the file.</p><important>  <p>Only <code>ATTACHMENTS</code> are supported.</p> </important><br>
    ///   - [`associated_resource_arn(impl Into<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::associated_resource_arn) / [`set_associated_resource_arn(Option<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_associated_resource_arn):<br>required: **true**<br><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>  <p>This value must be a valid ARN.</p> </note><br>
    ///   - [`created_by(CreatedByInfo)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::created_by) / [`set_created_by(Option<CreatedByInfo>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_created_by):<br>required: **false**<br><p>Represents the identity that created the file.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::set_tags):<br>required: **false**<br><p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p><br>
    /// - On success, responds with [`StartAttachedFileUploadOutput`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput) with field(s):
    ///   - [`file_arn(Option<String>)`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput::file_arn): <p>The unique identifier of the attached file resource (ARN).</p>
    ///   - [`file_id(Option<String>)`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput::file_id): <p>The unique identifier of the attached file resource.</p>
    ///   - [`creation_time(Option<String>)`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput::creation_time): <p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2024-05-03T02:41:28.172Z</code>.</p>
    ///   - [`file_status(Option<FileStatusType>)`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput::file_status): <p>The current status of the attached file.</p>
    ///   - [`created_by(Option<CreatedByInfo>)`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput::created_by): <p>Represents the identity that created the file.</p>
    ///   - [`upload_url_metadata(Option<UploadUrlMetadata>)`](crate::operation::start_attached_file_upload::StartAttachedFileUploadOutput::upload_url_metadata): <p>The headers to be provided while uploading the file to the URL.</p>
    /// - On failure, responds with [`SdkError<StartAttachedFileUploadError>`](crate::operation::start_attached_file_upload::StartAttachedFileUploadError)
    pub fn start_attached_file_upload(&self) -> crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder {
        crate::operation::start_attached_file_upload::builders::StartAttachedFileUploadFluentBuilder::new(self.handle.clone())
    }
}