sdk

package module
v1.0.8-0...-33a65fd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2017 License: Apache-2.0 Imports: 0 Imported by: 0

README

API Reference Build Status Apache V2 License

AWS SDK for Go

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

Getting Help

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

  • Ask a question on StackOverflow and tag it with the aws-sdk-go tag.
  • Come join the AWS SDK for Go community chat on gitter.
  • Open a support ticket with AWS Support.
  • If you think you may have found a bug, please open an issue.

Opening Issues

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

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

Reference Documentation

Getting Started Guide - 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 will help you get started using specific AWS services.

SDK API Reference Documentation - 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 - 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 - Included in the SDK's repo are a several hand crafted examples using the SDK features and AWS services.

Overview of SDK's Packages

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 of the SDK. Each client for a supported AWS service is available within its own package 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 all errors that occur in the SDK's processing. This includes service API response 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 Code method to compare returned error to specific error codes. See the package's documentation for additional values that can be extracted such as RequestID.

    • credentials - Provides the types and built in credentials providers the SDK will use to retrieve AWS credentials to make API requests with. Nested under this folder are also additional credentials providers such as stscreds 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 services are in a region, and what regions a service is in. Constants are also provided for all region identifiers, e.g UsWest2RegionID for "us-west-2".

    • session - Provides initial default configuration, and load configuration from external sources such as environment and shared credentials file.

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

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

How to Use the SDK's AWS Service Clients

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

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

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

Configuring the SDK

In the AWS SDK for Go, you can configure settings for service clients, such as 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 sign requests with the correct credentials. You can specify these values as part of a session or as environment variables.

See the SDK's configuration guide for more information.

See the session package documentation for more information on how to use Session with the SDK.

See the Config type in the aws package for more information on configuration options.

Configuring Credentials

When using the SDK you'll generally need your AWS credentials to authenticate with AWS services. The SDK supports multiple methods of supporting these credentials. By default the SDK will source credentials automatically from its default credential chain. See the session package for more information on this chain, and how to configure it. The common items in the credential chain are the following:

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

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

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

Credentials can be configured in code as well by setting the Config's Credentials value to a custom provider or using one of the providers included with the SDK to bypass the default credential chain and use a custom one. This is helpful when you want to instruct the SDK to only use a specific set of credentials 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 the credentials package documentation for more information on credential providers included with the SDK, and how to customize the SDK's usage of credentials.

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

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

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

To set the region via the environment variable set the "AWS_REGION" to the region you want to the SDK to use. Using this method to set the region will allow you to run your application in multiple regions without needing additional code in the application to select the region.

AWS_REGION=us-west-2

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

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

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

See the endpoints package for the AWS Regions and Endpoints metadata.

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

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

See the Config type in the aws package for more information and additional options such as setting the Endpoint, and other service client configuration options.

Making API Requests

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 response and 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 different ways 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 the API request, but not send it. This is also helpful when you want to get a presigned URL for a request, and share the presigned URL instead of your application making the request directly.

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

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

  • ListObjectsPagesWithContext - same as ListObjectsPages, but adds support for the Context pattern. Similar to ListObjectsWithContext this method also takes the request package's Option function option types as the variadic argument.

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

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

  • WaitUntilBucketExistsWithContext - Same as WaitUntilBucketExists, but adds support for the Context pattern. In addition these methods take request package's WaiterOptions to configure the waiter, and how underlying request will be made by the SDK.

The API method will document which error codes the service might return for the operation. These errors will also be available as const strings prefixed with "ErrCode" in the service client's package. If there are no errors listed in the API's SDK documentation you'll need to consult the AWS service's API documentation 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"),
  })
  if err != nil {
      // Cast err to awserr.Error to handle specific error codes.
      aerr, ok := err.(awserr.Error)
      if ok && aerr.Code() == s3.ErrCodeNoSuchKey {
          // Specific error code handling
      }
      return err
  }

  // Make sure to close the body when done with it for S3 GetObject APIs or
  // will leak connections.
  defer result.Body.Close()

  fmt.Println("Object Size:", aws.StringValue(result.ContentLength))
API Request Pagination and Resource Waiters

Pagination helper methods are suffixed with "Pages", and provide the functionality needed to round trip API page requests. Pagination methods take 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, lastPage bool) bool {
       for _, o := range p.Contents {
           objects = append(objects, aws.StringValue(o.Key))
       }
       return true // continue paging
   })
   if err != 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 resource state. These methods abstract the logic needed to to check the state of an AWS resource, and wait until that resource is in a desired state. The waiter will 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 will be request.WaiterResourceNotReadyErrorCode.

  err := svc.WaitUntilBucketExistsWithContext(ctx, &s3.HeadBucketInput{
      Bucket: aws.String(myBucket),
  })
  if err != nil {
      aerr, ok := err.(awserr.Error)
      if ok && 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")

Complete SDK Example

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

  package main

  import (
  	"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.txt
  func main() {
  	var bucket, key string
  	var timeout time.Duration

  	flag.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()
  	var cancelFn func()
  	if timeout > 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/
  	defer cancelFn()

  	// 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,
  	})
  	if err != nil {
  		if aerr, 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)
  }

License

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

Documentation

Overview

Package sdk is the official AWS SDK for the Go programming language.

The AWS SDK for Go provides APIs and utilities that developers can use to build Go applications that use AWS services, such as Amazon Elastic Compute Cloud (Amazon EC2) and Amazon Simple Storage Service (Amazon S3).

The SDK removes the complexity of coding directly against a web service interface. It hides a lot of the lower-level plumbing, such as authentication, request retries, and error handling.

The SDK also includes helpful utilities on top of the AWS APIs that add additional capabilities and functionality. For example, the Amazon S3 Download and Upload Manager will automatically split up large objects into multiple parts and transfer them concurrently.

See the s3manager package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/s3/s3manager/

Getting More Information

Checkout the Getting Started Guide and API Reference Docs detailed the SDK's components and details on each AWS client the SDK supports.

The Getting Started Guide provides examples and detailed description of how to get setup with the SDK. https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/welcome.html

The API Reference Docs include a detailed breakdown of the SDK's components such as utilities and AWS clients. Use this as a reference of the Go types included with the SDK, such as AWS clients, API operations, and API parameters. https://docs.aws.amazon.com/sdk-for-go/api/

Overview of SDK's Packages

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 of the SDK. Each client for a supported AWS service is available within its own package 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 all errors that occur in the SDK's processing. This includes service API response 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 Code method to compare returned error to specific error codes. See the package's documentation for additional values that can be extracted such as RequestId.

  • credentials - Provides the types and built in credentials providers the SDK will use to retrieve AWS credentials to make API requests with. Nested under this folder are also additional credentials providers such as stscreds 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 services are in a region, and what regions a service is in. Constants are also provided for all region identifiers, e.g UsWest2RegionID for "us-west-2".

  • session - Provides initial default configuration, and load configuration from external sources such as environment and shared credentials file.

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

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

