chore: Add transfer acceleration documentation for plugin options (#3125

)
aws-amplify · Aug 4, 2023 · 3bf204a · 3bf204a
1 parent 3c03eb7
commit 3bf204a
Showing 1 changed file with 17 additions and 3 deletions.
diff --git a/Amplify/Categories/Storage/Operation/Request/StorageDownloadDataRequest.swift b/Amplify/Categories/Storage/Operation/Request/StorageDownloadDataRequest.swift
@@ -51,12 +51,26 @@ public extension StorageDownloadDataRequest {
         /// a way to utilize the underlying storage system's functionality. See plugin documentation for expected
         /// key/values
         ///
+        /// As an example, if using the AWSS3StoragePlugin, one may be want to add something like the
+        /// following (please note that `useAccelerateEndpoint`
+        /// [should first be setup](https://docs.amplify.aws/lib/storage/transfer-acceleration/q/platform/js/),
+        /// otherwise, requests will fail):
+        ///
+        /// ```
+        ///  let options = StorageDownloadDataRequest.Options(
+        ///      pluginOptions: [
+        ///          "useAccelerateEndpoint": true
+        ///      ]
+        ///  )
+        /// ```
+        ///
+        /// # Reference
+        /// * [Storage - Use Transfer Acceleration](https://docs.amplify.aws/lib/storage/transfer-acceleration/q/platform/js/)
+        /// * [Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html)
+        ///
         /// - Tag: StorageDownloadDataRequestOptions.pluginOptions
         public let pluginOptions: Any?
 
-        // TODO: transferAcceleration should be in pluginOptions
-        // https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
-
         ///
         /// - Tag: StorageDownloadDataRequestOptions.init
         public init(accessLevel: StorageAccessLevel = .guest,