AWS Amplify Home
Options
All
  • Public
  • Public/Protected
  • All
Menu

Provide storage methods to use AWS S3

Hierarchy

  • AWSS3Provider

Implements

  • any

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static CATEGORY

CATEGORY: string = "Storage"

Static PROVIDER_NAME

PROVIDER_NAME: string = "AWSS3"

Methods

Private _ensureCredentials

  • _ensureCredentials(): any

configure

  • configure(config?: any): object

get

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

  • 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

getProviderName

  • getProviderName(): string

list

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

  • 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>

  • 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>

  • 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