@aws-amplify/storage

constructor

constructor(config?: StorageOptions);

• Initialize Storage with AWS configurations

  Parameter config

  Configuration object for storage

property CATEGORY

static CATEGORY: string;

property PROVIDER_NAME

static PROVIDER_NAME: string;

method configure

configure: (config?: any) => object;

• Configure Storage part with aws configuration

  Parameter config

  Configuration of the Storage {Object} - Current configuration

method get

get: (key: string, config?: any) => Promise<string | Object>;

• Get a presigned URL of the file or the object data when download:true

  Parameter key

  key of the object

  Parameter config

  - A promise resolves to Amazon S3 presigned URL on success

method getCategory

getCategory: () => string;

• get the category of the plugin

method getProviderName

getProviderName: () => string;

• get provider name of the plugin

method list

list: (path: any, config?: any) => Promise<any>;

• List bucket objects relative to the level and prefix specified

  Parameter path

  the path that contains objects

  Parameter config

  - Promise resolves to list of keys for all objects in path

method put

put: (key: string, object: any, config?: any) => Promise<Object>;

• Put a file in S3 bucket specified to configure method

  Parameter key

  key of the object

  Parameter object

  File to be put in Amazon S3 bucket

  Parameter config

  - promise resolves to object on success

method remove

remove: (key: string, config?: any) => Promise<any>;

• Remove the object for specified key

  Parameter key

  key of the object

  Parameter config

  - Promise resolves upon successful removal of the object

constructor

constructor();

• Initialize Storage

  Parameter config

  Configuration object for storage

property vault

vault: Storage;

• Modifiers

  • @public

method addPluggable

addPluggable: (pluggable: StorageProvider) => {};

• add plugin into Storage category

  Parameter pluggable

  an instance of the plugin

method cancel

cancel: (request: Promise<any>, message?: string) => void;

• Cancels an inflight request

  Parameter request

  The request to cancel

  Parameter message

  A message to include in the cancelation exception

method configure

configure: (config?: any) => any;

• Configure Storage

  Parameter config

  Configuration object for storage {Object} - Current configuration

method get

get: (key: string, config?: any) => Promise<String | Object>;

• Get a presigned URL of the file or the object data when download:true

  Parameter key

  key of the object

  Parameter config

  - A promise resolves to either a presigned url or the object

method getModuleName

getModuleName: () => string;

method getPluggable

getPluggable: (providerName: string) => StorageProvider;

• Get the plugin object

  Parameter providerName

  the name of the plugin

method isCancelError

isCancelError: (error: any) => boolean;

method list

list: (path: any, config?: any) => Promise<any>;

• List bucket objects relative to the level and prefix specified

  Parameter path

  the path that contains objects

  Parameter config

  - Promise resolves to list of keys for all objects in path

method put

put: (key: string, object: any, config?: any) => Promise<Object>;

• Put a file in storage bucket specified to configure method

  Parameter key

  key of the object

  Parameter object

  File to be put in bucket

  Parameter config

  - promise resolves to object on success

method remove

remove: (key: string, config?: any) => Promise<any>;

• Remove the object for specified key

  Parameter key

  key of the object

  Parameter config

  - Promise resolves upon successful removal of the object

method removePluggable

removePluggable: (providerName: string) => void;

• Remove the plugin object

  Parameter providerName

  the name of the plugin

property bucket

bucket?: string;

property credentials

credentials?: object;

property level

level?: string;

property region

region?: string;

method cancel

cancel: (request: Promise<any>) => void;

method configure

configure: (config: object) => object;

method get

get: (key: string, options?: any) => Promise<string | Object>;

method getCategory

getCategory: () => string;

method getProviderName

getProviderName: () => string;

method list

list: (path: any, options?: any) => Promise<any>;

method put

put: (key: string, object: any, options?: any) => Promise<Object>;

method remove

remove: (key: string, options?: any) => Promise<any>;