Repository files navigation

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

We previouslyannouncedthe upcomingend-of-support for AWS SDK for Go (v1).

Per that announcement, as of 7/31/2024,the SDK has entered maintenance mode.Going forward, we will limit releases to address critical bug fixes and securityissues only. The SDK will not receive API updates for new or existing services,or be updated to support new regions.

Maintenance mode will last for 1 year. After 7/31/2025, the SDK will enter end-of-support, and no updates at all will be made.We recommend that you migrate toAWS SDK for Go v2.For additional details as well as information on how to migrate, please referto the linked announcement.

Jump To:

• Getting Started
• Quick Examples
• Getting Help
• Contributing
• More Resources

Usego get to retrieve the SDK to add it to your project's Go module dependencies.

go get github.com/aws/aws-sdk-go

To update the SDK usego get -u to retrieve the latest version of the SDK.

go get -u github.com/aws/aws-sdk-go

This example shows a complete working Go file which will upload a file to S3and use the Context pattern to implement timeout logic that will cancel therequest if it takes too long. This example highlights how to use sessions,create a service client, make a request, handle the error, and process theresponse.

package mainimport ("context""flag""fmt""os""time""github.com/aws/aws-sdk-go/aws""github.com/aws/aws-sdk-go/aws/awserr""github.com/aws/aws-sdk-go/aws/request""github.com/aws/aws-sdk-go/aws/session""github.com/aws/aws-sdk-go/service/s3"  )// Uploads a file to S3 given a bucket and object key. Also takes a duration// value to terminate the update if it doesn't complete within that time.//// The AWS Region needs to be provided in the AWS shared config or on the// environment variable as `AWS_REGION`. Credentials also must be provided// Will default to shared config file, but can load from environment if provided.//// Usage://   # Upload myfile.txt to myBucket/myKey. Must complete within 10 minutes or will fail//   go run withContext.go -b mybucket -k myKey -d 10m < myfile.txtfuncmain() {varbucket,keystringvartimeout time.Durationflag.StringVar(&bucket,"b","","Bucket name.")flag.StringVar(&key,"k","","Object key name.")flag.DurationVar(&timeout,"d",0,"Upload timeout.")flag.Parse()// All clients require a Session. The Session provides the client with// shared configuration such as region, endpoint, and credentials. A// Session should be shared where possible to take advantage of// configuration and credential caching. See the session package for// more information.sess:=session.Must(session.NewSession())// Create a new instance of the service's client with a Session.// Optional aws.Config values can also be provided as variadic arguments// to the New function. This option allows you to provide service// specific configuration.svc:=s3.New(sess)// Create a context with a timeout that will abort the upload if it takes// more than the passed in timeout.ctx:=context.Background()varcancelFnfunc()iftimeout>0 {ctx,cancelFn=context.WithTimeout(ctx,timeout)  }// Ensure the context is canceled to prevent leaking.// See context package for more information, https://golang.org/pkg/context/ifcancelFn!=nil {defercancelFn()}// Uploads the object to S3. The Context will interrupt the request if the// timeout expires._,err:=svc.PutObjectWithContext(ctx,&s3.PutObjectInput{Bucket:aws.String(bucket),Key:aws.String(key),Body:os.Stdin,  })iferr!=nil {ifaerr,ok:=err.(awserr.Error);ok&&aerr.Code()==request.CanceledErrorCode {// If the SDK can determine the request or retry delay was canceled// by a context the CanceledErrorCode error code will be returned.fmt.Fprintf(os.Stderr,"upload canceled due to timeout, %v\n",err)  }else {fmt.Fprintf(os.Stderr,"failed to upload object, %v\n",err)  }os.Exit(1)  }fmt.Printf("successfully uploaded file to %s/%s\n",bucket,key)  }

The SDK is composed of two main components, SDK core, and service clients.The SDK core packages are all available under the aws package at the root ofthe SDK. Each client for a supported AWS service is available within its ownpackage under the service folder at the root of the SDK.

