Package files

Internal call graph ▹

Internal call graph ▾

In the call graph viewer below, each node
is a function belonging to this package
and its children are the functions it
calls—perhaps dynamically.

The root nodes are the entry points of the
package: functions that may be called from
outside the package.
There may be non-exported or anonymous
functions among them if they are called
dynamically from another package.

Click a node to visit that function's source code.
From there you can visit its callers by
clicking its declaring func
token.

Functions may be omitted if they were
determined to be unreachable in the
particular programs or tests that were
analyzed.

const (
// ErrCodeSerialization is the serialization error code that is received// during protocol unmarshaling.ErrCodeSerialization = "SerializationError"
// ErrCodeRead is an error that is returned during HTTP reads.ErrCodeRead = "ReadError"
// ErrCodeResponseTimeout is the connection timeout error that is received// during body reads.ErrCodeResponseTimeout = "ResponseTimeout"
// ErrCodeInvalidPresignExpire is returned when the expire time provided to// presign is invalidErrCodeInvalidPresignExpire = "InvalidPresignExpireError"
// CanceledErrorCode is the error code that will be returned by an// API request that was canceled. Requests given a aws.Context may// return this error when canceled.CanceledErrorCode = "RequestCanceled"
)

const (
// InvalidParameterErrCode is the error code for invalid parameters errorsInvalidParameterErrCode = "InvalidParameter"
// ParamRequiredErrCode is the error code for required parameter errorsParamRequiredErrCode = "ParamRequiredError"
// ParamMinValueErrCode is the error code for fields with too low of a// number value.ParamMinValueErrCode = "ParamMinValueError"
// ParamMinLenErrCode is the error code for fields without enough elements.ParamMinLenErrCode = "ParamMinLenError"
// ParamMaxLenErrCode is the error code for value being too long.ParamMaxLenErrCode = "ParamMaxLenError"
// ParamFormatErrCode is the error code for a field with invalid// format or characters.ParamFormatErrCode = "ParamFormatInvalidError"
)

const (
// HandlerResponseTimeout is what we use to signify the name of the// response timeout handler.HandlerResponseTimeout = "ResponseTimeoutHandler"
)

const WaiterResourceNotReadyErrorCode = "ResourceNotReady"

WaiterResourceNotReadyErrorCode is the error code returned by a waiter when
the waiter's max attempts have been exhausted.

MakeAddToUserAgentHandler will add the name/version pair to the User-Agent request
header. If the extra parameters are provided they will be added as metadata to the
name/version pair resulting in the following format.
"name/version (extra0; extra1; ...)"
The user agent part will be concatenated with this current request's user agent string.

type HandlerList struct {
// Called after each request handler in the list is called. If set// and the func returns true the HandlerList will continue to iterate// over the request handlers. If false is returned the HandlerList// will stop iterating.//// Should be used if extra logic to be performed between each handler// in the list. This can be used to terminate a list's iteration// based on a condition such as error like, HandlerListStopOnError.// Or for logging like HandlerListLogItem.
AfterEachFn func(item HandlerListRunItem) bool
// contains filtered or unexported fields
}

WithGetResponseHeader builds a request Option which will retrieve a single
header value from the HTTP Response. If there are multiple values for the
header key use WithGetResponseHeaders instead to access the http.Header
map directly. The passed in val pointer must be non-nil.

type Pagination struct {
// Function to return a Request value for each pagination request.// Any configuration or handlers that need to be applied to the request// prior to getting the next page should be done here before the request// returned.//// NewRequest should always be built from the same API operations. It is// undefined if different API operations are returned on subsequent calls.
NewRequest func() (*Request, error)
// EndPageOnSameToken, when enabled, will allow the paginator to stop on// token that are the same as its previous tokens.
EndPageOnSameToken bool
// contains filtered or unexported fields
}

A Pagination provides paginating of SDK API operations which are paginatable.
Generally you should not use this type directly, but use the "Pages" API
operations method to automatically perform pagination for you. Such as,
"S3.ListObjectsPages", and "S3.ListObjectsPagesWithContext" methods.

