aws_sdk_connect/client/
get_attached_file.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 [`GetAttachedFile`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::set_instance_id):<br>required: **true**<br><p>The unique identifier of the Amazon Connect instance.</p><br>
    ///   - [`file_id(impl Into<String>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::file_id) / [`set_file_id(Option<String>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::set_file_id):<br>required: **true**<br><p>The unique identifier of the attached file resource.</p><br>
    ///   - [`url_expiry_in_seconds(i32)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::url_expiry_in_seconds) / [`set_url_expiry_in_seconds(Option<i32>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::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>
    ///   - [`associated_resource_arn(impl Into<String>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::associated_resource_arn) / [`set_associated_resource_arn(Option<String>)`](crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::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>
    /// - On success, responds with [`GetAttachedFileOutput`](crate::operation::get_attached_file::GetAttachedFileOutput) with field(s):
    ///   - [`file_arn(Option<String>)`](crate::operation::get_attached_file::GetAttachedFileOutput::file_arn): <p>The unique identifier of the attached file resource (ARN).</p>
    ///   - [`file_id(Option<String>)`](crate::operation::get_attached_file::GetAttachedFileOutput::file_id): <p>The unique identifier of the attached file resource.</p>
    ///   - [`creation_time(Option<String>)`](crate::operation::get_attached_file::GetAttachedFileOutput::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::get_attached_file::GetAttachedFileOutput::file_status): <p>The current status of the attached file.</p>
    ///   - [`file_name(Option<String>)`](crate::operation::get_attached_file::GetAttachedFileOutput::file_name): <p>A case-sensitive name of the attached file being uploaded.</p>
    ///   - [`file_size_in_bytes(i64)`](crate::operation::get_attached_file::GetAttachedFileOutput::file_size_in_bytes): <p>The size of the attached file in bytes.</p>
    ///   - [`associated_resource_arn(Option<String>)`](crate::operation::get_attached_file::GetAttachedFileOutput::associated_resource_arn): <p>The resource to which the attached file is (being) uploaded to. <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Cases</a> are the only current supported resource.</p>
    ///   - [`file_use_case_type(Option<FileUseCaseType>)`](crate::operation::get_attached_file::GetAttachedFileOutput::file_use_case_type): <p>The use case for the file.</p>
    ///   - [`created_by(Option<CreatedByInfo>)`](crate::operation::get_attached_file::GetAttachedFileOutput::created_by): <p>Represents the identity that created the file.</p>
    ///   - [`download_url_metadata(Option<DownloadUrlMetadata>)`](crate::operation::get_attached_file::GetAttachedFileOutput::download_url_metadata): <p>URL and expiry to be used when downloading the attached file.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_attached_file::GetAttachedFileOutput::tags): <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    /// - On failure, responds with [`SdkError<GetAttachedFileError>`](crate::operation::get_attached_file::GetAttachedFileError)
    pub fn get_attached_file(&self) -> crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder {
        crate::operation::get_attached_file::builders::GetAttachedFileFluentBuilder::new(self.handle.clone())
    }
}