• aws - SDK core, provides common shared types such as Config, Logger,and utilities to make working with API parameters easier.

  • awserr - Provides the error interface that the SDK will use for allerrors that occur in the SDK's processing. This includes service APIresponse errors as well. The Error type is made up of a code and message.Cast the SDK's returned error type to awserr.Error and call the Codemethod to compare returned error to specific error codes. See the package'sdocumentation for additional values that can be extracted such as RequestID.

  • credentials - Provides the types and built in credentials providersthe SDK will use to retrieve AWS credentials to make API requests with.Nested under this folder are also additional credentials providers such asstscreds for assuming IAM roles, and ec2rolecreds for EC2 Instance roles.

  • endpoints - Provides the AWS Regions and Endpoints metadata for the SDK.Use this to lookup AWS service endpoint information such as which servicesare in a region, and what regions a service is in. Constants are also providedfor all region identifiers, e.g UsWest2RegionID for "us-west-2".

  • session - Provides initial default configuration, and loadconfiguration from external sources such as environment and sharedcredentials file.

  • request - Provides the API request sending, and retry logic for the SDK.This package also includes utilities for defining your own requestretryer, and configuring how the SDK processes the request.

• service - Clients for AWS services. All services supported by the SDK areavailable under this folder.

The SDK includes the Go types and utilities you can use to make requests toAWS service APIs. Within the service folder at the root of the SDK you'll finda package for each AWS service the SDK supports. All service clients follow common pattern of creation and usage.

When creating a client for an AWS service you'll first need to have a Sessionvalue constructed. The Session provides shared configuration that can be sharedbetween your service clients. When service clients are created you can passin additional configuration via the aws.Config type to override configurationprovided by in the Session to create service client instances with customconfiguration.

Once the service's client is created you can use it to make API requests theAWS service. These clients are safe to use concurrently.

In the AWS SDK for Go, you can configure settings for service clients, suchas the log level and maximum number of retries. Most settings are optional;however, for each service client, you must specify a region and your credentials.The SDK uses these values to send requests to the correct AWS region and signrequests with the correct credentials. You can specify these values as partof a session or as environment variables.

See the SDK'sconfiguration guide for more information.

See thesession package documentation for more information on how to use Sessionwith the SDK.

See theConfig type in theaws package for more information on configurationoptions.

When using the SDK you'll generally need your AWS credentials to authenticatewith AWS services. The SDK supports multiple methods of supporting thesecredentials. By default the SDK will source credentials automatically fromits default credential chain. See the session package for more informationon this chain, and how to configure it. The common items in the credentialchain are the following:

• Environment Credentials - Set of environment variables that are usefulwhen sub processes are created for specific roles.

• Shared Credentials file (~/.aws/credentials) - This file stores yourcredentials based on a profile name and is useful for local development.

• EC2 Instance Role Credentials - Use EC2 Instance Role to assign credentialsto application running on an EC2 instance. This removes the need to managecredential files in production.

Credentials can be configured in code as well by setting the Config's Credentialsvalue to a custom provider or using one of the providers included with theSDK to bypass the default credential chain and use a custom one. This ishelpful when you want to instruct the SDK to only use a specific set ofcredentials or providers.

This example creates a credential provider for assuming an IAM role, "myRoleARN"and configures the S3 service client to use that role for API requests.

// Initial credentials loaded from SDK's default credential chain. Such as// the environment, shared credentials (~/.aws/credentials), or EC2 Instance// Role. These credentials will be used to to make the STS Assume Role API.sess:=session.Must(session.NewSession())// Create the credentials from AssumeRoleProvider to assume the role// referenced by the "myRoleARN" ARN.creds:=stscreds.NewCredentials(sess,"myRoleArn")// Create service client value configured for credentials// from assumed role.svc:=s3.New(sess,&aws.Config{Credentials:creds})

See thecredentials package documentation for more information on credentialproviders included with the SDK, and how to customize the SDK's usage ofcredentials.

The SDK has support for the shared configuration file (~/.aws/config). Thissupport can be enabled by setting the environment variable, "AWS_SDK_LOAD_CONFIG=1",or enabling the feature in code when creating a Session via theOption's SharedConfigState parameter.

