AWSS3Provider | amplify-js

Provide storage methods to use AWS S3

Hierarchy

AWSS3Provider

Implements

StorageProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AWSS3Provider(config?: StorageOptions): AWSS3Provider

- Defined in packages/storage/src/Providers/AWSS3Provider.ts:62
Initialize Storage with AWS configurations

Parameters
- Optional config: StorageOptions
  
  Configuration object for storage
Returns AWSS3Provider

Properties

Static CATEGORY

CATEGORY: string = "Storage"

Static PROVIDER_NAME

PROVIDER_NAME: string = "AWSS3"

Methods

Private _ensureCredentials

_ensureCredentials(): any

- Defined in packages/storage/src/Providers/AWSS3Provider.ts:434
Returns any

configure

configure(config?: any): object

- Defined in packages/storage/src/Providers/AWSS3Provider.ts:92
Configure Storage part with aws configuration

Parameters
- Optional config: any
  
  Configuration of the Storage
Returns object
- Current configuration

get

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

Implementation of StorageProvider.get
- Defined in packages/storage/src/Providers/AWSS3Provider.ts:110
Get a presigned URL of the file or the object data when download:true

Parameters
- key: string
  
  key of the object
- Optional config: any
Returns Promise<String | Object>
- A promise resolves to Amazon S3 presigned URL on success

getCategory

getCategory(): string

Implementation of StorageProvider.getCategory
- Defined in packages/storage/src/Providers/AWSS3Provider.ts:76
get the category of the plugin

Returns string

getProviderName

getProviderName(): string

Implementation of StorageProvider.getProviderName
- Defined in packages/storage/src/Providers/AWSS3Provider.ts:83
get provider name of the plugin

Returns string

list

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

Implementation of StorageProvider.list
- Defined in packages/storage/src/Providers/AWSS3Provider.ts:376
List bucket objects relative to the level and prefix specified

Parameters
- path: any
  
  the path that contains objects
- Optional config: any
Returns Promise<any>
- Promise resolves to list of keys for all objects in path

put

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

Implementation of StorageProvider.put
- Defined in packages/storage/src/Providers/AWSS3Provider.ts:212
Put a file in S3 bucket specified to configure method

Parameters
- key: string
  
  key of the object
- object: any
  
  File to be put in Amazon S3 bucket
- Optional config: any
Returns Promise<Object>
- promise resolves to object on success

remove

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

Implementation of StorageProvider.remove
- Defined in packages/storage/src/Providers/AWSS3Provider.ts:326
Remove the object for specified key

Parameters
- key: string
  
  key of the object
- Optional config: any
Returns Promise<any>
- Promise resolves upon successful removal of the object