package
1.50.8
Repository: https://github.com/polygon-io/aws-sdk-go-v2.git
Documentation: pkg.go.dev

# Packages

Package arn provides a parser for interacting with Amazon Resource Names.
Package defaults provides recommended configuration values for AWS SDKs and CLIs.
No description provided by the author
No description provided by the author
No description provided by the author
Package retry provides interfaces and implementations for SDK request retry behavior.
No description provided by the author
No description provided by the author

# Functions

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.
GetResolvedRegion takes a service's EndpointResolverOptions and returns the ResolvedRegion value.
GetUseDualStackEndpoint takes a service's EndpointResolverOptions and returns the UseDualStackEndpoint value.
GetUseFIPSEndpoint takes a service's EndpointResolverOptions and returns the UseDualStackEndpoint value.
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.
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.
ParseRetryMode attempts to parse a RetryMode from the given string.
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.
ToBoolMap returns a map of bool values, that are dereferenced if the passed in pointer was not nil.
ToBoolSlice returns a slice of bool values, that are dereferenced if the passed in pointer was not nil.
ToByte returns byte value dereferenced if the passed in pointer was not nil.
ToByteMap returns a map of byte values, that are dereferenced if the passed in pointer was not nil.
ToByteSlice returns a slice of byte values, that are dereferenced if the passed in pointer was not nil.
ToDuration returns time.Duration value dereferenced if the passed in pointer was not nil.
ToDurationMap returns a map of time.Duration values, that are dereferenced if the passed in pointer was not nil.
ToDurationSlice returns a slice of time.Duration values, that are dereferenced if the passed in pointer was not nil.
ToFloat32 returns float32 value dereferenced if the passed in pointer was not nil.
ToFloat32Map returns a map of float32 values, that are dereferenced if the passed in pointer was not nil.
ToFloat32Slice returns a slice of float32 values, that are dereferenced if the passed in pointer was not nil.
ToFloat64 returns float64 value dereferenced if the passed in pointer was not nil.
ToFloat64Map returns a map of float64 values, that are dereferenced if the passed in pointer was not nil.
ToFloat64Slice returns a slice of float64 values, that are dereferenced if the passed in pointer was not nil.
ToInt returns int value dereferenced if the passed in pointer was not nil.
ToInt16 returns int16 value dereferenced if the passed in pointer was not nil.
ToInt16Map returns a map of int16 values, that are dereferenced if the passed in pointer was not nil.
ToInt16Slice returns a slice of int16 values, that are dereferenced if the passed in pointer was not nil.
ToInt32 returns int32 value dereferenced if the passed in pointer was not nil.
ToInt32Map returns a map of int32 values, that are dereferenced if the passed in pointer was not nil.
ToInt32Slice returns a slice of int32 values, that are dereferenced if the passed in pointer was not nil.
ToInt64 returns int64 value dereferenced if the passed in pointer was not nil.
ToInt64Map returns a map of int64 values, that are dereferenced if the passed in pointer was not nil.
ToInt64Slice returns a slice of int64 values, that are dereferenced if the passed in pointer was not nil.
ToInt8 returns int8 value dereferenced if the passed in pointer was not nil.
ToInt8Map returns a map of int8 values, that are dereferenced if the passed in pointer was not nil.
ToInt8Slice returns a slice of int8 values, that are dereferenced if the passed in pointer was not nil.
ToIntMap returns a map of int values, that are dereferenced if the passed in pointer was not nil.
ToIntSlice returns a slice of int values, that are dereferenced if the passed in pointer was not nil.
ToString returns string value dereferenced if the passed in pointer was not nil.
ToStringMap returns a map of string values, that are dereferenced if the passed in pointer was not nil.
ToStringSlice returns a slice of string values, that are dereferenced if the passed in pointer was not nil.
ToTime returns time.Time value dereferenced if the passed in pointer was not nil.
ToTimeMap returns a map of time.Time values, that are dereferenced if the passed in pointer was not nil.
ToTimeSlice returns a slice of time.Time values, that are dereferenced if the passed in pointer was not nil.
ToUint returns uint value dereferenced if the passed in pointer was not nil.
ToUint16 returns uint16 value dereferenced if the passed in pointer was not nil.
ToUint16Map returns a map of uint16 values, that are dereferenced if the passed in pointer was not nil.
ToUint16Slice returns a slice of uint16 values, that are dereferenced if the passed in pointer was not nil.
ToUint32 returns uint32 value dereferenced if the passed in pointer was not nil.
ToUint32Map returns a map of uint32 values, that are dereferenced if the passed in pointer was not nil.
ToUint32Slice returns a slice of uint32 values, that are dereferenced if the passed in pointer was not nil.
ToUint64 returns uint64 value dereferenced if the passed in pointer was not nil.
ToUint64Map returns a map of uint64 values, that are dereferenced if the passed in pointer was not nil.
ToUint64Slice returns a slice of uint64 values, that are dereferenced if the passed in pointer was not nil.
ToUint8 returns uint8 value dereferenced if the passed in pointer was not nil.
ToUint8Map returns a map of uint8 values, that are dereferenced if the passed in pointer was not nil.
ToUint8Slice returns a slice of uint8 values, that are dereferenced if the passed in pointer was not nil.
ToUintMap returns a map of uint values, that are dereferenced if the passed in pointer was not nil.
ToUintSlice returns a slice of uint values, that are dereferenced if the passed in pointer was not 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.

