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:89
Initialize Storage with AWS configurations

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

Properties

Static Readonly CATEGORY

CATEGORY: "Storage" = "Storage"

Static Readonly PROVIDER_NAME

PROVIDER_NAME: "AWSS3" = "AWSS3"

Methods

configure

configure(config?: any): object

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

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

copy

copy(src: S3CopySource, dest: S3CopyDestination, config?: S3ProviderCopyConfig, userAgentValue?: string): Promise<S3ProviderCopyOutput>

- Defined in packages/storage/src/providers/AWSS3Provider.ts:238
Copy an object from a source object to a new object within the same bucket. Can optionally copy files across different level or identityId (if source object's level is 'protected').

async

Parameters
- src: S3CopySource
  
  Key and optionally access level and identityId of the source object.
- dest: S3CopyDestination
  
  Key and optionally access level of the destination object.
- Optional config: S3ProviderCopyConfig
- Optional userAgentValue: string
  
  Optional string containing custom user agent value
Returns Promise<S3ProviderCopyOutput>

The key of the copied object.

get

get<T>(key: string, config?: T, userAgentValue?: string): Promise<S3ProviderGetOuput<T>>

- Defined in packages/storage/src/providers/AWSS3Provider.ts:354
Get a presigned URL of the file or the object data when download:true

Type parameters
- T: S3ProviderGetConfig & StorageOptions
Parameters
- key: string
  
  key of the object
- Optional config: T
- Optional userAgentValue: string
  
  Optional string containing custom user agent value
Returns Promise<S3ProviderGetOuput<T>>
- A promise resolves to Amazon S3 presigned URL or the GetObjectCommandOutput if download is set to true on success

getCategory

getCategory(): string

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

Returns string

getProperties

getProperties(key: string, config?: S3ProviderGetPropertiesConfig, userAgentValue?: string): Promise<S3ProviderGetPropertiesOutput>

- Defined in packages/storage/src/providers/AWSS3Provider.ts:516
Get Properties of the object

Parameters
- key: string
  
  key of the object
- Optional config: S3ProviderGetPropertiesConfig
- Optional userAgentValue: string
  
  Optional string containing custom user agent value
Returns Promise<S3ProviderGetPropertiesOutput>
- A promise resolves to contentType, contentLength, eTag, lastModified, metadata

getProviderName

getProviderName(): "AWSS3"

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

Returns "AWSS3"

list

list(path: string, config?: S3ProviderListConfig, userAgentValue?: string): Promise<S3ProviderListOutput>

- Defined in packages/storage/src/providers/AWSS3Provider.ts:817
List bucket objects relative to the level and prefix specified

Parameters
- path: string
  
  the path that contains objects
- Optional config: S3ProviderListConfig
- Optional userAgentValue: string
  
  Optional string containing custom user agent value
Returns Promise<S3ProviderListOutput>
- Promise resolves to list of keys, eTags, lastModified and file size for all objects in path

put

put<T>(key: string, object: PutObjectInput["Body"], config?: T, userAgentValue?: string): S3ProviderPutOutput<T>

- Defined in packages/storage/src/providers/AWSS3Provider.ts:596
Put a file in S3 bucket specified to configure method

Type parameters
- T: S3ProviderPutConfig
Parameters
- key: string
  
  key of the object
- object: PutObjectInput["Body"]
  
  File to be put in Amazon S3 bucket
- Optional config: T
- Optional userAgentValue: string
  
  Optional string containing custom user agent value
Returns S3ProviderPutOutput<T>

an instance of AWSS3UploadTask or a promise that resolves to an object with the new object's key on success.

remove

remove(key: string, config?: S3ProviderRemoveConfig, userAgentValue?: string): Promise<S3ProviderRemoveOutput>

- Defined in packages/storage/src/providers/AWSS3Provider.ts:737
Remove the object for specified key

Parameters
- key: string
  
  key of the object
- Optional config: S3ProviderRemoveConfig
- Optional userAgentValue: string
  
  Optional string containing custom user agent value
Returns Promise<S3ProviderRemoveOutput>
- Promise resolves upon successful removal of the object

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config: StorageOptions

Returns AWSS3Provider

Properties

Static Readonly CATEGORY

Static Readonly PROVIDER_NAME

Methods

configure

Parameters

Optional config: any

Returns object

copy

Parameters

src: S3CopySource

dest: S3CopyDestination

Optional config: S3ProviderCopyConfig

Optional userAgentValue: string

Returns Promise<S3ProviderCopyOutput>

get

Type parameters

T: S3ProviderGetConfig & StorageOptions

Parameters

key: string

Optional config: T

Optional userAgentValue: string

Returns Promise<S3ProviderGetOuput<T>>

getCategory

Returns string

getProperties

Parameters

key: string

Optional config: S3ProviderGetPropertiesConfig

Optional userAgentValue: string

Returns Promise<S3ProviderGetPropertiesOutput>

getProviderName

Returns "AWSS3"

list

Parameters

path: string

Optional config: S3ProviderListConfig

Optional userAgentValue: string

Returns Promise<S3ProviderListOutput>

put

Type parameters

T: S3ProviderPutConfig

Parameters

key: string

object: PutObjectInput["Body"]

Optional config: T

Optional userAgentValue: string

Returns S3ProviderPutOutput<T>

remove

Parameters

key: string

Optional config: S3ProviderRemoveConfig

Optional userAgentValue: string

Returns Promise<S3ProviderRemoveOutput>