sess:=session.Must(session.NewSessionWithOptions(session.Options{SharedConfigState:session.SharedConfigEnable,  }))

In addition to the credentials you'll need to specify the region the SDKwill use to make AWS API requests to. In the SDK you can specify the regioneither with an environment variable, or directly in code when a Session orservice client is created. The last value specified in code wins if the regionis specified multiple ways.

To set the region via the environment variable set the "AWS_REGION" to theregion you want to the SDK to use. Using this method to set the region willallow you to run your application in multiple regions without needing additionalcode in the application to select the region.

AWS_REGION=us-west-2

The endpoints package includes constants for all regions the SDK knows. Thevalues are all suffixed with RegionID. These values are helpful, because theyreduce the need to type the region string manually.

To set the region on a Session use the aws package's Config struct parameterRegion to the AWS region you want the service clients created from the session touse. This is helpful when you want to create multiple service clients, andall of the clients make API requests to the same region.

sess:=session.Must(session.NewSession(&aws.Config{Region:aws.String(endpoints.UsWest2RegionID),  }))

See theendpoints package for the AWS Regions and Endpoints metadata.

In addition to setting the region when creating a Session you can also setthe region on a per service client bases. This overrides the region of aSession. This is helpful when you want to create service clients in specificregions different from the Session's region.

svc:=s3.New(sess,&aws.Config{Region:aws.String(endpoints.UsWest2RegionID),  })

See theConfig type in theaws package for more information and additionaloptions such as setting the Endpoint, and other service client configuration options.

Once the client is created you can make an API request to the service.Each API method takes a input parameter, and returns the service responseand an error. The SDK provides methods for making the API call in multiple ways.

In this list we'll use the S3 ListObjects API as an example for the differentways of making API requests.

• ListObjects - Base API operation that will make the API request to the service.

• ListObjectsRequest - API methods suffixed with Request will construct theAPI request, but not send it. This is also helpful when you want to get apresigned URL for a request, and share the presigned URL instead of yourapplication making the request directly.

• ListObjectsPages - Same as the base API operation, but uses a callback toautomatically handle pagination of the API's response.

• ListObjectsWithContext - Same as base API operation, but adds support forthe Context pattern. This is helpful for controlling the canceling of inflight requests. See the Go standard library context package for moreinformation. This method also takes request package's Option functionaloptions as the variadic argument for modifying how the request will bemade, or extracting information from the raw HTTP response.

• ListObjectsPagesWithContext - same as ListObjectsPages, but adds support forthe Context pattern. Similar to ListObjectsWithContext this method alsotakes the request package's Option function option types as the variadicargument.

In addition to the API operations the SDK also includes several higher levelmethods that abstract checking for and waiting for an AWS resource to be ina desired state. In this list we'll use WaitUntilBucketExists to demonstratethe different forms of waiters.

• WaitUntilBucketExists. - Method to make API request to query an AWS service fora resource's state. Will return successfully when that state is accomplished.

• WaitUntilBucketExistsWithContext - Same as WaitUntilBucketExists, but addssupport for the Context pattern. In addition these methods take requestpackage's WaiterOptions to configure the waiter, and how underlying requestwill be made by the SDK.

The API method will document which error codes the service might return forthe operation. These errors will also be available as const strings prefixedwith "ErrCode" in the service client's package. If there are no errors listedin the API's SDK documentation you'll need to consult the AWS service's APIdocumentation for the errors that could be returned.