# Constants

DefaultsModeAuto is an experimental mode that builds on the standard mode.
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.
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.
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.
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.
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.
default state.
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.
EndpointSourceCustom denotes endpoint is a custom endpoint.
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.
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.

# Structs

AnonymousCredentials provides a sentinel CredentialsProvider that should be used to instruct the SDK's signing middleware to not sign the request.
A Config provides service configuration for service clients.
A Credentials is the AWS credentials value for individual credential fields.
CredentialsCache provides caching and concurrency safe credentials retrieval via the provider's retrieve method.
CredentialsCacheOptions are the options.
Endpoint represents the endpoint a service client should make API operation calls to.
EndpointNotFoundError is a sentinel error to indicate that the EndpointResolver implementation was unable to resolve an endpoint for the given service and region.
MissingRegionError is an error that is returned if region configuration value was not found.
NopRetryer provides a RequestRetryDecider implementation that will flag all attempt errors as not retryable, with a max attempts of 1.
RequestCanceledError is the error that will be returned by an API request that was canceled.
RuntimeEnvironment is a collection of values that are determined at runtime based on the environment that the SDK is executing in.

# Interfaces

AdjustExpiresByCredentialsCacheStrategy is an interface for CredentialCache to allow CredentialsProvider to intercept adjustments to Credentials expiry based on expectations and use cases of CredentialsProvider.
A CredentialsProvider is the interface for any component which will provide credentials Credentials.
EndpointResolver is an endpoint resolver that can be used to provide or override an endpoint for the given service and region.
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.
HandleFailRefreshCredentialsCacheStrategy is an interface for CredentialsCache to allow CredentialsProvider how failed to refresh credentials is handled.
HTTPClient provides the interface to provide custom HTTPClients.
Retryer is an interface to determine if a given error from a attempt should be retried, and if so what backoff delay to apply.
RetryerV2 is an interface to determine if a given error from an attempt should be retried, and if so what backoff delay to apply.

# Type aliases

ClientLogMode represents the logging mode of SDK clients.
CredentialsProviderFunc provides a helper wrapping a function value to satisfy the CredentialsProvider interface.
DefaultsMode is the SDK defaults mode setting.
DualStackEndpointState is a constant to describe the dual-stack endpoint resolution behavior.
EndpointDiscoveryEnableState indicates if endpoint discovery is enabled, disabled, auto or unset state.
EndpointResolverFunc wraps a function to satisfy the EndpointResolver interface.
EndpointResolverWithOptionsFunc wraps a function to satisfy the EndpointResolverWithOptions interface.
EndpointSource is the endpoint source type.
ExecutionEnvironmentID is the AWS execution environment runtime identifier.
FIPSEndpointState is a constant to describe the FIPS endpoint resolution behavior.
RetryMode provides the mode the API client will use to create a retryer based on.
Ternary is an enum allowing an unknown or none state in addition to a bool's true and false.