aws / aws-sdk-js-v3

Modularized AWS SDK for JavaScript.
Apache License 2.0
3.01k stars 565 forks source link

Improve the README with list of available service packages #1546

Closed koiker closed 2 years ago

koiker commented 3 years ago

Describe the issue with documentation For first time users (like me) when you get in the new aws-sdk-js-v3 package and read the documentation (README) you get the benefits of this new version and want to use this new version, but it's explicit described which services are available and the node/browser version syntax or even the alpha/beta/gamma/ga stage. I had to look into the issues list to find some hints on how the package is being structured.

To Reproduce (observed behavior) Ask for new users of this package how they discovered which services are available and what is the syntax to import them into their projects. Probably most part of them spend time in slack/gitter channels or search on issues or stackoverflow.

Expected behavior Include a list of available services in the README and the options available to install the packages. Ex:

npm install @aws-sdk/<SERVICE>@<RELEASE> or yarn install @aws-sdk/<SERVICE>@<RELEASE>

RELEASE can be: alpha, beta or gamma. Bellow is a list of services and in which release they are available. (example)

Service name alpha beta gamma
client-accessanalyzer
client-acm
client-acm-pca
client-alexa-for-business
client-amplify
client-api-gateway
client-apigatewaymanagementapi
client-apigatewayv2
client-app-mesh
client-appconfig
client-application-auto-scaling
client-application-discovery-service
client-application-insights
client-appstream
client-appsync
client-athena
client-auto-scaling
client-auto-scaling-plans
client-backup
client-batch
client-braket
client-budgets
client-chime
client-cloud9
client-clouddirectory
client-cloudformation
client-cloudfront
client-cloudhsm
client-cloudhsm-v2
client-cloudsearch
client-cloudsearch-domain
client-cloudtrail
client-cloudwatch
client-cloudwatch-events
client-cloudwatch-logs
client-codeartifact
client-codebuild
client-codecommit
client-codedeploy
client-codeguru-reviewer
client-codeguruprofiler
client-codepipeline
client-codestar
client-codestar-connections
client-codestar-notifications
client-cognito-identity
client-cognito-identity-provider
client-cognito-sync
client-comprehend
client-comprehendmedical
client-compute-optimizer
client-config-service
client-connect
client-connectparticipant
client-cost-and-usage-report-service
client-cost-explorer
client-data-pipeline
client-database-migration-service
client-dataexchange
client-datasync
client-dax
client-detective
client-device-farm
client-direct-connect
client-directory-service
client-dlm
client-docdb
client-dynamodb
client-dynamodb-streams
client-ebs
client-ec2
client-ec2-instance-connect
client-ecr
client-ecs
client-efs
client-eks
client-elastic-beanstalk
client-elastic-inference
client-elastic-load-balancing
client-elastic-load-balancing-v2
client-elastic-transcoder
client-elasticache
client-elasticsearch-service
client-emr
client-eventbridge
client-firehose
client-fms
client-forecast
client-forecastquery
client-frauddetector
client-fsx
client-gamelift
client-glacier
client-global-accelerator
client-glue
client-greengrass
client-groundstation
client-guardduty
client-health
client-honeycode
client-iam
client-imagebuilder
client-inspector
client-iot
client-iot-1click-devices-service
client-iot-1click-projects
client-iot-data-plane
client-iot-events
client-iot-events-data
client-iot-jobs-data-plane
client-iotanalytics
client-iotsecuretunneling
client-iotsitewise
client-iotthingsgraph
client-ivs
client-kafka
client-kendra
client-kinesis
client-kinesis-analytics
client-kinesis-analytics-v2
client-kinesis-video
client-kinesis-video-archived-media
client-kinesis-video-media
client-kinesis-video-signaling
client-kms
client-lakeformation
client-lambda
client-lex-model-building-service
client-lex-runtime-service
client-license-manager
client-lightsail
client-machine-learning
client-macie
client-macie2
client-managedblockchain
client-marketplace-catalog
client-marketplace-commerce-analytics
client-marketplace-entitlement-service
client-marketplace-metering
client-mediaconnect
client-mediaconvert
client-medialive
client-mediapackage
client-mediapackage-vod
client-mediastore
client-mediastore-data
client-mediatailor
client-migration-hub
client-migrationhub-config
client-mobile
client-mq
client-mturk
client-neptune
client-networkmanager
client-opsworks
client-opsworkscm
client-organizations
client-outposts
client-personalize
client-personalize-events
client-personalize-runtime
client-pi
client-pinpoint
client-pinpoint-email
client-pinpoint-sms-voice
client-polly
client-pricing
client-qldb
client-qldb-session
client-quicksight
client-ram
client-rds
client-rds-data
client-redshift
client-rekognition
client-resource-groups
client-resource-groups-tagging-api
client-robomaker
client-route-53
client-route-53-domains
client-route53resolver
client-s3
client-s3-control
client-sagemaker
client-sagemaker-a2i-runtime
client-sagemaker-runtime
client-savingsplans
client-schemas
client-secrets-manager
client-securityhub
client-serverlessapplicationrepository
client-service-catalog
client-service-quotas
client-servicediscovery
client-ses
client-sesv2
client-sfn
client-shield
client-signer
client-sms
client-snowball
client-sns
client-sqs
client-ssm
client-sso
client-sso-oidc
client-storage-gateway
client-sts
client-support
client-swf
client-synthetics
client-textract
client-transcribe
client-transcribe-streaming
client-transfer
client-translate
client-waf
client-waf-regional
client-wafv2
client-workdocs
client-worklink
client-workmail
client-workmailmessageflow
client-workspaces
client-xray

Screenshots If applicable, add screenshots to help explain your problem.

Additional context I have to inspect the git repo to get the list of services, if a user find this package by npm he will not be able to see the list of services unless he spend some time searching for more info and get to the source code. Documentation will be very helpful in this development phase to get more users to test the new packages. The table above is just an example on how users can use this v3, but I saw somewhere that there is the node and browser version of the package. How can we install one or another? What is the differences of each one? It's all those aspects of the package that will be good to include in the README or in the package description to make more easier to people to start using.

trivikr commented 3 years ago

We're using latest tag for Release Candidate versions, so yarn add or npm install would install the latest RC version.

The API Reference is being built, and will contain list of clients. We'll provide a link to API reference from README once it's ready.

github-actions[bot] commented 2 years ago

Greetings! We’re closing this issue because it has been open a long time and hasn’t been updated in a while and may not be getting the attention it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to comment or open a new issue.

github-actions[bot] commented 2 years ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.