31:[] 2f:{"title":"AWS S3 private file access","cells":[{"id":0,"value":"md`# AWS S3 private file access`","pinned":false,"hidden":false,"mode":"ojs"},{"id":289,"value":"This is a quick example to show how you can access a file from a private S3 bucket. Thanks to [Aaron Kyle Dennis](https://observablehq.com/@aaronkyle) for his [helpful notebook](https://observablehq.com/@categorise/secured-s3-connections) that explained most of this.","pinned":false,"hidden":false,"mode":"md"},{"id":288,"value":"AWS_Note = note(htl.html`Note: If you are getting started with AWS S3, take a look at our AWS S3 API Starter template.`)","pinned":false,"hidden":false,"mode":"ojs"},{"id":121,"value":"md`### 1. Load the AWS SDK from npm... \n(Version 2.794.0 has worked previously.)`","pinned":false,"hidden":false,"mode":"ojs"},{"id":17,"value":"//AWS = require('aws-amplify@3.3.14/dist/aws-amplify.js')\n//AWS = require('aws-sdk@2.824.0/dist/aws-sdk-react-native.js')\nAWS = require('aws-sdk@2.794.0/dist/aws-sdk-react-native.js')","pinned":false,"hidden":false,"mode":"ojs"},{"id":184,"value":"md`### 2. Set up your AWS credentials. \nIf this is a private notebook (personal or in a team space) you should not use this method, but rather use [Secrets](https://observablehq.com/@observablehq/secrets). This method is shown to demonstrate sharing the notebook outside the team.`","pinned":false,"hidden":false,"mode":"ojs"},{"id":27,"value":"viewof accessKeyID = secret(\"AWSaccessKeyID\", {\n description:\n \"This is your Access Key whose value is only available to you!\",\n submit: \"Set\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":29,"value":"viewof secretAccessKey = secret(\"AWSsecretAccessKey\", {\n description:\n \"This is your Secret whose value is only available to you!\",\n submit: \"Set\"\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":230,"value":"md`### 3. Configure AWS\nSet the credentials and region in the AWS object`","pinned":false,"hidden":false,"mode":"ojs"},{"id":156,"value":"credentials = AWS.config.credentials = \n new AWS.Credentials(localStorage[\"AWSaccessKeyId\"], localStorage[\"AWSsecretAccessKey\"])","pinned":true,"hidden":false,"mode":"ojs"},{"id":158,"value":"region = AWS.config.region = 'us-west-1'","pinned":true,"hidden":false,"mode":"ojs"},{"id":100,"value":"awsConfig = AWS.config.update({\n accessKeyId: localStorage[\"AWSaccessKeyID\"],\n secretAccessKey: localStorage[\"AWSsecretAccessKey\"],\n region: region\n });","pinned":true,"hidden":false,"mode":"ojs"},{"id":236,"value":"md`### 4. Create an S3 object`","pinned":false,"hidden":false,"mode":"ojs"},{"id":56,"value":"s3 = {\n // call credentials and region here to make sure those are set before creating the S3 object\n credentials;\n region;\n return new AWS.S3({apiVersion: '2006-03-01'})\n}","pinned":true,"hidden":false,"mode":"ojs"},{"id":240,"value":"md`### 5. Request a file from a bucket\nMake sure that you have CORS enabled for https://yourusername.static.observableusercontent.com in the S3 bucket permissions`","pinned":false,"hidden":false,"mode":"ojs"},{"id":199,"value":"viewof bucket = Text({label: \"Bucket name\", value: \"observable-demo-misc\"})","pinned":false,"hidden":false,"mode":"ojs"},{"id":211,"value":"viewof file = Text({label: \"File name\", value: \"testing.txt\"})","pinned":false,"hidden":false,"mode":"ojs"},{"id":171,"value":"objectParams = ({\n Bucket : bucket,\n Key : file\n });","pinned":false,"hidden":false,"mode":"ojs"},{"id":278,"value":"s3.getObject(objectParams)","pinned":true,"hidden":false,"mode":"ojs"},{"id":253,"value":"md`### 6. See the contents of your file!\nIn this case it is a text file, so the data is converted to a string.`","pinned":false,"hidden":false,"mode":"ojs"},{"id":284,"value":"errorNote = note(htl.html`Note: If no Access Key and Secret are entered (as specified in earlier steps), a TypeError will appear below.`)","pinned":false,"hidden":false,"mode":"ojs"},{"id":168,"value":"s3.getObject(objectParams)\n .promise()\n .then((json) => json.Body.toString('utf-8'))","pinned":false,"hidden":false,"mode":"ojs"},{"id":34,"value":"md`## Appendix\npinning the versions to ensure consistent behavior`","pinned":false,"hidden":false,"mode":"ojs"},{"id":25,"value":"import {secret} from \"@tmcw/secret@155\"","pinned":false,"hidden":false,"mode":"ojs"},{"id":194,"value":"import {Text} from \"@observablehq/inputs@426\"","pinned":false,"hidden":false,"mode":"ojs"},{"id":283,"value":"// 2022.06: Fabian Iwand's suggested improvement for Note:\nnote = {\n const scope = DOM.uid(\"note\").id;\n const style = document.head.appendChild(htl.html`