Page updated Nov 16, 2023

List files

You can list all of the objects uploaded under a given prefix by setting the pageSize. If the pageSize is set lower than the total file size available, A single Storage.list call only returns a subset of all the files. To list all the files with multiple calls, the user can use the nextToken from the previous call response.

This will list all public files:

StoragePagedListOptions options = StoragePagedListOptions.builder() .setPageSize(1000) .build(); Amplify.Storage.list( "", options, result -> { for (StorageItem item : result.getItems()) { Log.i("MyAmplifyApp", "Item: " + item.getKey()); } Log.i("MyAmplifyApp", "Next Token: " + result.getNextToken()); }, error -> Log.e("MyAmplifyApp", "List failure", error); );
1StoragePagedListOptions options = StoragePagedListOptions.builder()
2 .setPageSize(1000)
3 .build();
4
5Amplify.Storage.list(
6 "",
7 options,
8 result -> {
9 for (StorageItem item : result.getItems()) {
10 Log.i("MyAmplifyApp", "Item: " + item.getKey());
11 }
12 Log.i("MyAmplifyApp", "Next Token: " + result.getNextToken());
13 },
14 error -> Log.e("MyAmplifyApp", "List failure", error);
15);
Note: The range of pageSize can be from 1 - 1000.

You can also list private or protected files by passing options. For example, to list all protected files owned by a user identified by the ID otherUserID:

StoragePagedListOptions options = StoragePagedListOptions.builder() .accessLevel(StorageAccessLevel.PROTECTED) .targetIdentityId("otherUserID") .setPageSize(1000) .build(); Amplify.Storage.list( "", options, result -> { for (StorageItem item : result.getItems()) { Log.i("MyAmplifyApp", "Item: " + item.getKey()); } Log.i("MyAmplifyApp", "Next Token: " + result.getNextToken()); }, error -> Log.e("MyAmplifyApp", "List failure", error); );
1StoragePagedListOptions options = StoragePagedListOptions.builder()
2 .accessLevel(StorageAccessLevel.PROTECTED)
3 .targetIdentityId("otherUserID")
4 .setPageSize(1000)
5 .build();
6
7Amplify.Storage.list(
8 "",
9 options,
10 result -> {
11 for (StorageItem item : result.getItems()) {
12 Log.i("MyAmplifyApp", "Item: " + item.getKey());
13 }
14 Log.i("MyAmplifyApp", "Next Token: " + result.getNextToken());
15 },
16 error -> Log.e("MyAmplifyApp", "List failure", error);
17);