Documentation is very sparse?

[mickeypash]

Hello!

I come from Python an I'm used to the boto3 docs
Just curious how are people meant to use the Go SDK?

Should they be cross referencing boto3 or aws cli docs for how things work?
How do large projects like terraform-provider-aws use the SDK?

Also I noticed that the getting started page has a bug perhaps?

go run main.go
main.go:8:2: no required module provides package github.com/aws/aws-sdk-go-v2/service/s3; to add it:
        go get github.com/aws/aws-sdk-go-v2/service/s3

[jasdel]

The v2 SDK is intended to work with Go modules. This means you'll need to initialize a module for your application, and add the dependencies your application will use.

The following is an example how you can do that with the example in the getting started page.

go mod init <namespace for your app>
go get github.com/aws/aws-sdk-go-v2
go get github.com/aws/aws-sdk-go-v2/config
go get github.com/aws/aws-sdk-go-v2/service/s3

[mickeypash]

Yeah sorry I guess the documentation wasn't very explicit/clear about running:

go get github.com/aws/aws-sdk-go-v2/service/s3

I realise I've got 2 questions in one discussion however.
I think I'm more curious about the first one.
"How does one make sense of the API available?"

Maybe coming from a Python perspective I'm a bit naive.
At a second glance I realise we have access to these autogenerated docs although they don't seem as intuitive as the boto3 docs

[jasdel]

Thanks for the feedback @mickeypash. Correct, pkg.go.dev is the source of API reference documentation for the API. We are investigating alternative solutions for doc generation. We'll use this feedback as we're evaluating solutions.

[github-actions[bot]]

Hello! Reopening this discussion to make it searchable.