Global Navigation

  • Products
  • Overview
  • Getting Started
  • Guides
  • Resources
  • Console

Table of Contents

  • Introduction
    • App Builder Overview
    • What is App Builder
    • Business Case
    • FAQ
    • Community
  • Quick Start
    • App Builder Getting Started
      • Setting Up
      • Creating your First App
      • Publishing Your App
      • Troubleshooting
    • Runtime Getting Started
      • Overview
      • Activations
      • Deploy
      • Entities
      • How Runtime Works
      • Resources
      • Setup
      • Understanding Runtime
  • Develop
    • References
    • App Builder Guides
      • Architecture Overview
        • App Hooks
        • Introduction to React Spectrum
        • Using SDKs
      • Application State
      • Application Logging
        • Azure Log Analytics
        • New Relic
        • Splunk Cloud
        • Splunk Enterprise
      • Configuration
        • Webpack Configuration
      • Deployment
        • CI/CD for App Builder Apps
        • Credential Rotation
        • Setting Response Headers
      • Development
      • Distribution
      • Events
        • Webhooks
      • Exc App
        • Interfaces
          • Modules
          • Page ObjectWithHref
          • Page ObjectWithPath
          • Page PageAPI
          • Page PageAPIProperties
          • Runtime
          • TopBar Callback
          • TopBar CustomFeedbackConfig
          • TopBar CustomSearchConfig
          • TopBar ExternalFeedbackConfig
          • TopBar HelpCenterFeedbackConfig
          • TopBar Solution
          • TopBar TopBarAPI
          • TopBar TopBarAPIProperties
          • User UserAPI
          • User UserInfo
        • Migrate App to Exp Cloud SPA
        • Modules
          • Page
          • TopBar
          • User
      • Extensions
        • Extension Migration Guide
      • Optimization
      • Security
        • Understanding Authentication
      • Telemetry
    • Runtime Guides
      • Contribution Guide
      • Asynchronous Calls
      • Creating Actions
      • Creating REST APIs
      • CI/CD Pipeline
      • Debugging
      • Logging & Monitoring
      • Reference Docs
        • API Reference
        • CLI Usage
        • Configuring Proxy
        • Environment Variables
        • Feeds
        • Multiple Regions
        • Packages
        • Prepackages
        • Runtimes
        • Sequences & Compositions
        • Triggers & Rules
        • WSK Usage
      • Security General
      • Securing Web Actions
      • System Settings
      • Throughput Tuning
      • Tools
        • CLI Install
      • Troubleshooting
      • Using Packages
      • Using Runtime
    • Contribution Guide
  • Learning
    • Asset Compute Worker PS API
      • Requirements
      • Lesson 1: Create an app from Asset Compute template
      • Lesson 2: Configure the app
      • Lesson 3: Develop worker calling Photoshop API
      • Lesson 4: Integrate worker in AEMaaCS
      • Well done
    • Barcode Reader
      • Requirements
      • Lesson 1: Bootstrap a Headless App
      • Lesson 2: Writing a Serverless Action
      • Lesson 3: Unit and E2E Tests
      • Well done
    • Blog Articles
      • Blog Articles
    • CI/CD
      • Requirements
      • Lesson 1: Setup CI/CD
      • Lesson 2: Monitoring CI/CD
      • Lesson 3: Custom CI/CD workflow
      • Well done
    • Cron Jobs
      • Requirements
      • Lesson 1: Bootstrap a Headless App
      • Lesson 2: Set up Alarm Feed with Trigger and Rule
      • Lesson 3: Types of Alarm Feed
      • Well done
    • Custom Asset Compute Worker
      • Requirements
      • How AEM as Cloud assets works
      • Architecture of our worker
      • Configure services
      • Local environment setup
      • Implement the worker
      • Test the worker
      • Setup AEM to use the worker
      • Well Done
    • Customer Dashboard
      • Requirements
      • Lesson 1: Create a New App Builder App from Campaign Standard Template
      • Lesson 2: Explore the App Builder App
      • Lesson 3: Run the App Builder App Locally
      • Lesson 4: List All Customer Profiles on the UI
      • Lesson 5: Add Personalized Promotion Emails Triggering
      • Well Done
    • Debugging
      • Requirements
      • Lesson 1: Getting familiar with Debugger
      • Lesson 2: Debugging Application Code
      • Lesson 3: Managing Application Logs
      • Well Done
    • Event Driven
      • Requirements
      • Lesson 1: Create a New App Builder App from Template
      • Lesson 2: Register the App as Event Provider
      • Lesson 3: Fire an Event
      • Lesson 4: Consume Events
      • Well Done
    • Events Runtime
      • Requirements
      • Lesson 1: Step by Step Guide
      • Lesson 2: Verify the result
      • Well done
    • Journaling Events
      • Requirements
      • Lesson 1: Create an Event Provider using App Builder
      • Lesson 2: Create the Event Consumer using Journaling API
      • Lesson 3: End to end test
      • Well done
    • Sample Apps
      • Code Snippets
        • Caching HTTP responses
        • App Builder Files SDK
        • App Builder State SDK
        • I/O Events handler
        • Real-time data from Adobe Analytics API 1.4
    • Spectrum Introduction
      • Lesson 1: What is Spectrum ?
      • Lesson 2: Using Spectrum CSS
      • Lesson 3: Using React Spectrum
      • Lesson 4: Using React Spectrum in App Builder
      • Well done
    • Todo App
      • Requirements
      • Lesson 1: Create a New App Builder App with the React Spectrum template
      • Lesson 2: Setup Runtime actions
      • Lesson 3: Setup the CreateTodoList component
      • Lesson 4: Setup the Todo component
      • Lesson 5: Setup the TodoList component
      • Lesson 6: Bringing the pieces together to build the App
      • Well done
    • Videos
      • Overview
        • Introducing App Builder
        • Getting Started
        • Architecture
        • A Full Security Overview
        • User Journey
      • Exploring
        • Projects and Workspaces
        • React Spectrum
        • Custom Events
        • CI/CD
        • Debugging
        • Learning Resources
        • Dashboard Case Study
        • ODE Case Study
        • Deep Dive Use Cases
        • Live Wired Sneak
        • Softcrylic Partner Showcase
      • Developers Live
        • App Builder Deep Dive
        • Asset Compute Service Extensibility
        • Extend Adobe Experience Cloud
  1. Products
  2. Overview
  3. Resources
  4. Learning
  5. Sample Apps
  6. Code Snippets
  7. App Builder Files SDK

