aws_sdk_socialmessaging/client/
get_whats_app_message_media.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetWhatsAppMessageMedia`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`media_id(impl Into<String>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::media_id) / [`set_media_id(Option<String>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::set_media_id):<br>required: **true**<br><p>The unique identifier for the media file.</p><br>
7    ///   - [`origination_phone_number_id(impl Into<String>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::origination_phone_number_id) / [`set_origination_phone_number_id(Option<String>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::set_origination_phone_number_id):<br>required: **true**<br><p>The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's id.</p><br>
8    ///   - [`metadata_only(bool)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::metadata_only) / [`set_metadata_only(Option<bool>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::set_metadata_only):<br>required: **false**<br><p>Set to <code>True</code> to get only the metadata for the file.</p><br>
9    ///   - [`destination_s3_presigned_url(S3PresignedUrl)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::destination_s3_presigned_url) / [`set_destination_s3_presigned_url(Option<S3PresignedUrl>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::set_destination_s3_presigned_url):<br>required: **false**<br><p>The presign url of the media file.</p><br>
10    ///   - [`destination_s3_file(S3File)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::destination_s3_file) / [`set_destination_s3_file(Option<S3File>)`](crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::set_destination_s3_file):<br>required: **false**<br><p>The <code>bucketName</code> and <code>key</code> of the S3 media file.</p><br>
11    /// - On success, responds with [`GetWhatsAppMessageMediaOutput`](crate::operation::get_whats_app_message_media::GetWhatsAppMessageMediaOutput) with field(s):
12    ///   - [`mime_type(Option<String>)`](crate::operation::get_whats_app_message_media::GetWhatsAppMessageMediaOutput::mime_type): <p>The MIME type of the media.</p>
13    ///   - [`file_size(Option<i64>)`](crate::operation::get_whats_app_message_media::GetWhatsAppMessageMediaOutput::file_size): <p>The file size of the media, in KB.</p>
14    /// - On failure, responds with [`SdkError<GetWhatsAppMessageMediaError>`](crate::operation::get_whats_app_message_media::GetWhatsAppMessageMediaError)
15    pub fn get_whats_app_message_media(&self) -> crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder {
16        crate::operation::get_whats_app_message_media::builders::GetWhatsAppMessageMediaFluentBuilder::new(self.handle.clone())
17    }
18}