package
2.0.0-preview.4+incompatible
Repository: https://github.com/skarlso/aws-sdk-go-v2.git
Documentation: pkg.go.dev

# Packages

Package arn provides a parser for interacting with Amazon Resource Names.
Package awserr represents API error interface accessors for the SDK.
Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers.
Package ec2metadata provides the client for making API calls to the EC2 Metadata service.
No description provided by the author
Package endpointcreds provides support for retrieving credentials from an arbitrary HTTP endpoint.
Package endpoints provides the types and functionality for defining regions and endpoints, as well as querying those definitions.
No description provided by the author
Package plugincreds implements a credentials provider sourced from a Go plugin.
No description provided by the author
Package stscreds are credential Providers to retrieve STS AWS credentials.

# Functions

AddToUserAgent adds the string to the end of the request's current user agent.
BackgroundContext returns a context that will never be canceled, has no values, and no deadline.
Bool returns a pointer to the bool value passed in.
BoolMap converts a string map of bool values into a string map of bool pointers.
BoolSlice converts a slice of bool values into a slice of bool pointers.
BoolValue returns the value of the bool pointer passed in or false if the pointer is nil.
BoolValueMap converts a string map of bool pointers into a string map of bool values.
BoolValueSlice converts a slice of bool pointers into a slice of bool values.
ConstantWaiterDelay returns a WaiterDelay that will always return a constant delay the waiter should use between attempts.
Float64 returns a pointer to the float64 value passed in.
Float64Map converts a string map of float64 values into a string map of float64 pointers.
Float64Slice converts a slice of float64 values into a slice of float64 pointers.
Float64Value returns the value of the float64 pointer passed in or 0 if the pointer is nil.
Float64ValueMap converts a string map of float64 pointers into a string map of float64 values.
Float64ValueSlice converts a slice of float64 pointers into a slice of float64 values.
HandlerListLogItem logs the request handler and the state of the request's Error value.
HandlerListStopOnError returns false to stop the HandlerList iterating over request handlers if Request.Error is not nil.
Int returns a pointer to the int value passed in.
Int64 returns a pointer to the int64 value passed in.
Int64Map converts a string map of int64 values into a string map of int64 pointers.
Int64Slice converts a slice of int64 values into a slice of int64 pointers.
Int64Value returns the value of the int64 pointer passed in or 0 if the pointer is nil.
Int64ValueMap converts a string map of int64 pointers into a string map of int64 values.
Int64ValueSlice converts a slice of int64 pointers into a slice of int64 values.
IntMap converts a string map of int values into a string map of int pointers.
IntSlice converts a slice of int values into a slice of int pointers.
IntValue returns the value of the int pointer passed in or 0 if the pointer is nil.
IntValueMap converts a string map of int pointers into a string map of int values.
IntValueSlice converts a slice of int pointers into a slice of int values.
IsErrorExpiredCreds returns whether the error code is a credential expiry error.
IsErrorRetryable returns whether the error is retryable, based on its Code.
IsErrorThrottle returns whether the error is to be throttled based on its code.
MakeAddToUserAgentFreeFormHandler adds the input to the User-Agent request header.
MakeAddToUserAgentHandler will add the name/version pair to the User-Agent request header.
MillisecondsTimeValue converts an int64 pointer to a time.Time value representing milliseconds sinch Epoch or time.Time{} if the pointer is nil.
New returns a new Request pointer for the service API operation and parameters.
NewChainProvider returns a pointer to a new ChainProvider value wrapping a chain of credentials providers.
NewClient will return a pointer to a new initialized service client.
NewConfig returns a new Config pointer that can be chained with builder methods to set multiple configuration values inline without using pointers.
NewDefaultLogger returns a Logger which will write log messages to stdout, and use same formatting runes as the stdlib log.Logger TODO remove, moved to default pkg.
NewErrParamMinLen creates a new minimum length parameter error.
NewErrParamMinValue creates a new minimum value parameter error.
NewErrParamRequired creates a new required parameter error.
NewStaticCredentialsProvider return a StaticCredentialsProvider initialized with the AWS credentials passed in.
NewWriteAtBuffer creates a WriteAtBuffer with an internal buffer provided by buf.
ReadSeekCloser wraps a io.Reader returning a ReaderSeekerCloser.
ResolveWithEndpointURL allows a static URL to be used as a endpoint resolver.
SecondsTimeValue converts an int64 pointer to a time.Time value representing seconds since Epoch or time.Time{} if the pointer is nil.
SleepWithContext will wait for the timer duration to expire, or the context is canceled.
String returns a pointer to the string value passed in.
StringMap converts a string map of string values into a string map of string pointers.
StringSlice converts a slice of string values into a slice of string pointers.
StringValue returns the value of the string pointer passed in or "" if the pointer is nil.
StringValueMap converts a string map of string pointers into a string map of string values.
StringValueSlice converts a slice of string pointers into a slice of string values.
Time returns a pointer to the time.Time value passed in.
TimeMap converts a string map of time.Time values into a string map of time.Time pointers.
TimeSlice converts a slice of time.Time values into a slice of time.Time pointers.
TimeUnixMilli returns a Unix timestamp in milliseconds from "January 1, 1970 UTC".
TimeValue returns the value of the time.Time pointer passed in or time.Time{} if the pointer is nil.
TimeValueMap converts a string map of time.Time pointers into a string map of time.Time values.
TimeValueSlice converts a slice of time.Time pointers into a slice of time.Time values.
URLHostname will extract the Hostname without port from the URL value.
WithAppendUserAgent will add a string to the user agent prefixed with a single white space.
WithGetResponseHeader builds a request Option which will retrieve a single header value from the HTTP Response.
WithGetResponseHeaders builds a request Option which will retrieve the headers from the HTTP response and assign them to the passed in headers variable.
WithLogLevel is a request option that will set the request to use a specific log level when the request is made.
WithResponseReadTimeout is a request option that will wrap the body in a timeout read closer.
WithRetryer sets a config Retryer value to the given Config returning it for chaining.
WithWaiterDelay will set the Waiter to use the WaiterDelay passed in.
WithWaiterLogger returns a waiter option to set the logger a waiter should use to log warnings and errors to.
WithWaiterMaxAttempts returns the maximum number of times the waiter should attempt to check the resource for the target state.
WithWaiterRequestOptions returns a waiter option setting the request options for each request the waiter makes.