Pagination differs from a Paginator type in that pagination is the type that
does the pagination between API operations, and Paginator defines the
configuration that will be used per page request.

Build will build the request's object so it can be signed and sent
to the service. Build will also validate all the request's parameters.
Any additional build Handlers set on this request will be run
in the order they were set.

The request will only be built once. Multiple calls to build will have
no effect.

If any Validate or Build errors occur the build will stop and the error
which occurred will be returned.

Where "T" is the structure type matching the output structure of the given
operation. For example, a request object generated by
DynamoDB.ListTablesRequest() would expect to see dynamodb.ListTablesOutput
as the structure "T". The lastPage value represents whether the page is
the last page of data or not. The return value of this function should
return true to keep iterating or false to stop.

Deprecated Use Pagination type for configurable pagination of API operations

Presign returns the request's signed URL. Error will be returned
if the signing fails. The expire parameter is only used for presigned Amazon
S3 API requests. All other AWS services will use a fixed expiration
time of 15 minutes.

It is invalid to create a presigned URL with a expire duration 0 or less. An
error is returned if expire duration is 0 or less.

PresignRequest behaves just like presign, with the addition of returning a
set of headers that were signed. The expire parameter is only used for
presigned Amazon S3 API requests. All other AWS services will use a fixed
expiration time of 15 minutes.

It is invalid to create a presigned URL with a expire duration 0 or less. An
error is returned if expire duration is 0 or less.

Returns the URL string for the API operation with signature in the query string,
and the HTTP headers that were included in the signature. These headers must
be included in any HTTP request made with the presigned URL.

To prevent hoisting any headers to the query string set NotHoist to true on
this Request value prior to calling PresignRequest.

ResetBody rewinds the request body back to its starting position, and
sets the HTTP Request body reference. When the body is read prior
to being sent in the HTTP request it will need to be rewound.

ResetBody will automatically be called by the SDK's build handler, but if
the request is being used directly ResetBody must be called before the request
is Sent. SetStringBody, SetBufferBody, and SetReaderBody will automatically
call ResetBody.

Will also set the Go 1.8's http.Request.GetBody member to allow retrying
PUT/POST redirects.

SetContext adds a Context to the current request that can be used to cancel
a in-flight request. The Context value must not be nil, or this method will
panic.

Unlike http.Request.WithContext, SetContext does not return a copy of the
Request. It is not safe to use use a single Request value for multiple
requests. A new Request should be created for each API operation request.

Go 1.6 and below:
The http.Request's Cancel field will be set to the Done() value of
the context. This will overwrite the Cancel field's value.

Go 1.7 and above:
The http.Request.WithContext will be used to set the context on the underlying
http.Request. This will create a shallow copy of the http.Request. The SDK
may create sub contexts in the future for nested requests such as retries.

type Retryer interface {
// RetryRules return the retry delay that should be used by the SDK before// making another request attempt for the failed request.
RetryRules(*Request) time.Duration
// ShouldRetry returns if the failed request is retryable.//// Implementations may consider request attempt count when determining if a// request is retryable, but the SDK will use MaxRetries to limit the// number of attempts a request are made.
ShouldRetry(*Request) bool
// MaxRetries is the number of times a request may be retried before// failing.
MaxRetries() int
}

Retryer provides the interface drive the SDK's request retry behavior. The
Retryer implementation is responsible for implementing exponential backoff,
and determine if a request API error should be retried.

client.DefaultRetryer is the SDK's default implementation of the Retryer. It
uses the which uses the Request.IsErrorRetryable and Request.IsErrorThrottle
methods to determine if the request is retried.

WaitWithContext will make requests for the API operation using NewRequest to
build API requests. The request's response will be compared against the
Waiter's Acceptors to determine the successful state of the resource the
waiter is inspecting.

The passed in context must not be nil. If it is nil a panic will occur. The
Context will be used to cancel the waiter's pending requests and retry delays.
Use aws.BackgroundContext if no context is available.

The waiter will continue until the target state defined by the Acceptors,
or the max attempts expires.

Will return the WaiterResourceNotReadyErrorCode error code if the waiter's
retryer ShouldRetry returns false. This normally will happen when the max
wait attempts expires.