Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1377 from jeskew/docs/generate-service-list-to-se…
…parate-file Generate the list of services supported by the SDK to a separate file.
- Loading branch information
Showing
5 changed files
with
161 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| The SDK currently supports the following services: | ||
|
|
||
| <p class="note"><strong>Note</strong>: | ||
| Although all services are supported in the browser version of the SDK, | ||
| not all of the services are available in the default hosted build (using the | ||
| script tag provided above). Instructions on how to build a | ||
| custom version of the SDK with individual services are provided | ||
| in the "<a href="http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html">Building the SDK for Browsers</a>" section of the SDK Developer Guide. | ||
| </p> | ||
|
|
||
| Service Name | Class Name | API Version | Allows CORS | | ||
| ------------ | ---------- | ----------- | ----------- | | ||
| AWS Certificate Manager | AWS.ACM | 2015-12-08 | :tada: | | ||
| Amazon API Gateway | AWS.APIGateway | 2015-07-09 | :tada: | | ||
| Application Auto Scaling | AWS.ApplicationAutoScaling | 2016-02-06 | :tada: | | ||
| Amazon AppStream | AWS.AppStream | 2016-12-01 | | | ||
| Auto Scaling | AWS.AutoScaling | 2011-01-01 | :tada: | | ||
| AWS Batch | AWS.Batch | 2016-08-10 | | | ||
| AWS Budgets | AWS.Budgets | 2016-10-20 | | | ||
| Amazon CloudDirectory | AWS.CloudDirectory | 2016-05-10 | | | ||
| AWS CloudFormation | AWS.CloudFormation | 2010-05-15 | :tada: | | ||
| Amazon CloudFront | AWS.CloudFront | 2016-11-25 | :tada: | | ||
| Amazon CloudHSM | AWS.CloudHSM | 2014-05-30 | :tada: | | ||
| Amazon CloudSearch | AWS.CloudSearch | 2013-01-01 | | | ||
| Amazon CloudSearch | AWS.CloudSearch | 2011-02-01 | | | ||
| Amazon CloudSearch Domain | AWS.CloudSearchDomain | 2013-01-01 | | | ||
| AWS CloudTrail | AWS.CloudTrail | 2013-11-01 | :tada: | | ||
| Amazon CloudWatch | AWS.CloudWatch | 2010-08-01 | :tada: | | ||
| Amazon CloudWatch Events | AWS.CloudWatchEvents | 2015-10-07 | :tada: | | ||
| Amazon CloudWatch Logs | AWS.CloudWatchLogs | 2014-03-28 | :tada: | | ||
| AWS CodeBuild | AWS.CodeBuild | 2016-10-06 | | | ||
| AWS CodeCommit | AWS.CodeCommit | 2015-04-13 | :tada: | | ||
| AWS CodeDeploy | AWS.CodeDeploy | 2014-10-06 | :tada: | | ||
| AWS CodePipeline | AWS.CodePipeline | 2015-07-09 | :tada: | | ||
| Amazon Cognito Identity | AWS.CognitoIdentity | 2014-06-30 | :tada: | | ||
| Amazon Cognito Identity Provider | AWS.CognitoIdentityServiceProvider | 2016-04-18 | :tada: | | ||
| Amazon Cognito Sync | AWS.CognitoSync | 2014-06-30 | :tada: | | ||
| AWS Config | AWS.ConfigService | 2014-11-12 | :tada: | | ||
| AWS Cost and Usage Report Service | AWS.CUR | 2017-01-06 | :tada: | | ||
| AWS Data Pipeline | AWS.DataPipeline | 2012-10-29 | | | ||
| AWS Device Farm | AWS.DeviceFarm | 2015-06-23 | :tada: | | ||
| AWS Direct Connect | AWS.DirectConnect | 2012-10-25 | :tada: | | ||
| AWS Directory Service | AWS.DirectoryService | 2015-04-16 | | | ||
| AWS Application Discovery Service | AWS.Discovery | 2015-11-01 | | | ||
| AWS Database Migration Service | AWS.DMS | 2016-01-01 | | | ||
| Amazon DynamoDB | AWS.DynamoDB | 2012-08-10 | :tada: | | ||
| Amazon DynamoDB | AWS.DynamoDB | 2011-12-05 | :tada: | | ||
| Amazon DynamoDB Streams | AWS.DynamoDBStreams | 2012-08-10 | :tada: | | ||
| Amazon Elastic Compute Cloud | AWS.EC2 | 2016-11-15 | :tada: | | ||
| Amazon EC2 Container Registry | AWS.ECR | 2015-09-21 | :tada: | | ||
| Amazon EC2 Container Service | AWS.ECS | 2014-11-13 | :tada: | | ||
| Amazon Elastic File System | AWS.EFS | 2015-02-01 | | | ||
| Amazon ElastiCache | AWS.ElastiCache | 2015-02-02 | :tada: | | ||
| AWS Elastic Beanstalk | AWS.ElasticBeanstalk | 2010-12-01 | :tada: | | ||
| Elastic Load Balancing | AWS.ELB | 2012-06-01 | :tada: | | ||
| Elastic Load Balancing | AWS.ELBv2 | 2015-12-01 | :tada: | | ||
| Amazon Elastic MapReduce | AWS.EMR | 2009-03-31 | :tada: | | ||
| Amazon Elasticsearch Service | AWS.ES | 2015-01-01 | | | ||
| Amazon Elastic Transcoder | AWS.ElasticTranscoder | 2012-09-25 | :tada: | | ||
| Amazon Kinesis Firehose | AWS.Firehose | 2015-08-04 | :tada: | | ||
| Amazon GameLift | AWS.GameLift | 2015-10-01 | :tada: | | ||
| Amazon Glacier | AWS.Glacier | 2012-06-01 | | | ||
| AWS Health APIs and Notifications | AWS.Health | 2016-08-04 | | | ||
| AWS Identity and Access Management | AWS.IAM | 2010-05-08 | | | ||
| AWS Import/Export | AWS.ImportExport | 2010-06-01 | | | ||
| Amazon Inspector | AWS.Inspector | 2016-02-16 | :tada: | | ||
| AWS IoT | AWS.Iot | 2015-05-28 | :tada: | | ||
| AWS IoT Data Plane | AWS.IotData | 2015-05-28 | :tada: | | ||
| Amazon Kinesis | AWS.Kinesis | 2013-12-02 | :tada: | | ||
| Amazon Kinesis Analytics | AWS.KinesisAnalytics | 2015-08-14 | | | ||
| AWS Key Management Service | AWS.KMS | 2014-11-01 | :tada: | | ||
| AWS Lambda | AWS.Lambda | 2015-03-31 | :tada: | | ||
| AWS Lambda | AWS.Lambda | 2014-11-11 | :tada: | | ||
| Amazon Lex Runtime Service | AWS.LexRuntime | 2016-11-28 | :tada: | | ||
| Amazon Lightsail | AWS.Lightsail | 2016-11-28 | | | ||
| Amazon Machine Learning | AWS.MachineLearning | 2014-12-12 | :tada: | | ||
| AWS Marketplace Commerce Analytics | AWS.MarketplaceCommerceAnalytics | 2015-07-01 | :tada: | | ||
| AWSMarketplace Metering | AWS.MarketplaceMetering | 2016-01-14 | | | ||
| Amazon Mechanical Turk | AWS.MTurk | 2017-01-17 | :tada: | | ||
| Amazon Mobile Analytics | AWS.MobileAnalytics | 2014-06-05 | :tada: | | ||
| AWS OpsWorks | AWS.OpsWorks | 2013-02-18 | :tada: | | ||
| AWS OpsWorks for Chef Automate | AWS.OpsWorksCM | 2016-11-01 | | | ||
| AWS Organizations | AWS.Organizations | 2016-11-28 | | | ||
| Amazon Pinpoint | AWS.Pinpoint | 2016-12-01 | | | ||
| Amazon Polly | AWS.Polly | 2016-06-10 | :tada: | | ||
| Amazon Relational Database Service | AWS.RDS | 2014-10-31 | :tada: | | ||
| Amazon Relational Database Service | AWS.RDS | 2013-09-09 | :tada: | | ||
| Amazon Relational Database Service | AWS.RDS | 2013-02-12 | :tada: | | ||
| Amazon Relational Database Service | AWS.RDS | 2013-01-10 | :tada: | | ||
| Amazon Redshift | AWS.Redshift | 2012-12-01 | :tada: | | ||
| Amazon Rekognition | AWS.Rekognition | 2016-06-27 | :tada: | | ||
| Amazon Route 53 | AWS.Route53 | 2013-04-01 | :tada: | | ||
| Amazon Route 53 Domains | AWS.Route53Domains | 2014-05-15 | :tada: | | ||
| Amazon Simple Storage Service | AWS.S3 | 2006-03-01 | :tada: | | ||
| AWS Service Catalog | AWS.ServiceCatalog | 2015-12-10 | :tada: | | ||
| Amazon Simple Email Service | AWS.SES | 2010-12-01 | :tada: | | ||
| AWS Shield | AWS.Shield | 2016-06-02 | | | ||
| Amazon SimpleDB | AWS.SimpleDB | 2009-04-15 | | | ||
| AWS Server Migration Service | AWS.SMS | 2016-10-24 | | | ||
| Amazon Import/Export Snowball | AWS.Snowball | 2016-06-30 | | | ||
| Amazon Simple Notification Service | AWS.SNS | 2010-03-31 | :tada: | | ||
| Amazon Simple Queue Service | AWS.SQS | 2012-11-05 | :tada: | | ||
| Amazon Simple Systems Manager (SSM) | AWS.SSM | 2014-11-06 | :tada: | | ||
| AWS Storage Gateway | AWS.StorageGateway | 2013-06-30 | :tada: | | ||
| AWS Step Functions | AWS.StepFunctions | 2016-11-23 | | | ||
| AWS Security Token Service | AWS.STS | 2011-06-15 | :tada: | | ||
| AWS Support | AWS.Support | 2013-04-15 | | | ||
| Amazon Simple Workflow Service | AWS.SWF | 2012-01-25 | | | ||
| AWS X-Ray | AWS.XRay | 2016-04-12 | | | ||
| AWS WAF | AWS.WAF | 2015-08-24 | :tada: | | ||
| AWS WAF Regional | AWS.WAFRegional | 2016-11-28 | | | ||
| Amazon WorkSpaces | AWS.WorkSpaces | 2015-04-08 | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| "use strict"; | ||
| var fs_1 = require("fs"); | ||
| var path_1 = require("path"); | ||
| var clients = require('../clients/all'); | ||
| var metadata = require('../apis/metadata'); | ||
| var api_loader = require('../lib/api_loader'); | ||
| fs_1.writeFileSync(path_1.resolve(__dirname, '..', 'SERVICES.md'), Object.keys(clients).reduce(function (serviceTable, clientId) { | ||
| var cid = clientId.toLowerCase(); | ||
| return serviceTable + Object.keys(api_loader.services[cid]).reverse() | ||
| .map(function (version) { | ||
| var model = api_loader(cid, version); | ||
| return model.metadata.serviceFullName + " | AWS." + clientId + " | " + version + " | " + (metadata[cid].cors === true ? ':tada:' : '') + " |"; | ||
| }).join("\n") + "\n"; | ||
| }, "The SDK currently supports the following services:\n\n<p class=\"note\"><strong>Note</strong>:\nAlthough all services are supported in the browser version of the SDK,\nnot all of the services are available in the default hosted build (using the\nscript tag provided above). Instructions on how to build a\ncustom version of the SDK with individual services are provided\nin the \"<a href=\"http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html\">Building the SDK for Browsers</a>\" section of the SDK Developer Guide.\n</p>\n\nService Name | Class Name | API Version | Allows CORS |\n------------ | ---------- | ----------- | ----------- |\n")); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import {writeFileSync} from 'fs'; | ||
| import {resolve} from 'path'; | ||
|
|
||
| const clients = require('../clients/all'); | ||
| const metadata = require('../apis/metadata'); | ||
| const api_loader = require('../lib/api_loader'); | ||
|
|
||
| writeFileSync( | ||
| resolve(__dirname, '..', 'SERVICES.md'), | ||
| Object.keys(clients).reduce((serviceTable, clientId): string => { | ||
| const cid = clientId.toLowerCase(); | ||
| return serviceTable + Object.keys(api_loader.services[cid]).reverse() | ||
| .map((version: string): string => { | ||
| const model = api_loader(cid, version); | ||
| return `${model.metadata.serviceFullName} | AWS.${clientId} | ${version} | ${metadata[cid].cors === true ? ':tada:' : ''} |`; | ||
| }).join("\n") + "\n"; | ||
| }, `The SDK currently supports the following services: | ||
| <p class="note"><strong>Note</strong>: | ||
| Although all services are supported in the browser version of the SDK, | ||
| not all of the services are available in the default hosted build (using the | ||
| script tag provided above). Instructions on how to build a | ||
| custom version of the SDK with individual services are provided | ||
| in the "<a href="http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/building-sdk-for-browsers.html">Building the SDK for Browsers</a>" section of the SDK Developer Guide. | ||
| </p> | ||
| Service Name | Class Name | API Version | Allows CORS | | ||
| ------------ | ---------- | ----------- | ----------- | | ||
| `)); |