App Builder Files SDK

Demonstrates how to return a list of files stored with the Files SDK

/** * Return a list of files stored with the Files SDK * * Sample curl request: * curl --location --request GET 'https://my-namespace.adobeioruntime.net/api/v1/web/my-app-0.0.1/listfiles' * * You could add the query param "path" to reduce the scope of results within a directory. */ const { Core, Files } = require('@adobe/aio-sdk') const { errorResponse, stringParameters, checkMissingRequestInputs } = require('../../utils') // main function that will be executed by Adobe I/O Runtime async function main (params) { // create a Logger const logger = Core.Logger('main', { level: params.LOG_LEVEL || 'info' }) try { // 'info' is the default level if not set logger.info('Calling the main action') // log parameters, only if params.LOG_LEVEL === 'debug' logger.debug(stringParameters(params)) // check for missing request input parameters and headers const requiredParams = ['path'] const requiredHeaders = [] const errorMessage = checkMissingRequestInputs(params, requiredParams, requiredHeaders) if (errorMessage) { // return and log client errors return errorResponse(400, errorMessage, logger) } const files = await Files.init() const fileList = await files.list(params.path) logger.debug(fileList) const response = { headers: {}, body: { fileList }, statusCode: 200 } // log the response status code logger.info(`${response.statusCode}: successful request`) return response } catch (error) { // log any server errors logger.error(error) // return with 500 return errorResponse(500, 'server error', logger) } } exports.main = main

Return a presigned URL of a private file from the Files SDK