ctx:=context.Background()result,err:=svc.GetObjectWithContext(ctx,&s3.GetObjectInput{Bucket:aws.String("my-bucket"),Key:aws.String("my-key"),  })iferr!=nil {// Cast err to awserr.Error to handle specific error codes.aerr,ok:=err.(awserr.Error)ifok&&aerr.Code()==s3.ErrCodeNoSuchKey {// Specific error code handling      }returnerr  }// Make sure to close the body when done with it for S3 GetObject APIs or// will leak connections.deferresult.Body.Close()fmt.Println("Object Size:",aws.Int64Value(result.ContentLength))

Pagination helper methods are suffixed with "Pages", and provide thefunctionality needed to round trip API page requests. Pagination methodstake a callback function that will be called for each page of the API's response.

objects:= []string{}err:=svc.ListObjectsPagesWithContext(ctx,&s3.ListObjectsInput{Bucket:aws.String(myBucket),   },func(p*s3.ListObjectsOutput,lastPagebool)bool {for_,o:=rangep.Contents {objects=append(objects,aws.StringValue(o.Key))       }returntrue// continue paging   })iferr!=nil {panic(fmt.Sprintf("failed to list objects for bucket, %s, %v",myBucket,err))   }fmt.Println("Objects in bucket:",objects)

Waiter helper methods provide the functionality to wait for an AWS resourcestate. These methods abstract the logic needed to check the state of anAWS resource, and wait until that resource is in a desired state. The waiterwill block until the resource is in the state that is desired, an error occurs,or the waiter times out. If a resource times out the error code returned willbe request.WaiterResourceNotReadyErrorCode.

err:=svc.WaitUntilBucketExistsWithContext(ctx,&s3.HeadBucketInput{Bucket:aws.String(myBucket),  })iferr!=nil {aerr,ok:=err.(awserr.Error)ifok&&aerr.Code()==request.WaiterResourceNotReadyErrorCode {fmt.Fprintf(os.Stderr,"timed out while waiting for bucket to exist")      }panic(fmt.Errorf("failed to wait for bucket to exist, %v",err))  }fmt.Println("Bucket",myBucket,"exists")

Please use these community resources for getting help. We use the GitHub issuesfor tracking bugs and feature requests.

• Ask a question onStackOverflow and tag it with theaws-sdk-go tag.
• Come join the AWS SDK for Go community chat ongitter.
• Open a support ticket withAWS Support.
• If you think you may have found a bug, please open anissue.

This SDK implements AWS service APIs. For general issues regarding the AWS services and their limitations, you may also take a look at theAmazon Web Services Discussion Forums.

If you encounter a bug with the AWS SDK for Go we would like to hear about it.Search theexisting issues and seeif others are also experiencing the issue before opening a new issue. Pleaseinclude the version of AWS SDK for Go, Go language, and OS you’re using. Pleasealso include reproduction case when appropriate.

The GitHub issues are intended for bug reports and feature requests. For helpand questions with using AWS SDK for Go please make use of the resources listedin theGetting Help section.Keeping the list of open issues lean will help us respond in a timely manner.

We work hard to provide a high-quality and useful SDK for our AWS services, and we greatly value feedback and contributions from our community. Please review ourcontributing guidelines before submitting anyissues orpull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

For information about maintenance and support for SDK major versions and our underlying dependencies, see the following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide:

• AWS SDKs and Tools Maintenance Policy
• AWS SDKs and Tools Version Support Matrix

The v2 SDK follows the upstreamrelease policywith an additional six months of support for the most recently deprecatedlanguage version.

AWS reserves the right to drop support for unsupported Go versions earlier toaddress critical security issues.

Developer guide - This documentis a general introduction on how to configure and make requests with the SDK.If this is your first time using the SDK, this documentation and the APIdocumentation will help you get started. This document focuses on the syntaxand behavior of the SDK. TheService Developer Guidewill help you get started using specific AWS services.

SDK API Reference Documentation - Use thisdocument to look up all API operation input and output parameters for AWSservices supported by the SDK. The API reference also includes documentation ofthe SDK, and examples how to using the SDK, service client API operations, andAPI operation require parameters.

Service Documentation - Use thisdocumentation to learn how to interface with AWS services. These guides aregreat for getting started with a service, or when looking for moreinformation about a service. While this document is not required for coding,services may supply helpful samples to look out for.

SDK Examples -Included in the SDK's repo are several hand crafted examples using the SDKfeatures and AWS services.

Forum - Ask questions, get help, and give feedback

Issues - Report issues, submit pull requests, and get involved(seeApache 2.0 License)