package aws

Import Path
	github.com/aws/aws-sdk-go-v2/aws (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 12 packages

Involved Source Files config.go context.go credential_cache.go credentials.go defaultsmode.go Package aws provides the core SDK's utilities and shared types. Use this package's utilities to simplify setting and reading API operations parameters. # Value and Pointer Conversion Utilities This package includes a helper conversion utility for each scalar type the SDK's API use. These utilities make getting a pointer of the scalar, and dereferencing a pointer easier. Each conversion utility comes in two forms. Value to Pointer and Pointer to Value. The Pointer to value will safely dereference the pointer and return its value. If the pointer was nil, the scalar's zero value will be returned. The value to pointer functions will be named after the scalar type. So get a *string from a string value use the "String" function. This makes it easy to to get pointer of a literal string value, because getting the address of a literal requires assigning the value to a variable first. var strPtr *string // Without the SDK's conversion functions str := "my string" strPtr = &str // With the SDK's conversion functions strPtr = aws.String("my string") // Convert *string to string value str = aws.ToString(strPtr) In addition to scalars the aws package also includes conversion utilities for map and slice for commonly types used in API parameters. The map and slice conversion functions use similar naming pattern as the scalar conversion functions. var strPtrs []*string var strs []string = []string{"Go", "Gophers", "Go"} // Convert []string to []*string strPtrs = aws.StringSlice(strs) // Convert []*string to []string strs = aws.ToStringSlice(strPtrs) # SDK Default HTTP Client The SDK will use the http.DefaultClient if a HTTP client is not provided to the SDK's Session, or service client constructor. This means that if the http.DefaultClient is modified by other components of your application the modifications will be picked up by the SDK as well. In some cases this might be intended, but it is a better practice to create a custom HTTP Client to share explicitly through your application. You can configure the SDK to use the custom HTTP Client by setting the HTTPClient value of the SDK's Config type when creating a Session or service client. endpoints.go errors.go from_ptr.go go_module_metadata.go logging.go request.go retryer.go runtime.go to_ptr.go types.go Package aws provides core functionality for making requests to AWS services.
Package-Level Type Names (total 33, in which 31 are exported)
/* sort exporteds by: | */
AdjustExpiresByCredentialsCacheStrategy is an interface for CredentialCache to allow CredentialsProvider to intercept adjustments to Credentials expiry based on expectations and use cases of CredentialsProvider. Credential caches may use default implementation if nil. Given a Credentials as input, applying any mutations and returning the potentially updated Credentials, or error.
AnonymousCredentials provides a sentinel CredentialsProvider that should be used to instruct the SDK's signing middleware to not sign the request. Using `nil` credentials when configuring an API client will achieve the same result. The AnonymousCredentials type allows you to configure the SDK's external config loading to not attempt to source credentials from the shared config or environment. For example you can use this CredentialsProvider with an API client's Options to instruct the client not to sign a request for accessing public S3 bucket objects. The following example demonstrates using the AnonymousCredentials to prevent SDK's external config loading attempt to resolve credentials. cfg, err := config.LoadDefaultConfig(context.TODO(), config.WithCredentialsProvider(aws.AnonymousCredentials{}), ) if err != nil { log.Fatalf("failed to load config, %v", err) } client := s3.NewFromConfig(cfg) Alternatively you can leave the API client Option's `Credential` member to nil. If using the `NewFromConfig` constructor you'll need to explicitly set the `Credentials` member to nil, if the external config resolved a credential provider. client := s3.New(s3.Options{ // Credentials defaults to a nil value. }) This can also be configured for specific operations calls too. cfg, err := config.LoadDefaultConfig(context.TODO()) if err != nil { log.Fatalf("failed to load config, %v", err) } client := s3.NewFromConfig(config) result, err := client.GetObject(context.TODO(), s3.GetObject{ Bucket: aws.String("example-bucket"), Key: aws.String("example-key"), }, func(o *s3.Options) { o.Credentials = nil // Or o.Credentials = aws.AnonymousCredentials{} }) Retrieve implements the CredentialsProvider interface, but will always return error, and cannot be used to sign a request. The AnonymousCredentials type is used as a sentinel type instructing the AWS request signing middleware to not sign a request. AnonymousCredentials : CredentialsProvider
ClientLogMode represents the logging mode of SDK clients. The client logging mode is a bit-field where each bit is a flag that describes the logging behavior for one or more client components. The entire 64-bit group is reserved for later expansion by the SDK. Example: Setting ClientLogMode to enable logging of retries and requests clientLogMode := aws.LogRetries | aws.LogRequest Example: Adding an additional log mode to an existing ClientLogMode value clientLogMode |= aws.LogResponse ClearDeprecatedUsage clears the DeprecatedUsage logging mode bit ClearRequest clears the Request logging mode bit ClearRequestEventMessage clears the RequestEventMessage logging mode bit ClearRequestWithBody clears the RequestWithBody logging mode bit ClearResponse clears the Response logging mode bit ClearResponseEventMessage clears the ResponseEventMessage logging mode bit ClearResponseWithBody clears the ResponseWithBody logging mode bit ClearRetries clears the Retries logging mode bit ClearSigning clears the Signing logging mode bit IsDeprecatedUsage returns whether the DeprecatedUsage logging mode bit is set IsRequest returns whether the Request logging mode bit is set IsRequestEventMessage returns whether the RequestEventMessage logging mode bit is set IsRequestWithBody returns whether the RequestWithBody logging mode bit is set IsResponse returns whether the Response logging mode bit is set IsResponseEventMessage returns whether the ResponseEventMessage logging mode bit is set IsResponseWithBody returns whether the ResponseWithBody logging mode bit is set IsRetries returns whether the Retries logging mode bit is set IsSigning returns whether the Signing logging mode bit is set const LogDeprecatedUsage const LogRequest const LogRequestEventMessage const LogRequestWithBody const LogResponse const LogResponseEventMessage const LogResponseWithBody const LogRetries const LogSigning
A Config provides service configuration for service clients. APIOptions provides the set of middleware mutations modify how the API client requests will be handled. This is useful for adding additional tracing data to a request, or changing behavior of the SDK's client. The Bearer Authentication token provider to use for authenticating API operation calls with a Bearer Authentication token. The API clients and operation must support Bearer Authentication scheme in order for the token provider to be used. API clients created with NewFromConfig will automatically be configured with this option, if the API client support Bearer Authentication. The SDK's config.LoadDefaultConfig can automatically populate this option for external configuration options such as SSO session. https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html Configures the events that will be sent to the configured logger. This can be used to configure the logging of signing, retries, request, and responses of the SDK clients. See the ClientLogMode type documentation for the complete set of logging modes and available configuration. ConfigSources are the sources that were used to construct the Config. Allows for additional configuration to be loaded by clients. The credentials object to use when signing requests. Use the LoadDefaultConfig to load configuration from all the SDK's supported sources, and resolve credentials using the SDK's default credential chain. The configured DefaultsMode. If not specified, service clients will default to legacy. Supported modes are: auto, cross-region, in-region, legacy, mobile, standard An endpoint resolver that can be used to provide or override an endpoint for the given service and region. See the `aws.EndpointResolver` documentation for additional usage information. Deprecated: See Config.EndpointResolverWithOptions An endpoint resolver that can be used to provide or override an endpoint for the given service and region. When EndpointResolverWithOptions is specified, it will be used by a service client rather than using EndpointResolver if also specified. See the `aws.EndpointResolverWithOptions` documentation for additional usage information. The HTTP Client the SDK's API clients will use to invoke HTTP requests. The SDK defaults to a BuildableClient allowing API clients to create copies of the HTTP Client for service specific customizations. Use a (*http.Client) for custom behavior. Using a custom http.Client will prevent the SDK from modifying the HTTP client. The logger writer interface to write logging messages to. Defaults to standard error. 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 for information on AWS regions. RetryMaxAttempts specifies the maximum number attempts an API client will call an operation that fails with a retryable error. API Clients will only use this value to construct a retryer if the Config.Retryer member is not nil. This value will be ignored if Retryer is not nil. RetryMode specifies the retry model the API client will be created with. API Clients will only use this value to construct a retryer if the Config.Retryer member is not nil. This value will be ignored if Retryer is not nil. Retryer is a function that provides a Retryer implementation. A Retryer guides how HTTP requests should be retried in case of recoverable failures. When nil the API client will use a default retryer. In general, the provider function should return a new instance of a Retryer if you are attempting to provide a consistent Retryer configuration across all clients. This will ensure that each client will be provided a new instance of the Retryer implementation, and will avoid issues such as sharing the same retry token bucket across services. If not nil, RetryMaxAttempts, and RetryMode will be ignored by API clients. The RuntimeEnvironment configuration, only populated if the DefaultsMode is set to DefaultsModeAuto and is initialized by `config.LoadDefaultConfig`. You should not populate this structure programmatically, or rely on the values here within your applications. Copy will return a shallow copy of the Config object. If any additional configurations are provided they will be merged into the new config returned. func NewConfig() *Config func Config.Copy() Config func github.com/aws/aws-sdk-go-v2/service/s3.NewFromConfig(cfg Config, optFns ...func(*s3.Options)) *s3.Client
A Credentials is the AWS credentials value for individual credential fields. AWS Access key ID States if the credentials can expire or not. The time the credentials will expire at. Should be ignored if CanExpire is false. AWS Secret Access Key AWS Session Token Source of the credentials Expired returns if the credentials have expired. HasKeys returns if the credentials keys are set. func AdjustExpiresByCredentialsCacheStrategy.AdjustExpiresBy(Credentials, time.Duration) (Credentials, error) func AnonymousCredentials.Retrieve(context.Context) (Credentials, error) func (*CredentialsCache).Retrieve(ctx context.Context) (Credentials, error) func CredentialsProvider.Retrieve(ctx context.Context) (Credentials, error) func CredentialsProviderFunc.Retrieve(ctx context.Context) (Credentials, error) func HandleFailRefreshCredentialsCacheStrategy.HandleFailToRefresh(context.Context, Credentials, error) (Credentials, error) func github.com/aws/aws-sdk-go-v2/aws/middleware.GetSigningCredentials(ctx context.Context) (v Credentials) func github.com/aws/aws-sdk-go-v2/internal/v4a.(*SymmetricCredentialAdaptor).Retrieve(ctx context.Context) (Credentials, error) func AdjustExpiresByCredentialsCacheStrategy.AdjustExpiresBy(Credentials, time.Duration) (Credentials, error) func HandleFailRefreshCredentialsCacheStrategy.HandleFailToRefresh(context.Context, Credentials, error) (Credentials, error) func github.com/aws/aws-sdk-go-v2/aws/middleware.SetSigningCredentials(ctx context.Context, value Credentials) context.Context func github.com/aws/aws-sdk-go-v2/aws/signer/internal/v4.(*SigningKeyDeriver).DeriveKey(credential Credentials, service, region string, signingTime v4.SigningTime) []byte func github.com/aws/aws-sdk-go-v2/aws/signer/v4.NewStreamSigner(credentials Credentials, service, region string, seedSignature []byte, optFns ...func(*v4.StreamSignerOptions)) *v4.StreamSigner func github.com/aws/aws-sdk-go-v2/aws/signer/v4.HTTPPresigner.PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) (url string, signedHeader http.Header, err error) func github.com/aws/aws-sdk-go-v2/aws/signer/v4.HTTPSigner.SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error func github.com/aws/aws-sdk-go-v2/aws/signer/v4.(*Signer).PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) (signedURI string, signedHeaders http.Header, err error) func github.com/aws/aws-sdk-go-v2/aws/signer/v4.Signer.SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(options *v4.SignerOptions)) error func github.com/aws/aws-sdk-go-v2/service/s3.HTTPPresignerV4.PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) (url string, signedHeader http.Header, err error) func github.com/aws/aws-sdk-go-v2/service/s3.HTTPSignerV4.SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
CredentialsCache provides caching and concurrency safe credentials retrieval via the provider's retrieve method. CredentialsCache will look for optional interfaces on the Provider to adjust how the credential cache handles credentials caching. - HandleFailRefreshCredentialsCacheStrategy - Allows provider to handle credential refresh failures. This could return an updated Credentials value, or attempt another means of retrieving credentials. - AdjustExpiresByCredentialsCacheStrategy - Allows provider to adjust how credentials Expires is modified. This could modify how the Credentials Expires is adjusted based on the CredentialsCache ExpiryWindow option. Such as providing a floor not to reduce the Expires below. Invalidate will invalidate the cached credentials. The next call to Retrieve will cause the provider's Retrieve method to be called. IsCredentialsProvider returns whether credential provider wrapped by CredentialsCache matches the target provider type. Retrieve returns the credentials. If the credentials have already been retrieved, and not expired the cached credentials will be returned. If the credentials have not been retrieved yet, or expired the provider's Retrieve method will be called. Returns and error if the provider's retrieve method returns an error. *CredentialsCache : CredentialsProvider *CredentialsCache : github.com/aws/aws-sdk-go-v2/internal/sdk.Invalidator func NewCredentialsCache(provider CredentialsProvider, optFns ...func(options *CredentialsCacheOptions)) *CredentialsCache
CredentialsCacheOptions are the options ExpiryWindow will allow the credentials to trigger refreshing prior to the credentials actually expiring. This is beneficial so race conditions with expiring credentials do not cause request to fail unexpectedly due to ExpiredTokenException exceptions. An ExpiryWindow of 10s would cause calls to IsExpired() to return true 10 seconds before the credentials are actually expired. This can cause an increased number of requests to refresh the credentials to occur. If ExpiryWindow is 0 or less it will be ignored. ExpiryWindowJitterFrac provides a mechanism for randomizing the expiration of credentials within the configured ExpiryWindow by a random percentage. Valid values are between 0.0 and 1.0. As an example if ExpiryWindow is 60 seconds and ExpiryWindowJitterFrac is 0.5 then credentials will be set to expire between 30 to 60 seconds prior to their actual expiration time. If ExpiryWindow is 0 or less then ExpiryWindowJitterFrac is ignored. If ExpiryWindowJitterFrac is 0 then no randomization will be applied to the window. If ExpiryWindowJitterFrac < 0 the value will be treated as 0. If ExpiryWindowJitterFrac > 1 the value will be treated as 1.
A CredentialsProvider is the interface for any component which will provide credentials Credentials. A CredentialsProvider is required to manage its own Expired state, and what to be expired means. A credentials provider implementation can be wrapped with a CredentialCache to cache the credential value retrieved. Without the cache the SDK will attempt to retrieve the credentials for every request. Retrieve returns nil if it successfully retrieved the value. Error is returned if the value were not obtainable, or empty. AnonymousCredentials *CredentialsCache CredentialsProviderFunc *github.com/aws/aws-sdk-go-v2/internal/v4a.SymmetricCredentialAdaptor func IsCredentialsProvider(provider, target CredentialsProvider) bool func NewCredentialsCache(provider CredentialsProvider, optFns ...func(options *CredentialsCacheOptions)) *CredentialsCache func (*CredentialsCache).IsCredentialsProvider(target CredentialsProvider) bool
CredentialsProviderFunc provides a helper wrapping a function value to satisfy the CredentialsProvider interface. Retrieve delegates to the function value the CredentialsProviderFunc wraps. CredentialsProviderFunc : CredentialsProvider
DefaultsMode is the SDK defaults mode setting. SetFromString sets the DefaultsMode value to one of the pre-defined constants that matches the provided string when compared using EqualFold. If the value does not match a known constant it will be set to as-is and the function will return false. As a special case, if the provided value is a zero-length string, the mode will be set to LegacyDefaultsMode. func github.com/aws/aws-sdk-go-v2/aws/defaults.ResolveDefaultsModeAuto(region string, environment RuntimeEnvironment) DefaultsMode func github.com/aws/aws-sdk-go-v2/aws/defaults.GetModeConfiguration(mode DefaultsMode) (defaults.Configuration, error) const DefaultsModeAuto const DefaultsModeCrossRegion const DefaultsModeInRegion const DefaultsModeLegacy const DefaultsModeMobile const DefaultsModeStandard
DualStackEndpointState is a constant to describe the dual-stack endpoint resolution behavior. func GetUseDualStackEndpoint(options ...interface{}) (value DualStackEndpointState, found bool) func github.com/aws/aws-sdk-go-v2/internal/configsources.ResolveUseDualStackEndpoint(ctx context.Context, configs []interface{}) (value DualStackEndpointState, found bool, err error) func github.com/aws/aws-sdk-go-v2/internal/configsources.UseDualStackEndpointProvider.GetUseDualStackEndpoint(context.Context) (value DualStackEndpointState, found bool, err error) func github.com/aws/aws-sdk-go-v2/service/s3/internal/endpoints.Options.GetUseDualStackEndpoint() DualStackEndpointState const DualStackEndpointStateDisabled const DualStackEndpointStateEnabled const DualStackEndpointStateUnset
Endpoint represents the endpoint a service client should make API operation calls to. The SDK will automatically resolve these endpoints per API client using an internal endpoint resolvers. If you'd like to provide custom endpoint resolving behavior you can implement the EndpointResolver interface. Specifies if the endpoint's hostname can be modified by the SDK's API client. If the hostname is mutable the SDK API clients may modify any part of the hostname based on the requirements of the API, (e.g. adding, or removing content in the hostname). Such as, Amazon S3 API client prefixing "bucketname" to the hostname, or changing the hostname service name component from "s3." to "s3-accesspoint.dualstack." for the dualstack endpoint of an S3 Accesspoint resource. Care should be taken when providing a custom endpoint for an API. If the endpoint hostname is mutable, and the client cannot modify the endpoint correctly, the operation call will most likely fail, or have undefined behavior. If hostname is immutable, the SDK API clients will not modify the hostname of the URL. This may cause the API client not to function correctly if the API requires the operation specific hostname values to be used by the client. This flag does not modify the API client's behavior if this endpoint will be used instead of Endpoint Discovery, or if the endpoint will be used to perform Endpoint Discovery. That behavior is configured via the API Client's Options. The AWS partition the endpoint belongs to. The signing method that should be used for signing the requests to the endpoint. The service name that should be used for signing the requests to the endpoint. The region that should be used for signing the request to the endpoint. The source of the Endpoint. By default, this will be EndpointSourceServiceMetadata. When providing a custom endpoint, you should set the source as EndpointSourceCustom. If source is not provided when providing a custom endpoint, the SDK may not perform required host mutations correctly. Source should be used along with HostnameImmutable property as per the usage requirement. The base URL endpoint the SDK API clients will use to make API calls to. The SDK will suffix URI path and query elements to this endpoint. func EndpointResolver.ResolveEndpoint(service, region string) (Endpoint, error) func EndpointResolverFunc.ResolveEndpoint(service, region string) (Endpoint, error) func EndpointResolverWithOptions.ResolveEndpoint(service, region string, options ...interface{}) (Endpoint, error) func EndpointResolverWithOptionsFunc.ResolveEndpoint(service, region string, options ...interface{}) (Endpoint, error) func github.com/aws/aws-sdk-go-v2/internal/endpoints/v2.Partition.ResolveEndpoint(region string, options endpoints.Options) (resolved Endpoint, err error) func github.com/aws/aws-sdk-go-v2/internal/endpoints/v2.Partitions.ResolveEndpoint(region string, opts endpoints.Options) (Endpoint, error) func github.com/aws/aws-sdk-go-v2/service/s3.EndpointResolver.ResolveEndpoint(region string, options customizations.EndpointResolverOptions) (Endpoint, error) func github.com/aws/aws-sdk-go-v2/service/s3.EndpointResolverFunc.ResolveEndpoint(region string, options s3.EndpointResolverOptions) (endpoint Endpoint, err error) func github.com/aws/aws-sdk-go-v2/service/s3/internal/customizations.EndpointResolver.ResolveEndpoint(region string, options customizations.EndpointResolverOptions) (Endpoint, error) func github.com/aws/aws-sdk-go-v2/service/s3/internal/endpoints.(*Resolver).ResolveEndpoint(region string, options endpoints.Options) (endpoint Endpoint, err error)
EndpointDiscoveryEnableState indicates if endpoint discovery is enabled, disabled, auto or unset state. Default behavior (Auto or Unset) indicates operations that require endpoint discovery will use Endpoint Discovery by default. Operations that optionally use Endpoint Discovery will not use Endpoint Discovery unless EndpointDiscovery is explicitly enabled. func github.com/aws/aws-sdk-go-v2/internal/configsources.ResolveEnableEndpointDiscovery(ctx context.Context, configs []interface{}) (value EndpointDiscoveryEnableState, found bool, err error) func github.com/aws/aws-sdk-go-v2/internal/configsources.EnableEndpointDiscoveryProvider.GetEnableEndpointDiscovery(ctx context.Context) (value EndpointDiscoveryEnableState, found bool, err error) const EndpointDiscoveryAuto const EndpointDiscoveryDisabled const EndpointDiscoveryEnabled const EndpointDiscoveryUnset
EndpointNotFoundError is a sentinel error to indicate that the EndpointResolver implementation was unable to resolve an endpoint for the given service and region. Resolvers should use this to indicate that an API client should fallback and attempt to use it's internal default resolver to resolve the endpoint. Err error Error is the error message. Unwrap returns the underlying error. *EndpointNotFoundError : error
EndpointResolver is an endpoint resolver that can be used to provide or override an endpoint for the given service and region. API clients will attempt to use the EndpointResolver first to resolve an endpoint if available. If the EndpointResolver returns an EndpointNotFoundError error, API clients will fallback to attempting to resolve the endpoint using its internal default endpoint resolver. Deprecated: See EndpointResolverWithOptions ( EndpointResolver) ResolveEndpoint(service, region string) (Endpoint, error) EndpointResolverFunc
EndpointResolverFunc wraps a function to satisfy the EndpointResolver interface. Deprecated: See EndpointResolverWithOptionsFunc ResolveEndpoint calls the wrapped function and returns the results. Deprecated: See EndpointResolverWithOptions.ResolveEndpoint EndpointResolverFunc : EndpointResolver
EndpointResolverWithOptions is an endpoint resolver that can be used to provide or override an endpoint for the given service, region, and the service client's EndpointOptions. API clients will attempt to use the EndpointResolverWithOptions first to resolve an endpoint if available. If the EndpointResolverWithOptions returns an EndpointNotFoundError error, API clients will fallback to attempting to resolve the endpoint using its internal default endpoint resolver. ( EndpointResolverWithOptions) ResolveEndpoint(service, region string, options ...interface{}) (Endpoint, error) EndpointResolverWithOptionsFunc
EndpointResolverWithOptionsFunc wraps a function to satisfy the EndpointResolverWithOptions interface. ResolveEndpoint calls the wrapped function and returns the results. EndpointResolverWithOptionsFunc : EndpointResolverWithOptions
EndpointSource is the endpoint source type. func github.com/aws/aws-sdk-go-v2/aws/middleware.GetEndpointSource(ctx context.Context) (v EndpointSource) func github.com/aws/aws-sdk-go-v2/aws/middleware.SetEndpointSource(ctx context.Context, value EndpointSource) context.Context const EndpointSourceCustom const EndpointSourceServiceMetadata
ExecutionEnvironmentID is the AWS execution environment runtime identifier.
FIPSEndpointState is a constant to describe the FIPS endpoint resolution behavior. func GetUseFIPSEndpoint(options ...interface{}) (value FIPSEndpointState, found bool) func github.com/aws/aws-sdk-go-v2/internal/configsources.ResolveUseFIPSEndpoint(ctx context.Context, configs []interface{}) (value FIPSEndpointState, found bool, err error) func github.com/aws/aws-sdk-go-v2/internal/configsources.UseFIPSEndpointProvider.GetUseFIPSEndpoint(context.Context) (value FIPSEndpointState, found bool, err error) func github.com/aws/aws-sdk-go-v2/service/s3/internal/endpoints.Options.GetUseFIPSEndpoint() FIPSEndpointState const FIPSEndpointStateDisabled const FIPSEndpointStateEnabled const FIPSEndpointStateUnset
HandleFailRefreshCredentialsCacheStrategy is an interface for CredentialsCache to allow CredentialsProvider how failed to refresh credentials is handled. Given the previously cached Credentials, if any, and refresh error, may returns new or modified set of Credentials, or error. Credential caches may use default implementation if nil.
HTTPClient provides the interface to provide custom HTTPClients. Generally *http.Client is sufficient for most use cases. The HTTPClient should not follow 301 or 302 redirects. Do sends an HTTP request and returns an HTTP response. *github.com/aws/aws-sdk-go-v2/aws/transport/http.BuildableClient github.com/aws/aws-sdk-go-v2/service/s3.HTTPClient (interface) github.com/aws/smithy-go/transport/http.ClientDo (interface) github.com/aws/smithy-go/transport/http.ClientDoFunc github.com/aws/smithy-go/transport/http.NopClient go.pact.im/x/httpclient.Client (interface) *net/http.Client *net/http/httputil.ClientConn HTTPClient : github.com/aws/aws-sdk-go-v2/service/s3.HTTPClient HTTPClient : github.com/aws/smithy-go/transport/http.ClientDo HTTPClient : go.pact.im/x/httpclient.Client func github.com/aws/aws-sdk-go-v2/aws/transport/http.(*BuildableClient).Freeze() HTTPClient
MissingRegionError is an error that is returned if region configuration value was not found. (*MissingRegionError) Error() string *MissingRegionError : error
NopRetryer provides a RequestRetryDecider implementation that will flag all attempt errors as not retryable, with a max attempts of 1. GetAttemptToken returns a stub function that does nothing. GetInitialToken returns a stub function that does nothing. GetRetryToken returns a stub function that does nothing. IsErrorRetryable returns false for all error values. MaxAttempts always returns 1 for the original attempt. RetryDelay is not valid for the NopRetryer. Will always return error. NopRetryer : Retryer NopRetryer : RetryerV2
RequestCanceledError is the error that will be returned by an API request that was canceled. Requests given a Context may return this error when canceled. Err error CanceledError returns true to satisfy interfaces checking for canceled errors. (*RequestCanceledError) Error() string Unwrap returns the underlying error, if there was one. *RequestCanceledError : error
Retryer is an interface to determine if a given error from a attempt should be retried, and if so what backoff delay to apply. The default implementation used by most services is the retry package's Standard type. Which contains basic retry logic using exponential backoff. GetInitialToken returns the initial attempt token that can increment the retry token pool if the attempt is successful. GetRetryToken attempts to deduct the retry cost from the retry token pool. Returning the token release function, or error. IsErrorRetryable returns if the failed attempt is retryable. This check should determine if the error can be retried, or if the error is terminal. MaxAttempts returns the maximum number of attempts that can be made for an attempt before failing. A value of 0 implies that the attempt should be retried until it succeeds if the errors are retryable. RetryDelay returns the delay that should be used before retrying the attempt. Will return error if the if the delay could not be determined. NopRetryer RetryerV2 (interface) *github.com/aws/aws-sdk-go-v2/aws/retry.AdaptiveMode *github.com/aws/aws-sdk-go-v2/aws/retry.Standard func github.com/aws/aws-sdk-go-v2/aws/retry.AddWithErrorCodes(r Retryer, codes ...string) Retryer func github.com/aws/aws-sdk-go-v2/aws/retry.AddWithMaxAttempts(r Retryer, max int) Retryer func github.com/aws/aws-sdk-go-v2/aws/retry.AddWithMaxBackoffDelay(r Retryer, delay time.Duration) Retryer func github.com/aws/aws-sdk-go-v2/aws/retry.AddWithErrorCodes(r Retryer, codes ...string) Retryer func github.com/aws/aws-sdk-go-v2/aws/retry.AddWithMaxAttempts(r Retryer, max int) Retryer func github.com/aws/aws-sdk-go-v2/aws/retry.AddWithMaxBackoffDelay(r Retryer, delay time.Duration) Retryer func github.com/aws/aws-sdk-go-v2/aws/retry.NewAttemptMiddleware(retryer Retryer, requestCloner retry.RequestCloner, optFns ...func(*retry.Attempt)) *retry.Attempt
RetryerV2 is an interface to determine if a given error from an attempt should be retried, and if so what backoff delay to apply. The default implementation used by most services is the retry package's Standard type. Which contains basic retry logic using exponential backoff. RetryerV2 replaces the Retryer interface, deprecating the GetInitialToken method in favor of GetAttemptToken which takes a context, and can return an error. The SDK's retry package's Attempt middleware, and utilities will always wrap a Retryer as a RetryerV2. Delegating to GetInitialToken, only if GetAttemptToken is not implemented. GetAttemptToken returns the send token that can be used to rate limit attempt calls. Will be used by the SDK's retry package's Attempt middleware to get a send token prior to calling the temp and releasing the send token after the attempt has been made. GetInitialToken returns the initial attempt token that can increment the retry token pool if the attempt is successful. GetRetryToken attempts to deduct the retry cost from the retry token pool. Returning the token release function, or error. IsErrorRetryable returns if the failed attempt is retryable. This check should determine if the error can be retried, or if the error is terminal. MaxAttempts returns the maximum number of attempts that can be made for an attempt before failing. A value of 0 implies that the attempt should be retried until it succeeds if the errors are retryable. RetryDelay returns the delay that should be used before retrying the attempt. Will return error if the if the delay could not be determined. NopRetryer *github.com/aws/aws-sdk-go-v2/aws/retry.AdaptiveMode *github.com/aws/aws-sdk-go-v2/aws/retry.Standard RetryerV2 : Retryer
RetryMode provides the mode the API client will use to create a retryer based on. ( RetryMode) String() string RetryMode : expvar.Var RetryMode : fmt.Stringer func ParseRetryMode(v string) (mode RetryMode, err error) const RetryModeAdaptive const RetryModeStandard
RuntimeEnvironment is a collection of values that are determined at runtime based on the environment that the SDK is executing in. Some of these values may or may not be present based on the executing environment and certain SDK configuration properties that drive whether these values are populated.. EC2InstanceMetadataRegion string EnvironmentIdentifier ExecutionEnvironmentID Region string func github.com/aws/aws-sdk-go-v2/aws/defaults.ResolveDefaultsModeAuto(region string, environment RuntimeEnvironment) DefaultsMode
Ternary is an enum allowing an unknown or none state in addition to a bool's true and false. Bool returns true if the value is TrueTernary, false otherwise. ( Ternary) String() string Ternary : expvar.Var Ternary : fmt.Stringer func BoolTernary(v bool) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorRetryable.IsErrorRetryable(error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorRetryableFunc.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorRetryables.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorThrottle.IsErrorThrottle(error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorThrottleFunc.IsErrorThrottle(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorThrottles.IsErrorThrottle(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorTimeout.IsErrorTimeout(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorTimeoutFunc.IsErrorTimeout(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.IsErrorTimeouts.IsErrorTimeout(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.NoRetryCanceledError.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.RetryableConnectionError.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.RetryableError.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.RetryableErrorCode.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.RetryableHTTPStatusCode.IsErrorRetryable(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.ThrottleErrorCode.IsErrorThrottle(err error) Ternary func github.com/aws/aws-sdk-go-v2/aws/retry.TimeouterError.IsErrorTimeout(err error) Ternary const FalseTernary const TrueTernary const UnknownTernary
Package-Level Functions (total 114, in which 111 are exported)
Bool returns a pointer value for the bool value passed in.
BoolMap returns a map of bool pointers from the values passed in.
BoolSlice returns a slice of bool pointers from the values passed in.
BoolTernary returns a true or false Ternary value for the bool provided.
Byte returns a pointer value for the byte value passed in.
ByteMap returns a map of byte pointers from the values passed in.
ByteSlice returns a slice of byte pointers from the values passed in.
Duration returns a pointer value for the time.Duration value passed in.
DurationMap returns a map of time.Duration pointers from the values passed in.
DurationSlice returns a slice of time.Duration pointers from the values passed in.
Float32 returns a pointer value for the float32 value passed in.
Float32Map returns a map of float32 pointers from the values passed in.
Float32Slice returns a slice of float32 pointers from the values passed in.
Float64 returns a pointer value for the float64 value passed in.
Float64Map returns a map of float64 pointers from the values passed in.
Float64Slice returns a slice of float64 pointers from the values passed in.
GetDisableHTTPS takes a service's EndpointResolverOptions and returns the DisableHTTPS value. Returns boolean false if the provided options does not have a method to retrieve the DisableHTTPS.
GetResolvedRegion takes a service's EndpointResolverOptions and returns the ResolvedRegion value. Returns boolean false if the provided options does not have a method to retrieve the ResolvedRegion.
GetUseDualStackEndpoint takes a service's EndpointResolverOptions and returns the UseDualStackEndpoint value. Returns boolean false if the provided options does not have a method to retrieve the DualStackEndpointState.
GetUseFIPSEndpoint takes a service's EndpointResolverOptions and returns the UseDualStackEndpoint value. Returns boolean false if the provided options does not have a method to retrieve the DualStackEndpointState.
Int returns a pointer value for the int value passed in.
Int16 returns a pointer value for the int16 value passed in.
Int16Map returns a map of int16 pointers from the values passed in.
Int16Slice returns a slice of int16 pointers from the values passed in.
Int32 returns a pointer value for the int32 value passed in.
Int32Map returns a map of int32 pointers from the values passed in.
Int32Slice returns a slice of int32 pointers from the values passed in.
Int64 returns a pointer value for the int64 value passed in.
Int64Map returns a map of int64 pointers from the values passed in.
Int64Slice returns a slice of int64 pointers from the values passed in.
Int8 returns a pointer value for the int8 value passed in.
Int8Map returns a map of int8 pointers from the values passed in.
Int8Slice returns a slice of int8 pointers from the values passed in.
IntMap returns a map of int pointers from the values passed in.
IntSlice returns a slice of int pointers from the values passed in.
IsCredentialsProvider returns whether the target CredentialProvider is the same type as provider when comparing the implementation type. If provider has a method IsCredentialsProvider(CredentialsProvider) bool it will be responsible for validating whether target matches the credential provider type. When comparing the CredentialProvider implementations provider and target for equality, the following rules are used: If provider is of type T and target is of type V, true if type *T is the same as type *V, otherwise false If provider is of type *T and target is of type V, true if type *T is the same as type *V, otherwise false If provider is of type T and target is of type *V, true if type *T is the same as type *V, otherwise false If provider is of type *T and target is of type *V,true if type *T is the same as type *V, otherwise false
NewConfig returns a new Config pointer that can be chained with builder methods to set multiple configuration values inline without using pointers.
NewCredentialsCache returns a CredentialsCache that wraps provider. Provider is expected to not be nil. A variadic list of one or more functions can be provided to modify the CredentialsCache configuration. This allows for configuration of credential expiry window and jitter.
ParseRetryMode attempts to parse a RetryMode from the given string. Returning error if the value is not a known RetryMode.
String returns a pointer value for the string value passed in.
StringMap returns a map of string pointers from the values passed in.
StringSlice returns a slice of string pointers from the values passed in.
Time returns a pointer value for the time.Time value passed in.
TimeMap returns a map of time.Time pointers from the values passed in.
TimeSlice returns a slice of time.Time pointers from the values passed in.
ToBool returns bool value dereferenced if the passed in pointer was not nil. Returns a bool zero value if the pointer was nil.
ToBoolMap returns a map of bool values, that are dereferenced if the passed in pointer was not nil. The bool zero value is used if the pointer was nil.
ToBoolSlice returns a slice of bool values, that are dereferenced if the passed in pointer was not nil. Returns a bool zero value if the pointer was nil.
ToByte returns byte value dereferenced if the passed in pointer was not nil. Returns a byte zero value if the pointer was nil.
ToByteMap returns a map of byte values, that are dereferenced if the passed in pointer was not nil. The byte zero value is used if the pointer was nil.
ToByteSlice returns a slice of byte values, that are dereferenced if the passed in pointer was not nil. Returns a byte zero value if the pointer was nil.
ToDuration returns time.Duration value dereferenced if the passed in pointer was not nil. Returns a time.Duration zero value if the pointer was nil.
ToDurationMap returns a map of time.Duration values, that are dereferenced if the passed in pointer was not nil. The time.Duration zero value is used if the pointer was nil.
ToDurationSlice returns a slice of time.Duration values, that are dereferenced if the passed in pointer was not nil. Returns a time.Duration zero value if the pointer was nil.
ToFloat32 returns float32 value dereferenced if the passed in pointer was not nil. Returns a float32 zero value if the pointer was nil.
ToFloat32Map returns a map of float32 values, that are dereferenced if the passed in pointer was not nil. The float32 zero value is used if the pointer was nil.
ToFloat32Slice returns a slice of float32 values, that are dereferenced if the passed in pointer was not nil. Returns a float32 zero value if the pointer was nil.
ToFloat64 returns float64 value dereferenced if the passed in pointer was not nil. Returns a float64 zero value if the pointer was nil.
ToFloat64Map returns a map of float64 values, that are dereferenced if the passed in pointer was not nil. The float64 zero value is used if the pointer was nil.
ToFloat64Slice returns a slice of float64 values, that are dereferenced if the passed in pointer was not nil. Returns a float64 zero value if the pointer was nil.
ToInt returns int value dereferenced if the passed in pointer was not nil. Returns a int zero value if the pointer was nil.
ToInt16 returns int16 value dereferenced if the passed in pointer was not nil. Returns a int16 zero value if the pointer was nil.
ToInt16Map returns a map of int16 values, that are dereferenced if the passed in pointer was not nil. The int16 zero value is used if the pointer was nil.
ToInt16Slice returns a slice of int16 values, that are dereferenced if the passed in pointer was not nil. Returns a int16 zero value if the pointer was nil.
ToInt32 returns int32 value dereferenced if the passed in pointer was not nil. Returns a int32 zero value if the pointer was nil.
ToInt32Map returns a map of int32 values, that are dereferenced if the passed in pointer was not nil. The int32 zero value is used if the pointer was nil.
ToInt32Slice returns a slice of int32 values, that are dereferenced if the passed in pointer was not nil. Returns a int32 zero value if the pointer was nil.
ToInt64 returns int64 value dereferenced if the passed in pointer was not nil. Returns a int64 zero value if the pointer was nil.
ToInt64Map returns a map of int64 values, that are dereferenced if the passed in pointer was not nil. The int64 zero value is used if the pointer was nil.
ToInt64Slice returns a slice of int64 values, that are dereferenced if the passed in pointer was not nil. Returns a int64 zero value if the pointer was nil.
ToInt8 returns int8 value dereferenced if the passed in pointer was not nil. Returns a int8 zero value if the pointer was nil.
ToInt8Map returns a map of int8 values, that are dereferenced if the passed in pointer was not nil. The int8 zero value is used if the pointer was nil.
ToInt8Slice returns a slice of int8 values, that are dereferenced if the passed in pointer was not nil. Returns a int8 zero value if the pointer was nil.
ToIntMap returns a map of int values, that are dereferenced if the passed in pointer was not nil. The int zero value is used if the pointer was nil.
ToIntSlice returns a slice of int values, that are dereferenced if the passed in pointer was not nil. Returns a int zero value if the pointer was nil.
ToString returns string value dereferenced if the passed in pointer was not nil. Returns a string zero value if the pointer was nil.
ToStringMap returns a map of string values, that are dereferenced if the passed in pointer was not nil. The string zero value is used if the pointer was nil.
ToStringSlice returns a slice of string values, that are dereferenced if the passed in pointer was not nil. Returns a string zero value if the pointer was nil.
ToTime returns time.Time value dereferenced if the passed in pointer was not nil. Returns a time.Time zero value if the pointer was nil.
ToTimeMap returns a map of time.Time values, that are dereferenced if the passed in pointer was not nil. The time.Time zero value is used if the pointer was nil.
ToTimeSlice returns a slice of time.Time values, that are dereferenced if the passed in pointer was not nil. Returns a time.Time zero value if the pointer was nil.
ToUint returns uint value dereferenced if the passed in pointer was not nil. Returns a uint zero value if the pointer was nil.
ToUint16 returns uint16 value dereferenced if the passed in pointer was not nil. Returns a uint16 zero value if the pointer was nil.
ToUint16Map returns a map of uint16 values, that are dereferenced if the passed in pointer was not nil. The uint16 zero value is used if the pointer was nil.
ToUint16Slice returns a slice of uint16 values, that are dereferenced if the passed in pointer was not nil. Returns a uint16 zero value if the pointer was nil.
ToUint32 returns uint32 value dereferenced if the passed in pointer was not nil. Returns a uint32 zero value if the pointer was nil.
ToUint32Map returns a map of uint32 values, that are dereferenced if the passed in pointer was not nil. The uint32 zero value is used if the pointer was nil.
ToUint32Slice returns a slice of uint32 values, that are dereferenced if the passed in pointer was not nil. Returns a uint32 zero value if the pointer was nil.
ToUint64 returns uint64 value dereferenced if the passed in pointer was not nil. Returns a uint64 zero value if the pointer was nil.
ToUint64Map returns a map of uint64 values, that are dereferenced if the passed in pointer was not nil. The uint64 zero value is used if the pointer was nil.
ToUint64Slice returns a slice of uint64 values, that are dereferenced if the passed in pointer was not nil. Returns a uint64 zero value if the pointer was nil.
ToUint8 returns uint8 value dereferenced if the passed in pointer was not nil. Returns a uint8 zero value if the pointer was nil.
ToUint8Map returns a map of uint8 values, that are dereferenced if the passed in pointer was not nil. The uint8 zero value is used if the pointer was nil.
ToUint8Slice returns a slice of uint8 values, that are dereferenced if the passed in pointer was not nil. Returns a uint8 zero value if the pointer was nil.
ToUintMap returns a map of uint values, that are dereferenced if the passed in pointer was not nil. The uint zero value is used if the pointer was nil.
ToUintSlice returns a slice of uint values, that are dereferenced if the passed in pointer was not nil. Returns a uint zero value if the pointer was nil.
Uint returns a pointer value for the uint value passed in.
Uint16 returns a pointer value for the uint16 value passed in.
Uint16Map returns a map of uint16 pointers from the values passed in.
Uint16Slice returns a slice of uint16 pointers from the values passed in.
Uint32 returns a pointer value for the uint32 value passed in.
Uint32Map returns a map of uint32 pointers from the values passed in.
Uint32Slice returns a slice of uint32 pointers from the values passed in.
Uint64 returns a pointer value for the uint64 value passed in.
Uint64Map returns a map of uint64 pointers from the values passed in.
Uint64Slice returns a slice of uint64 pointers from the values passed in.
Uint8 returns a pointer value for the uint8 value passed in.
Uint8Map returns a map of uint8 pointers from the values passed in.
Uint8Slice returns a slice of uint8 pointers from the values passed in.
UintMap returns a map of uint pointers from the values passed in.
UintSlice returns a slice of uint pointers from the values passed in.
Package-Level Constants (total 35, in which 34 are exported)
DefaultsModeAuto is an experimental mode that builds on the standard mode. The SDK will attempt to discover the execution environment to determine the appropriate settings automatically. Note that the auto detection is heuristics-based and does not guarantee 100% accuracy. STANDARD mode will be used if the execution environment cannot be determined. The auto detection might query EC2 Instance Metadata service (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html), which might introduce latency. Therefore we recommend choosing an explicit defaults_mode instead if startup latency is critical to your application
DefaultsModeCrossRegion builds on the standard mode and includes optimization tailored for applications which call AWS services in a different region Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
DefaultsModeInRegion builds on the standard mode and includes optimization tailored for applications which call AWS services from within the same AWS region Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
DefaultsModeLegacy provides default settings that vary per SDK and were used prior to establishment of defaults_mode
DefaultsModeMobile builds on the standard mode and includes optimization tailored for mobile applications Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
DefaultsModeStandard provides the latest recommended default values that should be safe to run in most scenarios Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
DualStackEndpointStateDisabled disables dual-stack endpoint resolution for endpoints.
DualStackEndpointStateEnabled enables dual-stack endpoint resolution for service endpoints.
DualStackEndpointStateUnset is the default value behavior for dual-stack endpoint resolution.
EndpointDiscoveryAuto represents an AUTO state that allows endpoint discovery only when required by the api. This is the default configuration resolved by the client if endpoint discovery is neither enabled or disabled.
EndpointDiscoveryDisabled indicates client MUST not perform endpoint discovery even when required.
EndpointDiscoveryEnabled indicates client MUST always perform endpoint discovery if supported for the operation.
EndpointDiscoveryUnset represents EndpointDiscoveryEnableState is unset. Users do not need to use this value explicitly. The behavior for unset is the same as for EndpointDiscoveryAuto.
EndpointSourceCustom denotes endpoint is a custom endpoint. This source should be used when user provides a custom endpoint to be used by the SDK.
EndpointSourceServiceMetadata denotes service modeled endpoint metadata is used as Endpoint Source.
Enumerations for the values of the Ternary type.
FIPSEndpointStateDisabled disables FIPS endpoint resolution for endpoints.
FIPSEndpointStateEnabled enables FIPS endpoint resolution for service endpoints.
FIPSEndpointStateUnset is the default value behavior for FIPS endpoint resolution.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
Supported ClientLogMode bits that can be configured to toggle logging of specific SDK events.
RetryModeAdaptive model provides attempt send rate limiting on throttle responses in addition to standard mode's retry rate limiting. Adaptive retry mode is experimental and is subject to change in the future.
RetryModeStandard model provides rate limited retry attempts with exponential backoff delay.
SDKName is the name of this AWS SDK
SDKVersion is the version of this SDK
Enumerations for the values of the Ternary type.
Enumerations for the values of the Ternary type.