b22c6b7a4e
Adds READMEs and enforces vendor is done at repository root Signed-off-by: Derek McGowan <derek@mcgstyle.net>
122 lines
5.7 KiB
Markdown
122 lines
5.7 KiB
Markdown
# AWS SDK for Go
|
|
|
|
<span style="display: inline-block;">
|
|
[](http://docs.aws.amazon.com/sdk-for-go/api)
|
|
[](https://gitter.im/aws/aws-sdk-go?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://travis-ci.org/aws/aws-sdk-go)
|
|
[](https://github.com/aws/aws-sdk-go/blob/master/LICENSE.txt)
|
|
</span>
|
|
|
|
aws-sdk-go is the official AWS SDK for the Go programming language.
|
|
|
|
Checkout our [release notes](https://github.com/aws/aws-sdk-go/releases) for information about the latest bug fixes, updates, and features added to the SDK.
|
|
|
|
## Installing
|
|
|
|
If you are using Go 1.5 with the `GO15VENDOREXPERIMENT=1` vendoring flag, or 1.6 and higher you can use the following command to retrieve the SDK. The SDK's non-testing dependencies will be included and are vendored in the `vendor` folder.
|
|
|
|
go get -u github.com/aws/aws-sdk-go
|
|
|
|
Otherwise if your Go environment does not have vendoring support enabled, or you do not want to include the vendored SDK's dependencies you can use the following command to retrieve the SDK and its non-testing dependencies using `go get`.
|
|
|
|
go get -u github.com/aws/aws-sdk-go/aws/...
|
|
go get -u github.com/aws/aws-sdk-go/service/...
|
|
|
|
If you're looking to retrieve just the SDK without any dependencies use the following command.
|
|
|
|
go get -d github.com/aws/aws-sdk-go/
|
|
|
|
These two processes will still include the `vendor` folder and it should be deleted if its not going to be used by your environment.
|
|
|
|
rm -rf $GOPATH/src/github.com/aws/aws-sdk-go/vendor
|
|
|
|
## Reference Documentation
|
|
[`Getting Started Guide`](https://aws.amazon.com/sdk-for-go/) - This document is a general introduction how to configure and make requests with the SDK. If this is your first time using the SDK, this documentation and the API documentation will help you get started. This document focuses on the syntax and behavior of the SDK. The [Service Developer Guide](https://aws.amazon.com/documentation/) will help you get started using specific AWS services.
|
|
|
|
[`SDK API Reference Documentation`](https://docs.aws.amazon.com/sdk-for-go/api/) - Use this document to look up all API operation input and output parameters for AWS services supported by the SDK. The API reference also includes documentation of the SDK, and examples how to using the SDK, service client API operations, and API operation require parameters.
|
|
|
|
[`Service Developer Guide`](https://aws.amazon.com/documentation/) - Use this documentation to learn how to interface with an AWS service. These are great guides both, if you're getting started with a service, or looking for more information on a service. You should not need this document for coding, though in some cases, services may supply helpful samples that you might want to look out for.
|
|
|
|
[`SDK Examples`](https://github.com/aws/aws-sdk-go/tree/master/example) - Included in the SDK's repo are a several hand crafted examples using the SDK features and AWS services.
|
|
|
|
## Configuring Credentials
|
|
|
|
Before using the SDK, ensure that you've configured credentials. The best
|
|
way to configure credentials on a development machine is to use the
|
|
`~/.aws/credentials` file, which might look like:
|
|
|
|
```
|
|
[default]
|
|
aws_access_key_id = AKID1234567890
|
|
aws_secret_access_key = MY-SECRET-KEY
|
|
```
|
|
|
|
You can learn more about the credentials file from this
|
|
[blog post](http://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs).
|
|
|
|
Alternatively, you can set the following environment variables:
|
|
|
|
```
|
|
AWS_ACCESS_KEY_ID=AKID1234567890
|
|
AWS_SECRET_ACCESS_KEY=MY-SECRET-KEY
|
|
```
|
|
|
|
### AWS shared config file (`~/.aws/config`)
|
|
The AWS SDK for Go added support the shared config file in release [v1.3.0](https://github.com/aws/aws-sdk-go/releases/tag/v1.3.0). You can opt into enabling support for the shared config by setting the environment variable `AWS_SDK_LOAD_CONFIG` to a truthy value. See the [Session](https://github.com/aws/aws-sdk-go/wiki/sessions) wiki for more information about this feature.
|
|
|
|
## Using the Go SDK
|
|
|
|
To use a service in the SDK, create a service variable by calling the `New()`
|
|
function. Once you have a service client, you can call API operations which each
|
|
return response data and a possible error.
|
|
|
|
To list a set of instance IDs from EC2, you could run:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/aws/aws-sdk-go/aws"
|
|
"github.com/aws/aws-sdk-go/aws/session"
|
|
"github.com/aws/aws-sdk-go/service/ec2"
|
|
)
|
|
|
|
func main() {
|
|
sess, err := session.NewSession()
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// Create an EC2 service object in the "us-west-2" region
|
|
// Note that you can also configure your region globally by
|
|
// exporting the AWS_REGION environment variable
|
|
svc := ec2.New(sess, &aws.Config{Region: aws.String("us-west-2")})
|
|
|
|
// Call the DescribeInstances Operation
|
|
resp, err := svc.DescribeInstances(nil)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// resp has all of the response data, pull out instance IDs:
|
|
fmt.Println("> Number of reservation sets: ", len(resp.Reservations))
|
|
for idx, res := range resp.Reservations {
|
|
fmt.Println(" > Number of instances: ", len(res.Instances))
|
|
for _, inst := range resp.Reservations[idx].Instances {
|
|
fmt.Println(" - Instance ID: ", *inst.InstanceId)
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
You can find more information and operations in our
|
|
[API documentation](http://docs.aws.amazon.com/sdk-for-go/api/).
|
|
|
|
## License
|
|
|
|
This SDK is distributed under the
|
|
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
|
|
see LICENSE.txt and NOTICE.txt for more information.
|