{"id":13474022,"url":"https://github.com/aws/aws-sdk-js","last_synced_at":"2025-05-14T07:07:31.919Z","repository":{"id":4553637,"uuid":"5694513","full_name":"aws/aws-sdk-js","owner":"aws","description":"AWS SDK for JavaScript in the browser and Node.js (In Maintenance Mode, End-of-Life on 09/08/2025). The AWS SDK for JavaScript v3 in the browser and Node.js is available here: https://github.com/aws/aws-sdk-js-v3","archived":false,"fork":false,"pushed_at":"2025-04-14T16:34:49.000Z","size":673466,"stargazers_count":7620,"open_issues_count":1,"forks_count":1541,"subscribers_count":234,"default_branch":"master","last_synced_at":"2025-05-07T06:38:32.522Z","etag":null,"topics":["aws","aws-sdk","javascript"],"latest_commit_sha":null,"homepage":"https://aws.amazon.com/developer/language/javascript/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aws.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2012-09-05T22:31:25.000Z","updated_at":"2025-04-18T11:17:46.000Z","dependencies_parsed_at":"2023-10-02T22:58:06.681Z","dependency_job_id":"be4e6b00-e554-4737-ae22-b0ccf69a4e9c","html_url":"https://github.com/aws/aws-sdk-js","commit_stats":{"total_commits":5656,"total_committers":224,"mean_commits":25.25,"dds":0.6854667609618105,"last_synced_commit":"b9ce3461a495dcf4f4a0be133e103d98130847a6"},"previous_names":[],"tags_count":1967,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Faws-sdk-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Faws-sdk-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Faws-sdk-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Faws-sdk-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aws","download_url":"https://codeload.github.com/aws/aws-sdk-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092648,"owners_count":22013290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-sdk","javascript"],"created_at":"2024-07-31T16:01:08.907Z","updated_at":"2025-05-14T07:07:31.875Z","avatar_url":"https://github.com/aws.png","language":"JavaScript","readme":"# AWS SDK for JavaScript\n\n[![NPM version](https://img.shields.io/npm/v/aws-sdk.svg)](https://www.npmjs.com/package/aws-sdk)\n\n## In Maintenance Mode as of September 8, 2024\n\nThe AWS SDK for JavaScript v2 [has entered][v2-maintenance-mode] maintenance mode on **September 8, 2024** and will be reaching end-of-support on **September 8, 2025**. During maintenance mode, AWS will limit SDK releases to address critical bug fixes and security issues only. The SDK will not receive API updates for new or existing services, or be updated to support new regions.\n\nWe recommend that you migrate to [AWS SDK for JavaScript v3][aws-sdk-js-v3].\nFor dates, additional details, and information on how to migrate, please refer to the linked announcement.\n\nThe **AWS SDK for JavaScript v3** is the latest and recommended version, \nwhich has been GA since December 2020. Here is [why and how you should use\n**AWS SDK for JavaScript v3**][v3-recommended-blog]. You can try our migration scripts in [aws-sdk-js-codemod][aws-sdk-js-codemod] to migrate\nyour application from v2 to v3.\n\nTo get help with your migration, please follow our general guidelines to \n[open an issue][v3-new-issue] and choose [guidance][open-issue-v3-guidance].\nTo give feedback on and report issues in the v3 repo, please refer to \n[Giving feedback and contributing][v3-contributing].\n\nWatch this README and the [AWS Developer Tools Blog][aws-devtools-blog]\nfor updates and announcements regarding the maintenance plans and timelines.\n\nA maintenance mode message may be emitted by this package on startup. \nTo suppress this message, use an environment variable:\n\n```sh\nAWS_SDK_JS_SUPPRESS_MAINTENANCE_MODE_MESSAGE=1 node my_program.js\n```\n\nor a JavaScript setting as follows:\n```js\nvar SDK = require('aws-sdk');\nrequire('aws-sdk/lib/maintenance_mode_message').suppress = true;\n```\n\n[v3-new-issue]: https://github.com/aws/aws-sdk-js-v3/issues/new?assignees=\u0026labels=needs-triage%2Cv2-v3-inconsistency\u0026projects=\u0026template=v2-to-v3-migration.yml\u0026title=MIGRATION+ISSUE%3A+%5BYour+Title+Here%5D\n[v2-maintenance-mode]: https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-javascript-v2\n[v3-recommended-blog]: https://aws.amazon.com/blogs/developer/why-and-how-you-should-use-aws-sdk-for-javascript-v3-on-node-js-18/\n[v3-contributing]: https://github.com/aws/aws-sdk-js-v3#giving-feedback-and-contributing\n[aws-sdk-js-v3]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html\n[aws-devtools-blog]: https://aws.amazon.com/blogs/developer/\n[open-issue-v3-guidance]: https://github.com/aws/aws-sdk-js-v3/issues/new?assignees=\u0026labels=guidance%2C+needs-triage\u0026template=---questions---help.md\u0026title=\n[aws-sdk-js-codemod]: https://www.npmjs.com/package/aws-sdk-js-codemod\n\n## Table of Contents:\n* [Getting Started](#getting-Started)\n* [Getting Help](#getting-help)\n* [Contributing](#contributing)\n\n## Getting Started\n\n## How To Install\n\n### In the Browser\n\nTo use the SDK in the browser, simply add the following script tag to your\nHTML pages:\n\n    \u003cscript src=\"https://sdk.amazonaws.com/js/aws-sdk-2.1692.0.min.js\"\u003e\u003c/script\u003e\n\nYou can also build a custom browser SDK with your specified set of AWS services.\nThis can allow you to reduce the SDK's size, specify different API versions of\nservices, or use AWS services that don't currently support CORS if you are\nworking in an environment that does not enforce CORS. To get started:\n\nhttp://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html\n\nThe AWS SDK is also compatible with [browserify](http://browserify.org).\n\nFor browser-based web, mobile and hybrid apps, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/?utm_source=aws-js-sdk\u0026utm_campaign=browser) which extends the AWS SDK and provides an easier and declarative interface.\n\n### In Node.js\n\nThe preferred way to install the AWS SDK for Node.js is to use the\n[npm](http://npmjs.org) package manager for Node.js. Simply type the following\ninto a terminal window:\n\n```sh\nnpm install aws-sdk\n```\n\n### In React Native\nTo use the SDK in a react native project, first install the SDK using npm:\n\n```sh\nnpm install aws-sdk\n```\n\nThen within your application, you can reference the react native compatible version of the SDK with the following:\n\n```javascript\nvar AWS = require('aws-sdk/dist/aws-sdk-react-native');\n```\n\nAlternatively, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/media/react_native_guide?utm_source=aws-js-sdk\u0026utm_campaign=react-native) which extends AWS SDK and provides React Native UI components and CLI support to work with AWS services.\n\n### Using Bower\n\nYou can also use [Bower](http://bower.io) to install the SDK by typing the\nfollowing into a terminal window:\n\n```sh\nbower install aws-sdk-js\n```\n\n## Usage with TypeScript\nThe AWS SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read `.d.ts` files.\nOur goal is to keep these TypeScript definition files updated with each release for any public api.\n\n### Pre-requisites\nBefore you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:\n\n * Use latest version of TypeScript. We recommend 4.x+\n * Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:\n\n    ```sh\n    npm install --save-dev @types/node\n    ```\n\n * If you are targeting at es5 or older ECMA standards, your `tsconfig.json` has to include `'es5'` and `'es2015.promise'` under `compilerOptions.lib`.\n See [tsconfig.json](https://github.com/aws/aws-sdk-js/blob/master/ts/tsconfig.json) for an example.\n\n### In the Browser\nTo use the TypeScript definition files with the global `AWS` object in a front-end project, add the following line to the top of your JavaScript file:\n\n```javascript\n/// \u003creference types=\"aws-sdk\" /\u003e\n```\n\nThis will provide support for the global `AWS` object.\n\n### In Node.js\nTo use the TypeScript definition files within a Node.js project, simply import `aws-sdk` as you normally would.\n\nIn a TypeScript file:\n\n```javascript\n// import entire SDK\nimport AWS from 'aws-sdk';\n// import AWS object without services\nimport AWS from 'aws-sdk/global';\n// import individual service\nimport S3 from 'aws-sdk/clients/s3';\n```\n\n**NOTE:** You need to add `\"esModuleInterop\": true` to compilerOptions of your `tsconfig.json`. If not possible, use like `import * as AWS from 'aws-sdk'`.\n\nIn a JavaScript file:\n\n```javascript\n// import entire SDK\nvar AWS = require('aws-sdk');\n// import AWS object without services\nvar AWS = require('aws-sdk/global');\n// import individual service\nvar S3 = require('aws-sdk/clients/s3');\n```\n\n### With React\n\nTo create React applications with AWS SDK, you can use [AWS Amplify Library](https://aws.github.io/aws-amplify/media/react_guide?utm_source=aws-js-sdk\u0026utm_campaign=react) which provides React components and CLI support to work with AWS services.\n\n### With Angular\nDue to the SDK's reliance on node.js typings, you may encounter compilation \n[issues](https://github.com/aws/aws-sdk-js/issues/1271) when using the\ntypings provided by the SDK in an Angular project created using the Angular CLI.\n\nTo resolve these issues, either add `\"types\": [\"node\"]` to the project's `tsconfig.app.json`\nfile, or remove the `\"types\"` field entirely.\n\n[AWS Amplify Library](https://aws.github.io/aws-amplify/media/angular_guide?utm_source=aws-js-sdk\u0026utm_campaign=angular) provides Angular components and CLI support to work with AWS services.\n\n### Known Limitations\nThere are a few known limitations with the bundled TypeScript definitions at this time:\n\n * Service client typings reflect the latest `apiVersion`, regardless of which `apiVersion` is specified when creating a client.\n * Service-bound parameters use the `any` type.\n\n# Getting Help\n\nThe best way to interact with our team is through GitHub. \nYou can [open an issue](https://github.com/aws/aws-sdk-js/issues/new/choose) and choose from one of our templates for \n[bug reports](https://github.com/aws/aws-sdk-js/issues/new?assignees=\u0026labels=bug%2C+needs-triage\u0026template=---bug-report.md\u0026title=), \n[feature requests](https://github.com/aws/aws-sdk-js/issues/new?assignees=\u0026labels=feature-request\u0026template=---feature-request.md\u0026title=) \nor [guidance](https://github.com/aws/aws-sdk-js/issues/new?assignees=\u0026labels=guidance%2C+needs-triage\u0026template=---questions---help.md\u0026title=). \nYou may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-sdk-js) with the tag #aws-sdk-js.\nIf you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.\n\nPlease make sure to check out our resources too before opening an issue:\n* Our [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/welcome.html) and [API reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/)\n* Our [Changelog](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md) for recent changes.\n* Our [code examples](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/sdk-code-samples.html).\n\nPlease see [SERVICES.md](https://github.com/aws/aws-sdk-js/blob/master/SERVICES.md) for a list of supported services.\n\n# Maintenance and support for SDK major versions\nFor information about maintenance and support for SDK major versions and their underlying dependencies, see the following in the [AWS SDKs and Tools Shared Configuration and Credentials Reference Guide](https://docs.aws.amazon.com/credref/latest/refdocs/overview.html):\n* [AWS SDKs and Tools Maintenance Policy](https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html)\n* [AWS SDKs and Tools Version Support Matrix](https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html)\n\n\n\n# Contributing\nWe welcome community contributions and pull requests. See [CONTRIBUTING.md](https://github.com/aws/aws-sdk-js/blob/master/CONTRIBUTING.md) for information on how to set up a development environment and submit code.\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE.txt and NOTICE.txt for more information.\n","funding_links":[],"categories":["JavaScript","aws","💖 Admired Examples","Amazon Web Services (AWS)","SDKs and Samples","Node JS"],"sub_categories":["JavaScript SDK"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws%2Faws-sdk-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faws%2Faws-sdk-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws%2Faws-sdk-js/lists"}