# Constants

ErrCodeRead is an error that is returned during HTTP reads.
ErrCodeRequestCanceled is the error code that will be returned by an API request that was canceled.
ErrCodeResponseTimeout is the connection timeout error that is received during body reads.
ErrCodeSerialization is the serialization error code that is received during protocol unmarshaling.
match on error.
waiter failed.
HandlerResponseTimeout is what we use to signify the name of the response timeout handler.
InvalidParameterErrCode is the error code for invalid parameters errors.
LogDebug state that debug output should be logged by the SDK.
LogDebugWithHTTPBody states the SDK should log HTTP request and response HTTP bodys in addition to the headers and path.
LogDebugWithRequestErrors states the SDK should log when service requests fail to build, send, validate, or unmarshal.
LogDebugWithRequestRetries states the SDK should log when service requests will be retried.
LogDebugWithSigning states that the SDK should log request signing and presigning events.
LogOff states that no logging should be performed by the SDK.
ParamMinLenErrCode is the error code for fields without enough elements.
ParamMinValueErrCode is the error code for fields with too low of a number value.
ParamRequiredErrCode is the error code for required parameter errors.
match on all paths.
match on any path.
match on list of paths.
match on specific path.
waiter needs to be retried.
SDKName is the name of this AWS SDK.
SDKVersion is the version of this SDK.
StaticCredentialsProviderName provides a name of Static provider.
match on status code.
waiter successful.
WaiterResourceNotReadyErrorCode is the error code returned by a waiter when the waiter's max attempts have been exhausted.

# Variables

AnonymousCredentials is an empty CredentialProvider that can be used as dummy placeholder credentials for requests that do not need signed.
ErrMissingEndpoint is an error that is returned if an endpoint cannot be resolved for a service.
ErrMissingRegion is an error that is returned if region configuration is not found.
ErrStaticCredentialsEmpty is emitted when static credentials are empty.
NeverExpire is the time identifier used when a credential provider's credentials will not expire.
NoBody is a http.NoBody reader instructing Go HTTP client to not include and body in the HTTP request.

# Structs

A ChainProvider will search for a provider which returns credentials and cache that provider until Retrieve is called again.
A Client implements the base client request and response handling used by all service clients.
A Config provides service configuration for service clients.
A Credentials is the AWS credentials value for individual credential fields.
DefaultRetryer implements basic retry logic using exponential backoff for most services.
Endpoint represents the endpoint a service client should make requests to.
An ErrInvalidParams provides wrapping of invalid parameter errors found when validating API operation input parameters.
An ErrParamMinLen represents a minimum length parameter error.
An ErrParamMinValue represents a minimum value parameter error.
An ErrParamRequired represents an required parameter error.
A HandlerList manages zero or more handlers in a list.
A HandlerListRunItem represents an entry in the HandlerList which is being run.
A Handlers provides a collection of request handlers for various stages of handling requests.
Metadata wraps immutable data from the Client structure.
A NamedHandler is a struct that contains a name and function callback.
An Operation is the service API operation to be made.
A Pager provides paginating of SDK API operations which are paginatable.
A Paginator is the configuration data that defines how an API operation should be paginated.
ReaderSeekerCloser represents a reader that can also delegate io.Seeker and io.Closer interfaces to the underlying object if they are available.
A Request is the service request to be made.
Response provides the response meta data for a SDK API request's response.
SafeCredentialsProvider provides caching and concurrency safe credentials retrieval via the RetrieveFn.
A StaticCredentialsProvider is a set of credentials which are set programmatically, and will never expire.
A Waiter provides the functionality to perform a blocking call which will wait for a resource state to be satisfied by a service.
A WaiterAcceptor provides the information needed to wait for an API operation to complete.
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.

# Interfaces

Context is an copy of the Go v1.7 stdlib's context.Context interface.
A CredentialsProvider is the interface for any component which will provide credentials Credentials.
EndpointResolver resolves an endpoint for a service endpoint id and region.
An ErrInvalidParam represents an invalid parameter error type.
A Logger is a minimalistic interface for the SDK to log messages to.
Retryer is an interface to control retry logic for a given service.
Validator provides a way for types to perform validation logic on their input values that external code can use to determine if a type's values are valid.

# Type aliases

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the Resolver interface.
An Expiration provides wrapper around time with expiration related methods.
JSONValue is a representation of a grab bag type that will be marshaled into a json string.
A LoggerFunc is a convenience type to convert a function taking a variadic list of arguments and wrap it so the Logger interface can be used.
A LogLevel defines the level logging should be performed at.
A Option is a functional option that can augment or modify a request when using a WithContext API operation method.
ResolveWithEndpoint allows a static Resolved Endpoint to be used as an endpoint resolver.
WaiterDelay will return a delay the waiter should pause between attempts to check the resource state.
WaiterMatchMode is the mode that the waiter will use to match the WaiterAcceptor definition's Expected attribute.
A WaiterOption is a function that will update the Waiter value's fields to configure the waiter.
WaiterState are states the waiter uses based on WaiterAcceptor definitions to identify if the resource state the waiter is waiting on has occurred.