How to Use the SDK's AWS Service Clients

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

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

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

Configuring the SDK

In the AWS SDK for Go, you can configure settings for service clients, such as 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 sign requests with the correct credentials. You can specify these values as part of a session or as environment variables.

See the SDK's configuration guide for more information. https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html

See the session package documentation for more information on how to use Session with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/session/

See the Config type in the aws package for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

Configuring Credentials

When using the SDK you'll generally need your AWS credentials to authenticate with AWS services. The SDK supports multiple methods of supporting these credentials. By default the SDK will source credentials automatically from its default credential chain. See the session package for more information on this chain, and how to configure it. The common items in the credential chain are the following:

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

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

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

Credentials can be configured in code as well by setting the Config's Credentials value to a custom provider or using one of the providers included with the SDK to bypass the default credential chain and use a custom one. This is helpful when you want to instruct the SDK to only use a specific set of credentials 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 the credentials package documentation for more information on credential providers included with the SDK, and how to customize the SDK's usage of credentials. https://docs.aws.amazon.com/sdk-for-go/api/aws/credentials

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

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

Configuring AWS Region

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

To set the region via the environment variable set the "AWS_REGION" to the region you want to the SDK to use. Using this method to set the region will allow you to run your application in multiple regions without needing additional code in the application to select the region.

AWS_REGION=us-west-2

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

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

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

See the endpoints package for the AWS Regions and Endpoints metadata. https://docs.aws.amazon.com/sdk-for-go/api/aws/endpoints/

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

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

See the Config type in the aws package for more information and additional options such as setting the Endpoint, and other service client configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

Making API Requests

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 response and 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 different ways 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 the API request, but not send it. This is also helpful when you want to get a presigned URL for a request, and share the presigned URL instead of your application making the request directly.

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

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

  • ListObjectsPagesWithContext - same as ListObjectsPages, but adds support for the Context pattern. Similar to ListObjectsWithContext this method also takes the request package's Option function option types as the variadic argument.

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

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

  • WaitUntilBucketExistsWithContext - Same as WaitUntilBucketExists, but adds support for the Context pattern. In addition these methods take request package's WaiterOptions to configure the waiter, and how underlying request will be made by the SDK.

The API method will document which error codes the service might return for the operation. These errors will also be available as const strings prefixed with "ErrCode" in the service client's package. If there are no errors listed in the API's SDK documentation you'll need to consult the AWS service's API documentation 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"),
})
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == s3.ErrCodeNoSuchKey {
        // Specific error code handling
    }
    return err
}

// Make sure to close the body when done with it for S3 GetObject APIs or
// will leak connections.
defer result.Body.Close()

fmt.Println("Object Size:", aws.StringValue(result.ContentLength))

API Request Pagination and Resource Waiters

Pagination helper methods are suffixed with "Pages", and provide the functionality needed to round trip API page requests. Pagination methods take 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, lastPage bool) bool {
    for _, o := range p.Contents {
        objects = append(objects, aws.StringValue(o.Key))
    }
    return true // continue paging
})
if err != 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 resource state. These methods abstract the logic needed to to check the state of an AWS resource, and wait until that resource is in a desired state. The waiter will 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 will be request.WaiterResourceNotReadyErrorCode.

err := svc.WaitUntilBucketExistsWithContext(ctx, &s3.HeadBucketInput{
    Bucket: aws.String(myBucket),
})
if err != nil {
    aerr, ok := err.(awserr.Error)
    if ok && 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")

Complete SDK Example

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

 package main

 import (
 	"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.txt
 func main() {
 	var bucket, key string
 	var timeout time.Duration

 	flag.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()
 	var cancelFn func()
 	if timeout > 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/
 	defer cancelFn()

 	// 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,
 	})
 	if err != nil {
 		if aerr, 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)
 }

Directories

