Package: github.com/aws/aws-sdk-go-v2/aws/transport/http

package http Import Path github.com/aws/aws-sdk-go-v2/aws/transport/http (on go.dev) Dependency Relation imports 15 packages, and imported by 2 packages

Involved Source Files client.go content_type.go response_error.go response_error_middleware.go timeout_read_closer.go

Package-Level Type Names (total 9, in which 3 are exported)

/* sort exporteds by: alphabet | popularity */

type BuildableClient (struct) BuildableClient provides a HTTPClient implementation with options to create copies of the HTTPClient when additional configuration is provided. The client's methods will not share the http.Transport value between copies of the BuildableClient. Only exported member values of the Transport and optional Dialer will be copied between copies of BuildableClient. Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ client *http.Client clientTimeout time.Duration dialer *net.Dialer initOnce sync.Once transport *http.Transport Methods (total 10, in which 8 are exported) (*BuildableClient) Do(req *http.Request) (*http.Response, error) Do implements the HTTPClient interface's Do method to invoke a HTTP request, and receive the response. Uses the BuildableClient's current configuration to invoke the http.Request. If connection pooling is enabled (aka HTTP KeepAlive) the client will only share pooled connections with its own instance. Copies of the BuildableClient will have their own connection pools. Redirect (3xx) responses will not be followed, the HTTP response received will returned instead. (*BuildableClient) Freeze() aws.HTTPClient Freeze returns a frozen aws.HTTPClient implementation that is no longer a BuildableClient. Use this to prevent the SDK from applying DefaultMode configuration values to a buildable client. (*BuildableClient) GetDialer() *net.Dialer GetDialer returns a copy of the client's network dialer. (*BuildableClient) GetTimeout() time.Duration GetTimeout returns a copy of the client's timeout to cancel requests with. (*BuildableClient) GetTransport() *http.Transport GetTransport returns a copy of the client's HTTP Transport. (*BuildableClient) WithDialerOptions(opts ...func(*net.Dialer)) *BuildableClient WithDialerOptions copies the BuildableClient and returns it with the net.Dialer options applied. Will set the client's http.Transport DialContext member. (*BuildableClient) WithTimeout(timeout time.Duration) *BuildableClient WithTimeout Sets the timeout used by the client for all requests. (*BuildableClient) WithTransportOptions(opts ...func(*http.Transport)) *BuildableClient WithTransportOptions copies the BuildableClient and returns it with the http.Transport options applied. If a non (*http.Transport) was set as the round tripper, the round tripper will be replaced with a default Transport value before invoking the option functions. /* 2 unexporteds ... *//* 2 unexporteds: */ (*BuildableClient) build() (*BuildableClient) clone() *BuildableClient Implements (at least 4, all are exported) *BuildableClient : github.com/aws/aws-sdk-go-v2/aws.HTTPClient *BuildableClient : github.com/aws/aws-sdk-go-v2/service/s3.HTTPClient *BuildableClient : github.com/aws/smithy-go/transport/http.ClientDo *BuildableClient : go.pact.im/x/httpclient.Client As Outputs Of (at least 5, in which 4 are exported) func NewBuildableClient() *BuildableClient func (*BuildableClient).WithDialerOptions(opts ...func(*net.Dialer)) *BuildableClient func (*BuildableClient).WithTimeout(timeout time.Duration) *BuildableClient func (*BuildableClient).WithTransportOptions(opts ...func(*http.Transport)) *BuildableClient /* at least one unexported ... *//* at least one unexported: */ func (*BuildableClient).clone() *BuildableClient

type ResponseError (struct) ResponseError provides the HTTP centric error type wrapping the underlying error with the HTTP response value and the deserialized RequestID. Fields (total 4, all are exported) RequestID string RequestID associated with response error ResponseError *smithyhttp.ResponseError ResponseError.Err error ResponseError.Response *http.Response Methods (total 6, all are exported) (*ResponseError) As(target interface{}) bool As populates target and returns true if the type of target is a error type that the ResponseError embeds, (e.g.AWS HTTP ResponseError) (*ResponseError) Error() string Error returns the formatted error ( ResponseError) HTTPResponse() *http.Response HTTPResponse returns the HTTP response received from the service. ( ResponseError) HTTPStatusCode() int HTTPStatusCode returns the HTTP response status code received from the service. (*ResponseError) ServiceRequestID() string ServiceRequestID returns the request id associated with Response Error ( ResponseError) Unwrap() error Unwrap returns the nested error if any, or nil. Implements (at least one exported) *ResponseError : error

type ResponseTimeoutError (struct) ResponseTimeoutError is an error when the reads from the response are delayed longer than the timeout the read was configured for. Fields (only one, which is exported) TimeoutDur time.Duration Methods (total 2, both are exported) (*ResponseTimeoutError) Error() string (*ResponseTimeoutError) Timeout() bool Timeout returns that the error is was caused by a timeout, and can be retried. Implements (at least 4, in which 1 are exported) *ResponseTimeoutError : error /* 3+ unexporteds ... *//* 3+ unexporteds: */ *ResponseTimeoutError : github.com/go-pg/pg/v10.timeoutError *ResponseTimeoutError : net.timeout *ResponseTimeoutError : os.timeout

/* 6 unexporteds ... *//* 6 unexporteds: */

type readResult (struct) Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ err error n int

type readTimeout (struct) readTimeout wraps the response body with a timeoutReadCloser Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ duration time.Duration Methods (total 2, both are exported) (*readTimeout) HandleDeserialize(ctx context.Context, in middleware.DeserializeInput, next middleware.DeserializeHandler) (out middleware.DeserializeOutput, metadata middleware.Metadata, err error) HandleDeserialize implements the DeserializeMiddleware interface (*readTimeout) ID() string ID returns the id of the middleware Implements (at least 2, in which 1 are exported) *readTimeout : github.com/aws/smithy-go/middleware.DeserializeMiddleware /* at least one unexported ... *//* at least one unexported: */ *readTimeout : github.com/aws/smithy-go/middleware.ider

