AWS SDK for Go

API Reference Join the chat at https://gitter.im/aws/aws-sdk-go Build Status Apache V2 License API Reference

aws-sdk-go is the official AWS SDK for the Go programming language.

Checkout our release notes 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

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.

Alternatively, you can set the following environment variables:

AWS_ACCESS_KEY_ID=AKID1234567890
AWS_SECRET_ACCESS_KEY=MY-SECRET-KEY

AWS CLI config file (~/.aws/config)

The AWS SDK for Go does not support the AWS CLI's config file. The SDK will not use any contents from this file. The SDK only supports the shared credentials file (~/.aws/credentials). #384 tracks this feature request discussion.

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:

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() { // 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(session.New(), &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.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.