Skip to content

Commit 56104bc

Browse files
committed
docs(js): add durability options
1 parent b850c31 commit 56104bc

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

Diff for: src/pages/[platform]/build-a-backend/storage/copy-files/index.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,9 @@ Option | Type | Default | Description |
114114
| -- | :--: | :--: | ----------- |
115115
| path | string \| <br/>(\{ identityId \}) => string | Required | A string or callback that represents the path in source and destination bucket to copy the object to or from. <br /> **Each segment of the path in `source` must by URI encoded.** |
116116
| bucket | string \| <br />\{ bucketName: string;<br/> region: string; \} | Default bucket and region from Amplify configuration | A string representing the target bucket's assigned name in Amplify Backend or an object specifying the bucket name and region from the console.<br/><br/>Read more at [Configure additional storage buckets](/[platform]/build-a-backend/storage/set-up-storage/#configure-additional-storage-buckets). |
117+
| eTag | string | Optional | The copy **source object** entity tag (ETag) value. Only Copies the object if its ETag matches the specified tag. |
118+
| notModifiedSince | Date | Optional | Copies the **source object** if it hasn't been modified since the specified time. <br /><br/> **This is evaluated only when `eTag` is NOT supplied**|
119+
| expectedBucketOwner | string | Optional | The account ID that owns source or destination bucket. |
117120

118121
</InlineFilter>
119122

Diff for: src/pages/[platform]/build-a-backend/storage/download-files/index.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ const linkToStorageFile = await getUrl({
106106
expiresIn: 300,
107107
// whether to use accelerate endpoint
108108
useAccelerateEndpoint: true,
109+
// The account ID that owns the requested bucket.
110+
expectedBucketOwner: '123456789012',
109111
}
110112
});
111113
```
@@ -116,6 +118,7 @@ Option | Type | Default | Description |
116118
| validateObjectExistence | boolean | false | Whether to head object to make sure the object existence before downloading. |
117119
| expiresIn | number | 900 | Number of seconds till the URL expires. <br/><br/> The expiration time of the presigned url is dependent on the session and will max out at 1 hour. |
118120
| useAccelerateEndpoint | boolean | false | Whether to use accelerate endpoint. <br/><br/> Read more at [Transfer Acceleration](/[platform]/build-a-backend/storage/extend-s3-resources/#example---enable-transfer-acceleration) |
121+
| expectedBucketOwner | string | Optional | The account ID that owns requested bucket. |
119122

120123
</InlineFilter>
121124

@@ -1188,6 +1191,7 @@ Option | Type | Default | Description |
11881191
| onProgress | callback || Callback function tracking the upload/download progress. |
11891192
| bytesRange | \{ start: number; end:number; \} || Bytes range parameter to download a part of the file. |
11901193
| useAccelerateEndpoint | boolean | false | Whether to use accelerate endpoint.<br/><br/>Read more at [Transfer Acceleration](/[platform]/build-a-backend/storage/extend-s3-resources/#example---enable-transfer-acceleration) |
1194+
| expectedBucketOwner | string | Optional | The account ID that owns requested bucket. |
11911195

11921196
## Frequently Asked Questions
11931197

Diff for: src/pages/[platform]/build-a-backend/storage/list-files/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@ const result = await list({
240240
| nextToken | string | — | Indicates whether the list is being continued on this bucket with a token |
241241
| subpathStrategy | \{ strategy: 'include' \} \|<br/>\{ 'exclude',<br />delimiter?: string \} | \{ strategy: 'include' \} | An object representing the subpath inclusion strategy and the delimiter used to group results for exclusion. <br/><br/> Read more at [Excluding subpaths](/[platform]/build-a-backend/storage/list-files/#excluding-subpaths) |
242242
| useAccelerateEndpoint | boolean | false | Whether to use accelerate endpoint. <br/><br/> Read more at [Transfer Acceleration](/[platform]/build-a-backend/storage/extend-s3-resources/#example---enable-transfer-acceleration) |
243+
| expectedBucketOwner | string | Optional | The account ID that owns requested bucket. |
243244
244245
</InlineFilter>
245246

Diff for: src/pages/[platform]/build-a-backend/storage/remove-files/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -389,4 +389,5 @@ Future<void> remove() async {
389389
Option | Type | Default | Description |
390390
| -- | :--: | :--: | ----------- |
391391
| bucket | string \| <br />\{ bucketName: string;<br/> region: string; \} | Default bucket and region from Amplify configuration | A string representing the target bucket's assigned name in Amplify Backend or an object specifying the bucket name and region from the console.<br/><br/>Read more at [Configure additional storage buckets](/[platform]/build-a-backend/storage/set-up-storage/#configure-additional-storage-buckets) |
392+
| expectedBucketOwner | string | Optional | The account ID that owns requested bucket. |
392393
</InlineFilter>

Diff for: src/pages/[platform]/build-a-backend/storage/upload-files/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,7 @@ Option | Type | Description |
653653
| -- | -- | ----------- |
654654
| getProperties | boolean | Whether to retrieve properties for the uploaded object using theAmplify.Storage.getProperties() after the operation completes. When set to true the returned item will contain additional info such as metadata and content type. |
655655
| useAccelerateEndpoint | boolean | Whether to use accelerate endpoint. <br/><br/> Read more at [Transfer Acceleration](/[platform]/build-a-backend/storage/upload-files/#transfer-acceleration) |
656+
| expectedBucketOwner | string | Optional | The account ID that owns requested bucket. |
656657

657658
Example of `uploadFile` with options:
658659

0 commit comments

Comments
 (0)