aws_api for Deno
From-scratch Typescript AWS API client built for Deno.
A leading focus of this library is to be as lean as possible
on the number of files downloaded to use a specific service.
Thereās no single entrypoint; youāll need to make an ApiFactory
and then pass it to the service you want to use.
Package layout:
client/: A handwritten generic AWS API client (credentials, signing, etc)encoding/: Shared modules for dealing with XML, JSON, & querystringsservices/: Generated Typescript classes and interfaces for all supported AWS servicesdemo.ts: A trivial example of using this libraryexamples/: Several full examples of using individual servicesSERVICES.md: A complete list of all AWS APIs and their build status
Only some services have completed clients at this time.
Please reach out on Github Issues about missing clients or API issues,
or ping dantheman#8546 in the Deno Discord if you just wanna chat about this effort.
Usage
Basic example: (see demo.ts for several more services)
import {ApiFactory} from 'https://deno.land/x/aws_api/client/mod.ts';
const factory = new ApiFactory();
import STS from 'https://deno.land/x/aws_api/services/sts@2011-06-15/mod.ts';
const sts = new STS(factory);
const identity = await sts.getCallerIdentity();
console.log('You are', identity.UserId, 'in account', identity.Account);
console.log('Identity ARN:', identity.Arn);A couple more-detailed examples are in examples/ and show concepts such as
managing an EC2 instanceās lifecycle, redriving SQS messages,
and working directly with a Kinesis stream.
Disclaimer
This is NOT a port of the official AWS SDK JS. Lots of services are still not bound, and the services that are bound might have issues.
Do not use this module in mission critical stuff. Itās supposed to be for automation scripts, quick & dirty pieces of infrastructure, and prototype microservices and so on.
If you just want the real, full-fat AWS SDK, a port of it has been uploaded at /x/aws_sdk.
Finally, the APIs within client/ and encoding/ are liable to change.
For best upgradability, stick to making an ApiFactory object
and passing it to the services.
At some point (around 1.0.0?) the APIs should be ready to lock in.
Methodology
All of the clients are compiled from aws-sdk-jsās JSON data files.
The code to generate clients isnāt uploaded to /x/,
so if you want to read through it, make sure youāre in the Git repo.
āMostā of the heavy lifting (such as compiling waiter JMESPaths) runs in the generation step so that the modules on /x/ are ready to run.
Completeness
The following clients have been successfully used in scripts and should work quite well:
- SQS
- STS
- EC2
- Kinesis
The following credential sources are supported:
- Environment variables
- Static credentials in
~/.aws/credentials - EKS Pod Identity (web identity token files)
Some individual features that are implemented:
- Waiters (as
.waitForXYZ({...})) - Automatic credential loading
Multiple bits are missing:
- Automatic pagination
- AssumeRole credentials
- EC2 instance metadata, and instance credentials
- Credential chaining
- Services with REST or XML protocols
- Debug logging/tracing of API calls
- Automatic retries
- AWS endpoints other than
**.amazonaws.com(govcloud, China AWS, etc)
List of Typechecked API Clients
All API definitions are current as of aws-sdk-js v2.768.0.
| Class | Module | Protocol | File size | Approx check time |
|---|---|---|---|---|
| MigrationHub | AWSMigrationHub@2017-05-31.ts |
json | 19 KiB | 0.9 sec |
| ACMPCA | acm-pca@2017-08-22.ts |
json | 27 KiB | 0.8 sec |
| AlexaForBusiness | alexaforbusiness@2017-11-09.ts |
json | 107 KiB | 1.5 sec |
| ApplicationAutoScaling | application-autoscaling@2016-02-06.ts |
json | 25 KiB | 0.8 sec |
| Athena | athena@2017-05-18.ts |
json | 35 KiB | 0.9 sec |
| AutoScaling | autoscaling@2011-01-01.ts |
query | 101 KiB | 1.2 sec |
| AutoScalingPlans | autoscaling-plans@2018-01-06.ts |
json | 22 KiB | 0.9 sec |
| Budgets | budgets@2016-10-20.ts |
json | 21 KiB | 0.8 sec |
| CostExplorer | ce@2017-10-25.ts |
json | 77 KiB | 1.4 sec |
| Cloud9 | cloud9@2017-09-23.ts |
json | 14 KiB | 0.7 sec |
| CloudFormation | cloudformation@2010-05-15.ts |
query | 126 KiB | 2.1 sec |
| CloudHSM | cloudhsm@2014-05-30.ts |
json | 17 KiB | 0.8 sec |
| CloudHSMV2 | cloudhsmv2@2017-04-28.ts |
json | 15 KiB | 0.8 sec |
| CloudSearch | cloudsearch@2011-02-01.ts |
query | 34 KiB | 0.9 sec |
| CloudSearch | cloudsearch@2013-01-01.ts |
query | 57 KiB | 1.1 sec |
| CloudTrail | cloudtrail@2013-11-01.ts |
json | 23 KiB | 1.1 sec |
| CodeCommit | codecommit@2015-04-13.ts |
json | 95 KiB | 1.5 sec |
| CodePipeline | codepipeline@2015-07-09.ts |
json | 61 KiB | 1.1 sec |
| CodeStar | codestar@2017-04-19.ts |
json | 19 KiB | 1.0 sec |
| CodeStarconnections | codestar-connections@2019-12-01.ts |
json | 11 KiB | 0.7 sec |
| CognitoIdentityServiceProvider | cognito-idp@2016-04-18.ts |
json | 132 KiB | 1.8 sec |
| Comprehend | comprehend@2017-11-27.ts |
json | 88 KiB | 1.2 sec |
| ComprehendMedical | comprehendmedical@2018-10-30.ts |
json | 34 KiB | 0.9 sec |
| ComputeOptimizer | compute-optimizer@2019-11-01.ts |
json | 23 KiB | 0.8 sec |
| ConfigService | config@2014-11-12.ts |
json | 128 KiB | 1.4 sec |
| CUR | cur@2017-01-06.ts |
json | 8 KiB | 0.7 sec |
| DataPipeline | datapipeline@2012-10-29.ts |
json | 21 KiB | 1.2 sec |
| DataSync | datasync@2018-11-09.ts |
json | 42 KiB | 1.8 sec |
| DAX | dax@2017-04-19.ts |
json | 25 KiB | 1.0 sec |
| Discovery | discovery@2015-11-01.ts |
json | 32 KiB | 0.9 sec |
| DocDB | docdb@2014-10-31.ts |
query | 86 KiB | 1.2 sec |
| DirectoryService | ds@2015-04-16.ts |
json | 64 KiB | 1.3 sec |
| DynamoDB | dynamodb@2011-12-05.ts |
json | 23 KiB | 0.8 sec |
| DynamoDB | dynamodb@2012-08-10.ts |
json | 100 KiB | 1.3 sec |
| EC2 | ec2@2016-11-15.ts |
ec2 | 1024 KiB | 4.2 sec |
| EC2InstanceConnect | ec2-instance-connect@2018-04-02.ts |
json | 2 KiB | 0.7 sec |
| ElastiCache | elasticache@2015-02-02.ts |
query | 132 KiB | 1.4 sec |
| ElasticBeanstalk | elasticbeanstalk@2010-12-01.ts |
query | 99 KiB | 1.8 sec |
| ELB | elasticloadbalancing@2012-06-01.ts |
query | 48 KiB | 1.0 sec |
| ELBv2 | elasticloadbalancingv2@2015-12-01.ts |
query | 76 KiB | 1.6 sec |
| EMR | elasticmapreduce@2009-03-31.ts |
json | 96 KiB | 1.8 sec |
| SES | email@2010-12-01.ts |
query | 97 KiB | 1.5 sec |
| MarketplaceEntitlementService | entitlement.marketplace@2017-01-11.ts |
json | 3 KiB | 0.7 sec |
| EventBridge | eventbridge@2015-10-07.ts |
json | 37 KiB | 0.9 sec |
| CloudWatchEvents | events@2015-10-07.ts |
json | 37 KiB | 1.4 sec |
| Firehose | firehose@2015-08-04.ts |
json | 62 KiB | 1.0 sec |
| ForecastService | forecast@2018-06-26.ts |
json | 44 KiB | 1.2 sec |
| ForecastQueryService | forecastquery@2018-06-26.ts |
json | 2 KiB | 0.8 sec |
| FraudDetector | frauddetector@2019-11-15.ts |
json | 55 KiB | 1.0 sec |
| FSx | fsx@2018-03-01.ts |
json | 36 KiB | 1.1 sec |
| GameLift | gamelift@2015-10-01.ts |
json | 120 KiB | 1.6 sec |
| GlobalAccelerator | globalaccelerator@2018-08-08.ts |
json | 27 KiB | 1.5 sec |
| Health | health@2016-08-04.ts |
json | 22 KiB | 0.9 sec |
| IAM | iam@2010-05-08.ts |
query | 165 KiB | 1.6 sec |
| IdentityStore | identitystore@2020-06-15.ts |
json | 5 KiB | 0.7 sec |
| ImportExport | importexport@2010-06-01.ts |
query | 11 KiB | 0.8 sec |
| IoTSecureTunneling | iotsecuretunneling@2018-10-05.ts |
json | 9 KiB | 0.7 sec |
| IoTThingsGraph | iotthingsgraph@2018-09-06.ts |
json | 40 KiB | 1.4 sec |
| Kendra | kendra@2019-02-03.ts |
json | 67 KiB | 1.1 sec |
| Kinesis | kinesis@2013-12-02.ts |
json | 28 KiB | 0.8 sec |
| KMS | kms@2014-11-01.ts |
json | 44 KiB | 0.9 sec |
| LakeFormation | lakeformation@2017-03-31.ts |
json | 22 KiB | 0.9 sec |
| LicenseManager | license-manager@2018-08-01.ts |
json | 25 KiB | 0.8 sec |
| Macie | macie@2017-12-19.ts |
json | 9 KiB | 0.9 sec |
| MarketplaceCommerceAnalytics | marketplacecommerceanalytics@2015-07-01.ts |
json | 4 KiB | 0.7 sec |
| MediaStore | mediastore@2017-09-01.ts |
json | 17 KiB | 0.8 sec |
| MarketplaceMetering | meteringmarketplace@2016-01-14.ts |
json | 5 KiB | 0.7 sec |
| MigrationHubConfig | migrationhub-config@2019-06-30.ts |
json | 4 KiB | 1.0 sec |
| CloudWatch | monitoring@2010-08-01.ts |
query | 59 KiB | 1.1 sec |
| MTurk | mturk-requester@2017-01-17.ts |
json | 46 KiB | 1.3 sec |
| Neptune | neptune@2014-10-31.ts |
query | 129 KiB | 1.8 sec |
| OpsWorksCM | opsworkscm@2016-11-01.ts |
json | 23 KiB | 0.8 sec |
| Organizations | organizations@2016-11-28.ts |
json | 48 KiB | 1.2 sec |
| Personalize | personalize@2018-05-22.ts |
json | 60 KiB | 1.3 sec |
| PI | pi@2018-02-27.ts |
json | 6 KiB | 0.9 sec |
| Pricing | pricing@2017-10-15.ts |
json | 4 KiB | 0.8 sec |
| QLDBSession | qldb-session@2019-07-11.ts |
json | 8 KiB | 0.8 sec |
| RDS | rds@2013-01-10.ts |
query | 93 KiB | 1.2 sec |
| RDS | rds@2013-02-12.ts |
query | 100 KiB | 1.4 sec |
| RDS | rds@2013-09-09.ts |
query | 108 KiB | 1.3 sec |
| RDS | rds@2014-09-01.ts |
query | 111 KiB | 1.8 sec |
| RDS | rds@2014-10-31.ts |
query | 301 KiB | 2.2 sec |
| Redshift | redshift@2012-12-01.ts |
query | 176 KiB | 1.8 sec |
| ResourceGroupsTaggingAPI | resourcegroupstaggingapi@2017-01-26.ts |
json | 10 KiB | 0.9 sec |
| Route53Domains | route53domains@2014-05-15.ts |
json | 39 KiB | 1.0 sec |
| Route53Resolver | route53resolver@2018-04-01.ts |
json | 38 KiB | 1.4 sec |
| SageMaker | sagemaker@2017-07-24.ts |
json | 328 KiB | 2.1 sec |
| SimpleDB | sdb@2009-04-15.ts |
query | 13 KiB | 0.9 sec |
| SecretsManager | secretsmanager@2017-10-17.ts |
json | 20 KiB | 0.9 sec |
| ServiceQuotas | service-quotas@2019-06-24.ts |
json | 20 KiB | 0.8 sec |
| Shield | shield@2016-06-02.ts |
json | 24 KiB | 0.8 sec |
| SMS | sms@2016-10-24.ts |
json | 55 KiB | 1.0 sec |
| Snowball | snowball@2016-06-30.ts |
json | 30 KiB | 0.9 sec |
| SNS | sns@2010-03-31.ts |
query | 31 KiB | 0.9 sec |
| SQS | sqs@2012-11-05.ts |
query | 28 KiB | 0.9 sec |
| SSM | ssm@2014-11-06.ts |
json | 223 KiB | 1.9 sec |
| SSOAdmin | sso-admin@2020-07-20.ts |
json | 29 KiB | 0.9 sec |
| StepFunctions | states@2016-11-23.ts |
json | 43 KiB | 0.9 sec |
| StorageGateway | storagegateway@2013-06-30.ts |
json | 85 KiB | 1.4 sec |
| DynamoDBStreams | streams.dynamodb@2012-08-10.ts |
json | 10 KiB | 1.0 sec |
| STS | sts@2011-06-15.ts |
query | 14 KiB | 0.8 sec |
| Support | support@2013-04-15.ts |
json | 19 KiB | 1.1 sec |
| SWF | swf@2012-01-25.ts |
json | 101 KiB | 1.2 sec |
| Textract | textract@2018-06-27.ts |
json | 14 KiB | 0.8 sec |
| TimestreamQuery | timestream-query@2018-11-01.ts |
json | 6 KiB | 0.9 sec |
| TimestreamWrite | timestream-write@2018-11-01.ts |
json | 14 KiB | 0.7 sec |
| TranscribeService | transcribe@2017-10-26.ts |
json | 40 KiB | 0.9 sec |
| Transfer | transfer@2018-11-05.ts |
json | 22 KiB | 0.8 sec |
| Translate | translate@2017-07-01.ts |
json | 15 KiB | 0.8 sec |
| WAF | waf@2015-08-24.ts |
json | 90 KiB | 1.3 sec |
| WAFRegional | waf-regional@2016-11-28.ts |
json | 93 KiB | 2.1 sec |
| WAFV2 | wafv2@2019-07-29.ts |
json | 71 KiB | 1.4 sec |
| WorkMail | workmail@2017-10-01.ts |
json | 44 KiB | 1.0 sec |
| WorkSpaces | workspaces@2015-04-08.ts |
json | 63 KiB | 1.0 sec |
The check time column is a measurement of how long deno check on the file ran for on my laptop, with a sample size of 1.