Amplify Docs のカテゴリ間の行き来をちょっとだけやりやすくするための相関早見表 (2020/12/17版)

こちらは、 “ゆるWeb勉強会@札幌 Advent Calendar 2020” の 17日目の記事です。

AWS Amplify の機能はかなりの勢いで追加されており、それに応じてドキュメントも日々拡充されています。

で、 Amplify で開発するときって CLI で行なうのでどうしても CLI カテゴリを中心に読んでいたのですが(それでも読みきれない量になってきた)、色々と詰まってきたときに実は Libraries カテゴリを読むと欲しい情報が詰まっていた、、ということが最近よくありました。

というわけで、ドキュメントのカテゴリ CLI と Libraries と UI Components の中で、「同じ機能」を横断的に説明しているものが紐づくようなリストを作っておきたいと思います。

ついでに、 Gides カテゴリと AWSのサービスとの(簡易的な)相関も入れます。

カテゴリ間相関早見表

CLI	Libraries	UI Components	Guides	AWS Services
	Analytics			Pinpoint, Kinesis
API (GraphQL)	API (GraphQL), DataStore		API (GraphQL)	AppSync
– @model				DynamoDB
– @auth → Authentication
– @function → Functions
– @predictions	Predictions			AI / ML
– @searchable				Elasticsearch
API (REST) → Functions	API (REST)		API (REST)	API Gateway, Lambda
Authentication	Authentication	Authentication	Authentication	Cognito
	Interactions	Interactions		Lex
	PubSub			IoT
	Push Notifications			Pinpoint
Storage – S3	Storage	Storage		S3
Storage – NoSQL				DynamoDB
	XR			Sumerian
Functions			Functions	Lambda
Hosting			Hosting	CloudFront, S3

完全とは言えないかもしれませんが、現時点ではこのような感じで情報が配置されています。

CLI で「コマンド操作するときにどうするか」、
Guides や Libraries で「こういうことをやりたいけどどうやるか」、
UI Components で「画面と連携するときどうやるか」、
ということが読めると思います。

例えば認証だと、実際に下記のような流れで操作しつつドキュメントの参照をしたりしています。

この辺りが固まっていてくれると嬉しいと思う反面、現在の分け方の観点も悪いとは思わないのでなかなか難しいですね。

こういった情報をオフィシャルとは別でまとめるのも、個人的には有用だと思います。

気づいたことは、ボチボチと記録を残していこうと思います。