aws-sdk-support 1.113.0

AWS SDK for AWS Support
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAttachmentUploadLinks`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`file_name(impl Into<String>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::file_name) / [`set_file_name(Option<String>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::set_file_name):<br>required: **true**<br><p>The name of the file to upload, including the file extension. This value is required when you initiate a new upload.</p><br>
    ///   - [`file_size_bytes(i64)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::file_size_bytes) / [`set_file_size_bytes(Option<i64>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::set_file_size_bytes):<br>required: **false**<br><p>The total size of the file in bytes. The service uses this value to calculate the total number of parts and the size of each part. Required when you initiate a new upload (when <code>uploadId</code> isn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB).</p><br>
    ///   - [`upload_id(impl Into<String>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::upload_id) / [`set_upload_id(Option<String>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::set_upload_id):<br>required: **false**<br><p>The unique identifier of an in-progress multipart upload, returned by a previous call to <code>GetAttachmentUploadLinks</code>. Specify <code>uploadId</code> to retrieve additional presigned upload URLs for an upload that has already been initiated. Required when <code>fileSizeBytes</code> isn't provided. Length: 1 to 2,048 characters.</p><br>
    ///   - [`upload_range(UploadRange)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::upload_range) / [`set_upload_range(Option<UploadRange>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::set_upload_range):<br>required: **false**<br><p>The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::set_dry_run):<br>required: **false**<br><p>Specifies whether to validate the request without actually generating upload URLs. When set to <code>true</code>, the request is validated but no URLs are returned, and the operation returns a <code>DryRunOperationException</code>. When omitted or set to <code>false</code>, the request runs normally.</p><br>
    /// - On success, responds with [`GetAttachmentUploadLinksOutput`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksOutput) with field(s):
    ///   - [`upload_id(String)`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksOutput::upload_id): <p>The unique identifier for the multipart upload. Use this value in subsequent calls to <code>GetAttachmentUploadLinks</code>, <code>DescribeAttachmentUploadStatus</code>, and <code>CompleteAttachmentUpload</code>, and to attach the upload to a case through the <code>uploadIds</code> parameter on <code>CreateCase</code> or <code>AddCommunicationToCase</code>.</p>
    ///   - [`part_size_bytes(i64)`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksOutput::part_size_bytes): <p>The size, in bytes, of each part. Split the file into parts of this size before you upload them to the presigned URLs. For an upload with <code>n</code> total parts, parts 1 through <code>n</code> - 1 are exactly this size; the last part may be smaller. Maximum: 104,857,600 bytes (approximately 100 MB).</p>
    ///   - [`total_parts(i32)`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksOutput::total_parts): <p>The total number of parts that the file is split into. Upload one part to each presigned URL.</p>
    ///   - [`next_index(i32)`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksOutput::next_index): <p>The next part index to request presigned URLs for. If all upload URLs for the file have been returned, this field is <code>null</code>. Use this value as the <code>startIndex</code> in <code>uploadRange</code> on a subsequent call to <code>GetAttachmentUploadLinks</code> to retrieve the next batch of upload URLs.</p>
    ///   - [`upload_urls(Vec::<UploadUrl>)`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksOutput::upload_urls): <p>The list of presigned upload URLs for the requested range of parts. The list contains at most 10 URLs per call. Upload each part to its corresponding URL by using HTTP <code>PUT</code> before the URL expires.</p>
    /// - On failure, responds with [`SdkError<GetAttachmentUploadLinksError>`](crate::operation::get_attachment_upload_links::GetAttachmentUploadLinksError)
    pub fn get_attachment_upload_links(&self) -> crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder {
        crate::operation::get_attachment_upload_links::builders::GetAttachmentUploadLinksFluentBuilder::new(self.handle.clone())
    }
}