type removeContentTypeHeader (struct) removeContentTypeHeader is a build middleware that removes content type header if content-length header is unset or is set to zero, Methods (total 2, both are exported) (*removeContentTypeHeader) HandleBuild(ctx context.Context, in middleware.BuildInput, next middleware.BuildHandler) (out middleware.BuildOutput, metadata middleware.Metadata, err error) HandleBuild adds or appends the constructed user agent to the request. (*removeContentTypeHeader) ID() string ID the name of the middleware. Implements (at least 2, in which 1 are exported) *removeContentTypeHeader : github.com/aws/smithy-go/middleware.BuildMiddleware /* at least one unexported ... *//* at least one unexported: */ *removeContentTypeHeader : github.com/aws/smithy-go/middleware.ider

type responseErrorWrapper (struct) Methods (total 2, both are exported) (*responseErrorWrapper) HandleDeserialize(ctx context.Context, in middleware.DeserializeInput, next middleware.DeserializeHandler) (out middleware.DeserializeOutput, metadata middleware.Metadata, err error) (*responseErrorWrapper) ID() string ID returns the middleware identifier Implements (at least 2, in which 1 are exported) *responseErrorWrapper : github.com/aws/smithy-go/middleware.DeserializeMiddleware /* at least one unexported ... *//* at least one unexported: */ *responseErrorWrapper : github.com/aws/smithy-go/middleware.ider

type suppressBadHTTPRedirectTransport (struct) suppressBadHTTPRedirectTransport provides an http.RoundTripper implementation that wraps another http.RoundTripper to prevent HTTP client receiving 301 and 302 HTTP responses redirects without the required location header. Clients using this utility must have a CheckRedirect, e.g. limitedRedirect, that check for responses with having a URL of baseHTTPRedirectLocation, and suppress the redirect. Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ tr http.RoundTripper Methods (only one, which is exported) ( suppressBadHTTPRedirectTransport) RoundTrip(r *http.Request) (*http.Response, error) RoundTrip backfills a stub location when a 301/302 response is received without a location. This stub location is used by limitedRedirect to prevent the HTTP client from failing attempting to use follow a redirect without a location value. Implements (at least one exported) suppressBadHTTPRedirectTransport : net/http.RoundTripper

type timeoutReadCloser (struct) timeoutReadCloser will handle body reads that take too long. We will return a ErrReadTimeout error if a timeout occurs. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ duration time.Duration reader io.ReadCloser Methods (total 2, both are exported) (*timeoutReadCloser) Close() error (*timeoutReadCloser) Read(b []byte) (int, error) Read will spin off a goroutine to call the reader's Read method. We will select on the timer's channel or the read's channel. Whoever completes first will be returned. Implements (at least 3, all are exported) *timeoutReadCloser : io.Closer *timeoutReadCloser : io.ReadCloser *timeoutReadCloser : io.Reader

Package-Level Functions (total 9, in which 4 are exported)

func AddResponseErrorMiddleware(stack *middleware.Stack) error AddResponseErrorMiddleware adds response error wrapper middleware

func AddResponseReadTimeoutMiddleware(stack *middleware.Stack, duration time.Duration) error AddResponseReadTimeoutMiddleware adds a middleware to the stack that wraps the response body so that a read that takes too long will return an error.

func NewBuildableClient() *BuildableClient NewBuildableClient returns an initialized client for invoking HTTP requests.

func RemoveContentTypeHeader(stack *middleware.Stack) error RemoveContentTypeHeader removes content-type header if content length is unset or equal to zero.

/* 5 unexporteds ... *//* 5 unexporteds: */

func defaultDialer() *net.Dialer

func defaultHTTPTransport() *http.Transport

func limitedRedirect(r *http.Request, via []*http.Request) error limitedRedirect is a CheckRedirect that prevents the client from following any non 307/308 HTTP status code redirects. The 307 and 308 redirects are allowed because the client must use the original HTTP method for the redirected to location. Whereas 301 and 302 allow the client to switch to GET for the redirect. Suppresses all redirect requests with a URL of badHTTPRedirectLocation.

func shallowCopyStruct(src interface{}) interface{} shallowCopyStruct creates a shallow copy of the passed in source struct, and returns that copy of the same struct type.

func wrapWithLimitedRedirect(c *http.Client) *http.Client wrapWithLimitedRedirect updates the Client's Transport and CheckRedirect to not follow any redirect other than 307 and 308. No other redirect will be followed. If the client does not have a Transport defined will use a new SDK default http.Transport configuration.

Package-Level Variables (total 8, all are exported)

var DefaultDialConnectTimeout time.Duration Timeouts for net.Dialer's network connection.

var DefaultDialKeepAliveTimeout time.Duration Timeouts for net.Dialer's network connection.

var DefaultHTTPTransportExpectContinueTimeout time.Duration Defaults for the HTTPTransportBuilder.

var DefaultHTTPTransportIdleConnTimeout time.Duration Default connection timeouts

var DefaultHTTPTransportMaxIdleConns int Default connection pool options

var DefaultHTTPTransportMaxIdleConnsPerHost int Defaults for the HTTPTransportBuilder.

var DefaultHTTPTransportTLSHandleshakeTimeout time.Duration Defaults for the HTTPTransportBuilder.

var DefaultHTTPTransportTLSMinVersion uint16 Default to TLS 1.2 for all HTTPS requests.

Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */

const badHTTPRedirectLocation = "https://amazonaws.com/badhttpredirectlocation"