\n
Dependency<\/h2>\n<\/div><\/div>\n\n\n\n
The dependency is this: @aws-sdk\/client-s3<\/code><\/p>\n\n\n\nImports for our example<\/p>\n\n\n\n
import<\/span> {\n DeleteObjectCommand,\n DeleteObjectCommandInput,\n GetObjectCommand,\n GetObjectCommandInput,\n PutObjectCommand,\n S3Client\n} from '@aws-sdk\/client-s3'<\/span>\nimport<\/span> fs from 'fs'<\/span>\n<\/pre><\/div>\n\n\n\nClient instance<\/h2>\n\n\n\n
An instance of the client is needed for any access, and here is how you create an instance of the client:<\/p>\n\n\n\n
const<\/span> getClient = () : S3Client =>{\n \/\/ Set your AWS credentials from environment variables<\/span>\n const<\/span> accessKeyId = process.env['key'<\/span>]!!;\n const<\/span> secretAccessKey = process.env['secret'<\/span>]!!;\n\n const<\/span> endpoint: string<\/span> = 'https:\/\/us-east-1.linodeobjects.com'<\/span>;\n const<\/span> region: string<\/span> = 'us-east-1'<\/span>;\n\n \/\/ Configure the S3 client<\/span>\n const<\/span> credentials = {secretAccessKey, accessKeyId}\n return<\/span> new<\/span> S3Client({region, endpoint, credentials});\n}\n<\/pre><\/div>\n\n\n\nNote that the credentials are taken from the environment. No environment means the implementation looks in the normal places where AWS configuration is found. Note the endpoint, this makes the difference between going to Amazon or to an alternate cloud provider. In our case it is Linode<\/p>\n\n\n\n
Uploading object<\/h2>\n\n\n\n
Don’t pay attention to the fs dependency: we have an example here of how to upload a file, however any stream of data can be processed the same<\/p>\n\n\n\n
const<\/span> putObject = async () => {\n const<\/span> s3Client = getClient();\n const<\/span> bucketName = 'bucket-storage'<\/span>;\n const<\/span> filePath = 'c:\\\\temp\\\\alfa.dat'<\/span>; \/\/ Change this to the path of your file<\/span>\n const<\/span> fileStream = fs.createReadStream(filePath);\n\n \/\/ Specify the parameters for the upload<\/span>\n const<\/span> uploadParams = {\n Bucket: bucketName<\/span>,\n Key: 'alfa.dat'<\/span>, \/\/ Set the key (file name) under which you want to store the file in S3<\/span>\n Body: fileStream<\/span>,\n };\n\n const<\/span> command = new<\/span> PutObjectCommand(uploadParams);\n const<\/span> response = await s3Client.send(command);\n console.log(response);\n}\n<\/pre><\/div>\n\n\n\nDelete object<\/h2>\n\n\n\nconst<\/span> deleteObject = async() => {\n const<\/span> s3Client = getClient();\n const<\/span> bucketName = 'bucket-storage'<\/span>;\n\n \/\/ Specify the parameters for the upload<\/span>\n const<\/span> deleteObjectParam : DeleteObjectCommandInput<\/span> = {\n Bucket: bucketName<\/span>,\n Key: 'alfa.dat'<\/span>\n };\n\n const<\/span> command = new<\/span> DeleteObjectCommand(deleteObjectParam);\n const<\/span> response = await s3Client.send(command);\n console.log(response);\n}\n<\/pre><\/div>\n\n\n\nGet object<\/h2>\n\n\n\n
Note that the object comes in chunks so it has to be processed asynchronously; this eliminates the need to get all the data, putting it in temporary storage and then take it from there<\/p>\n\n\n\n
const<\/span> getObject = async () => {\n const<\/span> s3Client = getClient();\n const<\/span> bucketName = 'bucket-storage'<\/span>;\n\n const<\/span> getObjectParam : GetObjectCommandInput<\/span> = {\n Bucket: bucketName<\/span>,\n Key: 'alfa.dat'<\/span>\n }\n\n const<\/span> command: GetObjectCommand<\/span> = new<\/span> GetObjectCommand(getObjectParam);\n const<\/span> response = await s3Client.send(command);\n const<\/span> body = response.Body!!;\n\n const<\/span> fileStream = fs.createWriteStream('c:\\\\temp\\\\info.dat'<\/span>)\n await processBody(body, (chunk) => {fileStream.write(chunk)});\n fileStream.close();\n}\n\nconst<\/span> processBody = async (body: any<\/span>, callback: (bytes: Uint8Array<\/span>) => void<\/span>) : Promise<void<\/span>> => {\n return<\/span> new<\/span> Promise((resolve, reject) => {\n body.on('data'<\/span>, (chunk: Uint8Array<\/span>) => {\n callback(chunk);\n });\n\n body.once('end'<\/span>, () => {\n resolve()\n })\n\n body.once('error'<\/span>, (err : any<\/span>) => {\n reject(err)\n })\n });\n}\n<\/pre><\/div>\n\n\n\nIn this case, method processBody actually listens to the events that are triggered by the response.Body and assist in processing them asynchronously. <\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
This is about how operations are performed using AWS JavaScript libraries to access AWS S3 or similar services.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-138","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/coding101.xyz\/index.php?rest_route=\/wp\/v2\/posts\/138","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/coding101.xyz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/coding101.xyz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/coding101.xyz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/coding101.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=138"}],"version-history":[{"count":11,"href":"https:\/\/coding101.xyz\/index.php?rest_route=\/wp\/v2\/posts\/138\/revisions"}],"predecessor-version":[{"id":151,"href":"https:\/\/coding101.xyz\/index.php?rest_route=\/wp\/v2\/posts\/138\/revisions\/151"}],"wp:attachment":[{"href":"https:\/\/coding101.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=138"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/coding101.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=138"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/coding101.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=138"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}