Path Synopsis
aws
Package aws provides the core SDK's utilities and shared types.
Package aws provides the core SDK's utilities and shared types.
awserr
Package awserr represents API error interface accessors for the SDK.
Package awserr represents API error interface accessors for the SDK.
credentials
Package credentials provides credential retrieval and management The Credentials is the primary method of getting access to and managing credentials Values.
Package credentials provides credential retrieval and management The Credentials is the primary method of getting access to and managing credentials Values.
credentials/endpointcreds
Package endpointcreds provides support for retrieving credentials from an arbitrary HTTP endpoint.
Package endpointcreds provides support for retrieving credentials from an arbitrary HTTP endpoint.
credentials/stscreds
Package stscreds are credential Providers to retrieve STS AWS credentials.
Package stscreds are credential Providers to retrieve STS AWS credentials.
defaults
Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers.
Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers.
ec2metadata
Package ec2metadata provides the client for making API calls to the EC2 Metadata service.
Package ec2metadata provides the client for making API calls to the EC2 Metadata service.
endpoints
Package endpoints provides the types and functionality for defining regions and endpoints, as well as querying those definitions.
Package endpoints provides the types and functionality for defining regions and endpoints, as well as querying those definitions.
session
Package session provides configuration for the SDK's service clients.
Package session provides configuration for the SDK's service clients.
signer/v4
Package v4 implements signing for AWS V4 signer Provides request signing for request that need to be signed with AWS V4 Signatures.
Package v4 implements signing for AWS V4 signer Provides request signing for request that need to be signed with AWS V4 Signatures.
unit
Package unit performs initialization and validation for unit tests
Package unit performs initialization and validation for unit tests
internal
models
endpoints
Package endpoints contains the models for endpoints that should be used to generate endpoint definition files for the SDK.
Package endpoints contains the models for endpoints that should be used to generate endpoint definition files for the SDK.
private
protocol/ec2query
Package ec2query provides serialization of AWS EC2 requests and responses.
Package ec2query provides serialization of AWS EC2 requests and responses.
protocol/json/jsonutil
Package jsonutil provides JSON serialization of AWS requests and responses.
Package jsonutil provides JSON serialization of AWS requests and responses.
protocol/jsonrpc
Package jsonrpc provides JSON RPC utilities for serialization of AWS requests and responses.
Package jsonrpc provides JSON RPC utilities for serialization of AWS requests and responses.
protocol/query
Package query provides serialization of AWS query requests, and responses.
Package query provides serialization of AWS query requests, and responses.
protocol/rest
Package rest provides RESTful serialization of AWS requests and responses.
Package rest provides RESTful serialization of AWS requests and responses.
protocol/restjson
Package restjson provides RESTful JSON serialization of AWS requests and responses.
Package restjson provides RESTful JSON serialization of AWS requests and responses.
protocol/restxml
Package restxml provides RESTful XML serialization of AWS requests and responses.
Package restxml provides RESTful XML serialization of AWS requests and responses.
protocol/xml/xmlutil
Package xmlutil provides XML serialization of AWS requests and responses.
Package xmlutil provides XML serialization of AWS requests and responses.
Package service contains automatically generated AWS clients.
Package service contains automatically generated AWS clients.
acm
Package acm provides the client and types for making API requests to AWS Certificate Manager.
Package acm provides the client and types for making API requests to AWS Certificate Manager.
acm/acmiface
Package acmiface provides an interface to enable mocking the AWS Certificate Manager service client for testing your code.
Package acmiface provides an interface to enable mocking the AWS Certificate Manager service client for testing your code.
apigateway
Package apigateway provides the client and types for making API requests to Amazon API Gateway.
Package apigateway provides the client and types for making API requests to Amazon API Gateway.
apigateway/apigatewayiface
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.
Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.
applicationautoscaling
Package applicationautoscaling provides the client and types for making API requests to Application Auto Scaling.
Package applicationautoscaling provides the client and types for making API requests to Application Auto Scaling.
applicationautoscaling/applicationautoscalingiface
Package applicationautoscalingiface provides an interface to enable mocking the Application Auto Scaling service client for testing your code.
Package applicationautoscalingiface provides an interface to enable mocking the Application Auto Scaling service client for testing your code.
applicationdiscoveryservice
Package applicationdiscoveryservice provides the client and types for making API requests to AWS Application Discovery Service.
Package applicationdiscoveryservice provides the client and types for making API requests to AWS Application Discovery Service.
applicationdiscoveryservice/applicationdiscoveryserviceiface
Package applicationdiscoveryserviceiface provides an interface to enable mocking the AWS Application Discovery Service service client for testing your code.
Package applicationdiscoveryserviceiface provides an interface to enable mocking the AWS Application Discovery Service service client for testing your code.
appstream
Package appstream provides the client and types for making API requests to Amazon AppStream.
Package appstream provides the client and types for making API requests to Amazon AppStream.
appstream/appstreamiface
Package appstreamiface provides an interface to enable mocking the Amazon AppStream service client for testing your code.
Package appstreamiface provides an interface to enable mocking the Amazon AppStream service client for testing your code.
athena
Package athena provides the client and types for making API requests to Amazon Athena.
Package athena provides the client and types for making API requests to Amazon Athena.
athena/athenaiface
Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.
Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.
autoscaling
Package autoscaling provides the client and types for making API requests to Auto Scaling.
Package autoscaling provides the client and types for making API requests to Auto Scaling.
autoscaling/autoscalingiface
Package autoscalingiface provides an interface to enable mocking the Auto Scaling service client for testing your code.
Package autoscalingiface provides an interface to enable mocking the Auto Scaling service client for testing your code.
batch
Package batch provides the client and types for making API requests to AWS Batch.
Package batch provides the client and types for making API requests to AWS Batch.
batch/batchiface
Package batchiface provides an interface to enable mocking the AWS Batch service client for testing your code.
Package batchiface provides an interface to enable mocking the AWS Batch service client for testing your code.
budgets
Package budgets provides the client and types for making API requests to AWS Budgets.
Package budgets provides the client and types for making API requests to AWS Budgets.
budgets/budgetsiface
Package budgetsiface provides an interface to enable mocking the AWS Budgets service client for testing your code.
Package budgetsiface provides an interface to enable mocking the AWS Budgets service client for testing your code.
clouddirectory
Package clouddirectory provides the client and types for making API requests to Amazon CloudDirectory.
Package clouddirectory provides the client and types for making API requests to Amazon CloudDirectory.
clouddirectory/clouddirectoryiface
Package clouddirectoryiface provides an interface to enable mocking the Amazon CloudDirectory service client for testing your code.
Package clouddirectoryiface provides an interface to enable mocking the Amazon CloudDirectory service client for testing your code.
cloudformation
Package cloudformation provides the client and types for making API requests to AWS CloudFormation.
Package cloudformation provides the client and types for making API requests to AWS CloudFormation.
cloudformation/cloudformationiface
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code.
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code.
cloudfront
Package cloudfront provides the client and types for making API requests to Amazon CloudFront.
Package cloudfront provides the client and types for making API requests to Amazon CloudFront.
cloudfront/cloudfrontiface
Package cloudfrontiface provides an interface to enable mocking the Amazon CloudFront service client for testing your code.
Package cloudfrontiface provides an interface to enable mocking the Amazon CloudFront service client for testing your code.
cloudfront/sign
Package sign provides utilities to generate signed URLs for Amazon CloudFront.
Package sign provides utilities to generate signed URLs for Amazon CloudFront.
cloudhsm
Package cloudhsm provides the client and types for making API requests to Amazon CloudHSM.
Package cloudhsm provides the client and types for making API requests to Amazon CloudHSM.
cloudhsm/cloudhsmiface
Package cloudhsmiface provides an interface to enable mocking the Amazon CloudHSM service client for testing your code.
Package cloudhsmiface provides an interface to enable mocking the Amazon CloudHSM service client for testing your code.
cloudsearch
Package cloudsearch provides the client and types for making API requests to Amazon CloudSearch.
Package cloudsearch provides the client and types for making API requests to Amazon CloudSearch.
cloudsearch/cloudsearchiface
Package cloudsearchiface provides an interface to enable mocking the Amazon CloudSearch service client for testing your code.
Package cloudsearchiface provides an interface to enable mocking the Amazon CloudSearch service client for testing your code.
cloudsearchdomain
Package cloudsearchdomain provides the client and types for making API requests to Amazon CloudSearch Domain.
Package cloudsearchdomain provides the client and types for making API requests to Amazon CloudSearch Domain.
cloudsearchdomain/cloudsearchdomainiface
Package cloudsearchdomainiface provides an interface to enable mocking the Amazon CloudSearch Domain service client for testing your code.
Package cloudsearchdomainiface provides an interface to enable mocking the Amazon CloudSearch Domain service client for testing your code.
cloudtrail
Package cloudtrail provides the client and types for making API requests to AWS CloudTrail.
Package cloudtrail provides the client and types for making API requests to AWS CloudTrail.
cloudtrail/cloudtrailiface
Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code.
Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code.
cloudwatch
Package cloudwatch provides the client and types for making API requests to Amazon CloudWatch.
Package cloudwatch provides the client and types for making API requests to Amazon CloudWatch.
cloudwatch/cloudwatchiface
Package cloudwatchiface provides an interface to enable mocking the Amazon CloudWatch service client for testing your code.
Package cloudwatchiface provides an interface to enable mocking the Amazon CloudWatch service client for testing your code.
cloudwatchevents
Package cloudwatchevents provides the client and types for making API requests to Amazon CloudWatch Events.
Package cloudwatchevents provides the client and types for making API requests to Amazon CloudWatch Events.
cloudwatchevents/cloudwatcheventsiface
Package cloudwatcheventsiface provides an interface to enable mocking the Amazon CloudWatch Events service client for testing your code.
Package cloudwatcheventsiface provides an interface to enable mocking the Amazon CloudWatch Events service client for testing your code.
cloudwatchlogs
Package cloudwatchlogs provides the client and types for making API requests to Amazon CloudWatch Logs.
Package cloudwatchlogs provides the client and types for making API requests to Amazon CloudWatch Logs.
cloudwatchlogs/cloudwatchlogsiface
Package cloudwatchlogsiface provides an interface to enable mocking the Amazon CloudWatch Logs service client for testing your code.
Package cloudwatchlogsiface provides an interface to enable mocking the Amazon CloudWatch Logs service client for testing your code.
codebuild
Package codebuild provides the client and types for making API requests to AWS CodeBuild.
Package codebuild provides the client and types for making API requests to AWS CodeBuild.
codebuild/codebuildiface
Package codebuildiface provides an interface to enable mocking the AWS CodeBuild service client for testing your code.
Package codebuildiface provides an interface to enable mocking the AWS CodeBuild service client for testing your code.
codecommit
Package codecommit provides the client and types for making API requests to AWS CodeCommit.
Package codecommit provides the client and types for making API requests to AWS CodeCommit.
codecommit/codecommitiface
Package codecommitiface provides an interface to enable mocking the AWS CodeCommit service client for testing your code.
Package codecommitiface provides an interface to enable mocking the AWS CodeCommit service client for testing your code.
codedeploy
Package codedeploy provides the client and types for making API requests to AWS CodeDeploy.
Package codedeploy provides the client and types for making API requests to AWS CodeDeploy.
codedeploy/codedeployiface
Package codedeployiface provides an interface to enable mocking the AWS CodeDeploy service client for testing your code.
Package codedeployiface provides an interface to enable mocking the AWS CodeDeploy service client for testing your code.
codepipeline
Package codepipeline provides the client and types for making API requests to AWS CodePipeline.
Package codepipeline provides the client and types for making API requests to AWS CodePipeline.
codepipeline/codepipelineiface
Package codepipelineiface provides an interface to enable mocking the AWS CodePipeline service client for testing your code.
Package codepipelineiface provides an interface to enable mocking the AWS CodePipeline service client for testing your code.
codestar
Package codestar provides the client and types for making API requests to AWS CodeStar.
Package codestar provides the client and types for making API requests to AWS CodeStar.
codestar/codestariface
Package codestariface provides an interface to enable mocking the AWS CodeStar service client for testing your code.
Package codestariface provides an interface to enable mocking the AWS CodeStar service client for testing your code.
cognitoidentity
Package cognitoidentity provides the client and types for making API requests to Amazon Cognito Identity.
Package cognitoidentity provides the client and types for making API requests to Amazon Cognito Identity.
cognitoidentity/cognitoidentityiface
Package cognitoidentityiface provides an interface to enable mocking the Amazon Cognito Identity service client for testing your code.
Package cognitoidentityiface provides an interface to enable mocking the Amazon Cognito Identity service client for testing your code.
cognitoidentityprovider
Package cognitoidentityprovider provides the client and types for making API requests to Amazon Cognito Identity Provider.
Package cognitoidentityprovider provides the client and types for making API requests to Amazon Cognito Identity Provider.
cognitoidentityprovider/cognitoidentityprovideriface
Package cognitoidentityprovideriface provides an interface to enable mocking the Amazon Cognito Identity Provider service client for testing your code.
Package cognitoidentityprovideriface provides an interface to enable mocking the Amazon Cognito Identity Provider service client for testing your code.
cognitosync
Package cognitosync provides the client and types for making API requests to Amazon Cognito Sync.
Package cognitosync provides the client and types for making API requests to Amazon Cognito Sync.
cognitosync/cognitosynciface
Package cognitosynciface provides an interface to enable mocking the Amazon Cognito Sync service client for testing your code.
Package cognitosynciface provides an interface to enable mocking the Amazon Cognito Sync service client for testing your code.
configservice
Package configservice provides the client and types for making API requests to AWS Config.
Package configservice provides the client and types for making API requests to AWS Config.
configservice/configserviceiface
Package configserviceiface provides an interface to enable mocking the AWS Config service client for testing your code.
Package configserviceiface provides an interface to enable mocking the AWS Config service client for testing your code.
costandusagereportservice
Package costandusagereportservice provides the client and types for making API requests to AWS Cost and Usage Report Service.
Package costandusagereportservice provides the client and types for making API requests to AWS Cost and Usage Report Service.
costandusagereportservice/costandusagereportserviceiface
Package costandusagereportserviceiface provides an interface to enable mocking the AWS Cost and Usage Report Service service client for testing your code.
Package costandusagereportserviceiface provides an interface to enable mocking the AWS Cost and Usage Report Service service client for testing your code.
databasemigrationservice
Package databasemigrationservice provides the client and types for making API requests to AWS Database Migration Service.
Package databasemigrationservice provides the client and types for making API requests to AWS Database Migration Service.
databasemigrationservice/databasemigrationserviceiface
Package databasemigrationserviceiface provides an interface to enable mocking the AWS Database Migration Service service client for testing your code.
Package databasemigrationserviceiface provides an interface to enable mocking the AWS Database Migration Service service client for testing your code.
datapipeline
Package datapipeline provides the client and types for making API requests to AWS Data Pipeline.
Package datapipeline provides the client and types for making API requests to AWS Data Pipeline.
datapipeline/datapipelineiface
Package datapipelineiface provides an interface to enable mocking the AWS Data Pipeline service client for testing your code.
Package datapipelineiface provides an interface to enable mocking the AWS Data Pipeline service client for testing your code.
devicefarm
Package devicefarm provides the client and types for making API requests to AWS Device Farm.
Package devicefarm provides the client and types for making API requests to AWS Device Farm.
devicefarm/devicefarmiface
Package devicefarmiface provides an interface to enable mocking the AWS Device Farm service client for testing your code.
Package devicefarmiface provides an interface to enable mocking the AWS Device Farm service client for testing your code.
directconnect
Package directconnect provides the client and types for making API requests to AWS Direct Connect.
Package directconnect provides the client and types for making API requests to AWS Direct Connect.
directconnect/directconnectiface
Package directconnectiface provides an interface to enable mocking the AWS Direct Connect service client for testing your code.
Package directconnectiface provides an interface to enable mocking the AWS Direct Connect service client for testing your code.
directoryservice
Package directoryservice provides the client and types for making API requests to AWS Directory Service.
Package directoryservice provides the client and types for making API requests to AWS Directory Service.
directoryservice/directoryserviceiface
Package directoryserviceiface provides an interface to enable mocking the AWS Directory Service service client for testing your code.
Package directoryserviceiface provides an interface to enable mocking the AWS Directory Service service client for testing your code.
dynamodb
Package dynamodb provides the client and types for making API requests to Amazon DynamoDB.
Package dynamodb provides the client and types for making API requests to Amazon DynamoDB.
dynamodb/dynamodbattribute
Package dynamodbattribute provides marshaling and unmarshaling utilities to convert between Go types and dynamodb.AttributeValues.
Package dynamodbattribute provides marshaling and unmarshaling utilities to convert between Go types and dynamodb.AttributeValues.
dynamodb/dynamodbiface
Package dynamodbiface provides an interface to enable mocking the Amazon DynamoDB service client for testing your code.
Package dynamodbiface provides an interface to enable mocking the Amazon DynamoDB service client for testing your code.
dynamodbstreams
Package dynamodbstreams provides the client and types for making API requests to Amazon DynamoDB Streams.
Package dynamodbstreams provides the client and types for making API requests to Amazon DynamoDB Streams.
dynamodbstreams/dynamodbstreamsiface
Package dynamodbstreamsiface provides an interface to enable mocking the Amazon DynamoDB Streams service client for testing your code.
Package dynamodbstreamsiface provides an interface to enable mocking the Amazon DynamoDB Streams service client for testing your code.
ec2
Package ec2 provides the client and types for making API requests to Amazon Elastic Compute Cloud.
Package ec2 provides the client and types for making API requests to Amazon Elastic Compute Cloud.
ec2/ec2iface
Package ec2iface provides an interface to enable mocking the Amazon Elastic Compute Cloud service client for testing your code.
Package ec2iface provides an interface to enable mocking the Amazon Elastic Compute Cloud service client for testing your code.
ecr
Package ecr provides the client and types for making API requests to Amazon EC2 Container Registry.
Package ecr provides the client and types for making API requests to Amazon EC2 Container Registry.
ecr/ecriface
Package ecriface provides an interface to enable mocking the Amazon EC2 Container Registry service client for testing your code.
Package ecriface provides an interface to enable mocking the Amazon EC2 Container Registry service client for testing your code.
ecs
Package ecs provides the client and types for making API requests to Amazon EC2 Container Service.
Package ecs provides the client and types for making API requests to Amazon EC2 Container Service.
ecs/ecsiface
Package ecsiface provides an interface to enable mocking the Amazon EC2 Container Service service client for testing your code.
Package ecsiface provides an interface to enable mocking the Amazon EC2 Container Service service client for testing your code.
efs
Package efs provides the client and types for making API requests to Amazon Elastic File System.
Package efs provides the client and types for making API requests to Amazon Elastic File System.
efs/efsiface
Package efsiface provides an interface to enable mocking the Amazon Elastic File System service client for testing your code.
Package efsiface provides an interface to enable mocking the Amazon Elastic File System service client for testing your code.
elasticache
Package elasticache provides the client and types for making API requests to Amazon ElastiCache.
Package elasticache provides the client and types for making API requests to Amazon ElastiCache.
elasticache/elasticacheiface
Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.
Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.
elasticbeanstalk
Package elasticbeanstalk provides the client and types for making API requests to AWS Elastic Beanstalk.
Package elasticbeanstalk provides the client and types for making API requests to AWS Elastic Beanstalk.
elasticbeanstalk/elasticbeanstalkiface
Package elasticbeanstalkiface provides an interface to enable mocking the AWS Elastic Beanstalk service client for testing your code.
Package elasticbeanstalkiface provides an interface to enable mocking the AWS Elastic Beanstalk service client for testing your code.
elasticsearchservice
Package elasticsearchservice provides the client and types for making API requests to Amazon Elasticsearch Service.
Package elasticsearchservice provides the client and types for making API requests to Amazon Elasticsearch Service.
elasticsearchservice/elasticsearchserviceiface
Package elasticsearchserviceiface provides an interface to enable mocking the Amazon Elasticsearch Service service client for testing your code.
Package elasticsearchserviceiface provides an interface to enable mocking the Amazon Elasticsearch Service service client for testing your code.
elastictranscoder
Package elastictranscoder provides the client and types for making API requests to Amazon Elastic Transcoder.
Package elastictranscoder provides the client and types for making API requests to Amazon Elastic Transcoder.
elastictranscoder/elastictranscoderiface
Package elastictranscoderiface provides an interface to enable mocking the Amazon Elastic Transcoder service client for testing your code.
Package elastictranscoderiface provides an interface to enable mocking the Amazon Elastic Transcoder service client for testing your code.
elb
Package elb provides the client and types for making API requests to Elastic Load Balancing.
Package elb provides the client and types for making API requests to Elastic Load Balancing.
elb/elbiface
Package elbiface provides an interface to enable mocking the Elastic Load Balancing service client for testing your code.
Package elbiface provides an interface to enable mocking the Elastic Load Balancing service client for testing your code.
elbv2
Package elbv2 provides the client and types for making API requests to Elastic Load Balancing.
Package elbv2 provides the client and types for making API requests to Elastic Load Balancing.
elbv2/elbv2iface
Package elbv2iface provides an interface to enable mocking the Elastic Load Balancing service client for testing your code.
Package elbv2iface provides an interface to enable mocking the Elastic Load Balancing service client for testing your code.
emr
Package emr provides the client and types for making API requests to Amazon Elastic MapReduce.
Package emr provides the client and types for making API requests to Amazon Elastic MapReduce.
emr/emriface
Package emriface provides an interface to enable mocking the Amazon Elastic MapReduce service client for testing your code.
Package emriface provides an interface to enable mocking the Amazon Elastic MapReduce service client for testing your code.
firehose
Package firehose provides the client and types for making API requests to Amazon Kinesis Firehose.
Package firehose provides the client and types for making API requests to Amazon Kinesis Firehose.
firehose/firehoseiface
Package firehoseiface provides an interface to enable mocking the Amazon Kinesis Firehose service client for testing your code.
Package firehoseiface provides an interface to enable mocking the Amazon Kinesis Firehose service client for testing your code.
gamelift
Package gamelift provides the client and types for making API requests to Amazon GameLift.
Package gamelift provides the client and types for making API requests to Amazon GameLift.
gamelift/gameliftiface
Package gameliftiface provides an interface to enable mocking the Amazon GameLift service client for testing your code.
Package gameliftiface provides an interface to enable mocking the Amazon GameLift service client for testing your code.
glacier
Package glacier provides the client and types for making API requests to Amazon Glacier.
Package glacier provides the client and types for making API requests to Amazon Glacier.
glacier/glacieriface
Package glacieriface provides an interface to enable mocking the Amazon Glacier service client for testing your code.
Package glacieriface provides an interface to enable mocking the Amazon Glacier service client for testing your code.
health
Package health provides the client and types for making API requests to AWS Health APIs and Notifications.
Package health provides the client and types for making API requests to AWS Health APIs and Notifications.
health/healthiface
Package healthiface provides an interface to enable mocking the AWS Health APIs and Notifications service client for testing your code.
Package healthiface provides an interface to enable mocking the AWS Health APIs and Notifications service client for testing your code.
iam
Package iam provides the client and types for making API requests to AWS Identity and Access Management.
Package iam provides the client and types for making API requests to AWS Identity and Access Management.
iam/iamiface
Package iamiface provides an interface to enable mocking the AWS Identity and Access Management service client for testing your code.
Package iamiface provides an interface to enable mocking the AWS Identity and Access Management service client for testing your code.
inspector
Package inspector provides the client and types for making API requests to Amazon Inspector.
Package inspector provides the client and types for making API requests to Amazon Inspector.
inspector/inspectoriface
Package inspectoriface provides an interface to enable mocking the Amazon Inspector service client for testing your code.
Package inspectoriface provides an interface to enable mocking the Amazon Inspector service client for testing your code.
iot
Package iot provides the client and types for making API requests to AWS IoT. AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud.
Package iot provides the client and types for making API requests to AWS IoT. AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud.
iot/iotiface
Package iotiface provides an interface to enable mocking the AWS IoT service client for testing your code.
Package iotiface provides an interface to enable mocking the AWS IoT service client for testing your code.
iotdataplane
Package iotdataplane provides the client and types for making API requests to AWS IoT Data Plane.
Package iotdataplane provides the client and types for making API requests to AWS IoT Data Plane.
iotdataplane/iotdataplaneiface
Package iotdataplaneiface provides an interface to enable mocking the AWS IoT Data Plane service client for testing your code.
Package iotdataplaneiface provides an interface to enable mocking the AWS IoT Data Plane service client for testing your code.
kinesis
Package kinesis provides the client and types for making API requests to Amazon Kinesis.
Package kinesis provides the client and types for making API requests to Amazon Kinesis.
kinesis/kinesisiface
Package kinesisiface provides an interface to enable mocking the Amazon Kinesis service client for testing your code.
Package kinesisiface provides an interface to enable mocking the Amazon Kinesis service client for testing your code.
kinesisanalytics
Package kinesisanalytics provides the client and types for making API requests to Amazon Kinesis Analytics.
Package kinesisanalytics provides the client and types for making API requests to Amazon Kinesis Analytics.
kinesisanalytics/kinesisanalyticsiface
Package kinesisanalyticsiface provides an interface to enable mocking the Amazon Kinesis Analytics service client for testing your code.
Package kinesisanalyticsiface provides an interface to enable mocking the Amazon Kinesis Analytics service client for testing your code.
kms
Package kms provides the client and types for making API requests to AWS Key Management Service.
Package kms provides the client and types for making API requests to AWS Key Management Service.
kms/kmsiface
Package kmsiface provides an interface to enable mocking the AWS Key Management Service service client for testing your code.
Package kmsiface provides an interface to enable mocking the AWS Key Management Service service client for testing your code.
lambda
Package lambda provides the client and types for making API requests to AWS Lambda.
Package lambda provides the client and types for making API requests to AWS Lambda.
lambda/lambdaiface
Package lambdaiface provides an interface to enable mocking the AWS Lambda service client for testing your code.
Package lambdaiface provides an interface to enable mocking the AWS Lambda service client for testing your code.
lexmodelbuildingservice
Package lexmodelbuildingservice provides the client and types for making API requests to Amazon Lex Model Building Service.
Package lexmodelbuildingservice provides the client and types for making API requests to Amazon Lex Model Building Service.
lexmodelbuildingservice/lexmodelbuildingserviceiface
Package lexmodelbuildingserviceiface provides an interface to enable mocking the Amazon Lex Model Building Service service client for testing your code.
Package lexmodelbuildingserviceiface provides an interface to enable mocking the Amazon Lex Model Building Service service client for testing your code.
lexruntimeservice
Package lexruntimeservice provides the client and types for making API requests to Amazon Lex Runtime Service.
Package lexruntimeservice provides the client and types for making API requests to Amazon Lex Runtime Service.
lexruntimeservice/lexruntimeserviceiface
Package lexruntimeserviceiface provides an interface to enable mocking the Amazon Lex Runtime Service service client for testing your code.
Package lexruntimeserviceiface provides an interface to enable mocking the Amazon Lex Runtime Service service client for testing your code.
lightsail
Package lightsail provides the client and types for making API requests to Amazon Lightsail.
Package lightsail provides the client and types for making API requests to Amazon Lightsail.
lightsail/lightsailiface
Package lightsailiface provides an interface to enable mocking the Amazon Lightsail service client for testing your code.
Package lightsailiface provides an interface to enable mocking the Amazon Lightsail service client for testing your code.
machinelearning
Package machinelearning provides the client and types for making API requests to Amazon Machine Learning.
Package machinelearning provides the client and types for making API requests to Amazon Machine Learning.
machinelearning/machinelearningiface
Package machinelearningiface provides an interface to enable mocking the Amazon Machine Learning service client for testing your code.
Package machinelearningiface provides an interface to enable mocking the Amazon Machine Learning service client for testing your code.
marketplacecommerceanalytics
Package marketplacecommerceanalytics provides the client and types for making API requests to AWS Marketplace Commerce Analytics.
Package marketplacecommerceanalytics provides the client and types for making API requests to AWS Marketplace Commerce Analytics.
marketplacecommerceanalytics/marketplacecommerceanalyticsiface
Package marketplacecommerceanalyticsiface provides an interface to enable mocking the AWS Marketplace Commerce Analytics service client for testing your code.
Package marketplacecommerceanalyticsiface provides an interface to enable mocking the AWS Marketplace Commerce Analytics service client for testing your code.
marketplaceentitlementservice
Package marketplaceentitlementservice provides the client and types for making API requests to AWS Marketplace Entitlement Service.
Package marketplaceentitlementservice provides the client and types for making API requests to AWS Marketplace Entitlement Service.
marketplaceentitlementservice/marketplaceentitlementserviceiface
Package marketplaceentitlementserviceiface provides an interface to enable mocking the AWS Marketplace Entitlement Service service client for testing your code.
Package marketplaceentitlementserviceiface provides an interface to enable mocking the AWS Marketplace Entitlement Service service client for testing your code.
marketplacemetering
Package marketplacemetering provides the client and types for making API requests to AWSMarketplace Metering.
Package marketplacemetering provides the client and types for making API requests to AWSMarketplace Metering.
marketplacemetering/marketplacemeteringiface
Package marketplacemeteringiface provides an interface to enable mocking the AWSMarketplace Metering service client for testing your code.
Package marketplacemeteringiface provides an interface to enable mocking the AWSMarketplace Metering service client for testing your code.
mobileanalytics
Package mobileanalytics provides the client and types for making API requests to Amazon Mobile Analytics.
Package mobileanalytics provides the client and types for making API requests to Amazon Mobile Analytics.
mobileanalytics/mobileanalyticsiface
Package mobileanalyticsiface provides an interface to enable mocking the Amazon Mobile Analytics service client for testing your code.
Package mobileanalyticsiface provides an interface to enable mocking the Amazon Mobile Analytics service client for testing your code.
mturk
Package mturk provides the client and types for making API requests to Amazon Mechanical Turk.
Package mturk provides the client and types for making API requests to Amazon Mechanical Turk.
mturk/mturkiface
Package mturkiface provides an interface to enable mocking the Amazon Mechanical Turk service client for testing your code.
Package mturkiface provides an interface to enable mocking the Amazon Mechanical Turk service client for testing your code.
opsworks
Package opsworks provides the client and types for making API requests to AWS OpsWorks.
Package opsworks provides the client and types for making API requests to AWS OpsWorks.
opsworks/opsworksiface
Package opsworksiface provides an interface to enable mocking the AWS OpsWorks service client for testing your code.
Package opsworksiface provides an interface to enable mocking the AWS OpsWorks service client for testing your code.
opsworkscm
Package opsworkscm provides the client and types for making API requests to AWS OpsWorks for Chef Automate.
Package opsworkscm provides the client and types for making API requests to AWS OpsWorks for Chef Automate.
opsworkscm/opsworkscmiface
Package opsworkscmiface provides an interface to enable mocking the AWS OpsWorks for Chef Automate service client for testing your code.
Package opsworkscmiface provides an interface to enable mocking the AWS OpsWorks for Chef Automate service client for testing your code.
organizations
Package organizations provides the client and types for making API requests to AWS Organizations.
Package organizations provides the client and types for making API requests to AWS Organizations.
organizations/organizationsiface
Package organizationsiface provides an interface to enable mocking the AWS Organizations service client for testing your code.
Package organizationsiface provides an interface to enable mocking the AWS Organizations service client for testing your code.
pinpoint
Package pinpoint provides the client and types for making API requests to Amazon Pinpoint.
Package pinpoint provides the client and types for making API requests to Amazon Pinpoint.
pinpoint/pinpointiface
Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.
Package pinpointiface provides an interface to enable mocking the Amazon Pinpoint service client for testing your code.
polly
Package polly provides the client and types for making API requests to Amazon Polly.
Package polly provides the client and types for making API requests to Amazon Polly.
polly/pollyiface
Package pollyiface provides an interface to enable mocking the Amazon Polly service client for testing your code.
Package pollyiface provides an interface to enable mocking the Amazon Polly service client for testing your code.
rds
Package rds provides the client and types for making API requests to Amazon Relational Database Service.
Package rds provides the client and types for making API requests to Amazon Relational Database Service.
rds/rdsiface
Package rdsiface provides an interface to enable mocking the Amazon Relational Database Service service client for testing your code.
Package rdsiface provides an interface to enable mocking the Amazon Relational Database Service service client for testing your code.
redshift
Package redshift provides the client and types for making API requests to Amazon Redshift.
Package redshift provides the client and types for making API requests to Amazon Redshift.
redshift/redshiftiface
Package redshiftiface provides an interface to enable mocking the Amazon Redshift service client for testing your code.
Package redshiftiface provides an interface to enable mocking the Amazon Redshift service client for testing your code.
rekognition
Package rekognition provides the client and types for making API requests to Amazon Rekognition.
Package rekognition provides the client and types for making API requests to Amazon Rekognition.
rekognition/rekognitioniface
Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition service client for testing your code.
Package rekognitioniface provides an interface to enable mocking the Amazon Rekognition service client for testing your code.
resourcegroupstaggingapi
Package resourcegroupstaggingapi provides the client and types for making API requests to AWS Resource Groups Tagging API.
Package resourcegroupstaggingapi provides the client and types for making API requests to AWS Resource Groups Tagging API.
resourcegroupstaggingapi/resourcegroupstaggingapiiface
Package resourcegroupstaggingapiiface provides an interface to enable mocking the AWS Resource Groups Tagging API service client for testing your code.
Package resourcegroupstaggingapiiface provides an interface to enable mocking the AWS Resource Groups Tagging API service client for testing your code.
route53
Package route53 provides the client and types for making API requests to Amazon Route 53.
Package route53 provides the client and types for making API requests to Amazon Route 53.
route53/route53iface
Package route53iface provides an interface to enable mocking the Amazon Route 53 service client for testing your code.
Package route53iface provides an interface to enable mocking the Amazon Route 53 service client for testing your code.
route53domains
Package route53domains provides the client and types for making API requests to Amazon Route 53 Domains.
Package route53domains provides the client and types for making API requests to Amazon Route 53 Domains.
route53domains/route53domainsiface
Package route53domainsiface provides an interface to enable mocking the Amazon Route 53 Domains service client for testing your code.
Package route53domainsiface provides an interface to enable mocking the Amazon Route 53 Domains service client for testing your code.
s3
Package s3 provides the client and types for making API requests to Amazon Simple Storage Service.
Package s3 provides the client and types for making API requests to Amazon Simple Storage Service.
s3/s3crypto
Package s3crypto provides encryption to S3 using KMS and AES GCM.
Package s3crypto provides encryption to S3 using KMS and AES GCM.
s3/s3iface
Package s3iface provides an interface to enable mocking the Amazon Simple Storage Service service client for testing your code.
Package s3iface provides an interface to enable mocking the Amazon Simple Storage Service service client for testing your code.
s3/s3manager
Package s3manager provides utilities to upload and download objects from S3 concurrently.
Package s3manager provides utilities to upload and download objects from S3 concurrently.
s3/s3manager/s3manageriface
Package s3manageriface provides an interface for the s3manager package
Package s3manageriface provides an interface for the s3manager package
servicecatalog
Package servicecatalog provides the client and types for making API requests to AWS Service Catalog.
Package servicecatalog provides the client and types for making API requests to AWS Service Catalog.
servicecatalog/servicecatalogiface
Package servicecatalogiface provides an interface to enable mocking the AWS Service Catalog service client for testing your code.
Package servicecatalogiface provides an interface to enable mocking the AWS Service Catalog service client for testing your code.
ses
Package ses provides the client and types for making API requests to Amazon Simple Email Service.
Package ses provides the client and types for making API requests to Amazon Simple Email Service.
ses/sesiface
Package sesiface provides an interface to enable mocking the Amazon Simple Email Service service client for testing your code.
Package sesiface provides an interface to enable mocking the Amazon Simple Email Service service client for testing your code.
sfn
Package sfn provides the client and types for making API requests to AWS Step Functions.
Package sfn provides the client and types for making API requests to AWS Step Functions.
sfn/sfniface
Package sfniface provides an interface to enable mocking the AWS Step Functions service client for testing your code.
Package sfniface provides an interface to enable mocking the AWS Step Functions service client for testing your code.
shield
Package shield provides the client and types for making API requests to AWS Shield.
Package shield provides the client and types for making API requests to AWS Shield.
shield/shieldiface
Package shieldiface provides an interface to enable mocking the AWS Shield service client for testing your code.
Package shieldiface provides an interface to enable mocking the AWS Shield service client for testing your code.
simpledb
Package simpledb provides the client and types for making API requests to Amazon SimpleDB.
Package simpledb provides the client and types for making API requests to Amazon SimpleDB.
simpledb/simpledbiface
Package simpledbiface provides an interface to enable mocking the Amazon SimpleDB service client for testing your code.
Package simpledbiface provides an interface to enable mocking the Amazon SimpleDB service client for testing your code.
sms
Package sms provides the client and types for making API requests to AWS Server Migration Service.
Package sms provides the client and types for making API requests to AWS Server Migration Service.
sms/smsiface
Package smsiface provides an interface to enable mocking the AWS Server Migration Service service client for testing your code.
Package smsiface provides an interface to enable mocking the AWS Server Migration Service service client for testing your code.
snowball
Package snowball provides the client and types for making API requests to Amazon Import/Export Snowball.
Package snowball provides the client and types for making API requests to Amazon Import/Export Snowball.
snowball/snowballiface
Package snowballiface provides an interface to enable mocking the Amazon Import/Export Snowball service client for testing your code.
Package snowballiface provides an interface to enable mocking the Amazon Import/Export Snowball service client for testing your code.
sns
Package sns provides the client and types for making API requests to Amazon Simple Notification Service.
Package sns provides the client and types for making API requests to Amazon Simple Notification Service.
sns/snsiface
Package snsiface provides an interface to enable mocking the Amazon Simple Notification Service service client for testing your code.
Package snsiface provides an interface to enable mocking the Amazon Simple Notification Service service client for testing your code.
sqs
Package sqs provides the client and types for making API requests to Amazon Simple Queue Service.
Package sqs provides the client and types for making API requests to Amazon Simple Queue Service.
sqs/sqsiface
Package sqsiface provides an interface to enable mocking the Amazon Simple Queue Service service client for testing your code.
Package sqsiface provides an interface to enable mocking the Amazon Simple Queue Service service client for testing your code.
ssm
Package ssm provides the client and types for making API requests to Amazon Simple Systems Manager (SSM).
Package ssm provides the client and types for making API requests to Amazon Simple Systems Manager (SSM).
ssm/ssmiface
Package ssmiface provides an interface to enable mocking the Amazon Simple Systems Manager (SSM) service client for testing your code.
Package ssmiface provides an interface to enable mocking the Amazon Simple Systems Manager (SSM) service client for testing your code.
storagegateway
Package storagegateway provides the client and types for making API requests to AWS Storage Gateway.
Package storagegateway provides the client and types for making API requests to AWS Storage Gateway.
storagegateway/storagegatewayiface
Package storagegatewayiface provides an interface to enable mocking the AWS Storage Gateway service client for testing your code.
Package storagegatewayiface provides an interface to enable mocking the AWS Storage Gateway service client for testing your code.
sts
Package sts provides the client and types for making API requests to AWS Security Token Service.
Package sts provides the client and types for making API requests to AWS Security Token Service.
sts/stsiface
Package stsiface provides an interface to enable mocking the AWS Security Token Service service client for testing your code.
Package stsiface provides an interface to enable mocking the AWS Security Token Service service client for testing your code.
support
Package support provides the client and types for making API requests to AWS Support.
Package support provides the client and types for making API requests to AWS Support.
support/supportiface
Package supportiface provides an interface to enable mocking the AWS Support service client for testing your code.
Package supportiface provides an interface to enable mocking the AWS Support service client for testing your code.
swf
Package swf provides the client and types for making API requests to Amazon Simple Workflow Service.
Package swf provides the client and types for making API requests to Amazon Simple Workflow Service.
swf/swfiface
Package swfiface provides an interface to enable mocking the Amazon Simple Workflow Service service client for testing your code.
Package swfiface provides an interface to enable mocking the Amazon Simple Workflow Service service client for testing your code.
waf
Package waf provides the client and types for making API requests to AWS WAF.
Package waf provides the client and types for making API requests to AWS WAF.
waf/wafiface
Package wafiface provides an interface to enable mocking the AWS WAF service client for testing your code.
Package wafiface provides an interface to enable mocking the AWS WAF service client for testing your code.
wafregional
Package wafregional provides the client and types for making API requests to AWS WAF Regional.
Package wafregional provides the client and types for making API requests to AWS WAF Regional.
wafregional/wafregionaliface
Package wafregionaliface provides an interface to enable mocking the AWS WAF Regional service client for testing your code.
Package wafregionaliface provides an interface to enable mocking the AWS WAF Regional service client for testing your code.
workdocs
Package workdocs provides the client and types for making API requests to Amazon WorkDocs.
Package workdocs provides the client and types for making API requests to Amazon WorkDocs.
workdocs/workdocsiface
Package workdocsiface provides an interface to enable mocking the Amazon WorkDocs service client for testing your code.
Package workdocsiface provides an interface to enable mocking the Amazon WorkDocs service client for testing your code.
workspaces
Package workspaces provides the client and types for making API requests to Amazon WorkSpaces.
Package workspaces provides the client and types for making API requests to Amazon WorkSpaces.
workspaces/workspacesiface
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.
xray
Package xray provides the client and types for making API requests to AWS X-Ray.
Package xray provides the client and types for making API requests to AWS X-Ray.
xray/xrayiface
Package xrayiface provides an interface to enable mocking the AWS X-Ray service client for testing your code.
Package xrayiface provides an interface to enable mocking the AWS X-Ray service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL