UNPKG

1.24 kBTypeScriptView Raw
1import { ListAllInput, ListPaginateInput, ListAllOutput, ListPaginateOutput } from '../types';
2type ListApi = {
3 /**
4 * List files with given prefix in pages
5 * pageSize defaulted to 1000. Additionally, the result will include a nextToken if there are more items to retrieve.
6 * @param input - The ListPaginateInput object.
7 * @returns A list of keys and metadata with
8 * @throws service: {@link S3Exception} - S3 service errors thrown when checking for existence of bucket
9 * @throws validation: {@link StorageValidationErrorCode } - thrown when there are issues with credentials
10 */
11 (input?: ListPaginateInput): Promise<ListPaginateOutput>;
12 /**
13 * List all files from S3. You can set `listAll` to true in `options` to get all the files from S3.
14 * @param input - The ListAllInput object.
15 * @returns A list of keys and metadata for all objects in path
16 * @throws service: {@link S3Exception} - S3 service errors thrown when checking for existence of bucket
17 * @throws validation: {@link StorageValidationErrorCode } - thrown when there are issues with credentials
18 */
19 (input?: ListAllInput): Promise<ListAllOutput>;
20};
21export declare const list: ListApi;
22export {};