/** * Return a presigned URL of a private file from the Files SDK * * Sample curl request: * curl --location --request GET 'https://my-namespace.adobeioruntime.net/api/v1/web/my-app-0.0.1/downloadfile-presigned?fileLocation=/mydir/test.csv' */ const { Core, Files } = require('@adobe/aio-sdk') const { errorResponse, stringParameters, checkMissingRequestInputs } = require('../../utils') // main function that will be executed by Adobe I/O Runtime async function main (params) { // create a Logger const logger = Core.Logger('main', { level: params.LOG_LEVEL || 'info' }) try { // 'info' is the default level if not set logger.info('Calling the main action') // log parameters, only if params.LOG_LEVEL === 'debug' logger.debug(stringParameters(params)) // check for missing request input parameters and headers const requiredParams = ['fileLocation'] const requiredHeaders = [] const errorMessage = checkMissingRequestInputs(params, requiredParams, requiredHeaders) if (errorMessage) { // return and log client errors return errorResponse(400, errorMessage, logger) } const files = await Files.init() const presignUrl = await files.generatePresignURL(params.fileLocation, { expiryInSeconds: 60 }) logger.debug(presignUrl) const response = { headers: {}, body: { presignUrl }, statusCode: 200 } // log the response status code logger.info(`${response.statusCode}: successful request`) return response } catch (error) { // log any server errors logger.error(error) // return with 500 return errorResponse(500, 'server error', logger) } } exports.main = main

Return a file from the Files SDK with Redirect

/** * Return a file from the Files SDK with Redirect */ const { Core, Files } = require('@adobe/aio-sdk') const { errorResponse, stringParameters, checkMissingRequestInputs } = require('../../utils') // main function that will be executed by Adobe I/O Runtime async function main (params) { // create a Logger const logger = Core.Logger('main', { level: params.LOG_LEVEL || 'info' }) try { // 'info' is the default level if not set logger.info('Calling the main action') // log parameters, only if params.LOG_LEVEL === 'debug' logger.debug(stringParameters(params)) // check for missing request input parameters and headers const requiredParams = ['fileLocation'] const requiredHeaders = [] const errorMessage = checkMissingRequestInputs(params, requiredParams, requiredHeaders) if (errorMessage) { // return and log client errors return errorResponse(400, errorMessage, logger) } const files = await Files.init() // Generate a presigned URL of the file that is valid for 60 seconds only const presignUrl = await files.generatePresignURL(params.fileLocation, { expiryInSeconds: 60 }) logger.debug(presignUrl) const response = { headers: { location: presignUrl }, statusCode: 302 } // log the response status code logger.info(`${response.statusCode}: successful request`) return response } catch (error) { // log any server errors logger.error(error) // return with 500 return errorResponse(500, 'server error', logger) } } exports.main = main

Upload a file to the Files SDK

/** * Upload a file to the Files SDK * * Sample curl request: * curl --location --request POST 'https://my-namespace.adobeioruntime.net/api/v1/web/my-app-0.0.1/uploadfile' \ * --header 'Content-Type: application/json' \ * --data-raw '{ * "fileUrl": "https://url.of.file", * "fileLocation": "/mydir/test.csv" * }' */ const { Core, Files } = require('@adobe/aio-sdk') const fetch = require('node-fetch') const { errorResponse, getBearerToken, stringParameters, checkMissingRequestInputs } = require('../../utils') // main function that will be executed by Adobe I/O Runtime async function main (params) { // create a Logger const logger = Core.Logger('main', { level: params.LOG_LEVEL || 'info' }) try { // 'info' is the default level if not set logger.info('Calling the main action') // log parameters, only if params.LOG_LEVEL === 'debug' logger.debug(stringParameters(params)) // check for missing request input parameters and headers const requiredParams = ['fileUrl', 'fileLocation'] const requiredHeaders = [] const errorMessage = checkMissingRequestInputs(params, requiredParams, requiredHeaders) if (errorMessage) { // return and log client errors return errorResponse(400, errorMessage, logger) } const originalFile = await fetch(params.fileUrl) const files = await Files.init() logger.info('File SDK init done') const fileLocation = params.fileLocation await files.write(fileLocation, originalFile.body) const props = await files.getProperties(fileLocation) logger.debug(JSON.stringify(props)) const response = { statusCode: 200, body: {} } // log the response status code logger.info(`${response.statusCode}: successful request`) return response } catch (error) { // log any server errors logger.error(error) // return with 500 return errorResponse(500, 'server error', logger) } } exports.main = main