Documentation

Overview

    Package aws provides core functionality for making requests to AWS services.

    Index

    Constants

    View Source
    const DefaultRetries = -1

      DefaultRetries is the default number of retries for a service. The value of -1 indicates that the service specific retry default will be used.

      View Source
      const SDKName = "aws-sdk-go"

        SDKName is the name of this AWS SDK

        View Source
        const SDKVersion = "0.9.17"

          SDKVersion is the version of this SDK

          Variables

          View Source
          var (
          	// ErrMissingRegion is an error that is returned if region configuration is
          	// not found.
          	//
          	// @readonly
          	ErrMissingRegion error = awserr.New("MissingRegion", "could not find region configuration", nil)
          
          	// ErrMissingEndpoint is an error that is returned if an endpoint cannot be
          	// resolved for a service.
          	//
          	// @readonly
          	ErrMissingEndpoint error = awserr.New("MissingEndpoint", "'Endpoint' configuration is required for this service", nil)
          )

          Functions

          func Bool

          func Bool(v bool) *bool

            Bool returns a pointer to of the bool value passed in.

            func BoolMap

            func BoolMap(src map[string]bool) map[string]*bool

              BoolMap converts a string map of bool values into a string map of bool pointers

              func BoolSlice

              func BoolSlice(src []bool) []*bool

                BoolSlice converts a slice of bool values into a slice of bool pointers

                func BoolValue

                func BoolValue(v *bool) bool

                  BoolValue returns the value of the bool pointer passed in or false if the pointer is nil.

                  func BoolValueMap

                  func BoolValueMap(src map[string]*bool) map[string]bool

                    BoolValueMap converts a string map of bool pointers into a string map of bool values

                    func BoolValueSlice

                    func BoolValueSlice(src []*bool) []bool

                      BoolValueSlice converts a slice of bool pointers into a slice of bool values

                      func Float64

                      func Float64(v float64) *float64

                        Float64 returns a pointer to of the float64 value passed in.

                        func Float64Map

                        func Float64Map(src map[string]float64) map[string]*float64

                          Float64Map converts a string map of float64 values into a string map of float64 pointers

                          func Float64Slice

                          func Float64Slice(src []float64) []*float64

                            Float64Slice converts a slice of float64 values into a slice of float64 pointers

                            func Float64Value

                            func Float64Value(v *float64) float64

                              Float64Value returns the value of the float64 pointer passed in or 0 if the pointer is nil.

                              func Float64ValueMap

                              func Float64ValueMap(src map[string]*float64) map[string]float64

                                Float64ValueMap converts a string map of float64 pointers into a string map of float64 values

                                func Float64ValueSlice

                                func Float64ValueSlice(src []*float64) []float64

                                  Float64ValueSlice converts a slice of float64 pointers into a slice of float64 values

                                  func Int

                                  func Int(v int) *int

                                    Int returns a pointer to of the int value passed in.

                                    func Int64

                                    func Int64(v int64) *int64

                                      Int64 returns a pointer to of the int64 value passed in.

                                      func Int64Map

                                      func Int64Map(src map[string]int64) map[string]*int64

                                        Int64Map converts a string map of int64 values into a string map of int64 pointers

                                        func Int64Slice

                                        func Int64Slice(src []int64) []*int64

                                          Int64Slice converts a slice of int64 values into a slice of int64 pointers

                                          func Int64Value

                                          func Int64Value(v *int64) int64

                                            Int64Value returns the value of the int64 pointer passed in or 0 if the pointer is nil.

                                            func Int64ValueMap

                                            func Int64ValueMap(src map[string]*int64) map[string]int64

                                              Int64ValueMap converts a string map of int64 pointers into a string map of int64 values

                                              func Int64ValueSlice

                                              func Int64ValueSlice(src []*int64) []int64

                                                Int64ValueSlice converts a slice of int64 pointers into a slice of int64 values

                                                func IntMap

                                                func IntMap(src map[string]int) map[string]*int

                                                  IntMap converts a string map of int values into a string map of int pointers

                                                  func IntSlice

                                                  func IntSlice(src []int) []*int

                                                    IntSlice converts a slice of int values into a slice of int pointers

                                                    func IntValue

                                                    func IntValue(v *int) int

                                                      IntValue returns the value of the int pointer passed in or 0 if the pointer is nil.

                                                      func IntValueMap

                                                      func IntValueMap(src map[string]*int) map[string]int

                                                        IntValueMap converts a string map of int pointers into a string map of int values

                                                        func IntValueSlice

                                                        func IntValueSlice(src []*int) []int

                                                          IntValueSlice converts a slice of int pointers into a slice of int values

                                                          func String

                                                          func String(v string) *string

                                                            String returns a pointer to of the string value passed in.

                                                            func StringMap

                                                            func StringMap(src map[string]string) map[string]*string

                                                              StringMap converts a string map of string values into a string map of string pointers

                                                              func StringSlice

                                                              func StringSlice(src []string) []*string

                                                                StringSlice converts a slice of string values into a slice of string pointers

                                                                func StringValue

                                                                func StringValue(v *string) string

                                                                  StringValue returns the value of the string pointer passed in or "" if the pointer is nil.

                                                                  func StringValueMap

                                                                  func StringValueMap(src map[string]*string) map[string]string

                                                                    StringValueMap converts a string map of string pointers into a string map of string values

                                                                    func StringValueSlice

                                                                    func StringValueSlice(src []*string) []string

                                                                      StringValueSlice converts a slice of string pointers into a slice of string values

                                                                      func Time

                                                                      func Time(v time.Time) *time.Time

                                                                        Time returns a pointer to of the time.Time value passed in.

                                                                        func TimeMap

                                                                        func TimeMap(src map[string]time.Time) map[string]*time.Time

                                                                          TimeMap converts a string map of time.Time values into a string map of time.Time pointers

                                                                          func TimeSlice

                                                                          func TimeSlice(src []time.Time) []*time.Time

                                                                            TimeSlice converts a slice of time.Time values into a slice of time.Time pointers

                                                                            func TimeValue

                                                                            func TimeValue(v *time.Time) time.Time

                                                                              TimeValue returns the value of the time.Time pointer passed in or time.Time{} if the pointer is nil.

                                                                              func TimeValueMap

                                                                              func TimeValueMap(src map[string]*time.Time) map[string]time.Time

                                                                                TimeValueMap converts a string map of time.Time pointers into a string map of time.Time values

                                                                                func TimeValueSlice

                                                                                func TimeValueSlice(src []*time.Time) []time.Time

                                                                                  TimeValueSlice converts a slice of time.Time pointers into a slice of time.Time values

                                                                                  Types

                                                                                  type Config

                                                                                  type Config struct {
                                                                                  	// The credentials object to use when signing requests. Defaults to
                                                                                  	// {defaults.DefaultChainCredentials}.
                                                                                  	Credentials *credentials.Credentials
                                                                                  
                                                                                  	// An optional endpoint URL (hostname only or fully qualified URI)
                                                                                  	// that overrides the default generated endpoint for a client. Set this
                                                                                  	// to `""` to use the default generated endpoint.
                                                                                  	//
                                                                                  	// @note You must still provide a `Region` value when specifying an
                                                                                  	//   endpoint for a client.
                                                                                  	Endpoint *string
                                                                                  
                                                                                  	// The region to send requests to. This parameter is required and must
                                                                                  	// be configured globally or on a per-client basis unless otherwise
                                                                                  	// noted. A full list of regions is found in the "Regions and Endpoints"
                                                                                  	// document.
                                                                                  	//
                                                                                  	// @see http://docs.aws.amazon.com/general/latest/gr/rande.html
                                                                                  	//   AWS Regions and Endpoints
                                                                                  	Region *string
                                                                                  
                                                                                  	// Set this to `true` to disable SSL when sending requests. Defaults
                                                                                  	// to `false`.
                                                                                  	DisableSSL *bool
                                                                                  
                                                                                  	// The HTTP client to use when sending requests. Defaults to
                                                                                  	// `http.DefaultClient`.
                                                                                  	HTTPClient *http.Client
                                                                                  
                                                                                  	// An integer value representing the logging level. The default log level
                                                                                  	// is zero (LogOff), which represents no logging. To enable logging set
                                                                                  	// to a LogLevel Value.
                                                                                  	LogLevel *LogLevelType
                                                                                  
                                                                                  	// The logger writer interface to write logging messages to. Defaults to
                                                                                  	// standard out.
                                                                                  	Logger Logger
                                                                                  
                                                                                  	// The maximum number of times that a request will be retried for failures.
                                                                                  	// Defaults to -1, which defers the max retry setting to the service specific
                                                                                  	// configuration.
                                                                                  	MaxRetries *int
                                                                                  
                                                                                  	// Disables semantic parameter validation, which validates input for missing
                                                                                  	// required fields and/or other semantic request input errors.
                                                                                  	DisableParamValidation *bool
                                                                                  
                                                                                  	// Disables the computation of request and response checksums, e.g.,
                                                                                  	// CRC32 checksums in Amazon DynamoDB.
                                                                                  	DisableComputeChecksums *bool
                                                                                  
                                                                                  	// Set this to `true` to force the request to use path-style addressing,
                                                                                  	// i.e., `http://s3.amazonaws.com/BUCKET/KEY`. By default, the S3 client will
                                                                                  	// use virtual hosted bucket addressing when possible
                                                                                  	// (`http://BUCKET.s3.amazonaws.com/KEY`).
                                                                                  	//
                                                                                  	// @note This configuration option is specific to the Amazon S3 service.
                                                                                  	// @see http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
                                                                                  	//   Amazon S3: Virtual Hosting of Buckets
                                                                                  	S3ForcePathStyle *bool
                                                                                  
                                                                                  	SleepDelay func(time.Duration)
                                                                                  }

                                                                                    A Config provides service configuration for service clients. By default, all clients will use the {defaults.DefaultConfig} structure.

                                                                                    func NewConfig

                                                                                    func NewConfig() *Config

                                                                                      NewConfig returns a new Config pointer that can be chained with builder methods to set multiple configuration values inline without using pointers.

                                                                                      svc := s3.New(aws.NewConfig().WithRegion("us-west-2").WithMaxRetries(10))
                                                                                      

                                                                                      func (Config) Copy

                                                                                      func (c Config) Copy() *Config

                                                                                        Copy will return a shallow copy of the Config object.

                                                                                        func (Config) Merge

                                                                                        func (c Config) Merge(other *Config) *Config

                                                                                          Merge returns a new Config with the other Config's attribute values merged into this Config. If the other Config's attribute is nil it will not be merged into the new Config to be returned.

                                                                                          func (*Config) WithCredentials

                                                                                          func (c *Config) WithCredentials(creds *credentials.Credentials) *Config

                                                                                            WithCredentials sets a config Credentials value returning a Config pointer for chaining.

                                                                                            func (*Config) WithDisableComputeChecksums

                                                                                            func (c *Config) WithDisableComputeChecksums(disable bool) *Config

                                                                                              WithDisableComputeChecksums sets a config DisableComputeChecksums value returning a Config pointer for chaining.

                                                                                              func (*Config) WithDisableParamValidation

                                                                                              func (c *Config) WithDisableParamValidation(disable bool) *Config

                                                                                                WithDisableParamValidation sets a config DisableParamValidation value returning a Config pointer for chaining.

                                                                                                func (*Config) WithDisableSSL

                                                                                                func (c *Config) WithDisableSSL(disable bool) *Config

                                                                                                  WithDisableSSL sets a config DisableSSL value returning a Config pointer for chaining.

                                                                                                  func (*Config) WithEndpoint

                                                                                                  func (c *Config) WithEndpoint(endpoint string) *Config

                                                                                                    WithEndpoint sets a config Endpoint value returning a Config pointer for chaining.

                                                                                                    func (*Config) WithHTTPClient

                                                                                                    func (c *Config) WithHTTPClient(client *http.Client) *Config

                                                                                                      WithHTTPClient sets a config HTTPClient value returning a Config pointer for chaining.

                                                                                                      func (*Config) WithLogLevel

                                                                                                      func (c *Config) WithLogLevel(level LogLevelType) *Config

                                                                                                        WithLogLevel sets a config LogLevel value returning a Config pointer for chaining.

                                                                                                        func (*Config) WithLogger

                                                                                                        func (c *Config) WithLogger(logger Logger) *Config

                                                                                                          WithLogger sets a config Logger value returning a Config pointer for chaining.

                                                                                                          func (*Config) WithMaxRetries

                                                                                                          func (c *Config) WithMaxRetries(max int) *Config

                                                                                                            WithMaxRetries sets a config MaxRetries value returning a Config pointer for chaining.

                                                                                                            func (*Config) WithRegion

                                                                                                            func (c *Config) WithRegion(region string) *Config

                                                                                                              WithRegion sets a config Region value returning a Config pointer for chaining.

                                                                                                              func (*Config) WithS3ForcePathStyle

                                                                                                              func (c *Config) WithS3ForcePathStyle(force bool) *Config

                                                                                                                WithS3ForcePathStyle sets a config S3ForcePathStyle value returning a Config pointer for chaining.

                                                                                                                func (*Config) WithSleepDelay

                                                                                                                func (c *Config) WithSleepDelay(fn func(time.Duration)) *Config

                                                                                                                  WithSleepDelay overrides the function used to sleep while waiting for the next retry. Defaults to time.Sleep.

                                                                                                                  type LogLevelType

                                                                                                                  type LogLevelType uint

                                                                                                                    A LogLevelType defines the level logging should be performed at. Used to instruct the SDK which statements should be logged.

                                                                                                                    const (
                                                                                                                    	// LogOff states that no logging should be performed by the SDK. This is the
                                                                                                                    	// default state of the SDK, and should be use to disable all logging.
                                                                                                                    	LogOff LogLevelType = iota * 0x1000
                                                                                                                    
                                                                                                                    	// LogDebug state that debug output should be logged by the SDK. This should
                                                                                                                    	// be used to inspect request made and responses received.
                                                                                                                    	LogDebug
                                                                                                                    )
                                                                                                                    const (
                                                                                                                    	// LogDebugWithSigning states that the SDK should log request signing and
                                                                                                                    	// presigning events. This should be used to log the signing details of
                                                                                                                    	// requests for debugging. Will also enable LogDebug.
                                                                                                                    	LogDebugWithSigning LogLevelType = LogDebug | (1 << iota)
                                                                                                                    
                                                                                                                    	// LogDebugWithHTTPBody states the SDK should log HTTP request and response
                                                                                                                    	// HTTP bodys in addition to the headers and path. This should be used to
                                                                                                                    	// see the body content of requests and responses made while using the SDK
                                                                                                                    	// Will also enable LogDebug.
                                                                                                                    	LogDebugWithHTTPBody
                                                                                                                    
                                                                                                                    	// LogDebugWithRequestRetries states the SDK should log when service requests will
                                                                                                                    	// be retried. This should be used to log when you want to log when service
                                                                                                                    	// requests are being retried. Will also enable LogDebug.
                                                                                                                    	LogDebugWithRequestRetries
                                                                                                                    
                                                                                                                    	// LogDebugWithRequestErrors states the SDK should log when service requests fail
                                                                                                                    	// to build, send, validate, or unmarshal.
                                                                                                                    	LogDebugWithRequestErrors
                                                                                                                    )

                                                                                                                      Debug Logging Sub Levels

                                                                                                                      func LogLevel

                                                                                                                      func LogLevel(l LogLevelType) *LogLevelType

                                                                                                                        LogLevel returns the pointer to a LogLevel. Should be used to workaround not being able to take the address of a non-composite literal.

                                                                                                                        func (*LogLevelType) AtLeast

                                                                                                                        func (l *LogLevelType) AtLeast(v LogLevelType) bool

                                                                                                                          AtLeast returns true if this LogLevel is at least high enough to satisfies v. Is safe to use on nil value LogLevelTypes. If LogLevel is nill, will default to LogOff comparison.

                                                                                                                          func (*LogLevelType) Matches

                                                                                                                          func (l *LogLevelType) Matches(v LogLevelType) bool

                                                                                                                            Matches returns true if the v LogLevel is enabled by this LogLevel. Should be used with logging sub levels. Is safe to use on nil value LogLevelTypes. If LogLevel is nill, will default to LogOff comparison.

                                                                                                                            func (*LogLevelType) Value

                                                                                                                            func (l *LogLevelType) Value() LogLevelType

                                                                                                                              Value returns the LogLevel value or the default value LogOff if the LogLevel is nil. Safe to use on nil value LogLevelTypes.

                                                                                                                              type Logger

                                                                                                                              type Logger interface {
                                                                                                                              	Log(...interface{})
                                                                                                                              }

                                                                                                                                A Logger is a minimalistic interface for the SDK to log messages to. Should be used to provide custom logging writers for the SDK to use.

                                                                                                                                func NewDefaultLogger

                                                                                                                                func NewDefaultLogger() Logger

                                                                                                                                  NewDefaultLogger returns a Logger which will write log messages to stdout, and use same formatting runes as the stdlib log.Logger

                                                                                                                                  type ReaderSeekerCloser

                                                                                                                                  type ReaderSeekerCloser struct {
                                                                                                                                  	// contains filtered or unexported fields
                                                                                                                                  }

                                                                                                                                    ReaderSeekerCloser represents a reader that can also delegate io.Seeker and io.Closer interfaces to the underlying object if they are available.

                                                                                                                                    func ReadSeekCloser

                                                                                                                                    func ReadSeekCloser(r io.Reader) ReaderSeekerCloser

                                                                                                                                      ReadSeekCloser wraps a io.Reader returning a ReaderSeakerCloser

                                                                                                                                      func (ReaderSeekerCloser) Close

                                                                                                                                      func (r ReaderSeekerCloser) Close() error

                                                                                                                                        Close closes the ReaderSeekerCloser.

                                                                                                                                        If the ReaderSeekerCloser is not an io.Closer nothing will be done.

                                                                                                                                        func (ReaderSeekerCloser) Read

                                                                                                                                        func (r ReaderSeekerCloser) Read(p []byte) (int, error)

                                                                                                                                          Read reads from the reader up to size of p. The number of bytes read, and error if it occurred will be returned.

                                                                                                                                          If the reader is not an io.Reader zero bytes read, and nil error will be returned.

                                                                                                                                          Performs the same functionality as io.Reader Read

                                                                                                                                          func (ReaderSeekerCloser) Seek

                                                                                                                                          func (r ReaderSeekerCloser) Seek(offset int64, whence int) (int64, error)

                                                                                                                                            Seek sets the offset for the next Read to offset, interpreted according to whence: 0 means relative to the origin of the file, 1 means relative to the current offset, and 2 means relative to the end. Seek returns the new offset and an error, if any.

                                                                                                                                            If the ReaderSeekerCloser is not an io.Seeker nothing will be done.

                                                                                                                                            type WriteAtBuffer

                                                                                                                                            type WriteAtBuffer struct {
                                                                                                                                            	// contains filtered or unexported fields
                                                                                                                                            }

                                                                                                                                              A WriteAtBuffer provides a in memory buffer supporting the io.WriterAt interface Can be used with the s3manager.Downloader to download content to a buffer in memory. Safe to use concurrently.

                                                                                                                                              func (*WriteAtBuffer) Bytes

                                                                                                                                              func (b *WriteAtBuffer) Bytes() []byte

                                                                                                                                                Bytes returns a slice of bytes written to the buffer.

                                                                                                                                                func (*WriteAtBuffer) WriteAt

                                                                                                                                                func (b *WriteAtBuffer) WriteAt(p []byte, pos int64) (n int, err error)

                                                                                                                                                  WriteAt writes a slice of bytes to a buffer starting at the position provided The number of bytes written will be returned, or error. Can overwrite previous written slices if the write ats overlap.

                                                                                                                                                  Directories

                                                                                                                                                  Path Synopsis
                                                                                                                                                  Package awserr represents API error interface accessors for the SDK.
                                                                                                                                                  Package awserr represents API error interface accessors for the SDK.
                                                                                                                                                  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.
                                                                                                                                                  stscreds
                                                                                                                                                  Package stscreds are credential Providers to retrieve STS AWS credentials.
                                                                                                                                                  Package stscreds are credential Providers to retrieve STS AWS credentials.